0% found this document useful (0 votes)
103 views348 pages

8000gs Clig

Uploaded by

boyd
Copyright
© Attribution Non-Commercial (BY-NC)
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
103 views348 pages

8000gs Clig

Uploaded by

boyd
Copyright
© Attribution Non-Commercial (BY-NC)
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 348

Management Software

AT-S95

CLI Users Guide


AT-8000GS Series Stackable Gigabit Ethernet Switches Version 1.0.1

613-001020 Rev. A

Copyright 2008 Allied Telesis, Inc. All rights reserved. No part of this publication may be reproduced without prior written permission from Allied Telesis, Inc. Allied Telesis is a trademark of Allied Telesis, Inc. Microsoft and Internet Explorer are registered trademarks of Microsoft Corporation. Netscape Navigator is a registered trademark of Netscape Communications Corporation. All other product names, company names, logos or other designations mentioned herein are trademarks or registered trademarks of their respective owners. Allied Telesis, Inc. reserves the right to make changes in specifications and other information contained in this document without prior written notice. The information provided herein is subject to change without notice. In no event shall Allied Telesis, Inc. be liable for any incidental, special, indirect, or consequential damages whatsoever, including but not limited to lost profits, arising out of or related to this manual or the information contained herein, even if Allied Telesis, Inc. has been advised of, known, or should have known, the possibility of such damages.

Table of Contents
Preface ................................................................................................................................... 1
Intended Audience........................................................................................................................... 2 Document Conventions ................................................................................................................... 3 Contacting Allied Telesis ................................................................................................................. 4

Chapter 1.Using the CLI ....................................................................................................... 5


Overview ................................................................................................................................................5 CLI Command Modes...................................................................................................................... 5
Introduction ................................................................................................................................................5 User EXEC Mode ......................................................................................................................................5 Privileged EXEC Mode ..............................................................................................................................5 Global Configuration Mode ........................................................................................................................6 Interface Configuration and Specific Configuration Modes........................................................................7

Starting the CLI................................................................................................................................ 8 Editing Features .............................................................................................................................. 9


Entering Commands ..................................................................................................................................9 Terminal Command Buffer ...................................................................................................................9 Negating the Effect of Commands .....................................................................................................10 Command Completion........................................................................................................................10 Nomenclature .....................................................................................................................................10 Keyboard Shortcuts............................................................................................................................10 CLI Command Conventions ...............................................................................................................11 Copying and Pasting Text........................................................................................................................11

Chapter 2.ACL Commands ................................................................................................ 13


ip access-list.........................................................................................................................................13 permit (ip) .............................................................................................................................................13 deny (IP)...............................................................................................................................................16 mac access-list.....................................................................................................................................18 permit (MAC)........................................................................................................................................19 deny (MAC) ..........................................................................................................................................20 service-acl ............................................................................................................................................21 show access-lists .................................................................................................................................22 show interfaces access-lists.................................................................................................................22

Chapter 3.AAA Commands ................................................................................................ 24


aaa authentication login .......................................................................................................................24 aaa authentication enable ....................................................................................................................25 login authentication ..............................................................................................................................26 enable authentication ...........................................................................................................................27 ip http authentication ............................................................................................................................27

Page i

Allied Telesis
Command Line Interface Users Guide

ip https authentication.......................................................................................................................... 28 show authentication methods .............................................................................................................. 29 password ............................................................................................................................................. 30 username............................................................................................................................................. 30 show users accounts ........................................................................................................................... 31 enable password ................................................................................................................................. 32

Chapter 4.Address Table Commands ............................................................................... 34


bridge address..................................................................................................................................... 34 bridge multicast filtering....................................................................................................................... 34 bridge multicast address...................................................................................................................... 35 bridge multicast forbidden address...................................................................................................... 36 bridge multicast forward-all.................................................................................................................. 37 bridge multicast forbidden forward-all.................................................................................................. 38 bridge aging-time................................................................................................................................. 38 clear bridge.......................................................................................................................................... 39 port security ......................................................................................................................................... 39 port security mode ............................................................................................................................... 40 port security max ................................................................................................................................. 41 port security routed secure-address .................................................................................................... 41 show bridge address-table .................................................................................................................. 42 show bridge address-table static ......................................................................................................... 43 show bridge address-table count......................................................................................................... 44 show bridge multicast address-table ................................................................................................... 45 show bridge multicast address-table static.......................................................................................... 47 show bridge multicast filtering ............................................................................................................. 47 show ports security.............................................................................................................................. 49 show ports security addresses ............................................................................................................ 50

Chapter 5.Clock Commands .............................................................................................. 52


clock set............................................................................................................................................... 52 clock source......................................................................................................................................... 52 clock timezone..................................................................................................................................... 53 clock summer-time .............................................................................................................................. 54 sntp authentication-key........................................................................................................................ 55 sntp authenticate ................................................................................................................................. 56 sntp trusted-key ................................................................................................................................... 56 sntp client poll timer............................................................................................................................. 57 sntp broadcast client enable................................................................................................................ 57 sntp anycast client enable ................................................................................................................... 58 sntp client enable (Interface) ............................................................................................................... 59 sntp unicast client enable .................................................................................................................... 59 sntp unicast client poll ......................................................................................................................... 60 sntp server........................................................................................................................................... 60 show clock ........................................................................................................................................... 61 show sntp configuration....................................................................................................................... 62 show sntp status.................................................................................................................................. 63

Page ii Not approved by Document Control. For review only.

Chapter 6.Configuration and Image File Commands ...................................................... 65


copy......................................................................................................................................................65 dir .........................................................................................................................................................67 delete ...................................................................................................................................................68 boot system..........................................................................................................................................69 show running-config .............................................................................................................................69 show startup-config ..............................................................................................................................70 show bootvar........................................................................................................................................71

Chapter 7.DHCP Option 82 Commands ............................................................................ 72


ip dhcp information option ....................................................................................................................72 show ip dhcp information option...........................................................................................................72 ip dhcp relay enable .............................................................................................................................73

Chapter 8.DHCP Snooping Commands ............................................................................ 74


ip dhcp snooping ..................................................................................................................................74 ip dhcp snooping vlan ..........................................................................................................................74 ip dhcp snooping trust ..........................................................................................................................75 ip dhcp snooping information option allowed-untrusted .......................................................................76 ip dhcp snooping verify ........................................................................................................................76 ip dhcp snooping database ..................................................................................................................77 ip dhcp snooping database update-freq...............................................................................................77 ip dhcp snooping binding .....................................................................................................................78 clear ip dhcp snooping database .........................................................................................................79 show ip dhcp snooping.........................................................................................................................79 show ip dhcp snooping binding ............................................................................................................80

Chapter 9.Ethernet Configuration Commands................................................................. 82


interface ethernet .................................................................................................................................82 interface range ethernet .......................................................................................................................82 shutdown..............................................................................................................................................83 description............................................................................................................................................84 speed ...................................................................................................................................................84 duplex...................................................................................................................................................85 negotiation............................................................................................................................................86 flowcontrol ............................................................................................................................................86 mdix......................................................................................................................................................87 back-pressure ......................................................................................................................................88 port jumbo-frame..................................................................................................................................88 system flowcontrol................................................................................................................................89 clear counters.......................................................................................................................................89 set interface active ...............................................................................................................................90 show interfaces advertise.....................................................................................................................90 show interfaces configuration...............................................................................................................91 show interfaces status..........................................................................................................................93 show interfaces description..................................................................................................................94 show ports jumbo-frame.......................................................................................................................95

Page iii

Allied Telesis
Command Line Interface Users Guide

show interfaces counters..................................................................................................................... 95 show system flowcontrol...................................................................................................................... 99 port storm-control include-multicast (IC).............................................................................................. 99 port storm-control broadcast enable.................................................................................................. 100 port storm-control broadcast rate ...................................................................................................... 101 show ports storm-control ................................................................................................................... 102

Chapter 10.GVRP Commands.......................................................................................... 103


gvrp enable (Global) .......................................................................................................................... 103 gvrp enable (Interface) ...................................................................................................................... 103 garp timer .......................................................................................................................................... 104 gvrp vlan-creation-forbid.................................................................................................................... 105 gvrp registration-forbid....................................................................................................................... 105 clear gvrp statistics ............................................................................................................................ 106 show gvrp configuration..................................................................................................................... 106 show gvrp statistics ........................................................................................................................... 107 show gvrp error-statistics................................................................................................................... 108

Chapter 11.IGMP Snooping Commands ......................................................................... 110


ip igmp snooping (Global).................................................................................................................. 110 ip igmp snooping (Interface) .............................................................................................................. 110 ip igmp snooping mrouter learn-pim-dvmrp....................................................................................... 111 ip igmp snooping host-time-out ......................................................................................................... 112 ip igmp snooping querier enable ....................................................................................................... 112 ip igmp snooping querier address ..................................................................................................... 113 ip igmp snooping querier version....................................................................................................... 114 ip igmp snooping mrouter-time-out.................................................................................................... 114 ip igmp snooping leave-time-out........................................................................................................ 115 show ip igmp snooping mrouter......................................................................................................... 116 show ip igmp snooping interface ....................................................................................................... 117 show ip igmp snooping groups .......................................................................................................... 118

Chapter 12.IP Addressing Commands............................................................................ 119


ip address .......................................................................................................................................... 119 ip address dhcp ................................................................................................................................. 119 ip default-gateway ............................................................................................................................. 120 show ip interface................................................................................................................................ 121 arp ..................................................................................................................................................... 122 arp timeout......................................................................................................................................... 122 clear arp-cache.................................................................................................................................. 123 show arp ............................................................................................................................................ 124 ip domain-lookup ............................................................................................................................. 124 ip domain-name................................................................................................................................. 125 ip name-server................................................................................................................................... 126 ip domain-name................................................................................................................................. 126 ip name-server................................................................................................................................... 127 ip host ................................................................................................................................................ 127

Page iv Not approved by Document Control. For review only.

clear host............................................................................................................................................128 clear host dhcp...................................................................................................................................129 show hosts .........................................................................................................................................129

Chapter 13.Line Commands ............................................................................................ 131


line......................................................................................................................................................131 speed .................................................................................................................................................131 autobaud ............................................................................................................................................132 exec-timeout.......................................................................................................................................133 history.................................................................................................................................................133 history size .........................................................................................................................................134 terminal history...................................................................................................................................134 terminal history size ...........................................................................................................................135 show line ............................................................................................................................................135

Section 14.LACP Commands........................................................................................... 138


lacp system-priority ............................................................................................................................138 lacp port-priority .................................................................................................................................139 lacp timeout........................................................................................................................................140 show lacp ethernet .............................................................................................................................141 show lacp port-channel ......................................................................................................................143

Chapter 15.Management ACL Commands ..................................................................... 144


management access-list ....................................................................................................................144 permit (Management).........................................................................................................................145 deny (Management) ...........................................................................................................................146 management access-class.................................................................................................................146 show management access-list ...........................................................................................................147 show management access-class .......................................................................................................148

Chapter 16.PHY Diagnostics Commands ....................................................................... 149


test copper-port tdr.............................................................................................................................149 show copper-ports tdr ........................................................................................................................149 show copper-ports cable-length .........................................................................................................150

Chapter 17.Port Channel Commands ............................................................................. 152


interface port-channel ........................................................................................................................152 interface range port-channel ..............................................................................................................152 channel-group ....................................................................................................................................153 show interfaces port-channel .............................................................................................................153

Chapter 18.Port Monitor Commands .............................................................................. 155


port monitor ........................................................................................................................................155 show ports monitor.............................................................................................................................156

Chapter 19.Power over Ethernet Commands ................................................................. 157


power inline ........................................................................................................................................157

Page v

Allied Telesis
Command Line Interface Users Guide

power inline powered-device ............................................................................................................. 157 power inline priority............................................................................................................................ 158 power inline usage-threshold............................................................................................................. 159 power inline traps enable................................................................................................................... 159 show power inline .............................................................................................................................. 160

Chapter 20.QoS Commands ............................................................................................ 164


qos..................................................................................................................................................... 164 show qos ........................................................................................................................................... 164 priority-queue out num-of-queues ..................................................................................................... 165 rate-limit............................................................................................................................................. 165 traffic-shape....................................................................................................................................... 166 show qos interface............................................................................................................................. 166 wrr-queue cos-map............................................................................................................................ 167 qos trust(Global) ................................................................................................................................ 168 qos map dscp-queue ......................................................................................................................... 169 qos cos .............................................................................................................................................. 170 show qos map ................................................................................................................................... 170

Chapter 21.Radius Commands........................................................................................ 172


radius-server host.............................................................................................................................. 172 radius-server key ............................................................................................................................... 173 radius-server retransmit..................................................................................................................... 173 radius-server source-ip...................................................................................................................... 174 radius-server timeout......................................................................................................................... 175 radius-server deadtime...................................................................................................................... 175 show radius-servers .......................................................................................................................... 176

Chapter 22.RMON Commands......................................................................................... 178


show rmon statistics .......................................................................................................................... 178 rmon collection history....................................................................................................................... 180 show rmon collection history ............................................................................................................. 180 show rmon history ............................................................................................................................. 181 rmon alarm ........................................................................................................................................ 184 show rmon alarm-table ...................................................................................................................... 185 show rmon alarm ............................................................................................................................... 186 rmon event......................................................................................................................................... 187 show rmon events ............................................................................................................................. 188 show rmon log ................................................................................................................................... 189 rmon table-size .................................................................................................................................. 190

Chapter 23.SNMP Commands ......................................................................................... 192


snmp-server community .................................................................................................................... 192 snmp-server view .............................................................................................................................. 193 snmp-server group ............................................................................................................................ 194 snmp-server user............................................................................................................................... 194 snmp-server engineID local............................................................................................................... 196

Page vi Not approved by Document Control. For review only.

snmp-server enable traps ..................................................................................................................197 snmp-server filter ...............................................................................................................................197 snmp-server host ...............................................................................................................................198 snmp-server v3-host ..........................................................................................................................199 snmp-server trap authentication.........................................................................................................200 snmp-server contact...........................................................................................................................201 snmp-server location..........................................................................................................................201 snmp-server set .................................................................................................................................202 show snmp .........................................................................................................................................203 show snmp engineid ..........................................................................................................................204 show snmp views ...............................................................................................................................205 show snmp groups .............................................................................................................................205 show snmp filters ...............................................................................................................................206 show snmp users ...............................................................................................................................207

Chapter 24.Spanning-Tree Commands........................................................................... 208


spanning-tree .....................................................................................................................................208 spanning-tree mode ...........................................................................................................................208 spanning-tree forward-time ................................................................................................................209 spanning-tree hello-time.....................................................................................................................209 spanning-tree max-age ......................................................................................................................210 spanning-tree priority .........................................................................................................................211 spanning-tree disable.........................................................................................................................211 spanning-tree cost..............................................................................................................................212 spanning-tree port-priority ..................................................................................................................213 spanning-tree portfast ........................................................................................................................213 spanning-tree link-type.......................................................................................................................214 spanning-tree pathcost method..........................................................................................................214 spanning-tree bpdu ............................................................................................................................215 spanning-tree guard root....................................................................................................................216 spanning-tree bpduguard ...................................................................................................................216 clear spanning-tree detected-protocols..............................................................................................217 spanning-tree mst priority...................................................................................................................217 spanning-tree mst max-hops..............................................................................................................218 spanning-tree mst port-priority ...........................................................................................................218 spanning-tree mst cost.......................................................................................................................219 spanning-tree mst configuration.........................................................................................................220 instance (mst).....................................................................................................................................220 name (mst) .........................................................................................................................................221 revision (mst)......................................................................................................................................222 show (mst)..........................................................................................................................................222 exit (mst) ............................................................................................................................................223 abort (mst)..........................................................................................................................................224 show spanning-tree............................................................................................................................224

Chapter 25.SSH Commands ............................................................................................ 236


ip ssh port...........................................................................................................................................236

Page vii

Allied Telesis
Command Line Interface Users Guide

ip ssh server ...................................................................................................................................... 236 crypto key generate dsa .................................................................................................................... 237 crypto key generate rsa ..................................................................................................................... 237 ip ssh pubkey-auth ............................................................................................................................ 238 crypto key pubkey-chain ssh ............................................................................................................. 238 user-key............................................................................................................................................. 239 key-string ........................................................................................................................................... 240 show ip ssh........................................................................................................................................ 241 show crypto key mypubkey ............................................................................................................... 242 show crypto key pubkey-chain ssh.................................................................................................... 243

Chapter 26.Syslog Commands ........................................................................................ 245


logging on .......................................................................................................................................... 245 logging ............................................................................................................................................... 245 logging console.................................................................................................................................. 246 logging buffered................................................................................................................................. 247 logging buffered size ......................................................................................................................... 247 clear logging ...................................................................................................................................... 248 logging file ......................................................................................................................................... 249 clear logging file................................................................................................................................. 249 aaa logging ........................................................................................................................................ 250 file-system logging............................................................................................................................. 250 management logging ......................................................................................................................... 251 show logging...................................................................................................................................... 252 show logging file ................................................................................................................................ 254 show syslog-servers .......................................................................................................................... 256

Chapter 27.TACACS+ Commands................................................................................... 258


tacacs-server host ............................................................................................................................. 258 tacacs-server key .............................................................................................................................. 259 tacacs-server timeout ........................................................................................................................ 259 tacacs-server source-ip ..................................................................................................................... 260 show tacacs....................................................................................................................................... 260

Chapter 28.System Management Commands ................................................................ 262


ping.................................................................................................................................................... 262 reload................................................................................................................................................. 264 resume............................................................................................................................................... 264 hostname........................................................................................................................................... 265 stack master ...................................................................................................................................... 265 stack reload ....................................................................................................................................... 266 stack change unit-id........................................................................................................................... 267 show stack......................................................................................................................................... 267 show users ........................................................................................................................................ 269 show sessions ................................................................................................................................... 270 show system...................................................................................................................................... 271 show system id .................................................................................................................................. 272

Page viii Not approved by Document Control. For review only.

show version ......................................................................................................................................273 set system ..........................................................................................................................................275

Chapter 29.User Interface Commands ............................................................................ 276


enable ................................................................................................................................................276 disable................................................................................................................................................276 login....................................................................................................................................................277 configure ............................................................................................................................................277 exit (Configuration).............................................................................................................................278 exit......................................................................................................................................................278 end .....................................................................................................................................................279 help ....................................................................................................................................................279 terminal datadump .............................................................................................................................280 show history .......................................................................................................................................281 show privilege ....................................................................................................................................281

Chapter 30.VLAN Commands .......................................................................................... 283


vlan database.....................................................................................................................................283 vlan.....................................................................................................................................................283 default-vlan disable ............................................................................................................................284 default-vlan vlan .................................................................................................................................284 interface vlan......................................................................................................................................285 interface range vlan............................................................................................................................286 name ..................................................................................................................................................286 switchport protected ...........................................................................................................................287 switchport mode .................................................................................................................................288 switchport access vlan .......................................................................................................................289 switchport trunk allowed vlan .............................................................................................................289 switchport trunk native vlan................................................................................................................290 switchport general allowed vlan .........................................................................................................290 switchport general pvid ......................................................................................................................291 switchport general ingress-filtering disable ........................................................................................292 switchport general acceptable-frame-type tagged-only .....................................................................292 switchport general acceptable-frame-type tagged-only .....................................................................293 switchport general map macs-group vlan ..........................................................................................293 map mac macs-group ........................................................................................................................294 show vlan macs-group .......................................................................................................................295 switchport forbidden vlan ...................................................................................................................295 ip internal-usage-vlan.........................................................................................................................296 show vlan ...........................................................................................................................................298 show vlan internal usage....................................................................................................................298 show interfaces switchport .................................................................................................................299

Chapter 31.Web Server Commands ................................................................................ 303


ip http server ......................................................................................................................................303 ip http port ..........................................................................................................................................303 ip http exec-timeout............................................................................................................................304

Page ix

Allied Telesis
Command Line Interface Users Guide

ip https server .................................................................................................................................... 304 ip https port........................................................................................................................................ 305 ip https exec-timeout ......................................................................................................................... 305 crypto certificate generate ................................................................................................................. 306 crypto certificate request ................................................................................................................... 307 crypto certificate import ..................................................................................................................... 308 ip https certificate............................................................................................................................... 309 show crypto certificate mycertificate.................................................................................................. 310 show ip http ....................................................................................................................................... 311 show ip https...................................................................................................................................... 311

Chapter 32.802.1x Commands......................................................................................... 313


aaa authentication dot1x ................................................................................................................... 313 dot1x system-auth-control ................................................................................................................. 313 dot1x port-control............................................................................................................................... 314 dot1x re-authentication ...................................................................................................................... 315 dot1x timeout re-authperiod............................................................................................................... 315 dot1x re-authenticate......................................................................................................................... 316 dot1x timeout quiet-period ................................................................................................................. 316 dot1x timeout tx-period ...................................................................................................................... 317 dot1x max-req.................................................................................................................................... 318 dot1x timeout supp-timeout ............................................................................................................... 318 dot1x timeout server-timeout ............................................................................................................. 319 show dot1x ........................................................................................................................................ 320 show dot1x users............................................................................................................................... 323 show dot1x statistics.......................................................................................................................... 324 dot1x auth-not-req ............................................................................................................................. 326 dot1x guest-vlan ................................................................................................................................ 327 dot1x single-host-violation ................................................................................................................. 328 dot1x mac-authentication .................................................................................................................. 328 show dot1x advanced........................................................................................................................ 329 dot1x guest-vlan enable .................................................................................................................... 330 ........................................................................................................................................................... 331

Index................................................................................................................................... 332

Page x Not approved by Document Control. For review only.

Preface

Preface
This guide describes how to configure an AT-S95 v1.0.04 v1.1.0 Series switch using the command line interface. The commands are grouped by topic into the following chapters:

Chapter 1. "Using the CLI" Describe the CLI basic structure and command usage. Chapter 2. "ACL Commands" Define MAC and IP based ACLs and ACL bindings. Chapter 3. "AAA Commands" Define the authentication method lists for servers. Chapter 4. "Address Table Commands" Register MAC-layer Multicast addresses, and handles MAClayer secure address to a routed port . Chapter 5. "Clock Commands" Show the configuration or status of the Simple Network Time Protocol (SNTP). Chapter 6. "Configuration and Image File Commands" Display the contents of the currently running configuration file, specify contents of image files. Chapter 7. "DHCP Option 82 Commands" DHCP with Option 82 attaches authentication messages to the packets sent from the host. DHCP passes the configuration information to hosts on a TCP/IP network. This permits network administrators to limit address allocation authorized hosts. Chapter 8. "DHCP Snooping Commands" Contains parameters for enabling DHCP Snooping on the device Chapter 9. "Ethernet Configuration Commands" Configure multiple Ethernet type interfaces. Chapter 10. "GVRP Commands" Display the GARP VLAN Registration Protocol (GVRP) configuration information, enable GVRP globally or on an interface. Chapter 11. "IGMP Snooping Commands" Enable the Internet Group Management Protocol (IGMP) snooping. Chapter 12. "IP Addressing Commands" Define a default gateway, set an IP address for interface, delete entries from the host. Chapter 13. "Line Commands" Display line parameters, enable the command history function, or configure the command history buffer size. Configure system priority, physical port priority, assign

Page 1

Allied Telesis
Command Line Interface Users Guide

administrative LACP timeouts, display LACP information for Ethernet ports, and display LACP information for a port-channel. Chapter 15. "Management ACL Commands" Define a permit or deny a rule, or configure a management access control list. Chapter 16. "PHY Diagnostics Commands" Display the optical transceiver diagnostics. Chapter 17. "Port Channel Commands" Enter the interface configuration mode to configure a specific, or a multiple port-channel. Chapter 18. "Port Monitor Commands" Start a port monitoring session, or display the port monitoring status. Chapter 19. "Power over Ethernet Commands" Configure and display Power over Ethernet device settings. Chapter 20. "QoS Commands" Enable Quality of Service (QoS) on the device, create policy maps, and define traffic classifications Chapter 21. "Radius Commands" Specify the source IP address used for communication with Remote Authentication Dial-in User Service (RADIUS) servers, and display the RADIUS server settings. Chapter 22. "RMON Commands" Display the Remote Network Monitoring (RMON) Ethernet history statistics, alarms table and configuration. Chapter 23. "SNMP Commands" Configure the community access string to permit access to the Simple Network Management Protocol (SNMP) server, create or update SNMP server entries, and specify SNMP engineID. Chapter 24. "Spanning-Tree Commands" Configure the spanning-tree functionality. Chapter 25. "SSH Commands" Display the Secure Socket Shell (SSH) public keys on the device, SSH server configuration, or which SSH public key is manually configured. Chapter 26. "Syslog Commands" Log messages to a syslog server, or limit log messages to a syslog server. Chapter 27. "TACACS+ Commands" Display configuration and statistical information about a Terminal Access Controller Access Control System (TACACS+) server, or specify a TACACS+ host. Chapter 28. "System Management Commands" Display and list system, version or Telnet session information. Chapter 29. "User Interface Commands" Display and list system, version or Telnet session information. Chapter 30. "VLAN Commands" Enter the (Virtual Local Area Network) VLAN Configuration mode, enable simultaneously configuring multiple VLANs, or adds or remove VLANs. Chapter 31. "Web Server Commands" Enable configuring the device from a browser, or display the HTTP server configuration. Chapter 32. "802.1x Commands" Specify authentication, authorization and accounting (AAA) methods for use on interfaces running IEEE 802.1x, and enable 802.1x globally.

Intended Audience
This guide is intended for network administrators familiar with IT concepts and terminology.

Page 2 Not approved by Document Control. For review only.

Preface
Document Conventions

Document Conventions
This document uses the following conventions:

Note Provides related information or information of special importance. Caution Indicates potential damage to hardware or software, or loss of data. Warning Indicates a risk of personal injury.

Page 3

Allied Telesis
Command Line Interface Users Guide

Contacting Allied Telesis


This section provides Allied Telesis contact information for technical support as well as sales or corporate information. . Online Support You can request technical support online by accessing the Allied Telesis Knowledge Base from the following web site: www.alliedtelesis.com/support. You can use the Knowledge Base to submit questions to our technical support staff and review answers to previously asked questions..

Email and Telephone For Technical Support via email or telephone, refer to the Allied Telesis web site: www.alliedtelesis.com. Select your country from the list displayed on the website. Then Support select the appropriate menu tab. Returning Products Products for return or repair must first be assigned a Return Materials Authorization (RMA) number. A product sent to Allied Telesis without a RMA number will be returned to the sender at the senders expense. To obtain an RMA number, contact the Allied Telesis Technical Support group at our web site: www.alliedtelesis.com/support/rma. Select your country from the list displayed on the website. Then select the appropriate menu tab. For Sales or Corporate Information Warranty You can contact Allied Telesis for sales or corporate information at our web site: www.alliedtelesis.com. Select your country from the list displayed on the website. Then select the appropriate menu tab. The AT-AT-800GS series intelligent Multiservice Gateway has a limited warranty of two years. Go to www.alliedtelesis.com/warranty for the specific terms and conditions of the warranty and for warranty registration.

Page 4 Not approved by Document Control. For review only.

Using the CLI


CLI Command Modes

Chapter 1. Using the CLI


Overview
This chapter describes how to start using the CLI and the CLI command editing features.

CLI Command Modes


Introduction
To assist in configuring the device, the Command Line Interface (CLI) is divided into different command modes. Each command mode has its own set of specific commands. Entering a question mark "?" at the system prompt (console prompt) displays a list of commands available for that particular command mode. From each mode a specific command is used to navigate from one command mode to another. The standard order to access the modes is as follows: User EXEC mode, Privileged EXEC mode, Global Configuration mode, and Interface Configuration mode. When starting a session, the initial mode is the User EXEC mode. Only a limited subset of commands are available in User EXEC mode. This level is reserved for tasks that do not change the configuration. To enter the next level, the Privileged EXEC mode, a password is required. The Privileged EXEC mode gives access to commands that are restricted on User EXEC mode and provides access to the device Configuration mode. The Global Configuration mode manages the device configuration on a global level. The Interface Configuration mode configures specific interfaces in the device.

User EXEC Mode


After logging into the device, the user is automatically in User EXEC command mode unless the user is defined as a privileged user. In general, the User EXEC commands allow the user to perform basic tests, and list system information. The user-level prompt consists of the device host name followed by the angle bracket (>). Console> The default host name is Console unless it has been changed using the hostname command in the Global Configuration mode.

Privileged EXEC Mode


Privileged access is password protected to prevent unauthorized use because many of the privileged commands set operating system parameters. The password is not displayed on the screen and is case sensitive. Privileged users enter directly into the Privileged EXEC mode. To enter the Privileged EXEC mode from the User EXEC mode, perform the following steps: 1. At the prompt enter the enable command and press <Enter>. A password prompt is displayed.

Page 5

Allied Telesis
Command Line Interface Users Guide

2.

Enter the password and press <Enter>. The password is displayed as *. The Privileged EXEC mode prompt is displayed. The Privileged EXEC mode prompt consists of the device host name followed by #.

Console# To return from the Privileged EXEC mode to the User EXEC mode, use the disable command. The following example illustrates how to access the Privileged EXEC mode and return to the User EXEC mode: Console> enable Enter Password: ****** Console# Console# disable Console> The exit command is used to return from any mode to the previous mode except when returning to the User EXEC mode from the Privileged EXEC mode. For example, the exit command is used to return from the Interface Configuration mode to the Global Configuration mode.

Global Configuration Mode


Global Configuration mode commands apply to features that affect the system as a whole, rather than just a specific interface. The configure Privileged EXEC mode command is used to enter the Global Configuration mode. To enter the Global Configuration mode perform the following steps: 1. At the Privileged EXEC mode prompt enter the configure command and press <Enter>. The Global Configuration mode prompt is displayed. The Global Configuration mode prompt consists of the device host name followed by (config) and #.

Console(config)# One of the following commands can be used to return from the Global Configuration mode to the Privileged EXEC mode: exit end Ctrl+Z The following example illustrates how to access the Global Configuration mode and return to the Privileged EXEC mode: Console# Console# configure Console(config)# exit Console#

Page 6 Not approved by Document Control. For review only.

Using the CLI


CLI Command Modes

Interface Configuration and Specific Configuration Modes


Interface Configuration mode commands modify specific interface operations. The following are the Interface Configuration modes:

Line Interface Contains commands to configure the management connections. These include commands such as line timeout settings, etc. The line Global Configuration mode command is used to enter the Line Configuration command mode. VLAN Database Contains commands to create a VLAN as a whole. The VLAN database Global Configuration mode command is used to enter the VLAN Database Interface Configuration mode. Management Access List Contains commands to define management access-lists. The management access-list Global Configuration mode command is used to enter the Management Access List Configuration mode. Ethernet Contains commands to manage port configuration. The interface ethernet Global Configuration mode command is used to enter the Interface Configuration mode to configure an Ethernet type interface. Port Channel Contains commands to configure port-channels, for example, assigning ports to a portchannel. Most of these commands are the same as the commands in the Ethernet interface mode, and are used to manage the member ports as a single entity. The interface port-channel Global Configuration mode command is used to enter the Port Channel Interface Configuration mode. SSH Public Key-chain Contains commands to manually specify other device SSH public keys. The crypto key pubkey-chain ssh Global Configuration mode command is used to enter the SSH Public Keychain Configuration mode. QoS Contains commands related to service definitions. The qos Global Configuration mode command is used to enter the QoS services configuration mode. MAC Access-List Configures conditions required to allow traffic based on MAC addresses. The mac access-list Global Configuration mode command is used to enter the MAC access-list configuration mode.

Page 7

Allied Telesis
Command Line Interface Users Guide

Starting the CLI


The device can be managed over a direct connection to the device console RS-232 port or via a Telnet connection. The device is managed by entering command keywords and parameters at the prompt. Using the device Command Line Interface (CLI) is very similar to entering commands on a UNIX system. If access is via a Telnet connection, ensure that the device has a defined IP address, corresponding management access is granted, and the workstation used to access the device is connected to the device prior to using CLI commands. Note The following steps are for use on the console line only. To start using the CLI, perform the following steps: 1. Connect the DB9 null-modem or cross over cable to the RS-232 serial port of the device to the RS-232 serial port of the terminal or computer running the terminal emulation application. Note The default data rate is 115200 bps. a) Set the data format to 8 data bits, 1 stop bit, and no parity. b) Set Flow Control to none. c) Under Properties, select VT100 for Emulation mode. d) Select Terminal keys for Function, Arrow, and Ctrl keys. Ensure that the setting is for Terminal keys (not Windows keys). Note When using HyperTerminal with Microsoft Windows 2000, ensure that Windows 2000 Service Pack 2 or later is installed. With Windows 2000 Service Pack 2, the arrow keys function properly in HyperTerminals VT100 emulation. Go to www.microsoft.com for information on Windows 2000 service packs. 2. Enter the following commands to begin the configuration procedure:

Console> enable Console# configure Console(config)#


3. 4. Configure the device and enter the necessary commands to complete the required tasks. When finished, exit the session with the exit command.

When a different user is required to log onto the system, use the login Privileged EXEC mode command. This effectively logs off the current user and logs on the new user.

Page 8 Not approved by Document Control. For review only.

Using the CLI


Editing Features

Editing Features
Entering Commands
A CLI command is a series of keywords and arguments. Keywords identify a command, and arguments specify configuration parameters. For example, in the command show interfaces status ethernet 1/e11, show, interfaces and status are keywords, ethernet is an argument that specifies the interface type, and 1/e11 specifies the port. To enter commands that require parameters, enter the required parameters after the command keyword. For example, to set a password for the administrator, enter: Console(config)# username admin password alansmith When working with the CLI, the command options are not displayed. The command is not selected from a menu, but is manually entered. To see what commands are available in each mode or within an interface configuration, the CLI does provide a method of displaying the available commands, the command syntax requirements and in some instances parameters required to complete the command. The standard command to request help is ?. There are two instances where help information can be displayed: Keyword lookup The character ? is entered in place of a command. A list of all valid commands and corresponding help messages are is displayed. Partial keyword lookup If a command is incomplete and or the character ? is entered in place of a parameter. The matched keyword or parameters for this command are displayed. To assist in using the CLI, there is an assortment of editing features. The following features are described:

Terminal Command Buffer Command Completion Nomenclature Keyboard Shortcuts

Terminal Command Buffer


Every time a command is entered in the CLI, it is recorded on an internally managed Command History buffer. Commands stored in the buffer are maintained on a First In First Out (FIFO) basis. These commands can be recalled, reviewed, modified, and reissued. This buffer is not preserved across device resets. K ey wo r d Up-arrow key Ctrl+P Down-arrow key De scr ip t io n Recalls commands in the history buffer, beginning with the most recent command. Repeats the key sequence to recall successively older commands. Returns to more recent commands in the history buffer after recalling commands with the up-arrow key. Repeating the key sequence will recall successively more recent commands.

By default, the history buffer system is enabled, but it can be disabled at any time. For information about the command syntax to enable or disable the history buffer, see history. There is a standard default number of commands that are stored in the buffer. The standard number of 10 commands can be increased to 216. By configuring 0, the effect is the same as disabling the history buffer system. For information about the command syntax for configuring the command history buffer, see history size. To display the history buffer, see show history.

Page 9

Allied Telesis
Command Line Interface Users Guide

Negating the Effect of Commands


For many configuration commands, the prefix keyword no can be entered to cancel the effect of a command or reset the configuration to the default value. This guide describes the negation effect for all applicable commands.

Command Completion
If the command entered is incomplete, invalid or has missing or invalid parameters, then the appropriate error message is displayed. This assists in entering the correct command. By pressing the <Tab> button, an incomplete command is entered. If the characters already entered are not enough for the system to identify a single matching command, press ? to display the available commands matching the characters already entered.

Nomenclature
When referring to an Ethernet port in a CLI command, the following format is used:

For an Ethernet port on a standalone device: Ethernet_type port_number For an Ethernet port on a stacked device: unit_number/Ethernet_type port number

The Ethernet type may be Gigabit Ethernet (indicated by g) or Fast Ethernet (indicated by e). For example, g3 stands for Gigabit Ethernet port 3 on a stand-alone device, and e3 stands for Fast Ethernet port 3 on a stand-alone device, whereas 1/g3 stands for Gigabit Ethernet port 3 on stacking unit 1 and 1/e3 stands for Fast Ethernet port 3 on stacking unit 1. The ports may be described on an individual basis or within a range. Use format port number-port number to specify a set of consecutive ports and port number, port number to indicate a set of non-consecutive ports. For example, g1-3 stands for Gigabit Ethernet ports 1, 2 and 3, and g1, 5 stands for Gigabit Ethernet ports 1 and 5.

Keyboard Shortcuts
The CLI has a range of keyboard shortcuts to assist in editing the CLI commands. The following table describes the CLI shortcuts. Key bo ard Ke y Up-arrow key Down-arrow key D escr ip tio n Recalls commands from the history buffer, beginning with the most recent command. Repeat the key sequence to recall successively older commands. Returns the most recent commands from the history buffer after recalling commands with the up arrow key. Repeating the key sequence will recall successively more recent commands. Moves the cursor to the beginning of the command line. Moves the cursor to the end of the command line. Returns back to the Privileged EXEC mode from any configuration mode. Deletes one character left to the cursor position.

Ctrl+A Ctrl+E Ctrl+Z / End Backspace key

Page 10 Not approved by Document Control. For review only.

CLI Command Conventions


When entering commands there are certain command entry standards that apply to all commands. The following table describes the command conventions. Con ve nti on [] {} Desc ri pti on In a command line, square brackets indicates an optional entry. In a command line, curly brackets indicate a selection of compulsory parameters separated by the | character. One option must be selected. For example: flowcontrol {auto|on|off} means that for the flowcontrol command either auto, on or off must be selected. Indicates a parameter. Indicates an individual key on the keyboard. For example, <Enter> indicates the Enter key. Any combination keys pressed simultaneously on the keyboard. Indicates system messages and prompts appearing on the console. When a parameter is required to define a range of ports or parameters and all is an option, the default for the command is all when no parameters are defined. For example, the command interface range port-channel has the option of either entering a range of channels, or selecting all. When the command is entered without a parameter, it automatically defaults to all.

Italic font <Enter> Ctrl+F4

Screen Display
all

Copying and Pasting Text


Up to 1000 lines of text (i.e., commands) can be copied and pasted into the device. Note It is the users responsibility to ensure that the text copied into the device consists of legal commands only. This feature is dependent on the baud rate of the device. Note The default device baud rate is 115,200 When copying and pasting commands from a configuration file, make sure that the following conditions exist:

A device Configuration mode has been accessed. The commands contain no encrypted data, like encrypted passwords or keys. Encrypted data cannot be copied and pasted into the device.

Allied Telesis
Command Line Interface Users Guide

Page 12 Not approved by Document Control. For review only.

ACL Commands

Chapter 2. ACL Commands


ip access-list
The ip access-list Global Configuration mode command defines an IPv4 Access List and places the device in IPv4 Access List Configuration mode. Use the no form of this command to remove the Access List.

Syntax
ip access-list access-list-name no ip access-list access-list-name

Parameters access-list-name Name of the IPv4 Access List. Default Configuration


No IPv4 Access List is defined

Command Mode
Global Configuration mode

User Guidelines
IPv4 ACLs are defined by a unique name. An IPv4 ACL and MAC ACL cannot share the same name.

Example
The following example places the device in IPv4 Access List Configuration mode. Console(config)# ip access-list

permit (ip)
The permit Ip Access-list Configuration mode command sets conditions to allow a packet to pass a named IP Access List.

Syntax
permit {any | protocol} {any | {source source-wildcard}} {any | {destination destination-wildcard}} [dscp number | ip-precedence number] [fragments] permit-icmp {any | {source source-wildcard}} {any | {destination destination-wildcard}} {any | icmp-type} {any | icmp-code} [dscp number | ip-precedence number] permit-igmp {any | {source source-wildcard}} {any | {destination destination-wildcard}} {any | igmp-type} [dscp number | ip-precedence number] permit-tcp {any | { source source-wildcard}} {any | source-port} {any |{ destination destination-wildcard}} {any | destination-port} [dscp number | ip-precedence number] [flags list-of-flags]

Page 13

Allied Telesis
Command Line Interface Users Guide

permit-udp {any | { source source-wildcard}} {any | source-port} {any | {destination destination-wildcard}} {any | destination-port} [dscp number | ip-precedence number]

Parameters source Source IP address of the packet. source-wildcard Wildcard bits to be applied to the source IP address. Use 1s in the bit position to be
ignored. destination Destination IP address of the packet. destination-wildcard Wildcard bits to be applied to the destination IP address. Use 1s in the bit position to be ignored. protocol The name or the number of an IP protocol. Available protocol names: icmp, igmp, ip, tcp, egp, igp, udp, hmp, rdp, idpr, idrp, rsvp, gre, esp, ah, eigrp, ospf, ipip, pim, l2tp, isis. (Range: 0 - 255) dscp number Specifies the DSCP value. ip-precedence number Specifies the IP precedence value. fragments The set of conditions is applied only to noninitial fragments. icmp-type Specifies an ICMP message type for filtering ICMP packets. Enter a number or one of the following values: echo-reply, destination-unreachable, source-quench, redirect, alternate-hostaddress, echo-request, router-advertisement, router-solicitation, time-exceeded, parameter-problem, timestamp, timestamp-reply, information-request, information-reply, address-mask-request, address mask-reply, traceroute, datagram-conversion-error, mobile-host-redirect, mobile-registration-request, mobile-registration-reply, domain-name-request, domain-name-reply, skip, photuris. (Range: 0 - 255) icmp-code Specifies an ICMP message code for filtering ICMP packets. (Range: 0 - 255) igmp-type IGMP packets can be filtered by IGMP message type. Enter a number or one of the following values: host-query, host-report, dvmrp, pim, cisco-trace, host-report-v2, host-leave-v2, host-report-v3. (Range: 0 - 255) destination-port Specifies the UDP/TCP destination port. (Range: 0 - 65535) source-port Specifies the UDP/TCP source port. (Range: 0 - 65535) flags list-of-flags List of TCP flags that should occur. If a flag should be set it is prefixed by "+".If a flag should be unset it is prefixed by "-". Available options are +urg, +ack, +psh, +rst, +syn, +fin, -urg, -ack, psh, -rst, -syn and -fin. The flags are concatenated to a one string. For example: +fin-ack.

Page 14 Not approved by Document Control. For review only.

ACL Commands

IP P r o t oco l Internet Control Message Protocol Internet Group Management Protocol IP in IP (encapsulation) Protocol Transmission Control Protocol Exterior Gateway Protocol Interior Gateway Protocol User Datagram Protocol Host Monitoring Protocol Reliable Data Protocol Inter-Domain Policy Routing Protocol Ipv6 protocol Routing Header for IPv6 Fragment Header for IPv6 Inter-Domain Routing Protocol Reservation Protocol General Routing Encapsulation Encapsulating Security Payload (50) Authentication Header ICMP for IPv6 EIGRP routing protocol Open Shortest Path Protocol Protocol Independent Multicast Layer Two Tunneling Protocol ISIS over IPv4 (any IP protocol)

A bb r ev ia t ed N am e icmp igmp ipinip tcp egp igp udp hmp rdp idpr ipv6 ipv6-route ipv6-frag idrp rsvp gre esp ah ipv6-icmp eigrp ospf pim l2tp isis any

P r o to co l N u m be r 1 2 4 6 8 9 17 20 27 35 41 43 44 45 46 47 50 51 58 88 89 103 115 124 25504

dscp Indicates matching the dscp number with the packet dscp value. ip-precedence Indicates matching ip-precedence with the packet ip-precedence value. icmp-type Specifies an ICMP message type for filtering ICMP packets. Enter a value or one of the following values: echo-reply, destination-unreachable, source-quench, redirect, alternate-host-address, echorequest, router-advertisement, router-solicitation, time-exceeded, parameter-problem, timestamp, timestamp-reply, information-request, information-reply, address-mask-request, address-mask-reply, traceroute, datagram-conversion-error, mobile-host-redirect, ipv6-where-are-you, ipv6-i-am-here,

Page 15

Allied Telesis
Command Line Interface Users Guide

mobile-registration-request, mobile-registration-reply, domain-name-request, domain-name-reply, skip and photuris. (Range: 0-255) icmp-code Specifies an ICMP message code for filtering ICMP packets. ICMP packets that are filtered by ICMP message type can also be filtered by the ICMP message code. (Range: 0-255) igmp-type IGMP packets can be filtered by IGMP message type. Enter a number or one of the following values: dvmrp, host-query, host-report, pim or trace. (Range: 0-255) destination-port Specifies the UDP/TCP destination port. (Range: 0-65535) source-port Specifies the UDP/TCP source port. (Range: 0-65535) list-of-flags Specifies a list of TCP flags that can be triggered. If a flag is set, it is prefixed by +. If a flag is not set, it is prefixed by -. Possible values: +urg, +ack, +psh, +rst, +syn, +fin, -urg, -ack, -psh, -rst, -syn and -fin. The flags are concatenated into one string. For example: +fin-ack.

Default Configuration
No IPv4 ACL is defined.

Command Mode
Ip Access-list Configuration mode

User Guidelines
You enter IP-Access List configuration mode by using the ip access-list Global Configuration mode command.

Example
The following example shows how to define a permit statement for an IP ACL. Console(config)# ip access-list ip-acl1 Console(config-ip-al)# permit rsvp 192.1.1.1 0.0.0.0 any dscp 56

deny (IP)
The deny IP Access List Configuration mode command sets conditions to not allow a packet to pass a named IP Access List.

Syntax deny [disable-port] {any| protocol} {any|{source source-wildcard}} {any|{destination destinationwildcard}} [dscp number | ip-precedence number] deny-icmp [disable-port] {any|{source source-wildcard}} {any|{destination destination-wildcard}} {any|icmp-type} {any|icmp-code} [dscp number | ip-precedence number] deny-igmp [disable-port] {any|{source source-wildcard}} {any|{destination destination-wildcard}} {any|igmp-type} [dscp number | ip-precedence number] deny-tcp [disable-port] {any|{ source source-wildcard}} {any|source-port} {any|{ destination destination-wildcard}} {any|destination-port} [dscp number | ip-precedence number] [flags list-of-

Page 16 Not approved by Document Control. For review only.

ACL Commands

flags] deny-udp [disable-port] {any|{ source source-wildcard}} {any| source-port} {any|{destination destination-wildcard}} {any|destination-port} [dscp number | ip-precedence number] Parameters disable-port The Ethernet interface is disabled if the condition is matched. (Range: 0 - 65535) source Source IP address of the packet. source-wildcard Wildcard bits to be applied to the source IP address. Use 1s in the bit position to be
ignored. destination Packets destination IP address. destination-wildcard Wildcard bits to be applied to the destination IP address. Use 1s in the bit position to be ignored. protocol The name or number of an IP protocol. Available protocol names: icmp, igmp, ip, tcp, egp, igp, udp, hmp, rdp, idpr, idrp, rsvp, gre, esp, ah, eigrp, ospf, ipip, pim, l2tp, isis.: (Range: 0 - 255) dscp number Specifies the DSCP value. ip-precedence number Specifies the IP precedence value. icmp-type Specifies an ICMP message type for filtering ICMP packets. Enter a number, or one of the following values: echo-reply, destination-unreachable, source-quench, redirect, alternate-hostaddress, echo-request, router-advertisement, router-solicitation, time-exceeded, parameter-problem, timestamp, timestamp-reply, information-request, information-reply, address-mask-request, addressmask-reply, traceroute, datagram-conversion-error, mobile-host-redirect, mobile-registration-request, mobile-registration-reply, domain-name-request, domain-name-reply, skip, photuriss. (Range: 0 - 255) icmp-code Specifies an ICMP message code for filtering ICMP packets. (Range: 0 - 255) igmp-type GMP packets can be filtered by IGMP message type. Enter a number, or one of the following values: host-query, host-report, dvmrp, pim, cisco-trace, host-report-v2, host-leave-v2, host-report-v3. (Range: 0 - 255) destination-port Specifies the UDP/TCP destination port. source-port Specifies the UDP/TCP source port. (Range: 0 - 65535) flags list-of-flags List of TCP flags that should occur. If a flag is intended to be set, it is prefixed by +.If a flag should be unset it is prefixed by -. Available options are: +urg, +ack, +psh, +rst, +syn, +fin, -urg, -ack, -psh, -rst, -syn and -fin. The flags are concatenated to a single string. For example: +fin-ack. IP P r o t oco l Internet Control Message Protocol Internet Group Management Protocol Transmission Control Protocol Exterior Gateway Protocol Interior Gateway Protocol User Datagram Protocol Host Monitoring Protocol Reliable Data Protocol Inter-Domain Policy Routing Protocol A bb r ev ia t ed N am e icmp igmp tcp egp igp udp hmp rdp idpr P r o to co l N u m be r 1 2 6 8 9 17 20 27 35

Page 17

Allied Telesis
Command Line Interface Users Guide

IP P r o t oco l Ipv6 protocol Routing Header for IPv6 Fragment Header for IPv6 Inter-Domain Routing Protocol Reservation Protocol General Routing Encapsulation Encapsulating Security Payload (50) Authentication Header ICMP for IPv6 EIGRP routing protocol Open Shortest Path Protocol Protocol Independent Multicast Layer Two Tunneling Protocol ISIS over IPv4 (any IP protocol)

A bb r ev ia t ed N am e ipv6 ipv6-route ipv6-frag idrp rsvp gre esp ah ipv6-icmp eigrp ospf pim l2tp isis any

P r o to co l N u m be r 41 43 44 45 46 47 50 51 58 88 89 103 115 124 25504

Default Configuration
No IPv4 Access List is defined.

Command Mode
IP Access-list Configuration mode

User Guidelines Enter IP-Access List configuration mode by using the ip access-list Global Configuration mode command. After an access control entry (ACE) is added to an access control list, an implied deny-any-any condition
exists at the end of the list. That is, if there are no matches, the packets are denied. However, before the first ACE is added, the list permits all packets.

Example
The following example shows how to define a permit statement for an IP ACL. Console(config)# ip-access-list ip-acl1 Console(config-ip-al)# deny rsvp 192.1.1.1 0.0.0.255 any

mac access-list
The mac access-list Global Configuration mode command defines a Layer 2 Access List and places the device in MAC-Access List Configuration mode. Use the no form of this command to remove the Access List.

Page 18 Not approved by Document Control. For review only.

ACL Commands

Syntax
mac access-list access-list-name no mac access-list access-list-name

Parameters access-list-name Name of the MAC-Access List. Default Configuration


No MAC-Access List is defined.

Command Mode
Global Configuration mode

User Guidelines
MAC ACLs are defined by a unique name. An IPv4 ACL, IPv6 ACL and MAC ACL cannot share the same name.

Example
The following example shows how to create a MAC ACL. Console(config)# mac access-list macl-acl1 Console(config-mac-al)#

permit (MAC)
The permit MAC-Access List Configuration mode command sets permit conditions for a MAC-Access List.

Syntax
permit {any | {source source-wildcard} any | {destination destination-wildcard}} [vlan vlan-id] [cos cos coswildcard] [ethtype eth-type]

Parameters source Source MAC address of the packet. source-wildcard Wildcard bits to be applied to the source MAC address. Use 1s in the bit position to be
ignored. destination Destination MAC address of the packet. destination-wildcard Specifies wildcard bits to be applied to the destination MAC address. Use 1s in bit positions to be ignored. vlan-id Specifies the ID of the packet VLAN. cos Specifies the Class of Service (CoS) for the packet. (Range: 0-7) cos-wildcard Specifies wildcard bits to be applied to the CoS. eth-type Specifies the Ethernet type in hexadecimal format of the packet.

Default Configuration
No MAC ACL is defined.

Page 19

Allied Telesis
Command Line Interface Users Guide

Command Mode
MAC-Access List Configuration mode

User Guidelines Enter IP-Access List configuration mode by using the MAC access-list Global Configuration mode command. After an access control entry (ACE) is added to an access control list, an implied deny-any-any condition
exists at the end of the list. That is, if there are no matches, the packets are denied. However, before the first ACE is added, the list permits all packets.

Example
The following example shows how to create a MAC ACL with permit rules. Console(config)# mac access-list macl-acl1 Console(config-mac-al)# permit 6:6:6:6:6:6 0:0:0:0:0:0 any vlan 6

deny (MAC)
The deny MAC-Access List Configuration mode command sets deny conditions for an MAC-Access List.

Syntax
deny [disable-port] {any|{source source- wildcard} {any|{ destination destination- wildcard}} [vlan vlan-id] [cos cos cos-wildcard] [ethtype eth-type]

Parameters disable-port Indicates the Ethernet interface is disabled if the condition is matched. source Specifies source MAC address of the packet. source-wildcard Specifies wildcard bits to be applied to the source MAC address. Use 1s in the bit position
to be ignored. destination Specifies the MAC address of the host to which the packet is being sent. destination-wildcard Specifies wildcard bits to be applied to the destination MAC address. Use 1s in the bit position to be ignored. vlan-id Specifies the VLAN ID of the packet. (Range: 0 - 4095) cos Specifies the Class of Service of the packet. (Range: 0 - 7) cos-wildcard Specifies wildcard bits to be applied to the CoS. eth-type Specifies the Ethernet type in hexadecimal format of the packet. (Range: 0 - 0xFFFF)

Default Configuration
No MAC-Access List is defined.

Command Mode
MAC-Access List Configuration mode

Page 20 Not approved by Document Control. For review only.

ACL Commands

User Guidelines MAC BPDU packets cannot be denied. This command defines an Access Control Element (ACE). An ACE can only be removed by deleting the ACL,
using the no mac access-list Global Configuration mode command. Alternatively, the Web-based interface can be used to delete ACEs from an ACL. The following user guidelines are relevant to GE devices only: Before an Access Control Element (ACE) is added to an ACL, all packets are permitted. After an ACE is added, an implied deny-any-any condition exists at the end of the list and those packets that do not match the conditions defined in the permit statement are denied. If the VLAN ID is specified, the policy map cannot be connected to the VLAN interface.

Example
The following example shows how to create a MAC ACL with deny rules. Console(config)# mac access-list macl1 Console (config-mac-acl)# deny 6:6:6:6:6:6:0:0:0:0:0:0 any

service-acl
The service-acl Interface Configuration mode command controls access to an interface. Use the no form of this command to remove the access control.

Syntax
service-acl input acl-name no service-acl input

Parameters input Applies the specified ACL to the input interface. Default Configuration
This command has no default configuration.

Command Mode
Interface Configuration (Ethernet, Port-Channel) mode

User Guidelines
In advanced mode, when an ACL is bound to an interface, the port trust mode is set to trust 12-13 and not to 12.

Example
The following example, binds (services) an ACL to Ethernet interface g2. Console(config)# interface ethernet g2 Console(config-if)# service-acl input macl1

Page 21

Allied Telesis
Command Line Interface Users Guide

show access-lists
The show access-lists Privileged EXEC mode command displays Access Control Lists (ACLs) configured on the switch.

Syntax
show access-lists [name]

Parameters name Name of the ACL. Default Configuration


This command has no default configuration.

Command Mode
Privileged EXEC mode

User Guidelines
There are no user guidelines for this command.

Example
The following example displays access lists. Console# show access-lists IP access list ACL1 permit ip host 172.30.40.1 any permit rsvp host 172.30.8.8 any

show interfaces access-lists


The show interfaces access-lists Privileged EXEC mode command displays access lists applied on interfaces.

Syntax
show interfaces access-lists [ ethernet interface | vlan vlan-id | port-channel port-channel-number ]

Parameters vlan-id Specifies the ID of the VLAN. interface The full syntax is: unit/port. port-channel-number Valid port-channel Index. Default Configuration
This command has no default configuration.

Command Mode
Privileged EXEC mode

Page 22 Not approved by Document Control. For review only.

ACL Commands

User Guidelines
There are no user guidelines for this command. Example The following example displays ACLs applied to the interfaces of a device

Table 1: Con so le # sho w inte rface s a cce ss-lis ts Interfaces -------------1/e1 2/e1 Input ACL -------------ACL1 ACL3

Page 23

Allied Telesis
Command Line Interface Users Guide

Chapter 3. AAA Commands


aaa authentication login
The aaa authentication login Global Configuration mode command defines login authentication. Use the no form of this command to return to the default configuration.

Syntax
aaa authentication login {default | list-name} method1 [method2...] no aaa authentication login {default | list-name}

Parameters default Uses the listed authentication methods that follow this argument as the default list of methods
when a user logs in. list-name Character string used to name the list of authentication methods activated when a user logs in. (Range: 1-12 characters). method1 [method2...] Specify at least one from the following table: K ey wo r d enable line local none radius tacacs De scri p ti o n Uses the enable password for authentication. Uses the line password for authentication. Uses the local username database for authentication. Uses no authentication. Uses the list of all RADIUS servers for authentication. Uses the list of all TACACS+ servers for authentication.

Default Configuration
The local user database is checked. This has the same effect as the command aaa authentication login listname local. Note On the console, login succeeds without any authentication check if the authentication method is not defined.

Command Mode
Global Configuration mode

Page 24 Not approved by Document Control. For review only.

AAA Commands

User Guidelines The default and optional list names created with the aaa authentication login command are used with the
login authentication command. Create a list by entering the aaa authentication login list-name method command for a particular protocol, where list-name is any character string used to name this list. The method argument identifies the list of methods that the authentication algorithm tries, in the given sequence. The additional methods of authentication are used only if the previous method returns an error, not if it fails. To ensure that the authentication succeeds even if all methods return an error, specify none as the final method in the command line.

Example
The following example configures the authentication login. Console(config)# aaa authentication login default radius local enable none

aaa authentication enable


The aaa authentication enable Global Configuration mode command defines authentication method lists for accessing higher privilege levels. Use the no form of this command to return to the default configuration.

Syntax
aaa authentication enable {default | list-name} method1 [method2...] no aaa authentication enable {default | list-name}

Parameters default Uses the listed authentication methods that follow this argument as the default list of methods,
when using higher privilege levels. list-name Character string used to name the list of authentication methods activated, when using access higher privilege levels (Range: 1-12 characters). method1 [method2...] Specify at least one from the following table: K ey wo r d enable line none radius tacacs De scri p ti o n Uses the enable password for authentication. Uses the line password for authentication. Uses no authentication. Uses the list of all RADIUS servers for authentication. Uses username $enabx$., where x is the privilege level. Uses the list of all TACACS+ servers for authentication. Uses username "$enabx$." where x is the privilege level.

Default Configuration
If the default list is not set, only the enable password is checked. This has the same effect as the command aaa authentication enable default enable. On the console, the enable password is used if it exists. If no password is set, the process still succeeds. This has the same effect as using the command aaa authentication enable default enable none.

Page 25

Allied Telesis
Command Line Interface Users Guide

Command Mode
Global Configuration mode

User Guidelines The default and optional list names created with the aaa authentication enable command are used with the
enable authentication command. The additional methods of authentication are used only if the previous method returns an error, not if it fails. To ensure that the authentication succeeds even if all methods return an error, specify none as the final method in the command line. All aaa authentication enable default requests sent by the device to a RADIUS or TACACS+ server include the username $enabx$., where x is the requested privilege level.

Example
The following example sets the enable password for authentication when accessing higher privilege levels. Console(config)# aaa authentication enable default enable

login authentication
The login authentication Line Configuration mode command specifies the login authentication method list for a remote telnet or console. Use the no form of this command to return to the default configuration specified by the aaa authentication login command.

Syntax
login authentication {default | list-name} no login authentication

Parameters default Uses the default list created with the aaa authentication login command. list-name Uses the indicated list created with the aaa authentication login command. Default Configuration
Uses the default set with the command aaa authentication login.

Command Mode
Line Configuration mode

User Guidelines
Changing login authentication from default to another value may disconnect the telnet session.

Example
The following example specifies the default authentication method for a console. Console(config)# line console Console(config-line)# login authentication default

Page 26 Not approved by Document Control. For review only.

AAA Commands

enable authentication
The enable authentication Line Configuration mode command specifies the authentication method list when accessing a higher privilege level from a remote telnet or console. Use the no form of this command to return to the default configuration specified by the aaa authentication enable command.

Syntax
enable authentication {default | list-name} no enable authentication

Parameters default Uses the default list created with the aaa authentication enable command. list-name Uses the indicated list created with the aaa authentication enable command. Default Configuration
Uses the default set with the aaa authentication enable command.

Command Mode
Line Configuration mode

User Guidelines
There are no user guidelines for this command.

Example
The following example specifies the default authentication method when accessing a higher privilege level from a console. Console(config)# line console Console(config-line)# enable authentication default

ip http authentication
The ip http authentication Global Configuration mode command specifies authentication methods for HTTP server users. Use the no form of this command to return to the default configuration.

Syntax
ip http authentication method1 [method2...] no ip http authentication

Parameters method1 [method2...] Specify at least one from the following table:
Key wo rd local none Des cription Uses the local username database for authentication. Uses no authentication.

Page 27

Allied Telesis
Command Line Interface Users Guide

radius tacacs

Uses the list of all RADIUS servers for authentication. Uses the list of all TACACS+ servers for authentication.

Default Configuration
The local user database is checked. This has the same effect as the command ip http authentication local.

Command Mode
Global Configuration mode

User Guidelines
The additional methods of authentication are used only if the previous method returns an error, not if it fails. To ensure that the authentication succeeds even if all methods return an error, specify none as the final method in the command line.

Example
The following example configures the HTTP authentication. Console(config)# ip http authentication radius local

ip https authentication
The ip https authentication Global Configuration mode command specifies authentication methods for HTTPS server users. Use the no form of this command to return to the default configuration.

Syntax
ip https authentication method1 [method2...] no ip https authentication

Parameters method1 [method2...] Specify at least one from the following table:
Key wo rd local none radius tacacs Sou rce o r de st in at i on Uses the local username database for authentication. Uses no authentication. Uses the list of all RADIUS servers for authentication. Uses the list of all TACACS+ servers for authentication.

Default Configuration
The local user database is checked. This has the same effect as the command ip https authentication local.

Command Mode
Global Configuration mode

Page 28 Not approved by Document Control. For review only.

AAA Commands

User Guidelines
The additional methods of authentication are used only if the previous method returns an error, not if it fails. To ensure that the authentication succeeds even if all methods return an error, specify none as the final method in the command line.

Example
The following example configures HTTPS authentication. Console(config)# ip https authentication radius local

show authentication methods


The show authentication methods Privileged EXEC mode command displays information about the authentication methods.

Syntax
show authentication methods

Default Configuration
This command has no default configuration.

Command Mode
Privileged EXEC mode

User Guidelines
There are no user guidelines for this command.

Example
The following example displays the authentication configuration. Console# show authentication methods Login Authentication Method Lists --------------------------------Default: Radius, Local, Line Console_Login: Line, None Enable Authentication Method Lists ---------------------------------Default: Radius, Enable Console_Enable: Enable, None

Page 29

Allied Telesis
Command Line Interface Users Guide

Line -------------Console Telnet SSH http: Radius, Local https: Radius, Local dot1x: Radius

Login Method List ----------------Console_Login Default Default

Enable Method List -----------------Console_Enable Default Default

password
The password Line Configuration mode command specifies a password on a line. Use the no form of this command to remove the password.

Syntax
password password [encrypted] no password

Parameters password Password for this level (Range: 1-159 characters). encrypted Encrypted password to be entered, copied from another device configuration. Default Configuration
No password is defined.

Command Mode
Line Configuration mode

User Guidelines
If a password is defined as encrypted, the required password length is 32 characters.

Example
The following example specifies password secret on a console. Console(config)# line console Console(config-line)# password secret

username
The username Global Configuration mode command creates a user account in the local database. Use the no form of this command to remove a user name.

Page 30 Not approved by Document Control. For review only.

AAA Commands

Syntax
username name [password password] [level level] [encrypted] no username name

Parameters name The name of the user (Range: 1- 20 characters). password The authentication password for the user (Range: 1-159 characters). level The user level (Range: 1-15). encrypted Encrypted password entered, copied from another device configuration. Default Configuration
No user is defined.

Command Mode
Global Configuration mode

User Guidelines User account can be created without a password. A single username can be defined for privilege level 1 and another one for privilege level 15. Default usernames:
Privilege level 1: username = operator, password = operator Privilege level 15: username = manager, password = friend

Example
The following example configures user bob with password lee and user level 15 to the system. Console(config)# username bob password lee level 15

show users accounts


The show users accounts Privileged EXEC mode command displays information about the local user database.

Syntax
show users accounts

Default Configuration
This command has no default configuration.

Command Mode
Privileged EXEC mode

User Guidelines
There are no user guidelines for this command.

Page 31

Allied Telesis
Command Line Interface Users Guide

Example
The following example displays the local users configured with access to the system. Console# show users accounts Username -------Bob Admin Manager Privilege --------1 15 15 Password Aging -------120 120 120 Password Expiry date ----------Jan 21 2005 Jan 21 2005 Jan 21 2005 Lockout -------

The following table describes significant fields shown above.


F i el d Username Privilege Password Aging Password Expiry Date Lockout Description Name of the user. Users privilege level. Users password expiration time in days. Expiration date of the users password. If lockout control is enabled, specifies the number of failed authentication attempts since the user last logged in successfully. If the user account is locked, specifies LOCKOUT.

enable password
The enable password Global Configuration mode command sets a local password to control access to user and privilege levels. Use the no form of this command to remove the password requirement.

Syntax
enable password [level level] password [encrypted] no enable password [level level]

Parameters password Password for this level. (Range: 1-159 characters) level level Level for which the password applies. If not specified the level is 15. (Range: 1-15) encrypted Encrypted password entered, copied from another device configuration. Default Configuration
No enable password is defined.

Command Mode
Global Configuration mode

Page 32 Not approved by Document Control. For review only.

AAA Commands

User Guidelines
There are no user guidelines for this command.

Example
The following example sets a local level 15 password called secret to control access to user and privilege levels. . Console(config)# enable password secret level 15

Page 33

Allied Telesis
Command Line Interface Users Guide

Chapter 4. Address Table Commands


bridge address
The bridge address Interface Configuration (VLAN) mode command adds a MAC-layer station source address to the bridge table. Use the no form of this command to delete the MAC address.

Syntax
bridge address mac-address {ethernet interface | port-channel port-channel-number} [permanent permanent} | delete-on-reset delete-on-reset} | delete-on-timeout delete-on-timeout} | secure secure] no bridge address [mac-address]

Parameters mac-address A valid MAC address. interface A valid Ethernet port. port-channel-number A valid port-channel number. permanent The address can only be deleted by the no bridge address command. delete-on-reset The address is deleted after reset. delete-on-timeout The address is deleted after "age out" time has expired. secure The address is deleted after the port changes mode to unlock learning (no port security
command). This parameter is only available when the port is in the learning locked mode.

Default Configuration
No static addresses are defined. The default mode for an added address is permanent.

Command Mode
Interface Configuration (VLAN) mode

User Guidelines
Using the no form of the command without specifying a MAC address deletes all static MAC addresses belonging to this VLAN).

Example
The following example adds a permanent static MAC-layer station source address 3aa2.64b3.a245 on port 1/e16 to the bridge table. Console(config)# interface vlan 2 Console(config-if)# bridge address 3aa2.64b3.a245 ethernet 1/e16 permanent

bridge multicast filtering


The bridge multicast filtering Global Configuration mode command enables filtering of Multicast addresses. Use the no form of this command to disable filtering of Multicast addresses.

Page 34 Not approved by Document Control. For review only.

Address Table Commands

Syntax
bridge multicast filtering no bridge multicast filtering

Parameters
This command has no keywords or arguments.

Default Configuration
Filtering Multicast addresses is disabled. All Multicast addresses are flooded to all ports.

Command Mode
Global Configuration mode

User Guidelines If routers exist on the VLAN, do not change the unregistered Multicast addresses state to drop on the routers
ports. If Multicast routers exist on the VLAN and IGMP snooping isn't enabled, use the bridge multicast forwardall command to enable forwarding all Multicast packets to the Multicast routers.

Example
In this example, bridge Multicast filtering is enabled. Console(config)# bridge multicast filtering

bridge multicast address


The bridge multicast address Interface Configuration mode command registers MAC-layer Multicast addresses to the bridge table, and adds ports statically to the group. Use the no form of this command to deregister the address.

Syntax
bridge multicast address mac-multicast-address

Parameters add Adds ports to the group. If no option is specified, this is the default option. remove Removes ports from the group. mac-multicast-address A valid MAC Multicast address. interface-list Separate nonconsecutive Ethernet ports with a comma and no spaces; a hyphen is used to
designate a range of ports. port-channel-number-list Separate nonconsecutive port-channels with a comma and no spaces; a hyphen is used to designate a range of ports.

Default Configuration
No Multicast addresses are defined.

Page 35

Allied Telesis
Command Line Interface Users Guide

Command Mode
Interface configuration (VLAN) mode

User Guidelines If the command is executed without add or remove, the command only registers the group in the bridge
database. Static Multicast addresses can only be defined on static VLANs.

Example
The following example registers the MAC address: Console(config)# interface vlan 8 Console(config-if)# bridge multicast address 01:00:5e:02:02:03 The following example registers the MAC address and adds ports statically. console(config)# interface vlan 8 console(config-if)# bridge multicast address 01:00:5e:02:02:03 add ethernet 1/e1-9, 2/ e2

bridge multicast forbidden address


The bridge multicast forbidden address Interface Configuration mode command forbids adding specific Multicast addresses to specific ports. Use the no form of this command to return to default.

Syntax
bridge multicast forbidden address {mac-multicast-address | ip-multicast-address} {add | remove} {ethernet interface-list | port-channel port-channel-number-list} no bridge multicast forbidden address {mac-multicast-address | ip-multicast-address}

Parameters add Adds ports to the group. remove Removes ports from the group. mac-multicast-address A valid MAC Multicast address. interface-list Separate nonconsecutive Ethernet ports with a comma and no spaces; hyphen is used to
designate a range of ports. port-channel-number-list Separate nonconsecutive valid port-channels with a comma and no spaces; a hyphen is used to designate a range of port-channels.

Default Configuration
No forbidden addresses are defined.

Command Modes
Interface Configuration (VLAN) mode

Page 36 Not approved by Document Control. For review only.

Address Table Commands

User Guidelines
Before defining forbidden ports, the Multicast group should be registered.

Example
In this example, MAC address 0100.5e02.0203 is forbidden on port 2/e9 within VLAN 8. Console(config)# interface vlan 8 Console(config-if)# bridge multicast address 0100.5e02.0203 Console(config-if)# bridge multicast forbidden address 0100.5e02.0203 add ethernet 2/e9

bridge multicast forward-all


The bridge multicast forward-all Interface Configuration (VLAN) mode command enables forwarding all Multicast packets on a port. Use the no form of this command to restore the default configuration.

Syntax
bridge multicast forward-all {add | remove} {ethernet interface-list | port-channel port-channel-number-list} no bridge multicast forward-all

Parameters add Force forwarding all Multicast packets. remove Do not force forwarding all Multicast packets. interface-list Separate nonconsecutive Ethernet ports with a comma and no spaces; a hyphen is used to
designate a range of ports. port-channel-number-list Separate nonconsecutive port-channels with a comma and no spaces; a hyphen is used to designate a range of port-channels.

Default Configuration
This setting is disabled.

Command Mode
Interface Configuration (VLAN) mode

User Guidelines
There are no user guidelines for this command.

Example
In this example, all Multicast packets on port 1/e8 are forwarded. Console(config)# interface vlan 2 Console(config-if)# bridge multicast forward-all add ethernet 1/e8

Page 37

Allied Telesis
Command Line Interface Users Guide

bridge multicast forbidden forward-all


The bridge multicast forbidden forward-all Interface Configuration mode command forbids a port to be a Forward-all-Multicast port. Use the no form of this command to return to default.

Syntax
bridge multicast forbidden forward-all {add | remove} {ethernet interface-list | port-channel port-channelnumber-list} no bridge multicast forbidden forward-all

Parameters add Forbid forwarding all Multicast packets. remove Do not forbid forwarding all Multicast packets. interface-list Separates nonconsecutive Ethernet ports with a comma and no spaces; use a hyphen to
designate a range of ports. port-channel-number-list Separates nonconsecutive port-channels with a comma and no spaces; use a hyphen to designate a range of port-channels.

Default Configuration
This setting is disabled.

Command Mode
Interface Configuration (VLAN) mode

User Guidelines IGMP snooping dynamically discovers Multicast router ports. When a Multicast router port is discovered, all
the Multicast packets are forwarded to it unconditionally. This command prevents a port from becoming a Multicast router port.

Example
In this example, forwarding all Multicast packets to 1/e1 with VLAN 2 is forbidden. Console(config)# interface vlan 2 Console(config-if)# bridge multicast forbidden forward-all add ethernet 1/e1

bridge aging-time
The bridge aging-time Global Configuration mode command sets the aging time of the Address Table. Use the no form of this command to restore the default.

Syntax
bridge aging-time seconds no bridge aging-time

Parameters seconds Time in seconds. (Range: 10-630 seconds)

Page 38 Not approved by Document Control. For review only.

Address Table Commands

Default Configuration
The default setting is 300 seconds.

Command Mode
Global Configuration mode

User Guidelines
There are no user guidelines for this command.

Example
In this example the bridge aging time is set to 250. Console(config)# bridge aging-time 250

clear bridge
The clear bridge Privileged EXEC mode command removes any learned entries from the forwarding database.

Syntax
clear bridge

Default Configuration
This command has no default configuration.

Command Mode
Privileged EXEC mode

User Guidelines
There are no user guidelines for this command.

Example
In this example, the bridge tables are cleared. Console# clear bridge

port security
The port security Interface Configuration mode command enables port security on an interface. Use the no form of this command to disable port security on an interface.

Syntax
port security [forward | discard | discard-shutdown] [trap seconds] no port security

Page 39

Allied Telesis
Command Line Interface Users Guide

Parameters forward Forwards frames with unlearned source addresses, but does not learn the address. discard Discards frames with unlearned source addresses. This is the default if no option is indicated. discard-shutdown Discards frames with unlearned source addresses. The port is also shut down. trap seconds Send SNMP traps, and specifies the minimum time between consecutive traps. Default Configuration
This setting is disabled.

Command Mode
Interface Configuration (Ethernet, port-channel) mode

User Guidelines
There are no user guidelines for this command.

Example
In this example, port 1/e1 forwards all packets without learning addresses of packets from unknown sources and sends traps every 100 seconds if a packet with an unknown source address is received. Console(config)# interface ethernet 1/e1 Console(config-if)# port security forward trap 100

port security mode


The port security mode Interface Configuration mode command configures the port security mode. Use the no form of this command to return to the default configuration.

Syntax
port security mode {lock | max-addresses} no port security mode

Parameters lock Saves the current dynamic MAC addresses associated with the port and disables learning, relearning
and aging. max-addresses Delete the current dynamic MAC addresses associated with the port. Learn up to the maximum addresses allowed on the port. Relearning and aging are enabled.

Default Configuration
Lock.

Command Mode
Interface Configuration (Ethernet, port-channel) mode

User Guidelines
There are no user guidelines for this command.

Page 40 Not approved by Document Control. For review only.

Address Table Commands

Example
In this example, port security mode is set to dynamic for Ethernet interface 1/e7. Console(config)# interface ethernet 1/e7

port security max


The port security max Interface Configuration (Ethernet, port-channel) mode command configures the maximum number of addresses that can be learned on the port while the port is in port security mode. Use the no form of this command to return to the default configuration.

Syntax
port security max max-addr no port security max

Parameters max-addr Maximum number of addresses that can be learned by the port.
(Range: 1-128)

Default Configuration
The default setting is 1 address.

Command Mode
Interface Configuration (Ethernet, port-channel) mode

User Guidelines
This command is only relevant in dynamic learning modes.

Example
In this example, the maximum number of addresses that are learned on port 1/e7 before it is locked is set to 20. Console(config)# interface ethernet 1/e7 Console(config-if)# port security max 20

port security routed secure-address


The port security routed secure-address Interface Configuration (Ethernet, port-channel) mode command adds a MAC-layer secure address to a routed port. Use the no form of this command to delete a MAC address.

Syntax
port security routed secure-address mac-address no port security routed secure-address mac-address

Parameters mac-address A valid MAC address.

Page 41

Allied Telesis
Command Line Interface Users Guide

Default Configuration
No addresses are defined.

Command Mode
Interface Configuration (Ethernet, port-channel) mode. Cannot be configured for a range of interfaces (range context).

User Guidelines The command enables adding secure MAC addresses to a routed port in port security mode. The command is available when the port is a routed port and in port security mode. The address is deleted if the port exits the security mode or is not a routed port. Example
In this example, the MAC-layer address 66:66:66:66:66:66 is added to port 1/e1. Console(config)# interface ethernet 1/e1 Console(config-if)# port security routed secure-address 66:66:66:66:66:66

show bridge address-table


The show bridge address-table Privileged EXEC mode command displays all entries in the bridge-forwarding database.

Syntax
show bridge address-table [vlan vlan] [ethernet interface | port-channel port-channel-number]

Parameters vlan Specifies a valid VLAN, such as VLAN 1. interface A valid Ethernet port. port-channel-number A valid port-channel number. Default Configuration
This command has no default configuration.

Command Mode
Privileged EXEC mode

User Guidelines Internal usage VLANs (VLANs that are automatically allocated on ports with a defined Layer 3 interface) are
presented in the VLAN column by a port number and not by a VLAN ID. "Special" MAC addresses that were not statically defined or dynamically learned are displayed in the MAC Address Table.

Page 42 Not approved by Document Control. For review only.

Address Table Commands

Example
In this example, all classes of entries in the bridge-forwarding database are displayed. Console# show bridge address-table Aging time is 300 sec vlan --------1 1 1 mac address -------------00:02:3f:b4:28:05 00:07:40:c9:5f:83 00:15:77:74:64:40 Port ---e16 ch5 ch5 Type ------dynamic dynamic dynamic

show bridge address-table static


The show bridge address-table static Privileged EXEC mode command displays statically created entries in the bridge-forwarding database.

Syntax
show bridge address-table static [vlan vlan] [ethernet interface | port-channel port-channel-number]

Parameters vlan Specifies a valid VLAN, such as VLAN 1. interface A valid Ethernet port. port-channel-number A valid port-channel number. Default Configuration
This command has no default configuration.

Command Mode
Privileged EXEC mode

User Guidelines
There are no user guidelines for this command.

Example
In this example, all static entries in the bridge-forwarding database are displayed. Console# show bridge address-table static Aging time is 300 sec vlan mac address port type

Page 43

Allied Telesis
Command Line Interface Users Guide

---1 1 200

----------------00:60:70:4C:73:FF 00:60.70.8C.73:FF 00:10:0D:48:37:FF

---1/e8 1/e8 1/e9

----------------Permanent delete-on-timeout delete-on-reset

show bridge address-table count


The show bridge address-table count Privileged EXEC mode command displays the number of addresses present in the Forwarding Database.

Syntax
show bridge address-table count [vlan vlan][ ethernet interface-number | port-channel port-channel-number]

Parameters vlan Specifies a valid VLAN, such as VLAN 1. interface A valid Ethernet port. port-channel-number A valid port-channel number. Default Configuration
This command has no default configuration.

Command Mode
Privileged EXEC mode

User Guidelines
There are no user guidelines for this command.

Example
In this example, the number of addresses present in all VLANs are displayed. Console# show bridge address-table count This may take some time. Capacity: 8192 Free: 8190 Used: 2 Secure: 0 Dynamic: 2 Static : 0 Internal: 0

Page 44 Not approved by Document Control. For review only.

Address Table Commands

show bridge multicast address-table


The show bridge multicast address-table Privileged EXEC mode command displays the bridge Multicast Address Table information.

Syntax
show bridge multicast address-table [vlan vlan-id] [address mac-multicast-address | ip-multicast-address] [format ip | format mac] [source ip-address]

Parameters vlan-id A valid VLAN ID value. mac-multicast-address A valid MAC Multicast address. ip-multicast-address A valid IP Multicast address. ip-address Source IP address format ip|mac Multicast address format. Can be ip or mac. If the format is unspecified, the default is mac. Default Configuration
This command has no default configuration.

Command Mode
Privileged EXEC mode

User Guidelines
A MAC address can be displayed in IP format only if it is in the range of 0100.5e00.0000-0100.5e7f.ffff.

Page 45

Allied Telesis
Command Line Interface Users Guide

Examples
In these examples, Multicast MAC address and IP Address Table information is displayed. Console# show bridge multicast address-table Multicast address table for VLANs in MAC-GROUP bridging mode: Vlan ---1 1 19 19 MAC Address -------------0100.5e23.8787 01:00:5e:02:02:03 01:00:5e:02:02:08 00:00:5e:02:02:08 Type ------static dynamic static dynamic Ports ---------1/e1, 2/e2 1/e1, 2/e2 1/e1-e8 1/e9-e11

Forbidden ports for multicast addresses: Vlan ---1 19 MAC Address -------------01:00:5e:02:02:03 01:00:5e:02:02:08 Ports ----2/8 2/8

Console # show bridge multicast address-table format ip Multicast address table for VLANs in MAC-GROUP bridging mode: Vlan ---------1 1 19 19 Vlan --------1 19 IP/MAC Address --------------0100.9923.8787 224-239.130|2.2.3 224-239.130|2.2.8 224-239.130|2.2.8 IP/MAC Address ---------------224-239.130|2.2.3 224-239.130|2.2.8 Type ---------------static dynamic static dynamic Ports ----------2/8 2/8 Ports -----------------1/e1, 2/e2 1/e1, 2/e2 1/e1-e8 1/e9-e11

Forbidden ports for multicast addresses:

Page 46 Not approved by Document Control. For review only.

Address Table Commands

Note A Multicast MAC address maps to multiple IP addresses as shown above.

show bridge multicast address-table static


The show bridge multicast address-table static Privileged EXEC mode command displays statically configured Multicast addresses.

Syntax
show bridge multicast address-table static [vlan vlan-id] [address mac-multicast-address |

Parameters vlan-id A valid VLAN ID value. mac-multicast-address A valid MAC Multicast address. ip-multicast-address A valid IP Multicast address. ip-address Source IP address Default Configuration
This command has no default configuration.

Command Mode
Privileged EXEC mode

User Guidelines
A MAC address can be displayed in IP format only if it's in the range 0100.5e00.0000 through 0100.5e7f.ffff.

Example
In this example, Multicast MAC address and IP Address Table information is displayed. Console# show bridge multicast address-table static Multicast address table for VLANs in MAC-GROUP bridging mode: Vlan ---1 MAC Address -------------0100.5e23.8787 Type ------static Ports ---------1/e1, 2/e2

Forbidden ports for multicast addresses: Vlan ---------console# MAC Address ---------------Ports -------------------------------------

show bridge multicast filtering


The show bridge multicast filtering User EXEC mode command displays Multicast filtering configuration.

Page 47

Allied Telesis
Command Line Interface Users Guide

Syntax
show bridge multicast filtering vlan-id

Parameters vlan-id VLAN ID value. Default Configuration


This command has no default configuration.

Command Mode
User EXEC mode

User Guidelines
There are no user guidelines for this command.

Example
In this example, the Multicast configuration for VLAN 1 is displayed. Console# show bridge multicast filtering 1 Filtering: Enabled VLAN: 1 Forward-All Port ---1/e1 1/e2 1/e3 1/e4 1/e5 1/e6 1/e7 1/e8 1/e9 1/e10 1/e11 1/e12 Static --------Status --------Filter Filter Filter Filter Filter Filter Filter Filter Filter Filter Filter Filter

Page 48 Not approved by Document Control. For review only.

Address Table Commands

Console# show bridge multicast filtering 1 Filtering: Enabled VLAN: 1 Port ---1/e1 1/e2 1/e3 Forward-Unregistered Static --------Forbidden Forward Status --------Filter Forward(s) Forward(d) Forward-All Static --------Forbidden Forward Status ---------Filter Forward(s) Forward(d)

show ports security


The show ports security Privileged EXEC mode command displays the port-lock status.

Syntax
show ports security [ethernet interface | port-channel port-channel-number]

Parameters interface A valid Ethernet port. port-channel-number A valid port-channel number. Default Configuration
This command has no default configuration.

Command Mode
Privileged EXEC mode

User Guidelines
There are no user guidelines for this command.

Example
In this example, all classes of entries in the port-lock status are displayed: Console# show ports security Port ---1/e1 Status ------Locked Learning -------Dynamic Action ------Discard Maximum ------3 Trap ------Enable Frequency --------100

Page 49

Allied Telesis
Command Line Interface Users Guide

1/e2 1/e3

Unlocked Locked

Dynamic Disabled

Discard, Shutdown

28 8

Disable

The following table describes the fields shown above. Field Port Status Learning Action Maximum Trap Frequency Desc ription Port number Locked/Unlocked Learning mode Action on violation Maximum addresses that can be associated on this port in Static Learning mode or in Dynamic Learning mode Indicates if traps are sent in case of a violation Minimum time between consecutive traps

show ports security addresses


The show ports security addresses Privileged EXEC mode command displays the current dynamic addresses in locked ports.

Syntax
show ports security addresses [ethernet interface | port-channel port-channel-number]

Parameters interface A valid Ethernet port. port-channel-number A valid port-channel number. Default Configuration
This command has no default configuration.

Command Mode
Privileged EXEC mode

User Guidelines
There are no user guidelines for this command.

Examples
In these examples, dynamic addresses in currently locked ports are displayed. Console# show ports security addresses Port Status Learning Current Maximum

Page 50 Not approved by Document Control. For review only.

Address Table Commands

---1/e1 1/e2 1/e3 1/e4 1/e5 1/e6 ch1 ch2

-------Disabled Disabled Enabled Disabled Enabled Enabled Enabled

-------Lock Lock Max-addresses Lock Max-addresses Max-addresses Max-addresses

------0 0 0 0

------1 1 1 1 10 50 128

Port is a member in port-channel ch1

In this example, dynamic addresses in currently locked port 1/e1 are displayed. Console# show ports security addresses ethernet 1/e1 Port ---1/e1 Status -------Disabled Learning -------Lock Current ------Maximum ------1

Page 51

Allied Telesis
Command Line Interface Users Guide

Chapter 5. Clock Commands


clock set
The clock set Privileged EXEC mode command manually sets the system clock. To avoid an SNTP conflict, this command should only be used if there is no clock source set.

Syntax
clock set hh:mm:ss day month year or clock set hh:mm:ss month day year

Parameters hh:mm:ss Current time in hours (military format), minutes, and seconds (hh: 0 - 23, mm: 0 - 59, ss: 0 - 59). day Current day (by date) in the month (1 - 31). month Current month using the first three letters by name (Jan, , Dec). year Current year (2000 - 2097). Default Configuration
This command has no default configuration.

Command Mode
Privileged EXEC mode

User Guidelines
There are no user guidelines for this command.

Example
The following example sets the system time to 13:32:00 on the 7th March 2002. Console# clock set 13:32:00 7 Mar 2002

clock source
The clock source Global Configuration mode command configures an external time source for the system clock. Use no form of this command to disable external time source.

Syntax
clock source {sntp} no clock source

Parameters sntp SNTP servers

Page 52 Not approved by Document Control. For review only.

Clock Commands

Default Configuration
No external clock source

Command Mode
Global Configuration mode

User Guidelines
There are no user guidelines for this command.

Example
The following example configures an external time source for the system clock. Console(config)# clock source sntp

clock timezone
The clock timezone Global Configuration mode command sets the time zone for display purposes. Use the no form of this command to set the time to the Coordinated Universal Time (UTC).

Syntax
clock timezone hours-offset [minutes minutes-offset] [zone acronym] no clock timezone

Parameters hours-offset Hours difference from UTC. (Range: -12 +13) minutes-offset Minutes difference from UTC. (Range: 1 59) acronym The acronym of the time zone. (Range: Up to 4 characters) Default Configuration
Clock set to UTC.

Command Mode
Global Configuration mode

User Guidelines
The system internally keeps time in UTC, so this command is used only for display purposes and when the time is manually set.

Example
The following example sets the timezone to 6 hours difference from UTC. Console(config)# clock timezone -6 zone CST

Page 53

Allied Telesis
Command Line Interface Users Guide

clock summer-time
The clock summer-time Global Configuration mode command configures the system to automatically switch to summer time (daylight saving time). Use the no form of this command to configure the software not to automatically switch to summer time.

Syntax
clock summer-time recurring {usa | eu | {week day month hh:mm week day month hh:mm}} [offset offset] [zone acronym] clock summer-time date date month year hh:mm date month year hh:mm [offset offset] [zone acronym] clock summer-time date month date year hh:mm month date year hh:mm [offset offset] [zone acronym] no clock summer-time recurring

Parameters recurring Indicates that summer time should start and end on the corresponding specified days every
year. date Indicates that summer time should start on the first specific date listed in the command and end on the second specific date in the command. usa The summer time rules are the United States rules. eu The summer time rules are the European Union rules. week Week of the month. (Range: 1 - 5, first, last) day Day of the week (Range: first three letters by name, like sun) date Date of the month. (Range:1 - 31) month Month. (Range: first three letters by name, like Jan) year year - no abbreviation (Range: 2000 - 2097) hh:mm Time in military format, in hours and minutes. (Range: hh: 0 - 23, mm:0 - 59) offset Number of minutes to add during summer time. (Range: 1 - 1440) acronym The acronym of the time zone to be displayed when summer time is in effect. (Range: Up to 4 characters)

Default Configuration
Summer time is disabled. offset Default is 60 minutes. acronym If unspecified default to the timezone acronym. If the timezone has not been defined, the default is GMT.

Command Mode
Global Configuration mode

Page 54 Not approved by Document Control. For review only.

Clock Commands

User Guidelines
In both the date and recurring forms of the command, the first part of the command specifies when summer time begins, and the second part specifies when it ends. All times are relative to the local time zone. The start time is relative to standard time. The end time is relative to summer time. If the starting month is chronologically after the ending month, the system assumes that the device is in the southern hemisphere. USA rule for daylight savings time:

Start: Second Sunday in March End: First Sunday in November Time: 2 am local time EU rule for daylight savings time: Start: Last Sunday in March End: Last Sunday in October Time: 1.00 am (01:00)

Example
The following example sets summer time starting on the first Sunday in April at 2 am and finishing on the last Sunday in October at 2 am. Console(config)# clock summer-time recurring first sun apr 2:00 last sun oct 2:00

sntp authentication-key
The sntp authentication-key Global Configuration mode command defines an authentication key for Simple Network Time Protocol (SNTP). Use the no form of this command to remove the authentication key for SNTP.

Syntax
sntp authentication-key number md5 value no sntp authentication-key number

Parameters number Key number (Range: 1-4294967295) value Key value (Range: 1-8 characters) Default Configuration
No authentication key is defined.

Command Mode
Global Configuration mode

User Guidelines
Multiple keys can be generated.

Page 55

Allied Telesis
Command Line Interface Users Guide

Example
The following example defines the authentication key for SNTP. Console(config)# sntp authentication-key 8 md5 ClkKey

sntp authenticate
The sntp authenticate Global Configuration mode command grants authentication for received Simple Network Time Protocol (SNTP) traffic from servers. Use the no form of this command to disable the feature.

Syntax
sntp authenticate no sntp authenticate

Default Configuration
No authentication

Command Mode
Global Configuration mode

User Guidelines
The command is relevant for both Unicast and Broadcast.

Example
The following example defines the authentication key for SNTP and grants authentication. Console(config)# sntp authentication-key 8 md5 ClkKey Console(config)# sntp trusted-key 8 Console(config)# sntp authenticate

sntp trusted-key
The sntp trusted-key Global Configuration mode command authenticates the identity of a system to which Simple Network Time Protocol (SNTP) will synchronize. Use the no form of this command to disable authentication of the identity of the system.

Syntax
sntp trusted-key key-number no sntp trusted-key key-number

Parameters key-number Key number of authentication key to be trusted. (Range: 1 - 4294967295) Default Configuration
No keys are trusted.

Page 56 Not approved by Document Control. For review only.

Clock Commands

Command Mode
Global Configuration mode

User Guidelines
The command is relevant for both received Unicast and Broadcast. If there is at least 1 trusted key, then unauthenticated messages will be ignored.

Example
The following example authenticates key 8. Console(config)# sntp authentication-key 8 md5 ClkKey Console(config)# sntp trusted-key 8 Console(config)# sntp authenticate

sntp client poll timer


The sntp client poll timer Global Configuration mode command sets the polling time for the Simple Network Time Protocol (SNTP) client. Use the no form of this command to return to default configuration.

Syntax
sntp client poll timer seconds no sntp client poll timer

Parameters seconds Polling interval in seconds (Range: 60-86400) Default Configuration


Polling interval is 1024 seconds.

Command Mode
Global Configuration mode

User Guidelines
There are no user guidelines for this command.

Example
The following example sets the polling time for the Simple Network Time Protocol (SNTP) client to 120 seconds. Console(config)# sntp client poll timer 120

sntp broadcast client enable


The sntp broadcast client enable Global Configuration mode command enables Simple Network Time Protocol (SNTP) Broadcast clients. Use the no form of this command to disable SNTP Broadcast clients.

Page 57

Allied Telesis
Command Line Interface Users Guide

Syntax
sntp broadcast client enable no sntp broadcast client enable

Default Configuration
The SNTP Broadcast client is disabled.

Command Mode
Global Configuration mode

User Guidelines
Use the sntp client enable (Interface) Interface Configuration mode command to enable the SNTP client on a specific interface.

Example
The following example enables the SNTP Broadcast clients.

Console(config)# sntp broadcast client enable

sntp anycast client enable


The sntp anycast client enable Global Configuration mode command enables SNTP Anycast client. Use the no form of this command to disable the SNTP Anycast client.

Syntax
sntp anycast client enable no sntp anycast client enable

Default Configuration
The SNTP Anycast client is disabled.

Command Mode
Global Configuration mode

User Guidelines
The sntp client poll timer Global Configuration mode command determines polling time. Use the sntp client enable (Interface) Interface Configuration mode command to enable the SNTP client on a specific interface.

Example
The following example enables SNTP Anycast clients. console(config)# sntp anycast client enable

Page 58 Not approved by Document Control. For review only.

Clock Commands

sntp client enable (Interface)


The sntp client enable Interface Configuration (Ethernet, port-channel, VLAN) mode command enables the Simple Network Time Protocol (SNTP) client on an interface. This applies to both receive Broadcast and Anycast updates. Use the no form of this command to disable the SNTP client.

Syntax
sntp client enable no sntp client enable

Default Configuration
The SNTP client is disabled on an interface.

Command Mode
Interface configuration (Ethernet, port-channel, VLAN) mode

User Guidelines
Use the sntp broadcast client enable Global Configuration mode command to enable Broadcast clients globally. Use the sntp anycast client enable Global Configuration mode command to enable Anycast clients globally.

Example
The following example enables the SNTP client on Ethernet port 1/e3. onsole(config)# interface ethernet 1/e3 Console(config-if)# sntp client enable

sntp unicast client enable


The sntp unicast client enable Global Configuration mode command enables the device to use the Simple Network Time Protocol (SNTP) to request and accept SNTP traffic from servers. Use the no form of this command to disable requesting and accepting SNTP traffic from servers.

Syntax
sntp unicast client enable no sntp unicast client enable

Default Configuration
The SNTP Unicast client is disabled.

Command Mode
Global Configuration mode

User Guidelines
Use the sntp server Global Configuration mode command to define SNTP servers.

Page 59

Allied Telesis
Command Line Interface Users Guide

Example
The following example enables the device to use the Simple Network Time Protocol (SNTP) to request and accept SNTP traffic from servers. Console(config)# sntp unicast client enable

sntp unicast client poll


The sntp unicast client poll Global Configuration mode command enables polling for the Simple Network Time Protocol (SNTP) predefined Unicast servers. Use the no form of this command to disable the polling for SNTP client.

Syntax
sntp unicast client poll no sntp unicast client poll

Default Configuration
Polling is disabled.

Command Mode
Global Configuration mode

User Guidelines
The sntp client poll timer Global Configuration mode command determines polling time.

Example
The following example enables polling for Simple Network Time Protocol (SNTP) predefined Unicast clients. Console(config)# sntp unicast client poll

sntp server
The sntp server Global Configuration mode command configures the device to use the Simple Network Time Protocol (SNTP) to request and accept SNTP traffic from a specified server. Use the no form of this command to remove a server from the list of SNTP servers.

Syntax
sntp server {ip-address | hostname}[poll] [key keyid] no sntp server host

Parameters ip-address IP address of the server. hostname Hostname of the server. (Range: 1-158 characters) poll Enable polling. keyid Authentication key to use when sending packets to this peer.
(Range:1-4294967295)

Page 60 Not approved by Document Control. For review only.

Clock Commands

Default Configuration
No servers are defined.

Command Mode
Global Configuration mode

User Guidelines
Up to 8 SNTP servers can be defined. To enable predefined Unicast clients globally use the sntp unicast client enable Global Configuration mode command. To enabling global polling use the sntp unicast client poll Global Configuration mode command. The sntp client poll timer Global Configuration mode command determines polling time.

Example
The following example configures the device to accept SNTP traffic from the server on 192.1.1.1. Console(config)# sntp server 192.1.1.1

show clock
The show clock User EXEC mode command displays the time and date from the system clock.

Syntax
show clock [detail]

Parameters detail Shows timezone and summertime configuration. Default Configuration


This command has no default configuration.

Command Mode
User EXEC mode

User Guidelines
The symbol that precedes the show clock display indicates the following: Symb ol * (blank) . D escr ip tio n Time is not authoritative. Time is authoritative. Time is authoritative, but SNTP is not synchronized.

Page 61

Allied Telesis
Command Line Interface Users Guide

Example
The following example displays the time and date from the system clock. Console> show clock 15:29:03 PDT(UTC-7) Jun 17 2002 Time source is SNTP Console> show clock detail 15:29:03 PDT(UTC-7) Jun 17 2002 Time source is SNTP Time zone: Acronym is PST Offset is UTC-8 Summertime: Acronym is PDT Recurring every year. Begins at first Sunday of April at 2:00. Ends at last Sunday of October at 2:00. Offset is 60 minutes.

show sntp configuration


The show sntp configuration Privileged EXEC mode command shows the configuration of the Simple Network Time Protocol (SNTP).

Syntax
show sntp configuration

Default Configuration
This command has no default configuration.

Command Mode
Privileged EXEC mode

User Guidelines
There are no user guidelines for this command.

Example
The following example displays the current SNTP configuration of the device. Console# show sntp configuration Polling interval: 7200 seconds MD5 Authentication keys: 8, 9

Page 62 Not approved by Document Control. For review only.

Clock Commands

Authentication is required for synchronization. Trusted Keys: 8, 9 Unicast Clients: Enabled Unicast Clients Polling: Enabled Server ----------176.1.1.8 176.1.8.179 Broadcast Clients: Enabled Anycast Clients: Enabled Broadcast and Anycast Interfaces: 1/e1, 1/e3 Polling ------Enabled Disabled Encryption Key -------------9 Disabled

show sntp status


The show sntp status Privileged EXEC mode command shows the status of the Simple Network Time Protocol (SNTP).

Syntax
show sntp status

Default Configuration
This command has no default configuration.

Command Mode
Privileged EXEC mode

User Guidelines
There are no user guidelines for this command.

Example
The following example shows the status of the SNTP. Console# show sntp status Clock is synchronized, stratum 4, reference is 176.1.1.8, unicast Reference time is AFE2525E.70597B34 (00:10:22.438 PDT Jul 5 1993) Unicast servers: Server Status Last response Offset [mSec] Delay [mSec]

Page 63

Allied Telesis
Command Line Interface Users Guide

----------176.1.1.8 176.1.8.179 Anycast server: Server --------176.1.11.8 Broadcast: Interface --------176.9.1.1

------Up Unknown

---------------------------19:58:22.289 PDT Feb 19 2002 12:17.17.987 PDT Feb 19 2002

-----7.33 8.98

-----117.79 189.19

Interface ------VLAN 118

Status ----Up

Last response ----------------------------9:53:21.789 PDT Feb 19 2002

Offset [mSec] -----7.19

Delay [mSec] ----119.89

Interface --------VLAN 119

Last response ---------------------------19:17:59.792 PDT Feb 19 2002

Page 64 Not approved by Document Control. For review only.

Configuration and Image File Commands

Chapter 6. Configuration and Image File Commands


copy
The copy Privileged EXEC mode command copies files from a source to a destination.

Syntax
copy source-url destination-url

Parameters source-url The source file location URL or reserved keyword of the source file to be copied.
(Range: 1-160 characters) destination-url The destination file URL or reserved keyword of the destination file. (Range: 1-160 characters) The following table displays keywords and URL prefixes:

Key wo rd flash: running-config startup-config image boot tftp:// xmodem: unit://member/ image unit://member/ boot null: backup-config unit://member/ backup-config

Sou rce o r Dest i na t io n Source or destination URL for flash memory. Its the default in case a URL is specified without a prefix. Represents the current running configuration file. Represents the startup configuration file. If the source file, represents the active image file. If the destination file, represents the non-active image file. Boot file. Source or destination URL for a TFTP network server. The syntax for this alias is tftp:// host/[directory]/filename. The host can be represented by its IP address or hostname. Source for the file from a serial connection that uses the Xmodem protocol. Image file on one of the units. To copy from the master to all units, specify * in the member field. Boot file on one of the units. To copy from the master to all units, specify * in the member field. Null destination for copies or files. A remote file can be copied to null to determine its size. Represents the backup configuration file. Backup configuration on one of the units.

Default Configuration
This command has no default configuration.

Command Mode
Privileged EXEC mode

Page 65

Allied Telesis
Command Line Interface Users Guide

User Guidelines
Up to five backup configuration files are supported on the device. The location of a file system dictates the format of the source or destination URL. The entire copying process may take several minutes and differs from protocol to protocol and from network to network. *.prv and *.sys files cannot be copied. Understanding Invalid Combinations of Source and Destination Some invalid combinations of source and destination exist. Specifically, you cannot copy if one of the following conditions exist: The source file and destination file are the same file. xmodem: is the destination file. The source file can be copied to image, boot and null: only. tftp:// is the source file and destination file on the same copy. The following table describes copy characters: Cha rac te r ! . Desc ription For network transfers, indicates that the copy process is taking place. Each exclamation point indicates successful transfer of ten packets (512 bytes each). For network transfers, indicates that the copy process timed out. Generally, many periods in a row means that the copy process may fail.

Copying an Image File from a Server to Flash Memory To copy an image file from a server to flash memory, use the copy source-url image command. Copying a Boot File from a Server to Flash Memory To copy a boot file from a server to flash memory, enter the copy source-url boot command. Copying a Configuration File from a Server to the Running Configuration File To load a configuration file from a network server to the running configuration file of the device, enter the copy source-url running-config command. The commands in the loaded configuration file are added to those in the running configuration file as if the commands were typed in the command-line interface (CLI). Thus, the resulting configuration file is a combination of the previous running configuration and the loaded configuration files with the loaded configuration file taking precedence. Copying a Configuration File from a Server to the Startup Configuration To copy a configuration file from a network server to the startup configuration file of the device, enter copy sourceurl startup-config. The startup configuration file is replaced by the copied configuration file. Storing the Running or Startup Configuration on a Server Use the copy running-config destination-url command to copy the current configuration file to a network server using TFTP. Use the copy startup-config destination-url command to copy the startup configuration file to a network server. Saving the Running Configuration to the Startup Configuration To copy the running configuration to the startup configuration file, enter the copy running-config startup-config command. Backing up the Running or Startup Configuration to a Backup Configuration File

Page 66 Not approved by Document Control. For review only.

Configuration and Image File Commands

To copy the running configuration file to a backup configuration file, enter the copy running-config file command. To copy the startup configuration file to a backup configuration file, enter the copy startup-config file command. Before copying from the backup configuration file to the running configuration file, make sure that the backup configuration file has not been corrupted.

Example
The following example copies system image file1 from the TFTP server 172.16.101.101 to a non-active image file. Console# copy tftp://172.16.101.101/file1 image Accessing file 'file1' on 172.16.101.101... Loading file1 from 172.16.101.101: !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! [OK] Copy took 0:01:11 [hh:mm:ss]

dir
The dir Privileged EXEC mode command displays the list of files on a flash file system.

Syntax
dir

Default Configuration
This command has no default configuration.

Command Mode
Privileged EXEC mode

User Guidelines
There are no user guidelines for this command.

Example
The following example displays the list of files on a flash file system. Console# dir Directory of flash: File Name ---------image-1 image-2 dhcpsn.prv sshkeys.prv Permission ---------rw rw --FlashSize 5242880 5242880 131072 262144 DataSize 4325376 4325376 ----Modified ---------01-Jan-2000 01:07:13 01-Jan-2000 09:09:19 01-Jan-2000 01:02:15 01-Jan-2000 01:02:15 ---------- ----------

Page 67

Allied Telesis
Command Line Interface Users Guide

syslog1.sys syslog2.sys directry.prv startup-config

r r -rw

262144 262144 262144 524288

---4

01-Jan-2000 01:03:21 01-Jan-2000 01:03:21 01-Jan-2000 01:02:15 01-Jan-2000 01:06:34

Total size of flash: 15728640 bytes Free size of flash: 3538944 bytes console#

delete
The delete Privileged EXEC mode command deletes a file from a flash memory device.

Syntax
delete url

Parameters url The location URL or reserved keyword of the file to be deleted. (Range: 1-160 characters)
The following table displays keywords and URL prefixes: K ey wo r d flash: startup-config Sou r c e o r D es ti n at io n Source or destination URL for flash memory. Its the default in case a URL is specified without a prefix. Represents the startup configuration file.

Default Configuration
This command has no default configuration.

Command Mode
Privileged EXEC mode

User Guidelines
*.sys, *.prv, image-1 and image-2 files cannot be deleted.

Example
The following example deletes file test from flash memory. Console# delete flash:test Delete flash:test? [confirm]

Page 68 Not approved by Document Control. For review only.

Configuration and Image File Commands

boot system
The boot system Privileged EXEC mode command specifies the system image that the device loads at startup.

Syntax
boot system [unit unit] {image-1 | image-2}

Parameters unit Specifies the unit number. image-1 Specifies image 1 as the system startup image. image-2 Specifies image 2 as the system startup image. Default Configuration
If the unit number is unspecified, the default setting is the master unit number.

Command Mode
Privileged EXEC mode

User Guidelines
Use the show bootvar command to find out which image is the active image.

Example
The following example loads system image 1 at device startup. Console# boot system image-1

show running-config
The show running-config Privileged EXEC mode command displays the contents of the currently running configuration file.

Syntax
show running-config

Default Configuration
This command has no default configuration.

Command Mode
Privileged EXEC mode

User Guidelines
There are no user guidelines for this command.

Page 69

Allied Telesis
Command Line Interface Users Guide

Example
The following example displays the contents of the running configuration file. Console# show running-config software version 1.1 hostname device interface ethernet 1/e1 ip address 176.242.100.100 255.255.255.0 duplex full speed 1000 interface ethernet 1/e2 ip address 176.243.100.100 255.255.255.0 duplex full speed 1000

show startup-config
The show startup-config Privileged EXEC mode command displays the contents of the startup configuration file.

Syntax
show startup-config

Default Configuration
This command has no default configuration.

Command Mode
Privileged EXEC mode

User Guidelines
There are no user guidelines for this command.

Example
The following example displays the contents of the running configuration file. Console# show startup-config software version 1.1 hostname device

Page 70 Not approved by Document Control. For review only.

Configuration and Image File Commands

interface ethernet 1/e1 ip address 176.242.100.100 255.255.255.0 duplex full speed 1000 interface ethernet 1/e2 ip address 176.243.100.100 255.255.255.0 duplex full speed 1000

show bootvar
The show bootvar Privileged EXEC mode command displays the active system image file that is loaded by the device at startup.

Syntax
show bootvar [unit unit]

Parameters unit Specifies the unit number. Default Configuration


This command has no default configuration.

Command Mode
Privileged EXEC mode

User Guidelines
There are no user guidelines for this command.

Example
The following example displays the active system image file that is loaded by the device at startup. Console# show bootvar Images currently available on the FLASH image-1 image-2 Unit ---1 2 active not active (selected for next boot) Active Image -----------image-1 image-1 Selected for next boot ---------------------image-2 image-1

Page 71

Allied Telesis
Command Line Interface Users Guide

Chapter 7. DHCP Option 82 Commands


ip dhcp information option
The ip dhcp information option Global Configuration mode command enables Dynamic Host Configuration Protocol (DHCP) option-82 data insertion. Use the no form of this command to disable DHCP option-82 data insertion.

Syntax
ip dhcp information option no ip dhcp information option

Parameters
This command has no arguments or keywords.

Default Configuration
DHCP option-82 data insertion is enabled.

Command Mode
Global Configuration mode

User Guidelines
DHCP option 82 is enabled only if DHCP snooping or DHCP relay are enabled.

Example
The following example enables DHCP option-82 data insertion. Console(config)# ip dhcp information option

show ip dhcp information option


The show ip dhcp information option EXEC mode command displays the DHCP option 82 configuration.

Syntax
show ip dhcp information option

Parameters
This command has no arguments or keywords.

Default Configuration
DHCP option-82 data insertion is enabled.

Page 72 Not approved by Document Control. For review only.

DHCP Option 82 Commands

Command Mode
Privileged EXEC

User Guidelines
There are no user guidelines for this command.

Example
The following example displays the DHCP option 82 configuration. Console(config)# show ip dhcp information option

ip dhcp relay enable


The ip dhcp relay enable Global Configuration mode command enables DHCP relay features on your router. Use the no form of this command to disable the relay agent features.

Syntax
ip dhcp relay {address|enable} no ip dhcp relay {address|enable}

Parameters
This command has no arguments or keywords.

Default Configuration
Disabled.

Command Mode
Global Configuration

User Guidelines
There are no user guidelines for this command.

Example
The following example enables DHCP relay features. Console(config)# ip dhcp relay enable

Page 73

Allied Telesis
Command Line Interface Users Guide

Chapter 8. DHCP Snooping Commands


ip dhcp snooping
The ip dhcp snooping Global Configuration mode command globally enables DHCP snooping. Use the no form of this command to return to the default setting.

Syntax
ip dhcp snooping no ip dhcp snooping

Parameters
This command has no arguments or keywords

Default Configuration
Disabled

Command Mode
Global Configuration mode

User Guidelines
For any DHCP snooping configuration to take effect, DHCP snooping must be globally enabled. DHCP snooping is not active until snooping on a VLAN is enabled by using the ip dhcp snooping VLAN Global Configuration mode command.

Example
.The following example configures globally enabling DHCP snooping. Console(config)# ip dhcp snooping

ip dhcp snooping vlan


The ip dhcp snooping vlan Global Configuration mode command enables DHCP snooping on a VLAN. Use the no form of this command to disable DHCP snooping on a VLAN

Syntax
ip dhcp snooping vlan vlan-id no ip dhcp snooping vlan vlan-id

Parameters vlan-id Specify VLAN ID. Default Configuration


Disabled

Page 74 Not approved by Document Control. For review only.

DHCP Snooping Commands

Command Mode
Global Configuration mode

User Guidelines
DHCP snooping must be first globally enabled before enabling DHCP snooping on a VLAN.

Example
The following example configures DHCP snooping on a VLAN. Console(config)# ip dhcp snooping vlan 1

ip dhcp snooping trust


The ip dhcp snooping trust Interface Configuration mode command configures a port as trusted for DHCP snooping purposes. Use the no form of this command to return to the default setting.

Syntax
ip dhcp snooping trust no ip dhcp snooping trust

Parameters
This command has no arguments or keywords.

Default Configuration
Interface configuration (Ethernet, Port-channel)

Command Mode
Interface Configuration mode

User Guidelines
Configure as trusted ports those that are connected to a DHCP server or to other switches or routers. Configure as untrusted ports those that are connected to DHCP clients.

Example
.The following example configures a port as trusted for DHCP snooping purposes. console# console# configure console(config)# interface ethernet 1/e1 console(config-if)# ip dhcp snooping trust console(config-if)#

Page 75

Allied Telesis
Command Line Interface Users Guide

ip dhcp snooping information option allowed-untrusted


The ip dhcp snooping information option allowed-untrusted Global Configuration mode command configures a switch to accept DHCP packets with option-82 information from an untrusted port. Use the no form of this command to configure the switch to drop these packets from an untrusted port.

Syntax
ip dhcp snooping information option allowed-untrusted no ip dhcp snooping information option allowed-untrusted

Parameters
This command has no arguments or keywords. Default Configuration Discard DHCP packets with option-82 information from an untrusted port.

Command Mode
Global Configuration mode

User Guidelines
There are no user guidelines for this command.

Example
The following example configures the switch to accept DHCP packets with option-82 information from an untrusted port. Console(config)# ip dhcp snooping information option allowed-untrusted

ip dhcp snooping verify


The ip dhcp snooping verify Global Configuration mode command configures the switch to verify, on an untrusted port, that the source MAC address in a DHCP packet matches the client hardware address. Use the no form of this command to configure the switch to not verify the MAC addresses.

Syntax
ip dhcp snooping verify no ip dhcp snooping verify

Parameters
This command has no arguments or keywords.

Default Configuration
The switch verifies the source MAC address in a DHCP packet that is received on untrusted ports matches the client hardware address in the packet.

Command Mode
Global configuration.

Page 76 Not approved by Document Control. For review only.

DHCP Snooping Commands

User Guidelines
There are no user guidelines for this command.

Example
The following example configures the switch to verify on an untrusted port that the source MAC address in a DHCP packet matches the client hardware address

Console(config) #ip dhcp snooping verify

ip dhcp snooping database


The ip dhcp snooping database Global Configuration mode command configures the DHCP snooping binding file. Use the no form of this command to delete the binding file.

Syntax
ip dhcp snooping database no ip dhcp snooping database

Parameters
This command has no arguments or keywords.

Default Configuration
The URL is not defined.

Command Mode
Global Configuration mode

User Guidelines
To ensure that the lease time in the database is accurate, Simple Network Time Protocol (SNTP) is enabled and configured. The switch writes binding changes to the binding file only when the switch system clock is synchronized with SNTP.

Example
.The following example configures the DHCP snooping binding file. Console(config)# ip dhcp snooping database

ip dhcp snooping database update-freq


The ip dhcp snooping database update-freq Global Configuration mode command configures the update frequency of the DHCP snooping binding file. Use the no form of this command to return to default.

Syntax
ip dhcp snooping database update-freq seconds

Page 77

Allied Telesis
Command Line Interface Users Guide

no ip dhcp snooping database update-freq

Parameters seconds Specify, in seconds, the update frequency (Range: 600 - 86400 ). Default Configuration
1200

Command Mode
Global Configuration mode

User Guidelines
There are no user guidelines for this command.

Example
The following example configures the update frequency of the DHCP snooping binding file. Console(config)# ip dhcp snooping database update-freq

ip dhcp snooping binding


The ip dhcp snooping binding Privileged EXEC mode command configures the DHCP snooping binding database and adds binding entries to the database. Use the no form of this command to delete entries from the binding database.

Syntax
ip dhcp snooping binding mac-address vlan-id ip-address {ethernet interface | port-channel port-channelnumber} expiry seconds no ip dhcp snooping binding mac-address vlan-id

Parameters mac-address Specify a MAC address vlan-id Specify a VLAN number ip-address Specify an IP address interface Specify Ethernet port port-channel-number Specify Port-channel number expiry seconds Specify the interval, in seconds, after which the binding entry is no longer valid (Range: 10
- 4294967295)

Default Configuration
No static binding exists

Command Mode
Privileged EXEC

Page 78 Not approved by Document Control. For review only.

DHCP Snooping Commands

User Guidelines
After entering this command an entry is added to the DHCP snooping database. If DHCP snooping binding file exists, the entry is added to that file also. The entry is displayed in the show commands as a DHCP Snooping entry.

Example
The following example configures the DHCP snooping binding database and adds binding entries to the database. Console# ip dhcp snooping binding 0060.704c.73ff 3 10.1.8.1 ethernet 1/e21

clear ip dhcp snooping database


The clear ip dhcp snooping database Privileged EXEC mode command clears the DHCP binding database.

Syntax
clear ip dhcp snooping database

Parameters
This command has no arguments or keywords.

Default Configuration
No static binding exists

Command Mode
Privileged EXEC mode

User Guidelines
There are no user guidelines for this command.

Example
The following example clears the DHCP binding database. Console# clear ip dhcp snooping database

show ip dhcp snooping


The show ip dhcp snooping EXEC mode command displays the DHCP snooping configuration.

Syntax
show ip dhcp snooping [ethernet interface | port-channel port-channel-number]

Parameters interface Specify Ethernet port port-channel-number Specify Port-channel number Default Configuration
This command has no default configuration.

Page 79

Allied Telesis
Command Line Interface Users Guide

Command Mode
EXEC mode.

User Guidelines
There are no user guidelines for this command.

Example
The following example displays the DHCP snooping configuration. Console# show ip dhcp snooping DHCP snooping is enabled DHCP snooping is configured on following VLANs: 2, 7-18 DHCP snooping database: enabled Option 82 on untrusted port is allowed Relay agent information option 82 is enabled. Verification of hwaddr field is enabled Interface ---------------------1/1 1/2 Trusted ---------------------Yes Yes

show ip dhcp snooping binding


The show ip dhcp snooping binding User EXEC mode command displays the DHCP snooping binding database and configuration information for all interfaces on a switch.

Syntax
show ip dhcp snooping binding [mac-address mac-address] [ip-address ip-address] [vlan vlan] [ethernet interface | port-channel port-channel-number]

Parameters mac-address Specify a MAC address ip-address Specify an IP address. vlan-id Specify a VLAN number. interface Specify Ethernet port. port-channel-number Specify Port-channel number Default Configuration

Command Mode
EXEC

Page 80 Not approved by Document Control. For review only.

DHCP Snooping Commands

User Guidelines
There are no user guidelines for this command.

Example
Console# show ip dhcp snooping binding Total number of binding: 2 MAC Adreess IP Address Lease (sec) ------------------ --------------- -----------00:60:70:4c:73:ff 10.1.8.1 4294967295 00:60:70:4c:7f:c1 10.1.8.2 4294967295 Console# Type VLAN Interface ---------- ---- ---------snooping 3 1/e21 snooping 3 1/e22

Page 81

Allied Telesis
Command Line Interface Users Guide

Chapter 9. Ethernet Configuration Commands


interface ethernet
The interface ethernet Global Configuration mode command enters the interface configuration mode to configure an Ethernet type interface.

Syntax
interface ethernet interface

Parameters interface Valid Ethernet port. (Full syntax: unit/port) Default Configuration
This command has no default configuration.

Command Mode
Global Configuration mode

User Guidelines
There are no user guidelines for this command.

Example
The following example enables configuring Ethernet port 5/e18. Console(config)# interface ethernet 5/e18

interface range ethernet


The interface range ethernet Global Configuration mode command configures multiple Ethernet type interfaces at the same time.

Syntax
interface range ethernet {port-range | all}

Parameters port-range List of valid ports. Where more than one port is listed, separate nonconsecutive ports with a
comma and no spaces, use a hyphen to designate a range of ports and group a list separated by commas in brackets. all All Ethernet ports.

Default Configuration
This command has no default configuration.

Page 82 Not approved by Document Control. For review only.

Ethernet Configuration Commands

Command Mode
Global Configuration mode

User Guidelines
Commands under the interface range context are executed independently on each active interface in the range. If the command returns an error on one of the active interfaces, it does not stop executing commands on other active interfaces.

Example
The following example shows how ports 5/e18 to 5/e20 and 3/e1 to 3/24 are grouped to receive the same command. Console(config)# interface range ethernet 5/e18-20,3/e1-24 Console(config-if)#

shutdown
The shutdown Interface Configuration (Ethernet, port-channel) mode command disables an interface. Use the no form of this command to restart a disabled interface.

Syntax
shutdown no shutdown

Default Configuration
The interface is enabled.

Command Mode
Interface Configuration (Ethernet, port-channel) mode

User Guidelines
There are no user guidelines for this command.

Example
The following example disables Ethernet port 1/e5 operations. Console(config)# interface ethernet 1/e5 Console(config-if)# shutdown The following example restarts the disabled Ethernet port. Console(config)# interface ethernet 1/e5 Console(config-if)# no shutdown

Page 83

Allied Telesis
Command Line Interface Users Guide

description
The description Interface Configuration (Ethernet, port-channel) mode command adds a description to an interface. Use the no form of this command to remove the description.

Syntax
description string no description

Parameters string Comment or a description of the port to enable the user to remember what is attached to the port.
(Range: 1-64 characters)

Default Configuration
The interface does not have a description.

Command Mode
Interface Configuration (Ethernet, port-channel) mode

User Guidelines
There are no user guidelines for this command.

Example
The following example adds a description to Ethernet port 1/e5. Console(config)# interface ethernet 1/e5 Console(config-if)# description "RD SW#3"

speed
The speed Interface Configuration (Ethernet, port-channel) mode command configures the speed of a given Ethernet interface when not using auto-negotiation. Use the no form of this command to restore the default configuration.

Syntax
speed {10 | 100 | 1000} no speed

Parameters 10 Forces10 Mbps operation. 100 Forces 100 Mbps operation. 1000 Forces 1000 Mbps operation. Default Configuration
Maximum port capability

Page 84 Not approved by Document Control. For review only.

Ethernet Configuration Commands

Command Mode
Interface Configuration (Ethernet, port-channel) mode

User Guidelines
The no speed command in a port-channel context returns each port in the port-channel to its maximum capability.

Example
The following example configures the speed operation of Ethernet port 1/e5 to 100 Mbps operation. Console(config)# interface ethernet 1/e5 Console(config-if)# speed 100 This document uses the following conventions to highlight important information: Note The speed setting for SFP ports is dependent on the maximum speed of the port.

duplex
The duplex Interface Configuration (Ethernet) mode command configures the full/half duplex operation of a given Ethernet interface when not using auto-negotiation. Use the no form of this command to restore the default configuration.

Syntax
duplex {half | full} no duplex

Parameters half Forces half-duplex operation full Forces full-duplex operation Default Configuration
The interface is set to full duplex.

Command Mode
Interface Configuration (Ethernet) mode

User Guidelines
When configuring a particular duplex mode on the port operating at 10/100 Mbps, disable the auto-negotiation on that port. Half duplex mode can be set only for ports operating at 10 Mbps or 100 Mbps.

Page 85

Allied Telesis
Command Line Interface Users Guide

Example
The following example configures the duplex operation of Ethernet port 1/e5 to full duplex operation. Console(config)# interface ethernet 1/e5 Console(config-if)# duplex full

negotiation
The negotiation Interface Configuration (Ethernet, port-channel) mode command enables auto-negotiation operation for the speed and duplex parameters of a given interface. Use the no form of this command to disable auto-negotiation.

Syntax
negotiation [capability1 [capability2capability5]] no negotiation

Parameters capability Specifies the capabilities to advertise. (Possible values: 10h, 10f, 100h,100f, 1000f) Default Configuration
Auto-negotiation is enabled. If unspecified, the default setting is to enable all capabilities of the port.

Command Mode
Interface Configuration (Ethernet, port-channel) mode

User Guidelines
If capabilities were specified when auto-negotiation was previously entered, not specifying capabilities when currently entering auto-negotiation overrides the previous configuration and enables all capabilities.

Example
The following example enables auto-negotiation on Ethernet port 1/e5. Console(config)# interface ethernet 1/e5 Console(config-if)# negotiation

flowcontrol
The flowcontrol Interface Configuration (Ethernet, port-channel) mode command configures flow control on a given interface. Use the no form of this command to disable flow control.

Syntax
flowcontrol {on | off | auto} no flowcontrol

Page 86 Not approved by Document Control. For review only.

Ethernet Configuration Commands

Parameters on Force flow control as enabled. off Force flow control as disabled. auto Enable AUTO flow control configuration. Default Configuration
Flow control is off.

Command Mode
Interface Configuration (Ethernet, port-channel) mode

User Guidelines
Negotiation should be enabled for flow control auto.

Example
In the following example, flow control is enabled on port 1/e5. Console(config)# interface ethernet 1/e5 Console(config-if)# flowcontrol on

mdix
The mdix Interface Configuration (Ethernet) mode command enables cable crossover on a given interface. Use the no form of this command to disable cable crossover.

Syntax
mdix {on | auto} no mdix

Parameters on Manual mdix auto Automatic mdi/mdix Default Configuration


The default setting is on.

Command Mode
Interface Configuration (Ethernet) mode

User Guidelines
Auto: All possibilities to connect a PC with cross or normal cables are supported and are automatically detected. On: It is possible to connect to a PC only with a normal cable and to connect to another device only with a cross cable. No: It is possible to connect to a PC only with a cross cable and to connect to another device only with a normal cable.

Page 87

Allied Telesis
Command Line Interface Users Guide

Example
In the following example, automatic crossover is enabled on port 1/e5. Console(config)# interface ethernet 1/e5 Console(config-if)# mdix auto

back-pressure
The back-pressure Interface Configuration (Ethernet, port-channel) mode command enables back pressure on a given interface. Use the no form of this command to disable back pressure.

Syntax
back-pressure no back-pressure

Default Configuration
Back pressure is enabled.

Command Mode
Interface Configuration (Ethernet, port-channel) mode

User Guidelines
There are no user guidelines for this command.

Example
In the following example back pressure is enabled on port 1/e5. Console(config)# interface ethernet 1/e5 Console(config-if)# back-pressure

port jumbo-frame
The port jumbo-frame Global Configuration mode command enables jumbo frames for the device. Use the no form of this command to disable it.

Syntax
port jumbo-frame no port jumbo-frame

Default Configuration
Disabled.

Command Mode
Global Configuration mode.

Page 88 Not approved by Document Control. For review only.

Ethernet Configuration Commands

User Guidelines
The command is effective only after reset.

Example
The following example enables jumbo frames for the device. Console(config)# port jumbo-frame

system flowcontrol
Use system flowcontrol Global Configuration mode to enable flow control on cascade ports. Use the no form of this command to disable it.

Syntax
system flowcontrol no system flowcontrol

Default Configuration
This command has no default configuration.

Command Mode
GLOBAL Configuration mode

User Guidelines
There are no user guidelines for this command.

clear counters
The clear counters User EXEC mode command clears statistics on an interface.

Syntax
clear counters [ethernet interface | port-channel port-channel-number]

Parameters interface Valid Ethernet port. (Full syntax: unit/port) port-channel-number Valid port-channel number. Default Configuration
This command has no default configuration.

Command Mode
User EXEC mode

User Guidelines
There are no user guidelines for this command.

Page 89

Allied Telesis
Command Line Interface Users Guide

Example
In the following example, the counters for interface 1/e1 are cleared. Console> clear counters ethernet 1/e1

set interface active


The set interface active Privileged EXEC mode command reactivates an interface that was shutdown.

Syntax
set interface active {ethernet interface | port-channel port-channel-number}

Parameters interface Valid Ethernet port. (Full syntax: unit/port) port-channel-number Valid port-channel number. Default Configuration
This command has no default configuration.

Command Mode
Privileged EXEC mode

User Guidelines
This command is used to activate interfaces that were configured to be active, but were shutdown by the system for some reason (e.g., port security).

Example
The following example reactivates interface 1/e5. Console# set interface active ethernet 1/e5

show interfaces advertise


The show interfaces advertise Privileged EXEC mode command displays autonegotiation data.

Syntax
show interfaces advertise [ethernet interface | port-channel port-channel-number ]

Parameters interface Valid Ethernet port. (Full syntax: unit/port) port-channel-number Valid port-channel number. Default Configuration
This command has no default configuration.

Page 90 Not approved by Document Control. For review only.

Ethernet Configuration Commands

Command Modes
Privileged EXEC mode

User Guidelines
There are no user guidelines for this command.

Example
The following examples display autonegotiation information. Console# show interfaces advertise Port ---e1 e2 e3 e4 e5 e6 e7 e8 e9 e10 e11 e12 e13 e14 e15 e16 e17 e18 e19 e20 Type ----------100M-Copper 100M-Copper 100M-Copper 100M-Copper 100M-Copper 100M-Copper 100M-Copper 100M-Copper 100M-Copper 100M-Copper 100M-Copper 100M-Copper 100M-Copper 100M-Copper 100M-Copper 100M-Copper 100M-Copper 100M-Copper 100M-Copper 100M-Copper Neg ------Enabled Enabled Enabled Enabled Enabled Enabled Enabled Enabled Enabled Enabled Enabled Enabled Enabled Enabled Enabled Enabled Enabled Enabled Enabled Enabled Operational Link Advertisement ---------------------------------100f, 100h, 10f, 10h ----------------

show interfaces configuration


The show interfaces configuration Privileged EXEC mode command displays the configuration for all configured interfaces.

Syntax
show interfaces configuration [ethernet interface | port-channel port-channel-number]

Page 91

Allied Telesis
Command Line Interface Users Guide

Parameters interface Valid Ethernet port. (Full syntax: unit/port) port-channel-number Valid port-channel number. Default Configuration
This command has no default configuration.

Command Modes
Privileged EXEC mode

User Guidelines
There are no user guidelines for this command.

Example
The following example displays the configuration of all configured interfaces: Console# show interfaces configuration Port ---e1 e2 e3 e4 e5 e6 e7 e8 e9 e10 e11 e12 e13 e14 e15 e16 e17 e18 e19 Type ----------100M-Copper 100M-Copper 100M-Copper 100M-Copper 100M-Copper 100M-Copper 100M-Copper 100M-Copper 100M-Copper 100M-Copper 100M-Copper 100M-Copper 100M-Copper 100M-Copper 100M-Copper 100M-Copper 100M-Copper 100M-Copper 100M-Copper Duplex -----Full Full Full Full Full Full Full Full Full Full Full Full Full Full Full Full Full Full Full Speed ----100 100 100 100 100 100 100 100 100 100 100 100 100 100 100 100 100 100 100 Neg ------Enabled Enabled Enabled Enabled Enabled Enabled Enabled Enabled Enabled Enabled Enabled Enabled Enabled Enabled Enabled Enabled Enabled Enabled Enabled Flow Ctrl ---Off Off Off Off Off Off Off Off Off Off Off Off Off Off Off Off Off Off Off Link State ----Up Up Up Up Up Up Up Up Up Up Up Up Up Up Up Up Up Up Up Back Pressure -------Disabled Disabled Disabled Disabled Disabled Disabled Disabled Disabled Disabled Disabled Disabled Disabled Disabled Disabled Disabled Disabled Disabled Disabled Disabled Mdix Mode ---Auto Auto Auto Auto Auto Auto Auto Auto Auto Auto Auto Auto Auto Auto Auto Auto Auto Auto Auto

Page 92 Not approved by Document Control. For review only.

Ethernet Configuration Commands

show interfaces status


The show interfaces status Privileged EXEC mode command displays the status of all configured interfaces.

Syntax
show interfaces status [ethernet interface| port-channel port-channel-number]

Parameters interface A valid Ethernet port. (Full syntax: unit/port) port-channel-number A valid port-channel number. Default Configuration
This command has no default configuration.

Command Mode
Privileged EXEC mode

User Guidelines
There are no user guidelines for this command.

Example
The following example displays the status of all configured interfaces: Console# show interfaces status Port ---e1 e2 e3 e4 e5 e6 e7 e8 e9 e10 e11 e12 e13 e14 Type ----------100M-Copper 100M-Copper 100M-Copper 100M-Copper 100M-Copper 100M-Copper 100M-Copper 100M-Copper 100M-Copper 100M-Copper 100M-Copper 100M-Copper 100M-Copper 100M-Copper Duplex ---------Full ---------Speed --------100 ---------Neg ----------Enabled ---------Flow Ctrl -------Off ---------Link State ----Down Down Down Down Up Down Down Down Down Down Down Down Down Down Back Pressure -----------Disabled ---------Mdix Mode -------Auto ----------

Page 93

Allied Telesis
Command Line Interface Users Guide

e15 e16 e17 e18 e19

100M-Copper 100M-Copper 100M-Copper 100M-Copper 100M-Copper

------

------

------

------

Down Down Down Down Down

------

------

show interfaces description


The show interfaces description Privileged EXEC mode command displays the description for all configured interfaces.

Syntax
show interfaces description [ethernet interface | port-channel port-channel-number]

Parameters interface Valid Ethernet port. (Full syntax: unit/port) port-channel-number A valid port-channel number. Default Configuration
This command has no default configuration.

Command Modes
Privileged EXEC mode

User Guidelines
There are no user guidelines for this command.

Example
The following example displays descriptions of configured interfaces. Console# show interfaces description Port ---1/e1 1/e2 1/e3 1/e4 1/e5 1/e6 ch1 ch2 Description ----------lab

Page 94 Not approved by Document Control. For review only.

Ethernet Configuration Commands

show ports jumbo-frame


The show port jumbo-frame Privileged EXEC mode command displays the configuration of jumbo frames.

Syntax
show port jumbo-frame

Parameters
This command has no arguments or keywords.

Default Configuration
This command has no default configuration.

Command Modes
Privileged EXEC mode

User Guidelines
There are no user guidelines for this command.

Example
The following example enables the display of the configuration of jumbo frames. Console# show port jumbo-frame Jumbo frames are disabled Jumbo frames will be enabled after reset

show interfaces counters


The show interfaces counters User EXEC mode command displays traffic seen by the physical interface.

Syntax
show interfaces counters [ethernet interface | port-channel port-channel-number]

Parameters interface A valid Ethernet port. (Full syntax: unit/port) port-channel-number A valid port-channel number. Default Configuration
This command has no default configuration.

Command Modes
User EXEC mode

User Guidelines
There are no user guidelines for this command.

Page 95

Allied Telesis
Command Line Interface Users Guide

Example
The following example displays traffic seen by the physical interface: Console# show interfaces counters Port ---1/e1 2/e1 3/e1 Port ----1/e1 2/e1 3/e1 Ch --1 Ch --1 InOctets -------183892 0 123899 OutOctets ---------9188 0 8789 InOctets -------27889 OutOctets --------23739 InUcastPkts ----------0 0 0 OutUcastPkts -----------0 0 0 InUcastPkts ---------0 OutUcastPkts -----------0 InMcastPkts ----------0 0 0 OutMcastPkts -----------0 0 0 InMcastPkts ----------0 OutMcastPkts -----------0 InBcastPkts ----------0 0 0 OutBcastPkts -----------0 0 0 InBcastPkts ----------0 OutBcastPkts -----------0

The following example displays counters for Ethernet port 1/e1.0 console# show interfaces counters Port -------1/e1 1/e2 1/e3 Port -------1/e1 1/e2 1/e3 Ch ---InUcastPkts ---------0 0 0 OutUcastPkts ----------0 0 InMcastPkts -----------0 0 0 OutMcastPkts ---------------0 0 InBcastPkts --------------0 0 0 OutBcastPkts ---------------0 0 InOctets -----------0 0 0 OutOctets -----------0 0 0 InOctets ------------

0 InUcastPkts ------------

0 InMcastPkts --------------

0 InBcastPkts -------------

Page 96 Not approved by Document Control. For review only.

Ethernet Configuration Commands

ch1 ch2 ch3 ch4 ch5 ch6 ch7 ch8 -------ch1 ch2 ch3 ch4 ch5 ch6 ch7 ch8 console#

0 0 0 0 0 0 0 0 OutUcastPkts -----------0 0 0 0 0 0 0 0

0 0 0 0 0 0 0 0 OutMcastPkts -----------0 0 0 0 0 0 0 0

0 0 0 0 0 0 0 0 OutBcastPkts -----------------0 0 0 0 0 0 0 0

0 0 0 0 0 0 0 0 OutOctets --------------0 0 0 0 0 0 0 0

Console# show interfaces counters ethernet 1/e1 Port -----1/e1 Port -----1/e1 InUcastPkts ----------0 OutUcastPkts ----------0 InMcastPkts -------------0 OutMcastPkts -------------0 InBcastPkts ----------0 OutBcastPkts -----------0 InOctets ----------0 OutOctets -----------0

FCS Errors: 0 Single Collision Frames: 0 Late Collisions: 0 Oversize Packets: 0 Internal MAC Rx Errors: 0 Received Pause Frames: 0

Page 97

Allied Telesis
Command Line Interface Users Guide

Transmitted Pause Frames: 0 Console# Console# show interfaces counters ethernet 1/e1 Port -----1/e1 Port -----1/e1 InOctets ----------183892 OutOctets ----------9188 InUcastPkts -------------0 OutUcastPkts -------------0 InMcastPkts ----------0 OutMcastPkts -----------0 InBcastPkts ----------0 OutBcastPkts -----------0

FCS Errors: 8 Single Collision Frames: 0 Late Collisions: 0 Oversize Packets: 0 Internal MAC Rx Errors: 0 Symbol Errors: 0 Received Pause Frames: 0 Transmitted Pause Frames: 0 The following table describes the fields shown in the display: Field InOctets InUcastPkts InMcastPkts InBcastPkts OutOctets OutUcastPkts OutMcastPkts OutBcastPkts FCS Errors Single Collision Frames Late Collisions Des cription Counted received octets. Counted received Unicast packets. Counted received Multicast packets. Counted received Broadcast packets. Counted transmitted octets. Counted transmitted Unicast packets. Counted transmitted Multicast packets. Counted transmitted Broadcast packets. Counted received frames that are an integral number of octets in length but do not pass the FCS check. Counted frames that are involved in a single collision, and are subsequently transmitted successfully. Number of times that a collision is detected later than one slotTime into the transmission of a packet.

Page 98 Not approved by Document Control. For review only.

Ethernet Configuration Commands

Oversize Packets Internal MAC Rx Errors Received Pause Frames Transmitted Pause Frames

Counted frames received that exceed the maximum permitted frame size. Counted frames for which reception fails due to an internal MAC sublayer receive error. Counted MAC Control frames received with an opcode indicating the PAUSE operation. Counted MAC Control frames transmitted on this interface with an opcode indicating the PAUSE operation.

show system flowcontrol


The show system flowcontrol Privileged EXEC mode command displays the flow control state on cascade ports.

Syntax
show system flowcontrol

Default Configuration
This command has no default configuration.

Command Mode
Privileged EXEC mode

User Guidelines
There are no user guidelines for this command.

Example
Console# show system flowcontrol

port storm-control include-multicast (IC)


The port storm-control include-multicast Interface Configuration (Ethernet) mode command counts Multicast packets in Broadcast storm control. Use the no form of this command to disable counting Multicast packets.

Syntax
port storm-control include-multicast [unknown-unicast] no port storm-control include-multicast

Parameters unknown-unicast Specifies also counting unknown Unicast packets. Default Configuration
Multicast packets are not counted.

Page 99

Allied Telesis
Command Line Interface Users Guide

Command Modes
Interface Configuration (Ethernet) mode

User Guidelines
This command is relevant to FE devices only. To control Multicasts storms, use the port storm-control broadcast enable and port storm-control broadcast rate commands.

Example
The following example enables counting Broadcast and Multicast packets on Ethernet port 2/e3. Console(config)# interface ethernet 2/e3 Console(config-if)# port storm-control include-multicast

port storm-control broadcast enable


The port storm-control broadcast enable Interface Configuration (Ethernet) mode command enables Broadcast storm control. Use the no form of this command to disable Broadcast storm control.

Syntax
port storm-control broadcast enable no port storm-control broadcast enable

Default Configuration
Broadcast storm control is disabled.

Command Modes
Interface Configuration (Ethernet) mode

User Guidelines
Use the port storm-control broadcast rate Interface Configuration (Ethernet) mode command, to set the maximum allowable Broadcast rate. Use the port storm-control include-multicast Global Configuration mode command to enable counting Multicast packets in the storm control calculation. For FE devices, use the port storm-control include-multicast Interface Configuration (Ethernet) mode command to enable counting Multicast packets and optionally unknown Unicast packets in the storm control calculation. For GE devices, use the port storm-control include-multicast Global Configuration mode command to enable counting Multicast packets in the storm control calculation.

Examples
The following example enables Broadcast storm control on Ethernet port 1/e5 of a FE device. Console(config)# interface ethernet 1/e5 Console(config-if)# port storm-control broadcast enable

Page 100 Not approved by Document Control. For review only.

Ethernet Configuration Commands

The following example enables Broadcast storm control on port 1/g5 for aGE devices. Console(config)# interface ethernet 1/g5 Console(config)# port storm-control broadcast enable The following example enables Broadcast storm control on port 1/g5. Console(config)# interface ethernet 1/g5 Console(config)# port storm-control broadcast enable

port storm-control broadcast rate


The port storm-control broadcast rate Interface Configuration (Ethernet) mode command configures the maximum Broadcast rate. Use the no form of this command to return to the default configuration.

Syntax
port storm-control broadcast rate rate no port storm-control broadcast rate

Parameters rate Maximum kilobits per second of Broadcast and Multicast traffic on a port. Possible values are in a
range of 3500-1000000. For FE ports, possible values are 70K - 100M. For GE ports, possible values are in a range of 3500-1000000.

Default Configuration
For FE ports, the default storm control Broadcast rate is 3500Kbits/Sec. For GE ports, the default storm control Broadcast rate is 12,000 Kbits/Sec.

Command Mode
Interface Configuration (Ethernet) mode

User Guidelines
Use the port storm-control broadcast enable Interface Configuration mode command to enable Broadcast storm control. For FE ports, the software displays the actual rate since granularity depends on the requested rate. For GE ports, the rate is rounded off to the nearest 64 Kbits/Sec (except for 1-63 Kbits/Sec which is rounded off to 64 Kbits/Sec). If the rate is 0, Broadcast packets are not forwarded.

Page 101

Allied Telesis
Command Line Interface Users Guide

Example
The following example configures the maximum storm control Broadcast rate at 900 Kbits/Sec on Ethernet port 1/ e5 of a FE port. Console(config)# interface ethernet 1/e5 Console(config-if)# port storm-control broadcast rate 900

show ports storm-control


The show ports storm-control User/Privileged EXEC mode command displays the storm control configuration. show ports storm-control [interface]

Parameters interface A valid Ethernet port. (Full syntax: unit/port) Default Configuration
This command has no default configuration.

Command Modes
Privileged EXEC mode

User Guidelines
There are no user guidelines for this command.

Example
The following example displays the storm control configuration. Console# show ports storm-control Port ---1/e1 2/e1 3/e1 State -------Enabled Enabled Disabled Rate [Kbits/Sec] ---------------70 100 100 Included -------------------------------------Broadcast, Multicast, Unknown Unicast Broadcast Broadcast

Page 102 Not approved by Document Control. For review only.

GVRP Commands

Chapter 10.GVRP Commands


gvrp enable (Global)
GARP VLAN Registration Protocol (GVRP) is an industry-standard protocol designed to propagate VLAN information from device to device. With GVRP, a single device is manually configured with all desired VLANs for the network, and all other devices on the network learn these VLANs dynamically. The gvrp enable Global Configuration mode command enables GVRP globally. Use the no form of this command to disable GVRP on the device.

Syntax
gvrp enable no gvrp enable

Default Configuration
GVRP is globally disabled.

Command Mode
Global Configuration mode

User Guidelines
There are no user guidelines for this command.

Example
The following example enables GVRP globally on the device. Console(config)# gvrp enable

gvrp enable (Interface)


The gvrp enable Interface Configuration (Ethernet, port-channel) mode command enables GVRP on an interface. Use the no form of this command to disable GVRP on an interface.

Syntax
gvrp enable no gvrp enable

Default Configuration
GVRP is disabled on all interfaces.

Command Mode
Interface Configuration (Ethernet, port-channel) mode

Page 103

Allied Telesis
Command Line Interface Users Guide

User Guidelines
An access port does not dynamically join a VLAN because it is always a member in only one VLAN. Membership in an untagged VLAN is propagated in the same way as in a tagged VLAN. That is, the PVID is manually defined as the untagged VLAN VID.

Example
The following example enables GVRP on Ethernet port 1/e6. Console(config)# interface ethernet 1/e6 Console(config-if)# gvrp enable

garp timer
The garp timer Interface Configuration (Ethernet, Port channel) mode command adjusts the values of the join, leave and leaveall timers of GARP applications. Use the no form of this command to return to the default configuration.

Syntax
garp timer {join | leave | leaveall} timer_value no garp timer

Parameters {join | leave | leaveall} Indicates the type of timer. timer_value Timer values in milliseconds in multiples of 10. (Range: 10-2147483647) Default Configuration
Following are the default timer values:

Join timer 200 milliseconds Leave timer 600 milliseconds Leavall timer 10000 milliseconds

Command Mode
Interface configuration (Ethernet, port-channel) mode

User Guidelines
The following relationship must be maintained between the timers: Leave time must be greater than or equal to three times the join time. Leave-all time must be greater than the leave time. Set the same GARP timer values on all Layer 2-connected devices. If the GARP timers are set differently on Layer 2-connected devices, the GARP application will not operate successfully.

Page 104 Not approved by Document Control. For review only.

GVRP Commands

Example
The following example sets the leave timer for Ethernet port 1/e6 to 900 milliseconds. Console(config)# interface ethernet 1/e6 Console(config-if)# garp timer leave 900

gvrp vlan-creation-forbid
The gvrp vlan-creation-forbid Interface Configuration (Ethernet, port-channel) mode command disables dynamic VLAN creation or modification. Use the no form of this command to enable dynamic VLAN creation or modification.

Syntax
gvrp vlan-creation-forbid no gvrp vlan-creation-forbid

Default Configuration
Dynamic VLAN creation or modification is enabled.

Command Mode
Interface Configuration (Ethernet, port-channel) mode

User Guidelines
This command forbids dynamic VLAN creation from the interface. The creation or modification of dynamic VLAN registration entries as a result of the GVRP exchanges on an interface are restricted only to those VLANs for which static VLAN registration exists.

Example
The following example disables dynamic VLAN creation on Ethernet port 1/e6. Console(config)# interface ethernet 1/e6 Console(config-if)# gvrp vlan-creation-forbid

gvrp registration-forbid
The gvrp registration-forbid Interface Configuration (Ethernet, port-channel) mode command deregisters all dynamic VLANs on a port and prevents VLAN creation or registration on the port. Use the no form of this command to allow dynamic registration of VLANs on a port.

Syntax
gvrp registration-forbid no gvrp registration-forbid

Default Configuration
Dynamic registration of VLANs on the port is allowed.

Page 105

Allied Telesis
Command Line Interface Users Guide

Command Mode
Interface Configuration (Ethernet, port-channel) mode

User Guidelines
There are no user guidelines for this command.

Example
The following example forbids dynamic registration of VLANs on Ethernet port 1/e6. Console(config)# interface ethernet 1/e6 Console(config-if)# gvrp registration-forbid

clear gvrp statistics


The clear gvrp statistics Privileged EXEC mode command clears all GVRP statistical information.

Syntax
clear gvrp statistics [ethernet interface | port-channel port-channel-number]

Parameters interface A valid Ethernet port. (Full syntax: unit/port) port-channel-number A valid port-channel number. Default Configuration
This command has no default configuration.

Command Mode
Privileged EXEC mode

User Guidelines
There are no user guidelines for this command.

Example
The following example clears all GVRP statistical information on Ethernet port 1/e6. Console# clear gvrp statistics ethernet 1/e6

show gvrp configuration


The show gvrp configuration User EXEC mode command displays GVRP configuration information, including timer values, whether GVRP and dynamic VLAN creation is enabled, and which ports are running GVRP.

Syntax
show gvrp configuration [ethernet interface | port-channel port-channel-number]

Page 106 Not approved by Document Control. For review only.

GVRP Commands

Parameters interface A valid Ethernet port. (Full syntax: unit/port) port-channel-number A valid port-channel number. Default Configuration
This command has no default configuration.

Command Mode
User EXEC mode

User Guidelines
There are no user guidelines for this command.

Example
The following example displays GVRP configuration information: Console> show gvrp configuration GVRP Feature is currently enabled on the device. Maximum VLANs: 255 Timers (milliseconds) Port(s) -----1/e1 1/e2 1/e3 1/e4 1/e5 1/e6 1/e7 1/e8 1/e9 Console> Status ------Disabled Disabled Disabled Disabled Disabled Disabled Disabled Disabled Disabled Registration -----------Normal Normal Normal Normal Normal Normal Normal Normal Normal Dynamic VLAN Creation ----------Enabled Enabled Enabled Enabled Enabled Enabled Enabled Enabled Enabled Join ---200 200 200 200 200 200 200 200 200 Leave ----600 600 600 600 600 600 600 600 600 Leave All --------10000 10000 10000 10000 10000 10000 10000 10000 10000

show gvrp statistics


The show gvrp statistics User EXEC mode command displays GVRP statistics.

Syntax
show gvrp statistics [ethernet interface | port-channel port-channel-number]

Page 107

Allied Telesis
Command Line Interface Users Guide

Parameters interface A valid Ethernet port. (Full syntax: unit/port) port-channel-number A valid port-channel number. Default Configuration
This command has no default configuration.

Command Mode
User EXEC mode

User Guidelines
There are no user guidelines for this command.

Example
The following example shows GVRP statistical information: Console> show gvrp statistics GVRP Statistics: Legend: rJE rLE sJE sLE Port : : : : rJE Join Empty Received Empty Received Leave Empty Received Join Empty Sent Empty Sent Leave Empty Sent rJIn rEmp rLIn rLE rLA rJIn: rLIn: rLA : sJIn: sLIn: sLA : sJE sJIn Join In Received Leave In Received Leave All Received Join In Sent Leave In Sent Leave All Sent sEmp sLIn sLE sLA rEmp :

sEmp :

show gvrp error-statistics


The show gvrp error-statistics User EXEC mode command displays GVRP error statistics.

Syntax
show gvrp error-statistics [ethernet interface | port-channel port-channel-number]

Parameters interface A valid Ethernet port. (Full syntax: unit/port) port-channel-number A valid port-channel number. Default Configuration
This command has no default configuration.

Page 108 Not approved by Document Control. For review only.

GVRP Commands

Command Mode
User EXEC mode

User Guidelines
There are no user guidelines for this command.

Example
The following example displays GVRP statistical information. Console> show gvrp error-statistics GVRP Error Statistics: Legend: INVPROT : INVATYP : INVAVAL: Invalid Protocol Id Invalid Attribute Type Invalid Attribute Value INVALEN : INVEVENT: Invalid Attribute Length Invalid Event

Port INVPROT INVATYP INVAVAL INVALEN INVEVENT

Page 109

Allied Telesis
Command Line Interface Users Guide

Chapter 11.IGMP Snooping Commands

Note In order to enable IGMP snooping, the user must enable bridge Multicast filtering

ip igmp snooping (Global)


The ip igmp snooping Global Configuration mode command enables Internet Group Management Protocol (IGMP) snooping. Use the no form of this command to disable IGMP snooping.

Syntax
ip igmp snooping no ip igmp snooping

Default Configuration
IGMP snooping is disabled.

Command Mode
Global Configuration mode

User Guidelines
IGMP snooping can only be enabled on static VLANs.

Example
The following example enables IGMP snooping. Console(config)# ip igmp snooping

ip igmp snooping (Interface)


The ip igmp snooping Interface Configuration (VLAN) mode command enables Internet Group Management Protocol (IGMP) snooping on a specific VLAN. Use the no form of this command to disable IGMP snooping on a VLAN interface.

Syntax
ip igmp snooping no ip igmp snooping

Default Configuration
IGMP snooping is disabled .

Page 110 Not approved by Document Control. For review only.

IGMP Snooping Commands

Command Mode
Interface Configuration (VLAN) mode

User Guidelines
IGMP snooping can only be enabled on static VLANs.

Example
The following example enables IGMP snooping on VLAN 2. Console(config)# interface vlan 2 Console(config-if)# ip igmp snooping

ip igmp snooping mrouter learn-pim-dvmrp


The ip igmp snooping mrouter learn-pim-dvmrp Interface Configuration (VLAN) mode command enables automatic learning of Multicast device ports in the context of a specific VLAN. Use the no form of this command to remove automatic learning of Multicast device ports.

Syntax
ip igmp snooping mrouter learn-pim-dvmrp no ip igmp snooping mrouter learn-pim-dvmrp

Default Configuration
Automatic learning of Multicast device ports is enabled.

Command Mode
Interface Configuration (VLAN) mode

User Guidelines
Multicast device ports can be configured statically using the bridge multicast forward-all Interface Configuration (VLAN) mode command.

Example
The following example enables automatic learning of Multicast device ports on VLAN 2. Console(config) # interface vlan 2 Console(config-if)# ip igmp snooping mrouter learn-pim-dvmrp

Page 111

Allied Telesis
Command Line Interface Users Guide

ip igmp snooping host-time-out


The ip igmp snooping host-time-out Interface Configuration (VLAN) mode command configures the host-timeout. If an IGMP report for a Multicast group was not received for a host-time-out period from a specific port, this port is deleted from the member list of that Multicast group. Use the no form of this command to return to the default configuration.

Syntax
ip igmp snooping host-time-out time-out no ip igmp snooping host-time-out

Parameters time-out Host timeout in seconds. (Range: 60 2147483647) Default Configuration


The default host-time-out is 260 seconds.

Command Mode
Interface Configuration (VLAN) mode

User Guidelines
The timeout should be at least greater than 2*query_interval+max_response_time of the IGMP router.

Example
The following example configures the host timeout to 300 seconds. Console(config)# interface vlan 2 Console(config-if)# ip igmp snooping host-time-out 300

ip igmp snooping querier enable


The ip igmp snooping querier enable Interface Configuration mode command enables Internet Group Management Protocol (IGMP) querier on a specific VLAN. Use the no form of this command to disable IGMP querier on a VLAN interface.

Syntax
ip igmp snooping querier enable no ip igmp snooping querier enable

Parameters
This command has no arguments or keywords

Default Configuration
Disabled.

Page 112 Not approved by Document Control. For review only.

IGMP Snooping Commands

Command Mode
Interface Configuration (VLAN) mode

User Guidelines
IGMP snooping querier can be enabled on a VLAN only if IGMP snooping is enabled for that VLAN. No more then one switch can be configured as an IGMP Querier for a VLAN. When IGMP Snooping Querier is enabled, it starts after host-time-out/2 with no IGMP traffic detected from a Multicast router. The IGMP Snooping Querier disables itself if it detects IGMP traffic from a Multicast router. It restarts itself after host-time-out/2. Following are the IGMP Snooping Querier parameters as function of the IGMP Snooping parameters:

QueryMaxResponseTime: host-time-out/15 QueryInterval: host-time-out/ 3

Example
.The following example configures Internet Group Management Protocol (IGMP) querier on a specific VLAN. Console(config)# interface vlan 2 Console(config-if)# ip igmp snooping querier enable

ip igmp snooping querier address


The ip igmp snooping querier address Interface Configuration mode command defines the source IP address that the IGMP Snooping querier uses. Use the no form of this command to return to default.

Syntax
ip igmp snooping querier address ip-address no ip igmp snooping querier address

Parameters
This command has no arguments or keywords.

Default Configuration
If an IP address is configured for the VLAN, it is used as the source address of the IGMP snooping querier.

Command Mode
Interface Configuration (VLAN) mode

User Guidelines
If an IP address is not configured by this command, and no IP address is configured for the IGMP querier VLAN interface, the querier is disabled.

Page 113

Allied Telesis
Command Line Interface Users Guide

Example
.The following example configures the source IP address that the IGMP Snooping querier uses. Console(config)# interface vlan 2 Console(config-if)# ip igmp snooping querier address 192.168.1.220

ip igmp snooping querier version


The ip igmp snooping querier version Interface Configuration mode command configures the IGMP version of an IGMP querier on a specific VLAN. Use the no form of this command to return to default.

Syntax
ip igmp snooping querier version {2 | 3} no ip igmp snooping querier version

Parameters 2 Specifies that the IGMP version is IGMPv2. 3 Specifies that the IGMP version is IGMPv3. Default Configuration
IGMPv3

Command Mode
Interface Configuration (VLAN) mode

User Guidelines
If the IGMP querier is configured to IGMPv3, the querier trys to work in IGMPv3. In case the hosts do not support IGMPv3, the querier version is downgraded. If the IGMP querier is configured to IGMPv2, the querier trys to work in IGMPv2. It can be downgraded automatically to IGMPv1, but never upgraded automatically to IGMPv3.

Example
.The following example configures the IGMP version of an IGMP querier on a specific VLAN. Console(config)# interface vlan 2 Console(config-if)# ip igmp snooping querier version 2

ip igmp snooping mrouter-time-out


The ip igmp snooping mrouter-time-out Interface Configuration (VLAN) mode command configures the mrouter-time-out. The ip igmp snooping mrouter-time-out Interface Configuration (VLAN) mode command is used for setting the aging-out time after Multicast device ports are automatically learned. Use the no form of this command to return to the default configuration.

Syntax
ip igmp snooping mrouter-time-out time-out

Page 114 Not approved by Document Control. For review only.

IGMP Snooping Commands

no ip igmp snooping mrouter-time-out

Parameters time-out Multicast device timeout in seconds (Range: 1 - 2147483647) Default Configuration
The default value is 300 seconds.

Command Mode
Interface Configuration (VLAN) mode

User Guidelines
There are no user guidelines for this command.

Example
The following example configures the Multicast device timeout to 200 seconds. Console(config)# interface vlan 2 Console(config-if)# ip igmp snooping mrouter-time-out 200

ip igmp snooping leave-time-out


The ip igmp snooping leave-time-out Interface Configuration (VLAN) mode command configures the leavetime-out. If an IGMP report for a Multicast group was not received for a leave-time-out period after an IGMP Leave was received from a specific port, this port is deleted from the member list of that Multicast group. Use the no form of this command to return to the default configuration.

Syntax
ip igmp snooping leave-time-out {time-out | immediate-leave} no ip igmp snooping leave-time-out

Parameters time-out Specifies the leave-time-out in seconds for IGMP queries. (Range: 0-2147483647) immediate-leave Indicates that the port should be immediately removed from the members list after
receiving IGMP Leave.

Default Configuration
The default leave-time-out configuration is 10 seconds.

Command Mode
Interface Configuration (VLAN) mode

User Guidelines
The leave timeout should be set greater than the maximum time that a host is allowed to respond to an IGMP query.

Page 115

Allied Telesis
Command Line Interface Users Guide

Use immediate leave only where there is just one host connected to a port.

Example
The following example configures the host leave-time-out to 60 seconds. Console(config)# interface vlan 2 Console(config-if)# ip igmp snooping leave-time-out 60

show ip igmp snooping mrouter


The show ip igmp snooping mrouter User EXEC mode command displays information on dynamically learned Multicast device interfaces.

Syntax
show ip igmp snooping mrouter [interface vlan-id]

Parameters vlan-id VLAN number. Default Configuration


This command has no default configuration.

Command Mode
User EXEC mode

User Guidelines
There are no user guidelines for this command.

Example
The following example displays Multicast device interfaces in VLAN 1000. Console> show ip igmp snooping mrouter interface 1000 VLAN ---1000 Ports ----1/e1

Detected Multicast devices that are forbidden statically: VLAN ---1000 Ports ----1/e19

Page 116 Not approved by Document Control. For review only.

IGMP Snooping Commands

show ip igmp snooping interface


The show ip igmp snooping interface EXEC mode command shows IGMP snooping configuration.

Syntax
show ip igmp snooping interface vlan-id

Parameters vlan-id VLAN number. Default Configuration


This command has no default configuration.

Command Mode
User EXEC mode

User Guidelines
There are no user guidelines for this command.

Example

Console # show ip igmp snooping interface 1000 IGMP Snooping is globally enabled IGMP Snooping admin: Enabled Hosts and routers IGMP version: 2 IGMP snooping oper mode: Enabled IGMP snooping querier admin: Enabled IGMP snooping querier oper: Enabled IGMP snooping querier address admin: IGMP snooping querier address oper: 172.16.1.1 IGMP snooping querier version admin: 3 IGMP snooping querier version oper: 2

IGMP host timeout is 300 sec IGMP Immediate leave is disabled. IGMP leave timeout is 10 sec IGMP mrouter timeout is 300 sec Automatic learning of multicast router ports is enable

Page 117

Allied Telesis
Command Line Interface Users Guide

show ip igmp snooping groups


The show ip igmp snooping groups command displays the Multicast groups that was learned by the IGMP snooping

Syntax
show ip igmp snooping groups [vlan vlan-id] [ip-multicast-address ip-multicast-address] [ip-address ipaddress]

Parameters vlan-id VLAN ID value ip-multicast-address A valid IP Multicast address ip-address Source IP address Default Configuration
This command has no default configuration.

Command Mode
EXEC mode

User Guidelines
To see the actual Multicast Address Table use the show bridge multicast address-table command

Example
The following example shows IGMP snooping information on Multicast groups. Vlan 1 1 19 19 19 Group Address 231.2.2.3 231.2.2.3 231.2.2.8 231.2.2.8 231.2.2.8 Source address 172.16.1.1 172.16.1.2 172.16.1.1 172.16.1.2 172.16.1.3 Include Ports 1/e1 2/e2 1/e9 1/e10-e11 1/e12 1/e12 Exclude ports

IGMP Reporters that are forbidden statically:

Vlan 1 19

Group Address 231.2.2.3 231.2.2.8

Source address 172.16.1.1 172.16.1.1

Ports 2/e8 2/e8

Page 118 Not approved by Document Control. For review only.

IP Addressing Commands

Chapter 12.IP Addressing Commands


ip address
The ip address Interface Configuration (Ethernet, VLAN, port-channel) mode command sets an IP address. Use the no form of this command to remove an IP address.

Syntax
ip address ip-address {mask | prefix-length} no ip address [ip-address]

Parameters ip-address Valid IP address mask Valid network mask of the IP address. prefix-length Specifies the number of bits that comprise the IP address prefix. The prefix length must be
preceded by a forward slash (/). (Range: 8 -30)

Default Configuration
No IP address is defined for interfaces.

Command Mode
Interface Configuration (VLAN) mode

User Guidelines
A single IP address can be defined. The IP address can be defined only on the Management VLAN.

Example
The following example configures VLAN 1 with IP address 131.108.1.27 and subnet mask 255.255.255.0. Console(config)# interface vlan 1 Console(config-if)# ip address 131.108.1.27 255.255.255.0

ip address dhcp
The ip address dhcp Interface Configuration (Ethernet, VLAN, port-channel) mode command acquires an IP address for an Ethernet interface from the Dynamic Host Configuration Protocol (DHCP) server. Use the no form of this command to deconfigure an acquired IP address.

Syntax
ip address dhcp [hostname host-name] no ip address dhcp

Page 119

Allied Telesis
Command Line Interface Users Guide

Parameters host-name Specifies the name of the host to be placed in the DHCP option 12 field. This name does not
have to be the same as the host name specified in the hostname Global Configuration mode command. (Range: 1-20 characters)

Default Configuration
This command has no default configuration.

Command Mode
Interface Configuration (VLAN) mode

User Guidelines
The ip address dhcp command allows any interface to dynamically learn its IP address by using the DHCP protocol. Some DHCP servers require that the DHCPDISCOVER message have a specific host name. The ip address dhcp hostname host-name command is most typically used when the host name is provided by the system administrator. If the device is configured to obtain its IP address from a DHCP server, it sends a DHCPDISCOVER message to provide information about itself to the DHCP server on the network. If the ip address dhcp command is used with or without the optional keyword, the DHCP option 12 field (host name option) is included in the DISCOVER message. By default, the specified DHCP host name is the globally configured host name of the device. However, the ip address dhcp hostname host-name command can be used to place a different host name in the DHCP option 12 field. The no ip address dhcp command deconfigures any IP address that was acquired, thus sending a DHCPRELEASE message. The IP address is defined only on the management VLAN.

Example
The following example acquires an IP address for VLAN 1 from DHCP. Console(config)# interface vlan 1 Console(config-if)# ip address dhcp

ip default-gateway
The ip default-gateway Global Configuration mode command defines a default gateway ( device). Use the no form of this command to return to the default configuration.

Syntax
ip default-gateway ip-address no ip default-gateway

Parameters ip-address Valid IP address of the default gateway.

Page 120 Not approved by Document Control. For review only.

IP Addressing Commands

Default Configuration
No default gateway is defined.

Command Mode
Global Configuration mode

User Guidelines
There are no user guidelines for this command.

Example
The following example defines default gateway 192.168.1.1. Console(config)# ip default-gateway 192.168.1.1

show ip interface
The show ip interface Privileged EXEC mode command displays the usability status of configured IP interfaces.

Syntax
show ip interface [ethernet interface-number | vlan vlan-id | port-channel port-channel number ]

Parameters interface-number Valid Ethernet port. vlan-id Valid VLAN number. port-channel number Valid Port-channel number. Default Configuration
This command has no default configuration.

Command Mode
Privileged EXEC mode

User Guidelines
There are no user guidelines for this command.

Example
The following example the displays the configured IP interfaces and their types. Console# show ip interface Gateway IP Address -----------------192.168.1.1 Activity status -----Active Type --------------Static

Page 121

Allied Telesis
Command Line Interface Users Guide

IP Address ------------192.168.1.200/24 console#

I/F --------VLAN 1

Type ------Static

arp
The arp Global Configuration mode command adds a permanent entry in the Address Resolution Protocol (ARP) cache. Use the no form of this command to remove an entry from the ARP cache.

Syntax
arp ip_addr hw_addr {ethernet interface-number | vlan vlan-id | port-channel port-channel number | out-ofband-eth oob-interface } no arp ip_addr {ethernet interface-number | vlan vlan-id | port-channel port-channel number | out-of-band-eth oob-interface }

Parameters ip_addr Valid IP address or IP alias to map to the specified MAC address. hw_addr Valid MAC address to map to the specified IP address or IP alias. ethernet interface-number Valid Ethernet port. vlan vlan-id Valid VLAN number. port-channel number. Valid port-channel number. Default Configuration
This command has no default configuration.

Command Mode
Global Configuration mode

User Guidelines
The software uses ARP cache entries to translate 32-bit IP addresses into 48-bit hardware addresses. Because most hosts support dynamic resolution, static ARP cache entries do not generally have to be specified.

Example
The following example adds IP address 198.133.219.232 and MAC address 00:00:0c:40:0f:bc to the ARP table.

console(config)# arp 198.133.219.232 00:00:0c:40:0f:bc ethernet 1/e6

arp timeout
The arp timeout Global Configuration mode command configures how long an entry remains in the ARP cache. Use the no form of this command to restore the default configuration.

Page 122 Not approved by Document Control. For review only.

IP Addressing Commands

Syntax
arp timeout seconds no arp timeout

Parameters seconds Time (in seconds) that an entry remains in the ARP cache. (Range: 1-40000000) Default Configuration
The default timeout is 60000 seconds.

Command Mode
Global Configuration mode

User Guidelines
It is recommended not to set the timeout value to less than 3600.

Example
The following example configures the ARP timeout to 12000 seconds. Console(config)# arp timeout 12000

clear arp-cache
The clear arp-cache Privileged EXEC mode command deletes all dynamic entries from the ARP cache.

Syntax
clear arp-cache

Default Configuration
This command has no default configuration.

Command Mode
Privileged EXEC mode

User Guidelines
There are no user guidelines for this command.

Example
The following example deletes all dynamic entries from the ARP cache. Console# clear arp-cache

Page 123

Allied Telesis
Command Line Interface Users Guide

show arp
The show arp Privileged EXEC mode command displays entries in the ARP table.

Syntax
show arp [ip-address ip-address] [mac-address mac-address] [ethernet interface | port-channel port-channelnumber]

Parameters ip-address Displays the ARP entry of a specific IP address. mac-address Displays the ARP entry of a specific MAC address. interface Displays the ARP entry of a specific Ethernet port interface. port-channel-number Displays the ARP entry of a specific Port-channel number interface. Default Configuration
This command has no default configuration.

Command Mode
Privileged EXEC mode

User Guidelines
Since the associated interface of a MAC address can be aged out from the FDB table, the Interface field can be empty. When an ARP entry is associated with an IP interface that is defined on a port or port-channel, the VLAN field is empty.

Example
The following example displays entries in the ARP table. Console# show arp ARP timeout: 80000 Seconds VLAN ------------VLAN 1 VLAN 1 Interface ------------1/e1 2/e2 IP Address ------------10.7.1.102 10.7.1.135 HW Address ------------Status -------------

00:10:B5:04:DB:4B Dynamic 00:50:22:00:2A:A4 Static

ip domain-lookup
The ip domain-lookup Global Configuration mode command enables the IP Domain Naming System (DNS)based host name-to-address translation. Use the no form of this command to disable DNS-based host name-toaddress translation.

Page 124 Not approved by Document Control. For review only.

IP Addressing Commands

Syntax
ip domain-lookup no ip domain-lookup

Default Configuration
The default configuration is set to enabled.

Command Mode
Global Configuration mode

User Guidelines
There are no user guidelines for this command.

Example
The following example enables IP Domain Naming System (DNS)-based host name-to-address translation. Console(config)# ip domain-lookup

ip domain-name
The ip domain-name Global Configuration mode command defines a default domain name used by the software to complete unqualified host names (names without a dotted-decimal domain name). Use the no form of this command to remove the default domain name.

Syntax
ip domain-name name no ip domain-name

Parameters name Specifies the default domain name used to complete unqualified host names. Do not include the
initial period that separates an unqualified name from the domain name. (Range: 1-158 characters)

Default Configuration
A default domain name is not defined.

Command Mode
Global Configuration mode

User Guidelines
There are no user guidelines for this command.

Example
The following example defines default domain name www.website.com. Console(config)# ip domain-name www.website.com

Page 125

Allied Telesis
Command Line Interface Users Guide

ip name-server
The ip name-server Global Configuration mode command defines the available name servers. Use the no form of this command to remove a name server.

Syntax
ip name-server server-address [server-address2 server-address8] no ip name-server [server-address1 server-address8]

Parameters server-address Specifies IP addresses of the name server. Default Configuration


No name server addresses are specified.

Command Mode
Global Configuration mode

User Guidelines
The preference of the servers is determined by the order in which they were entered. Up to 8 servers can be defined using one command or using multiple commands. To define a radius server on the out-of-band port, use the out-of-band IP address format: oob/ip-address.

Example
The following example sets the available name server. Console(config)# ip name-server 176.16.1.18

ip domain-name
The ip domain-name Global Configuration mode command defines a default domain name used by the software to complete unqualified host names (names without a dotted-decimal domain name). Use the no form of this command to remove the default domain name,.

Syntax
ip domain-name name no ip domain-name

Parameters name Specifies the default domain name used to complete unqualified host names. Do not include the
initial period that separates an unqualified name from the domain name. (Range: 1-158 characters)

Default Configuration
A default domain name is not defined.

Page 126 Not approved by Document Control. For review only.

IP Addressing Commands

Command Mode
Global Configuration mode

User Guidelines
There are no user guidelines for this command.

Example
The following example defines default domain name www.website.com. Console(config)# ip domain-name www.website.com

ip name-server
The ip name-server Global Configuration mode command defines the available name servers. Use the no form of this command to remove a name server.

Syntax
ip name-server server-address [server-address2 server-address8] no ip name-server [server-address1 server-address8]

Parameters server-address Specifies IP addresses of the name server. Default Configuration


No name server addresses are specified.

Command Mode
Global Configuration mode

User Guidelines
The preference of the servers is determined by the order in which they were entered. Up to 8 servers can be defined using one command or using multiple commands. To define a radius server on the out-of-band port, use the out-of-band IP address format: oob/ip-address.

Example
The following example sets the available name server. Console(config)# ip name-server 176.16.1.18

ip host
The ip host Global Configuration mode command defines static host name-to-address mapping in the host cache. Use the no form of this command to remove the name-to-address mapping.

Page 127

Allied Telesis
Command Line Interface Users Guide

Syntax
ip host name address no ip host name

Parameters name Specifies the name of the host. (Range: 1-158 characters) address Specifies the associated IP address. Default Configuration
No host is defined.

Command Mode
Interface Configuration (VLAN) mode

User Guidelines
To define an out-of-band address, use the out-of-band IP address format: oob/ip-address.

Example
The following example defines a static host name-to-address mapping in the host cache. Console(config)# ip host accounting.website.com 176.10.23.1

clear host
The clear host Privileged EXEC mode command deletes entries from the host name-to-address cache.

Syntax
clear host {name | *}

Parameters name Specifies the host entry to be removed. (Range: 1-158 characters) * Removes all entries. Default Configuration
This command has no default configuration.

Command Mode
Privileged EXEC mode

User Guidelines
There are no user guidelines for this command.

Page 128 Not approved by Document Control. For review only.

IP Addressing Commands

Example
The following example deletes all entries from the host name-to-address cache. Console# clear host *

clear host dhcp


The clear host dhcp Privileged EXEC mode command deletes entries from the host name-to-address mapping received from Dynamic Host Configuration Protocol (DHCP).

Syntax
clear host dhcp {name | *}

Parameters name Specifies the host entry to be removed. (Range: 1-158 characters) * Removes all entries. Default Configuration
This command has no default configuration.

Command Mode
Privileged EXEC mode

User Guidelines
This command deletes the host name-to-address mapping temporarily until the next renew of the IP address.

Example
The following example deletes all entries from the host name-to-address mapping. Console# clear host dhcp *

show hosts
The show hosts Privileged EXEC mode command displays the default domain name, a list of name server hosts, the static and the cached list of host names and addresses.

Syntax
show hosts [name]

Parameters name Specifies the host name. (Range: 1-158 characters) Default Configuration
This command has no default configuration.

Page 129

Allied Telesis
Command Line Interface Users Guide

Command Mode
Privileged EXEC mode

User Guidelines
There are no user guidelines for this command.

Example
The following example displays host information. Console# show hosts System name: Device Default domain is gm.com, sales.gm.com, usa.sales.gm.com(DHCP) Name/address lookup is enabled Name servers (Preference order): 176.16.1.18 176.16.1.19

Configured host name-to-address mapping: Host ---accounting.gm.com Addresses --------176.16.8.8 176.16.8.9 (DHCP)

Cache: Host ---www.stanford.edu

TTL(Hours) Total ----72 Elapsed ------3 Type -----IP Addresses --------171.64.14.203

Page 130 Not approved by Document Control. For review only.

Line Commands

Chapter 13.Line Commands


line
The line Global Configuration mode command identifies a specific line for configuration and enters the Line Configuration command mode.

Syntax
line {console | telnet | ssh}

Parameters console Console terminal line. telnet Virtual terminal for remote console access (Telnet). ssh Virtual terminal for secured remote console access (SSH). Default Configuration
This command has no default configuration.

Command Mode
Global Configuration mode

User Guidelines
There are no user guidelines for this command.

Example
The following example configures the device as a virtual terminal for remote console access. Console(config)# line telnet Console(config-line)#

speed
The speed Line Configuration mode command sets the line baud rate. Use the no form of this command to return to the default configuration.

Syntax
speed bps no speed

Parameters bpsBaud rate in bits per second (bps). Possible values are 2400, 9600, 19200, 38400, 57600 and 115200.

Page 131

Allied Telesis
Command Line Interface Users Guide

Default Configuration
The default speed is 9600 bps.

Command Mode
Line Configuration (console) mode

User Guidelines
This command is available only on the line console. The configured speed is applied when Autobaud is disabled. This configuration applies only to the current session.

Example
The following example configures the line baud rate to 115200. Console(config)# line console Console(config-line)# speed 115200

autobaud
The autobaud Line Configuration mode command sets the line for automatic baud rate detection (autobaud). Use the no form of this command to disable automatic baud rate detection.

Syntax
autobaud no autobaud

Default Configuration
Autobaud is disabled.

Command Mode
Line Configuration (console) mode

User Guidelines
This command is available only on the line console. To start communication using Autobaud , press <Enter> twice. This configuration applies only to the current session.

Example
The following example enables autobaud. Console(config)# line console Console(config-line)# autobaud

Page 132 Not approved by Document Control. For review only.

Line Commands

exec-timeout
The exec-timeout Line Configuration mode command sets the interval that the system waits until user input is detected. Use the no form of this command to return to the default configuration.

Syntax
exec-timeout minutes [seconds] no exec-timeout

Parameters minutes Specifies the number of minutes. (Range: 0 - 65535) seconds Specifies additional time intervals in seconds. (Range: 0 - 59) Default Configuration
The default configuration is 10 minutes.

Command Mode
Line Configuration mode

User Guidelines
To specify no timeout, enter the exec-timeout 0 command.

Example
The following example configures the interval that the system waits until user input is detected to 20 minutes. Console(config)# line console Console(config-line)# exec-timeout 20

history
The history Line Configuration mode command enables the command history function. Use the no form of this command to disable the command history function.

Syntax
history no history

Default Configuration
The command history function is enabled.

Command Mode
Line Configuration mode

User Guidelines
This command enables the command history function for a specified line. To enable or disable the command history function for the current terminal session, use the terminal history user EXEC mode command.

Page 133

Allied Telesis
Command Line Interface Users Guide

Example
The following example enables the command history function for telnet. Console(config)# line telnet Console(config-line)# history

history size
The history size Line Configuration mode command configures the command history buffer size for a particular line. Use the no form of this command to reset the command history buffer size to the default configuration.

Syntax
history size number-of-commands no history size

Parameters number-of-commandsNumber of commands that the system records in its history buffer. (Range: 10 -206) Default Configuration
The default history buffer size is 10.

Command Mode
Line Configuration mode

User Guidelines
This command configures the command history buffer size for a particular line. To configure the command history buffer size for the current terminal session, use the terminal history size User EXEC mode command.

Example
The following example changes the command history buffer size to 100 entries for a particular line. Console(config-line)# history size 100

terminal history
The terminal history user EXEC command enables the command history function for the current terminal session. Use the no form of this command to disable the command history function.

Syntax
terminal history terminal no history

Default Configuration
The default configuration for all terminal sessions is defined by the history line configuration command.

Page 134 Not approved by Document Control. For review only.

Line Commands

Command Mode
User EXEC mode

User Guidelines
There are no user guidelines for this command.

Example
The following example disables the command history function for the current terminal session. Console# terminal no history

terminal history size


The terminal history size user EXEC command configures the command history buffer size for the current terminal session. Use the no form of this command to reset the command history buffer size to the default setting.

Syntax
terminal history size number-of-commands terminal no history size

Parameters number-of-commandsSpecifies the number of commands the system may record in its command history
buffer. (Range: 10-206)

Default Configuration
The default command history buffer size is 10.

Command Mode
User EXEC mode

User Guidelines
The terminal history size user EXEC command configures the size of the command history buffer for the current terminal session. Use the history line configuration command to change the default size of the command history buffer. The maximum number of commands in all buffers is 256.

Example
The following example configures the command history buffer size to 20 commands for the current terminal session. Console# terminal history size 20

show line
The show line User EXEC mode command displays line parameters.

Page 135

Allied Telesis
Command Line Interface Users Guide

Syntax
show line [console | telnet | ssh]

Parameters console Console terminal line. telnet Virtual terminal for remote console access (Telnet). ssh Virtual terminal for secured remote console access (SSH). Default Configuration
If the line is not specified, the default value is console.

Command Mode
User EXEC mode

User Guidelines
There are no user guidelines for this command.

Example
The following example displays the line configuration. Console> show line Console configuration: Interactive timeout: Disabled History: 10 Baudrate: 9600 Databits: 8 Parity: none Stopbits: 1 Telnet configuration: Interactive timeout: 10 minutes 10 seconds History: 10 SSH configuration: Interactive timeout: 10 minutes 10 seconds History: 10

Page 136 Not approved by Document Control. For review only.

Line Commands

Page 137

Allied Telesis
Command Line Interface Users Guide

Section 14. LACP Commands


lacp system-priority
The lacp system-priority Global Configuration mode command configures the system priority. Use the no form of this command to return to the default configuration.

Syntax
lacp system-priority value no lacp system-priority

Parameters value Specifies system priority value. (Range: 1 - 65535) Default Configuration
The default system priority is 1.

Command Mode
Global Configuration mode

User Guidelines
There are no user guidelines for this command.

Example
The following example configures the system priority to 120. Console(config)# lacp system-priority 120

Page 138

LACP Commands

lacp port-priority
The lacp port-priority Interface Configuration (Ethernet) mode command configures physical port priority. Use the no form of this command to return to the default configuration, use the no form of this command.

Syntax
lacp port-priority value no lacp port-priority

Parameters value Specifies port priority. (Range: 1 - 65535) Default Configuration


The default port priority is 1.

Command Mode
Interface Configuration (Ethernet) mode

User Guidelines
There are no user guidelines for this command.

Example
The following example defines the priority of Ethernet port 1/e6 as 247. Console(config)# interface ethernet 1/e6 Console(config-if)# lacp port-priority 247

Page 139

Allied Telesis
Command Line Interface Users Guide

lacp timeout
The lacp timeout Interface Configuration (Ethernet) mode command assigns an administrative LACP timeout. Use the no form of this command to return to the default configuration.

Syntax
lacp timeout {long | short} no lacp timeout

Parameters long Specifies the long timeout value. short Specifies the short timeout value. Default Configuration
The default port timeout value is long.

Command Mode
Interface Configuration (Ethernet) mode

User Guidelines
There are no user guidelines for this command.

Example
The following example assigns a long administrative LACP timeout to Ethernet port 1/e6 . Console(config)# interface ethernet 1/e6 Console(config-if)# lacp timeout long

Page 140

LACP Commands

show lacp ethernet


The show lacp ethernet Privileged EXEC mode command displays LACP information for Ethernet ports.

Syntax
show lacp ethernet interface [parameters | statistics | protocol-state]

Parameters interface Valid Ethernet port. (Full syntax: unit/port) parameters Link aggregation parameter information. statistics Link aggregation statistics information. protocol-state Link aggregation protocol-state information. Default Configuration
This command has no default configuration.

Command Mode
Privileged EXEC mode

User Guidelines
There are no user guidelines for this command.

Example
The following example display LACP information for Ethernet port 1/e1. Console show lacp ethernet 1/e1 Port 1/e1 LACP parameters: Actor system priority: system mac addr: port Admin key: port Oper key: port Oper number: port Admin priority: port Oper priority: port Admin timeout: port Oper timeout: LACP Activity: Aggregation: synchronization: collecting: 1 00:00:12:34:56:78 30 30 21 1 1 LONG LONG ACTIVE AGGREGATABLE FALSE FALSE

Page 141

Allied Telesis
Command Line Interface Users Guide

distributing: expired: Partner system priority: system mac addr: port Admin key: port Oper key: port Oper number: port Admin priority: port Oper priority: port Oper timeout: LACP Activity: Aggregation: synchronization: collecting: distributing: expired: Port 1/e1 LACP Statistics: LACP PDUs sent: LACP PDUs received: Port 1/e1 LACP Protocol State: LACP State Machines: Receive FSM: Mux FSM: Periodic Tx FSM: Control Variables: BEGIN: LACP_Enabled: Ready_N: Selected: Port_moved: NNT: Port_enabled: Timer counters: periodic tx timer: current while timer: wait while timer:

FALSE FALSE 0 00:00:00:00:00:00 0 0 0 0 0 LONG PASSIVE AGGREGATABLE FALSE FALSE FALSE FALSE

2 2

Port Disabled State Detached State No Periodic State FALSE TRUE FALSE UNSELECTED FALSE FALSE FALSE 0 0 0

Page 142

LACP Commands

show lacp port-channel


The show lacp port-channel Privileged EXEC mode command displays LACP information for a port-channel.

Syntax
show lacp port-channel [port_channel_number]

Parameters port_channel_number Valid port-channel number. Default Configuration


This command has no default configuration.

Command Mode
Privileged EXEC mode

User Guidelines
There are no user guidelines for this command.

Example
The following example displays LACP information about port-channel 1. Console# show lacp port-channel 1 Port-Channel 1: Port Type 1000 Ethernet Actor System Priority: MAC Address: Admin Key: Oper Key: Partner System Priority: MAC Address: Oper Key: 0 00:00:00:00:00:00 14 1 00:02:85:0E:1C:00 29 29

Page 143

Allied Telesis
Command Line Interface Users Guide

Chapter 15.Management ACL Commands


management access-list
The management access-list Global Configuration mode command configures a management Access List and enters the Management Access-list Configuration command mode. Use the no form of this command to delete an Access List.

Syntax
management access-list name no management access-list name

Parameters name Access list name. (Range: 1-32 characters) Default Configuration
This command has no default configuration.

Command Mode
Global Configuration mode

User Guidelines
Use this command to configure a management Access List. The command enters the Access-list Configuration mode, where permit and deny access rules are defined using the permit (Management) and deny (Management) commands. If no match criteria are defined, the default is deny. If you reenter an Access List context, the new rules are entered at the end of the Access List. Use the management access-class command to select the active Access List. The active management list cannot be updated or removed. Management ACL requires a valid management interface, which is a port, VLAN, or port-channel with an IP address or console interface. Management ACL only restricts access to the device for management configuration or viewing.

Example
The following example creates a management Access List called mlist, configures management Ethernet interfaces 1/e1 and 2/e9 and makes the new Access List the active list. Console(config)# management access-list mlist Console(config-macl)# permit ethernet 1/e1 Console(config-macl)# permit ethernet 2/e9 Console(config-macl)# exit Console(config)# management access-class mlist

Page 144 Not approved by Document Control. For review only.

Management ACL Commands

The following example creates a management Access List called mlist, configures all interfaces to be management interfaces except Ethernet interfaces 1/e1 and 2/e9 and makes the new Access List the active list. Console(config)# management access-list mlist Console(config-macl)# deny ethernet 1/e1 Console(config-macl)# deny ethernet 2/e9 Console(config-macl)# permit Console(config-macl)# exit Console(config)# management access-class mlist

permit (Management)
The permit Management Access-List Configuration mode command defines a permit rule.

Syntax
permit [ethernet interface-number | vlan vlan-id | port-channel port-channel-number] [service service] permit ip-source ip-address [mask mask | prefix-length] [ethernet interface-number | vlan vlan-id | port-channel port-channel-number] [service service]

Parameters interface-number A valid Ethernet port number. vlan-id A valid VLAN number. port-channel-number A valid port channel index. ip-address A valid source IP address. mask A valid network mask of the source IP address. prefix-length Number of bits that comprise the source IP address prefix. The prefix length must be
preceded by a forward slash (/). (Range: 0 - 32) service Service type. Possible values: telnet, ssh, http, https and snmp.

Default Configuration
If no permit rule is defined, the default is set to deny.

Command Mode
Management Access-list Configuration mode

User Guidelines
Rules with Ethernet, VLAN and port-channel parameters are valid only if an IP address is defined on the appropriate interface. The system supports up to 128 management access rules.

Example
The following example permits all ports in the mlist Access List. Console(config)# management access-list mlist Console(config-macl)# permit

Page 145

Allied Telesis
Command Line Interface Users Guide

deny (Management)
The deny Management Access-List Configuration mode command defines a deny rule.

Syntax
deny [ethernet interface-number | vlan vlan-id | port-channel port-channel-number] [service service] deny ip-source ip-address [mask mask | prefix-length] [ethernet interface-number | vlan vlan-id | port-channel port-channel-number] [service service]

Parameters interface-number A valid Ethernet port number. vlan-id A valid VLAN number. port-channel-number A valid port-channel number. ip-address A valid source IP address. mask A valid network mask of the source IP address. mask prefix-length Specifies the number of bits that comprise the source IP address prefix. The prefix
length must be preceded by a forward slash (/). (Range: 0-32) service Service type. Possible values: telnet, ssh, http, https and snmp.

Default Configuration
This command has no default configuration.

Command Mode
Management Access-list Configuration mode

User Guidelines
Rules with Ethernet, VLAN and port-channel parameters are valid only if an IP address is defined on the appropriate interface. The system supports up to 128 management access rules.

Example
The following example denies all ports in the Access List called mlist. Console(config)# management access-list mlist Console(config-macl)# deny

management access-class
The management access-class Global Configuration mode command restricts management connections by defining the active management Access List. Use the no form of this command to disable this restriction.

Syntax
management access-class {console-only | name} no management access-class

Page 146 Not approved by Document Control. For review only.

Management ACL Commands

Parameters console-only Indicates that the device can be managed only from the console. name Specifies the name of the Access List to be used. (Range: 1-32 characters) Default Configuration
If no Access List is specified, an empty Access List is used.

Command Mode
Global Configuration mode

User Guidelines
There are no user guidelines for this command.

Example
The following example configures an Access List called mlist as the management Access List. Console(config)# management access-class mlist

show management access-list


The show management access-list Privileged EXEC mode command displays management access-lists.

Syntax
show management access-list [name]

Parameters name Specifies the name of a management Access List. (Range: 1 - 32 characters) Default Configuration
This command has no default configuration.

Command Mode
Privileged EXEC mode

User Guidelines
There are no user guidelines for this command.

Example
The following example displays the mlist management Access List. Console# show management access-list mlist mlist ----permit ethernet 1/e1

Page 147

Allied Telesis
Command Line Interface Users Guide

permit ethernet 2/e2 ! (Note: all other access implicitly denied)

show management access-class


The show management access-class Privileged EXEC mode command displays the active management Access List.

Syntax
show management access-class

Default Configuration
This command has no default configuration.

Command Mode
Privileged EXEC mode

User Guidelines
There are no user guidelines for this command.

Example
The following example displays information about the active management Access List. Console# show management access-class Management access-class is enabled, using access list mlist

Page 148 Not approved by Document Control. For review only.

PHY Diagnostics Commands

Chapter 16.PHY Diagnostics Commands


test copper-port tdr
The test copper-port tdr Privileged EXEC mode command uses Time Domain Reflectometry (TDR) technology to diagnose the quality and characteristics of a copper cable attached to a port.

Syntax
test copper-port tdr interface

Parameters interface A valid Ethernet port. (Full syntax: unit/port) Default Configuration
This command has no default configuration.

Command Mode
Privileged EXEC mode

User Guidelines
The port to be tested should be shut down during the test, unless it is a combination port with fiber port active. The maximum length of the cable for the TDR test is 120 meter.

Example
The following example results in a report on the cable attached to port 1/e3. Console# test copper-port tdr 1/e3 Cable is open at 64 meters Console# test copper-port tdr 2/e3 Cant perform this test on fiber ports

show copper-ports tdr


The show copper-ports tdr User EXEC mode command displays information on the last Time Domain Reflectometry (TDR) test performed on copper ports.

Syntax
show copper-ports tdr [interface]

Parameters interface A valid Ethernet port. (Full syntax: unit/port)

Page 149

Allied Telesis
Command Line Interface Users Guide

Default Configuration
This command has no default configuration.

Command Mode
User EXEC mode

User Guidelines
The maximum length of the cable for the TDR test is 120 meter.

Example
The following example displays information on the last TDR test performed on all copper ports. Console show copper-ports tdr Port ---1/e1 1/e2 1/e3 1/e4 1/e5 Result -----OK Short Open Fiber 50 64 13:32:00 23 July2005 13:32:00 23 July 2005 Test has not been performed Length [meters] --------------Date ----

show copper-ports cable-length


The show copper-ports cable-length User EXEC mode command displays the estimated copper cable length attached to a port.

Syntax
show copper-ports cable-length [interface]

Parameters interface A valid Ethernet port. (Full syntax: unit/port) Default Configuration
This command has no default configuration.

Command Mode
User EXEC mode

User Guidelines
The port must be active and working in 100M or 1000M mode.

Page 150 Not approved by Document Control. For review only.

PHY Diagnostics Commands

Example
The following example displays the estimated copper cable length attached to all ports. Console show copper-ports cable-length Port ---1/e1 1/e2 1/e3 1/g1 Length [meters] --------------------< 50 Copper not active 110-140 Fiber

Page 151

Allied Telesis
Command Line Interface Users Guide

Chapter 17.Port Channel Commands


interface port-channel
The interface port-channel Global Configuration mode command enters the interface configuration mode to configure a specific port-channel.

Syntax
interface port-channel port-channel-number

Parameters port-channel-number A valid port-channel number. Default Configuration


This command has no default configuration.

Command Mode
Global Configuration mode

User Guidelines
Eight aggregated links can be defined with up to eight member ports per port-channel. The aggregated links valid IDs are 1-8.

Example
The following example enters the context of port-channel number 1. Console(config)# interface port-channel 1

interface range port-channel


The interface range port-channel Global Configuration mode command enters the interface configuration mode to configure multiple port-channels.

Syntax
interface range port-channel {port-channel-range | all}

Parameters port-channel-range List of valid port-channels to add. Separate nonconsecutive port-channels with a
comma and no spaces. A hyphen designates a range of port-channels. all All valid port-channels.

Default Configuration
This command has no default configuration.

Page 152 Not approved by Document Control. For review only.

Port Channel Commands

Command Mode
Global Configuration mode

User Guidelines
Commands under the interface range context are executed independently on each interface in the range.

Example
The following example groups port-channels 1, 2 and 6 to receive the same command. Console(config)# interface range port-channel 1-2,6

channel-group
The channel-group Interface Configuration (Ethernet) mode command associates a port with a port-channel. Use the no form of this command to remove a port from a port-channel.

Syntax
channel-group port-channel-number no channel-group

Parameters port-channel-number Specifies the number of the valid port-channel for the current port to join. Default Configuration
The port is not assigned to a port-channel.

Command Mode
Interface Configuration (Ethernet) mode

User Guidelines
There are no user guidelines for this command.

Example
The following example forces port 1/e1 to join port-channel 1. Console(config)# interface ethernet 1/e1 Console(config-if)# channel-group 1 mode on

show interfaces port-channel


The show interfaces port-channel Privileged EXEC mode command displays port-channel information.

Syntax
show interfaces port-channel [port-channel-number]

Page 153

Allied Telesis
Command Line Interface Users Guide

Parameters port-channel-number Valid port-channel number. Default Configuration


This command has no default configuration.

Command Mode
Privileged EXEC mode

User Guidelines
There are no user guidelines for this command.

Example
The following example displays information on all port-channels. Console# show interfaces port-channel Channel ------1 2 3 Ports --------------------------------Active: 1/e1, 2/e2 Active: 2/e2, 2/e7 Inactive: 3/e1 Active: 3/e3, 3/e8

Page 154 Not approved by Document Control. For review only.

Port Monitor Commands

Chapter 18.Port Monitor Commands


port monitor
The port monitor Interface Configuration mode command starts a port monitoring session. Use the no form of this command to stop a port monitoring session.

Syntax
port monitor src-interface [rx | tx] no port monitor src-interface

Parameters src-interfaceValid Ethernet port. (Full syntax: unit/port) rxMonitors received packets only. txMonitors transmitted packets only. Default Configuration
Monitors both received and transmitted packets.

Command Mode
Interface Configuration (Ethernet) mode

User Guidelines
This command enables traffic on one port to be copied to another port, or between the source port (src-interface) and a destination port (port being configured). The following restrictions apply to ports configured as destination ports: The port cannot be already configured as a source port. The port cannot be a member in a port-channel. An IP interface is not configured on the port. GVRP is not enabled on the port. The port is not a member of a VLAN, except for the default VLAN (will automatically be removed from the default VLAN). The following restrictions apply to ports configured to be source ports: The port cannot be already configured as a destination port.

Example
The following example copies traffic on port 1/e8 (source port) to port 1/e1 (destination port). Console(config)# interface ethernet 1/e1 Console(config-if)# port monitor 1/e8

Page 155

Allied Telesis
Command Line Interface Users Guide

show ports monitor


The show ports monitor User EXEC mode command displays the port monitoring status.

Syntax
show ports monitor

Default Configuration
This command has no default configuration.

Command Mode
User EXEC mode

User Guidelines
There are no user guidelines for this command.

Example
The following example shows how the port monitoring status is displayed. Console show ports monitor Source Port ----------1/e1 1/e2 1/e18 Destination Port ---------------1/e8 1/e8 1/e8 Type ----RX,TX RX,TX RX Status ------Active Active Active

Page 156 Not approved by Document Control. For review only.

Power over Ethernet Commands

Chapter 19.Power over Ethernet Commands

Note The PoE commands are operational in the AT-S94/24, AT-S94/24POE, AT-S94/48 and AT-S94/48POE devices.

power inline
The port inline Interface Configuration (Ethernet) mode command configures the administrative mode of inline power on an interface.

Syntax
power inline {auto | never}

Parameters autoEnables the device discovery protocol and, if found, supplies power to the device. neverDisables the device discovery protocol and stops supplying power to the device. Default Configuration
The device discovery protocol is enabled.

Command Mode
Interface Configuration (Ethernet) mode

User Guidelines
There are no user guidelines for this command.

Example
The following example enables powered device discovery protocol on port 1/e1, so that power will be supplied to a discovered device. Console(config)# interface ethernet 1/e1 Console(config-if)# power inline auto

power inline powered-device


The power inline powered-device Interface Configuration (Ethernet) mode command adds a comment or description of the powered device type to enable the user to remember what is attached to the interface. Use the no form of this command to remove the description.

Syntax
power inline powered-device pd-type

Page 157

Allied Telesis
Command Line Interface Users Guide

no power inline powered-device

Parameters pd-typeSpecifies the type of powered device attached to the interface. (Range: 1-24 characters) Default Configuration
This command has no default configuration.

Command Mode
Interface Configuration (Ethernet) mode

User Guidelines
There are no user guidelines for this command.

Example
The following example configures a description to an IP-phone to a powered device connected to Ethernet interface 1/e1. Console(config)# interface ethernet 1/e1 Console(config-if)# power inline powered-device IP-phone

power inline priority


The power inline priority Interface Configuration (Ethernet) mode command configures the inline power management priority of the interface. Use the no form of this command to return to the default configuration.

Syntax
power inline priority {critical | high | low} no power inline priority

Parameters critical Indicates that operating the powered device is critical. high Indicates that operating the powered device has high priority. lowIndicates that operating the powered device has low priority. Default Configuration
The default setting is low priority.

Command Mode
Interface Configuration (Ethernet) mode

User Guidelines
There are no user guidelines for this command.

Page 158 Not approved by Document Control. For review only.

Power over Ethernet Commands

Example
The following example configures the device connected to Ethernet interface 1/e1 as a high-priority powered device. Console(config)# interface ethernet 1/e1 Console(config-if)# power inline priority high

power inline usage-threshold


The power inline usage-threshold Global Configuration mode command configures the threshold for initiating inline power usage alarms. Use the no form of this command to return to the default configuration.

Syntax
power inline usage-threshold percentage no power inline usage-threshold

Parameters percentageSpecifies the threshold as a percentage to compare measured power. (Range: 1-99) Default Configuration
The default threshold is 95 percent.

Command Mode
Global Configuration mode

User Guidelines
There are no user guidelines for this command.

Example
The following example configures the power usage threshold for which alarms are sent to 80%. Console(config)# power inline usage-threshold 80

power inline traps enable


The power inline traps enable Global Configuration mode command enables inline power traps. Use the no form of this command to disable inline power traps.

Syntax
power inline traps enable no power inline traps enable

Default Configuration
Inline power traps are disabled.

Page 159

Allied Telesis
Command Line Interface Users Guide

Command Mode
Global Configuration mode

User Guidelines
There are no user guidelines for this command.

Example
The following example enables inline power traps to be sent when a power usage threshold is exceeded. Console(config)# power inline traps enable

show power inline


The show power inline User EXEC mode command displays the information about inline power.

Syntax
show power inline [power-consumption interface]

Parameters interface Valid Ethernet port. (Full syntax: unit/port) Default Configuration
This command has no default configuration.

Command Mode
User EXEC mode

User Guidelines
There are no user guidelines for this command.

Example
The following example displays information about inline power. Console show power inline Power: On Nominal Power: 150 Watt Consumed Power: 120 Watts (80%) Usage Threshold: 95% Traps: Enabled

Page 160 Not approved by Document Control. For review only.

Power over Ethernet Commands

Port ---1/e1 2/e1 3/e1

Powered Device ---------------IP Phone Model A Wireless AP Model

State ----Auto Auto Auto

Priority -------High Low Low

Status -----On On Off

Classification [w] ----------------0.44 - 12.95 0.44 - 3.84 N/A

Console show power inline ethernet 1/e1 Port ---1/e1 Powered Device ---------------IP Phone Model A State ----Auto Priority -------High Status -----On Classification [w] ----------------0.44 - 12.95

Overload Counter: 1 Short Counter: 0 Denied Counter: 0 Absent Counter: 0 Invalid Signature Counter: 0

console# show power inline Unit ---1 2 3 4 5 6 Port ---4/e1 4/e2 4/e3 4/e4 4/e5

Power
------Off Off Off On Off

Nominal Power
------------1 Watts 1 Watts 1 Watts 180 Watts 1 Watts 1 Watts State ----------Auto Auto Auto Auto Auto

Consumed Power -------------0 Watts (0%) 0 Watts (0%) 0 Watts (0%) 48 Watts (27%) 0 Watts (0%) 0 Watts (0%) Status ------------On On On On On

Usage Threshold --------------

Traps ------Disable Disable Disable Disable Disable Disable Class -------class1 class3 class1 class0 class1

95 95 95 95 95
95 Priority -----------low low low low low

Off
Powered Device -------

Page 161

Allied Telesis
Command Line Interface Users Guide

4/e6 4/e7 4/e8 4/e9 4/e10 .

Auto Auto Auto Auto Auto

On On On Searching Searching

low low low low low

class2 class4 class3 class0 class0

Console show power inline Power: On Nominal Power: 150 Watt Consumed Power: 120 Watts (80%) Usage Threshold: 95% Traps: Enabled Port ---1/e1 2/e1 3/e1 Powered Device ---------------IP Phone Model A Wireless AP Model State ----Auto Auto Auto Priority -------High Low Low Status -----On On Off Classification [w] ----------------0.44 - 12.95 0.44 - 3.84 N/A

Console show power inline ethernet 1/e1 Port ---1/e1 Powered Device ---------------IP Phone Model A State ----Auto Priority -------High Status -----On Classification [w] ----------------0.44 - 12.95

Overload Counter: 1 Short Counter: 0 Denied Counter: 0 Absent Counter: 0 Invalid Signature Counter: 0

console# show power inline interface 4/e1 Port ---4/e1 Powered Device ------State ----------Auto Status ------------On Priority -----------low Class -------class1

Page 162 Not approved by Document Control. For review only.

Power over Ethernet Commands

Overload Counter: Short Counter: Denied Counter: Absent Counter:

0 0 0 1

Invalid Signature Counter: 0 The following table describes the significant fields shown in the example: Field Power Nominal Power Consumed Power Usage Threshold Traps Port Powered Device State Priority Status Classification Overload Counter Short Counter Denied Counter Absent Counter Invalid Signature Counter Desc ription The operational status of the inline power sourcing equipment. The nominal power of the inline power sourcing equipment in Watts. Measured usage power in Watts. The usage threshold expressed in percents for comparing the measured power and initiating an alarm if threshold is exceeded. Indicates if inline power traps are enabled. The Ethernet port number. Description of the powered device type. Indicates if the port is enabled to provide power. Can be: Auto or Never. The priority of the port from the point of view of inline power management. Can be: Critical, High or Low. Describes the inline power operational status of the port. Can be: On, Off, TestFail, Testing, Searching or Fault. The power consumption range of the powered device. Can be: 0.44 12.95, 0.44 3.84, 3.84 6.49 or 6.49 12.95. Counts the number of overload conditions that has been detected. Counts the number of short conditions that has been detected. Counts the number of times power has been denied. Counts the number of times power has been removed because powered device dropout was detected. Counts the number of times an invalid signature of a powered device was detected.

Page 163

Allied Telesis
Command Line Interface Users Guide

Chapter 20.QoS Commands


qos
The qos Global Configuration mode command enables quality of service (QoS) on the device. Use the no form of this command to disable QoS on the device.

Syntax
qos no qos

Default Configuration
QoS is disabled on the device.

Command Mode
Global Configuration mode

User Guidelines
There are no user guidelines for this command.

Example
The following example enables QoS on the device. Console(config)# qos

show qos
The show qos User EXEC mode command displays quality of service (QoS) for the device.

Syntax
show qos

Default Configuration
This command has no default configuration.

Command Mode
User EXEC mode

User Guidelines
There are no user guidelines for this command.

Page 164 Not approved by Document Control. For review only.

QoS Commands

Example
The following example displays QoS attributes when QoS is disabled on the device. Console show qos Qos: disable Trust: dscp

priority-queue out num-of-queues


The priority-queue out num-of-queues Global Configuration mode command configures the number of expedite queues. Use the no form of this command to return to the default configuration.

Syntax
priority-queue out num-of-queues number-of-queues no priority-queue out num-of-queues

Parameters number-of-queues Specifies the number of expedite queues. The expedite queues are the queues with
higher indexes. (Range: 0-4)

Default Configuration
All queues are expediting queues.

Command Mode
Global Configuration mode

User Guidelines
When the specified number of expedite queues is 0, the Strict Priority scheduling method is used. When the specified number of expedite queues is 4, weights are defined as 1, 2, 4 and 8.

Example
The following example configures the number of expedite queues as 0. Console(config)# priority-queue out num-of-queues 0

rate-limit
The rate-limit Interface Configuration mode command limits the rate of the incoming traffic. The no form of this command is used to disable rate limiting.

Syntax
rate-limit rate no rate-limit

Parameters rate Maximum kilobits per second of ingress traffic on a port. (Range: 1K - 100M).)

Page 165

Allied Telesis
Command Line Interface Users Guide

Default Configuration
1000 Kbits/Sec

Command Mode
Interface Configuration (Ethernet, port-channel) mode

User Guidelines
The command can be enabled on a specific port only if port storm-control Broadcast enable interface configuration command is not enabled on that port.

Example
The following example limits the rate of the incoming traffic to 62. Console(config-if)# rate-limit 62

traffic-shape
The traffic-shape Interface Configuration mode command sets a shaper on an egress interface. Use the no form of this command to disable the shaper.

Syntax
traffic-shape committed-rate [committed-burst] no traffic-shape

Parameters committed-rate The average traffic rate (CIR) in bits per second (bps). (Range: 64-10000000.) committed-burst The excess burst size (CBS) in bytes. (Range: 4096-16769020.) Default Configuration
No shape is defined.

Command Mode
Interface Configuration mode

User Guidelines
There are no user guidelines for this command.

Example
The following example configures a shaper on port e1. Console(config-if)# traffic-shape 50000

show qos interface


The show qos interface User EXEC mode command displays interface QoS information.

Page 166 Not approved by Document Control. For review only.

QoS Commands

Syntax
show qos interface [ethernet interface-number | vlan vlan-id | port-channel number] [queuing]

Parameters interface-number Valid Ethernet port number. vlan-id Valid VLAN ID. number Valid port-channel number. queuing Indicates the queue strategy (WRR or EF), the weight for WRR queues, the CoS to queue map
and the EF priority.

Default Configuration
There is no default configuration for this command.

Command Mode
User EXEC mode

User Guidelines
If no keyword is specified, port QoS information (e.g., DSCP trusted, CoS trusted, untrusted, etc.) is displayed. If no interface is specified, QoS information about all interfaces is displayed.

Example
The following example displays QoS information about Ethernet port 1/e11. Console> show qos interface ethernet 1/e11 queuing Ethernet 1/e11 Strict Priority. Cos-queue map: cos 0 1 2 3 4 5 6 7 qid 2 1 1 2 3 3 4 4

wrr-queue cos-map
The wrr-queue cos-map Global Configuration mode command maps Class of Service (CoS) values to a specific egress queue. Use the no form of this command to return to the default configuration.

Page 167

Allied Telesis
Command Line Interface Users Guide

Syntax
wrr-queue cos-map queue-id cos1...cos8 no wrr-queue cos-map [queue-id]

Parameters queue-id Specifies the queue number to which the CoS values are mapped. cos1...cos8 Specifies CoS values to be mapped to a specific queue. (Range: 0-7) Default Configuration.
Value (VPT) 0 1 2 3 4 5 6 7 Queue 2 1 1 2 3 3 4 4

Command Mode
Global Configuration mode

User Guidelines
Queue 4 is reserved for stacking.

Example
The following example maps CoS 7 to queue 2. Console(config)# wrr-queue cos-map 2 7

qos trust(Global)
The qos trust Global Configuration mode command configures the System to basic mode and the trust state. Use the no form to return untrusted state.

Syntax
qos trust {cos | dscp} no qos trust

Page 168 Not approved by Document Control. For review only.

QoS Commands

Parameters dscp-list Specify up to 8 DSCP values, with each value separated by space. dp Enter the Drop Precedence value to which the DSCP values corresponds. Possible values are 0 - 2
(Where 2 is the highest Drop Precedence).

Parameters Range dscp-list 0 - 63 dp 0 - 2 Default Configuration


All the DSCPs are mapped to Drop Precedence 0.

Command Mode
Global Configuration mode

User Guidelines
There are no user guidelines for this command.

Example
The following example configures the System to basic mode and the trust state. Console(config)# qos map dscp-dp 2 4 6 8 10 to 2

qos map dscp-queue


The qos map dscp-queue Global Configuration mode command modifies the DSCP to CoS map. Use the no form of this command to return to the default map.

Syntax
qos map dscp-queue dscp-list to queue-id no qos map dscp-queue

Parameters dscp-list Specifies up to 8 DSCP values separated by a space. (Range: 0 - 63) queue-id Specifies the queue number to which the DSCP values are mapped. Default Configuration
The following table describes the default map. DSCP value 00-15 16-31 32-47 48-63 Queue-ID 1 2 3 4

Page 169

Allied Telesis
Command Line Interface Users Guide

Command Mode
Global Configuration mode

User Guidelines
There are no user guidelines for this command.

Example
The following example maps DSCP values 33, 40 and 41 to queue 1. Console(config)# qos map dscp-queue 33 40 41 to 1

qos cos
The qos cos Interface Configuration (Ethernet, port-channel) mode command defines the default CoS value of a port. Use the no form of this command to return to the default configuration.

Syntax
qos cos default-cos no qos cos

Parameters default-cos Specifies the default CoS value of the port. (Range: 0 - 7) Default Configuration
Default CoS value of a port is 0.

Command Mode
Interface Configuration (Ethernet, port-channel) mode

User Guidelines
If the port is trusted, the default CoS value of the port is used to assign a CoS value to all untagged packets entering the port.

Example
The following example configures port 1/e15 default CoS value to 3. Console(config)# interface ethernet 1/e15 Console(config-if) qos cos 3

show qos map


The show qos map User EXEC mode command displays all QoS maps.

Syntax
show qos map [dscp-queue]

Page 170 Not approved by Document Control. For review only.

QoS Commands

Parameters dscp-queue Indicates the DSCP to queue map. Default Configuration


This command has no default configuration.

Command Mode
User EXEC mode

User Guidelines
There are no user guidelines for this command.

Example
The following example displays the DSCP port-queue map. Console> show qos map Dscp-queue map: d1 -0 1 2 3 4 5 6 : : : : : : : : : d2 -0 -01 01 02 02 03 04 04 1 -01 01 02 02 03 04 04 2 -01 01 02 03 03 04 04 3 -01 01 02 03 03 04 04 4 -01 01 02 03 03 04 5 -01 01 02 03 03 04 6 -01 02 02 03 03 04 7 -01 02 02 03 03 04 8 -01 02 02 03 04 04 9 -01 02 02 03 04 04

The following table describes the significant fields shown above. Column d1 d2 01 - 04 Des cription Decimal Bit 1 of DSCP Decimal Bit 2 of DSCP Queue numbers

Page 171

Allied Telesis
Command Line Interface Users Guide

Chapter 21.Radius Commands


radius-server host
The radius-server host Global Configuration mode command specifies a RADIUS server host. Use the no form of this command to delete the specified RADIUS host.

Syntax
radius-server host {ip-address | hostname} [auth-port auth-port-number] [timeout timeout] [retransmit retries] [deadtime deadtime] [key key-string] [source source] [priority priority] [usage type] no radius-server host {ip-address | hostname}

Parameters ip-address IP address of the RADIUS server host. hostname Hostname of the RADIUS server host. (Range: 1-158 characters) auth-port-number Port number for authentication requests. The host is not used for authentication if the
port number is set to 0. (Range: 0-65535) timeout Specifies the timeout value in seconds. (Range: 1-30) retries Specifies the retransmit value. (Range: 1-10) deadtime Length of time in minutes during which a RADIUS server is skipped over by transaction requests. (Range: 0-2000) key-string Specifies the authentication and encryption key for all RADIUS communications between the device and the RADIUS server. This key must match the encryption used on the RADIUS daemon. To specify an empty string, enter "". (Range: 0-128 characters) source Specifies the source IP address to use for communication. 0.0.0.0 is interpreted as request to use the IP address of the outgoing IP interface. priority Determines the order in which servers are used, where 0 has the highest priority. (Range: 0-65535) type Specifies the usage type of the server. Possible values: login, dot.1x or all.

Default Configuration
No RADIUS server host is specified. The port number for authentication requests is 1812. The usage type is all.

Command Mode
Global Configuration mode

User Guidelines
To specify multiple hosts, multiple radius-server host commands can be used. If no host-specific timeout, retries, deadtime or key-string values are specified, global values apply to each RADIUS server host. The address type of the source parameter must be the same as the ip-address parameter.

Page 172 Not approved by Document Control. For review only.

Radius Commands

Example
The following example specifies a RADIUS server host with IP address 192.168.10.1, authentication request port number 20 and a 20-second timeout period. Console(config)# radius-server host 192.168.10.1 auth-port 20 timeout 20

radius-server key
The radius-server key Global Configuration mode command sets the authentication and encryption key for all RADIUS communications between the device and the RADIUS daemon. Use the no form of this command to return to the default configuration.

Syntax
radius-server key [key-string] no radius-server key

Parameters key-string Specifies the authentication and encryption key for all RADIUS communications between the
device and the RADIUS server. This key must match the encryption used on the RADIUS daemon. (Range: 0-128 characters)

Default Configuration
The key-string is an empty string.

Command Mode
Global Configuration mode

User Guidelines
There are no user guidelines for this command.

Example
The following example defines the authentication and encryption key for all RADIUS communications between the device and the RADIUS daemon. Console(config)# radius-server key ati-server

radius-server retransmit
The radius-server retransmit Global Configuration mode command specifies the number of times the software searches the list of RADIUS server hosts. Use the no form of this command to reset the default configuration.

Syntax
radius-server retransmit retries no radius-server retransmit

Page 173

Allied Telesis
Command Line Interface Users Guide

Parameters retries Specifies the retransmit value. (Range: 1 - 10) Default Configuration
The software searches the list of RADIUS server hosts 3 times.

Command Mode
Global Configuration mode

User Guidelines
There are no user guidelines for this command.

Example
The following example configures the number of times the software searches the list of RADIUS server hosts to 5 times. console(config)# radius-server retransmit 5

radius-server source-ip
The radius-server source-ip Global Configuration mode command specifies the source IP address used for communication with RADIUS servers. Use the no form of this command to return to the default configuration.

Syntax
radius-server source-ip source no radius-source-ip source

Parameters source Specifies a valid source IP address. Default Configuration


The source IP address is the IP address of the outgoing IP interface.

Command Mode
Global Configuration mode

User Guidelines
N/A

Example
The following example configures the source IP address used for communication with RADIUS servers to 10.1.1.1. console(config)# radius-server source-ip 10.1.1.1

Page 174 Not approved by Document Control. For review only.

Radius Commands

radius-server timeout
The radius-server timeout Global Configuration mode command sets the interval during which the device waits for a server host to reply. Use the no form of this command to return to the default configuration.

Syntax
radius-server timeout timeout no radius-server timeout

Parameters timeout Specifies the timeout value in seconds. (Range: 1 - 30) Default Configuration
The timeout value is 3 seconds.

Command Mode
Global Configuration mode

User Guidelines
There are no user guidelines for this command.

Example
The following example configures the timeout interval to 5 seconds. Console(config)# radius-server timeout 5

radius-server deadtime
The radius-server deadtime Global Configuration mode command improves RADIUS response time when servers are unavailable. The command is used to cause the unavailable servers to be skipped. Use the no form of this command to return to the default configuration.

Syntax
radius-server deadtime deadtime no radius-server deadtime

Parameters deadtime Length of time in minutes during which a RADIUS server is skipped over by transaction
requests. (Range: 0 - 2000)

Default Configuration
The deadtime setting is 0.

Command Mode
Global Configuration mode

Page 175

Allied Telesis
Command Line Interface Users Guide

User Guidelines
There are no user guidelines for this command.

Example
The following example sets the deadtime to 10 minutes. Console(config)# radius-server deadtime 10

show radius-servers
The show radius-servers Privileged EXEC mode command displays the RADIUS server settings.

Syntax
show radius-servers

Default Configuration
This command has no default configuration.

Command Mode
Privileged EXEC mode

User Guidelines
There are no user guidelines for this command.

Example
The following example displays RADIUS server settings. Console# show radius-servers IP address --------172.16.1.1 172.16.1.2 Global values ------------TimeOut: 3 Retransmit: 3 Deadtime: 0 Source IP: 172.16.8.1 Port Auth ---1645 1645 TimeOut ------Global 11 Retransmit ---------Global 8 DeadTime -----Global Global Source IP -------Global Priority -------1 2 Usage ----All All

Page 176 Not approved by Document Control. For review only.

Radius Commands

Console# show radius-servers IP address --------192.168.1.10 1 Global values ------------TimeOut: 3 Retransmit: 3 Deadtime: 0 Source IP: 0.0.0.0 Port Auth ---1812 Port Acc ------1813 Timeout ----Global Global Retrans DeadTime -----Global Source IP -------Global Priority -------0 Usage ----all

Page 177

Allied Telesis
Command Line Interface Users Guide

Chapter 22.RMON Commands


show rmon statistics
The show rmon statistics User EXEC mode command displays RMON Ethernet statistics.

Syntax
show rmon statistics {ethernet interface number | port-channel port-channel-number}

Parameters interface number Valid Ethernet port. port-channel-number Valid port-channel number. Default Configuration
This command has no default configuration.

Command Mode
User EXEC mode

User Guidelines
There are no user guidelines for this command.

Example
The following example displays RMON Ethernet statistics for Ethernet port 1/e1. Console> show rmon statistics ethernet 1/e1 Port: 1/e1 Octets: 878128 Broadcast: 7 CRC Align Errors: 0 Undersize Pkts: 0 Fragments: 0 64 Octets: 98 128 to 255 Octets: 0 512 to 1023 Octets: 491 Packets: 978 Multicast: 1 Collisions: 0 Oversize Pkts: 0 Jabbers: 0 65 to 127 Octets: 0 256 to 511 Octets: 0 1024 to 1518 Octets: 389

Page 178 Not approved by Document Control. For review only.

RMON Commands

The following table describes significant fields shown above: Field Octets Packets Broadcast Multicast CRC Align Errors De scrip tio n The total number of octets of data (including those in bad packets) received on the network (excluding framing bits but including FCS octets). The total number of packets (including bad packets, Broadcast packets, and Multicast packets) received. The total number of good packets received and directed to the Broadcast address. This does not include Multicast packets. The total number of good packets received and directed to a Multicast address. This number does not include packets directed to the Broadcast address. The total number of packets received with a length (excluding framing bits, but including FCS octets) of between 64 and 1518 octets, inclusive, but with either a bad Frame Check Sequence (FCS) with an integral number of octets (FCS Error) or a bad FCS with a non-integral number of octets (Alignment Error). The best estimate of the total number of collisions on this Ethernet segment. The total number of packets received less than 64 octets long (excluding framing bits, but including FCS octets) and otherwise well formed. The total number of packets received longer than 1518 octets (excluding framing bits, but including FCS octets) and otherwise well formed. The total number of packets received less than 64 octets in length (excluding framing bits but including FCS octets) and either a bad Frame Check Sequence (FCS) with an integral number of octets (FCS Error) or a bad FCS with a non-integral number of octets (Alignment Error). The total number of packets received longer than 1518 octets (excluding framing bits, but including FCS octets), and either a bad Frame Check Sequence (FCS) with an integral number of octets (FCS Error) or a bad FCS with a non-integral number of octets (Alignment Error). The total number of packets (including bad packets) received that are 64 octets in length (excluding framing bits but including FCS octets). The total number of packets (including bad packets) received that are between 65 and 127 octets in length inclusive (excluding framing bits but including FCS octets). The total number of packets (including bad packets) received that are between 128 and 255 octets in length inclusive (excluding framing bits but including FCS octets). The total number of packets (including bad packets) received that are between 256 and 511 octets in length inclusive (excluding framing bits but including FCS octets). The total number of packets (including bad packets) received that are between 512 and 1023 octets in length inclusive (excluding framing bits but including FCS octets). The total number of packets (including bad packets) received that are between 1024 and 1518 octets in length inclusive (excluding framing bits but including FCS octets).

Collisions Undersize Pkts Oversize Pkts Fragments

Jabbers

64 Octets 65 to 127 Octets 128 to 255 Octets 256 to 511 Octets 512 to 1023 Octets 1024 to 1518 Octets

Page 179

Allied Telesis
Command Line Interface Users Guide

rmon collection history


The rmon collection history Interface Configuration (Ethernet, port-channel) mode command enables a Remote Monitoring (RMON) MIB history statistics group on an interface. Use the no form of this command to remove a specified RMON history statistics group.

Syntax
rmon collection history index [owner ownername] [buckets bucket-number] [interval seconds] no rmon collection history index

Parameters index Specifies the statistics group index . (Range: 1-65535) ownername Specifies the RMON statistics group owner name. bucket-number Number of buckets specified for the RMON collection history group of statistics. If
unspecified, defaults to 50. (Range:1-65535) seconds Number of seconds in each polling cycle. (Range: 1-3600)

Default Configuration
RMON statistics group owner name is an empty string. Number of buckets specified for the RMON collection history statistics group is 50. Number of seconds in each polling cycle is 1800.

Command Mode
Interface Configuration (Ethernet, port-channel) mode

User Guidelines
Cannot be configured for a range of interfaces (range context).

Example
The following example enables a Remote Monitoring (RMON) MIB history statistics group on Ethernet port 1/e1 with index number 1 and a polling interval period of 2400 seconds. Console(config)# interface ethernet 1/e1 Console(config-if)# rmon collection history 1 interval 2400

show rmon collection history


The show rmon collection history User EXEC mode command displays the requested RMON history group statistics.

Syntax
show rmon collection history [ethernet interface | port-channel port-channel-number]

Parameters interface Valid Ethernet port. (Full syntax: unit/port) port-channel-number Valid port-channel number.

Page 180 Not approved by Document Control. For review only.

RMON Commands

Default Configuration
This command has no default configuration.

Command Mode
User EXEC mode

User Guidelines
There are no user guidelines for this command.

Example
The following example displays all RMON history group statistics. Console> show rmon collection history Index ----1 2 Interface --------1/e1 1/e1 Interval -------30 1800 Requested Samples --------50 50 Granted Samples ------50 50 Owner ------CLI Manager

The following table describes significant fields shown above: Field Index Interface Interval Requested Samples Granted Samples Owner Desc rip t ion An index that uniquely identifies the entry. The sampled Ethernet interface The interval in seconds between samples. The requested number of samples to be saved. The granted number of samples to be saved. The entity that configured this entry.

show rmon history


The show rmon history User EXEC mode command displays RMON Ethernet history statistics.

Syntax
show rmon history index {throughput | errors | other} [period seconds]

Parameters index Specifies the requested set of samples. (Range: 1 - 65535) throughput Indicates throughput counters. errors Indicates error counters. other Indicates drop and collision counters. seconds Specifies the period of time in seconds. (Range: 0-4294967295)

Page 181

Allied Telesis
Command Line Interface Users Guide

Default Configuration
This command has no default configuration.

Command Mode
User EXEC mode

User Guidelines
There are no user guidelines for this command.

Examples
The following examples displays RMON Ethernet history statistics for index 1. Console> show rmon history 1 throughput Sample Set: 1 Interface: 1/e1 Requested samples: 50 Maximum table size: 500 Time -------------------Jan 18 2002 21:57:00 Jan 18 2002 21:57:30 Octets --------303595962 287696304 Packets ------357568 275686 Broadcast ---------3289 2789 Multicast --------7287 5878 Util ----19% 20% Owner: CLI Interval: 1800 Granted samples: 50

Console> show rmon history 1 errors Sample Set: 1 Interface: 1/e1 Requested samples: 50 Owner: Me Interval: 1800 Granted samples: 50

Maximum table size: 500 (800 after reset) Time ---------Jan 18 2002 21:57:00 Jan 18 2002 21:57:30 CRC Align --------1 1 Undersize --------1 1 Oversize -------0 0 Fragments --------49 27 Jabbers ------0 0

Page 182 Not approved by Document Control. For review only.

RMON Commands

Console> show rmon history 1 other Sample Set: 1 Interface: 1/e1 Requested samples: 50 Maximum table size: 500 Time -------------------Jan 18 2002 21:57:00 Jan 18 2002 21:57:30 Dropped -------3 3 Collisions ---------0 0 Owner: Me Interval: 1800 Granted samples: 50

The following table describes significant fields shown above: Field Time Octets Packets Broadcast Multicast Util CRC Align D escr ip tio n Date and Time the entry is recorded. The total number of octets of data (including those in bad packets) received on the network (excluding framing bits but including FCS octets). The number of packets (including bad packets) received during this sampling interval. The number of good packets received during this sampling interval that were directed to the Broadcast address. The number of good packets received during this sampling interval that were directed to a Multicast address. This number does not include packets addressed to the Broadcast address. The best estimate of the mean physical layer network utilization on this interface during this sampling interval, in hundredths of a percent. The number of packets received during this sampling interval that had a length (excluding framing bits but including FCS octets) between 64 and 1518 octets, inclusive, but had either a bad Frame Check Sequence (FCS) with an integral number of octets (FCS Error) or a bad FCS with a non-integral number of octets (Alignment Error). The number of packets received during this sampling interval that were less than 64 octets long (excluding framing bits but including FCS octets) and were otherwise well formed. The number of packets received during this sampling interval that were longer than 1518 octets (excluding framing bits but including FCS octets) but were otherwise well formed. The total number of packets received during this sampling interval that were less than 64 octets in length (excluding framing bits but including FCS octets) had either a bad Frame Check Sequence (FCS) with an integral number of octets (FCS Error), or a bad FCS with a nonintegral number of octets (Alignment Error). It is normal for etherHistoryFragments to increment because it counts both runts (which are normal occurrences due to collisions) and noise hits. The number of packets received during this sampling interval that were longer than 1518 octets (excluding framing bits but including FCS octets), and had either a bad Frame Check Sequence (FCS) with an integral number of octets (FCS Error) or a bad FCS with a non-integral number of octets (Alignment Error).

Undersize Oversize Fragments

Jabbers

Page 183

Allied Telesis
Command Line Interface Users Guide

Dropped

The total number of events in which packets were dropped by the probe due to lack of resources during this sampling interval. This number is not necessarily the number of packets dropped, it is just the number of times this condition has been detected. The best estimate of the total number of collisions on this Ethernet segment during this sampling interval.

Collisions

rmon alarm
The rmon alarm Global Configuration mode command configures alarm conditions. Use the no form of this command to remove an alarm.

Syntax
rmon alarm index variable interval rthreshold fthreshold revent fevent [type type] [startup direction] [owner name] no rmon alarm index

Parameters index Specifies the alarm index. (Range: 1-65535) variable Specifies the object identifier of the variable to be sampled. interval Specifies the interval in seconds during which the data is sampled and compared with rising and
falling thresholds. (Range: 1-2147483647) rthreshold Specifies the rising threshold. (Range: 0-2147483647) fthreshold Specifies the falling threshold. (Range: 0-2147483647) revent Specifies the event index used when a rising threshold is crossed. (Range: 1-65535) fevent Specifies the event index used when a falling threshold is crossed. (Range: 1-65535) type Specifies the method used for sampling the selected variable and calculating the value to be compared against the thresholds. Possible values are absolute and delta. If the method is absolute, the value of the selected variable is compared directly with the thresholds at the end of the sampling interval. If the method is delta, the selected variable value of the last sample is subtracted from the current value, and the difference is compared with the thresholds. direction Specifies the alarm that may be sent when this entry is first set to valid. Possible values are rising, rising-falling and falling. If the first sample (after this entry becomes valid) is greater than or equal to rthreshold and direction is equal to rising or rising-falling, a single rising alarm is generated. If the first sample (after this entry becomes valid) is less than or equal to fthreshold and direction is equal to falling or rising-falling, a single falling alarm is generated. name Specifies the name of the person who configured this alarm. If unspecified, the name is an empty string.

Default Configuration
The type is absolute. The startup direction is rising-falling.

Page 184 Not approved by Document Control. For review only.

RMON Commands

Command Mode
Global Configuration mode

User Guidelines
There are no user guidelines for this command.

Example
The following example configures the following alarm conditions:

Alarm index 1000 Variable identifier ati Sample interval 360000 seconds Rising threshold 1000000 Falling threshold 1000000 Rising threshold event index 10 Falling threshold event index 20 Console(config)# rmon alarm 1000 ati 360000 1000000 1000000 10 20

show rmon alarm-table


The show rmon alarm-table User EXEC mode command displays the alarms table.

Syntax
show rmon alarm-table

Default Configuration
This command has no default configuration.

Command Mode
User EXEC mode

User Guidelines
There are no user guidelines for this command.

Example
The following example displays the alarms table. Console> show rmon alarm-table Index ----1 2 3 OID ---------------------1.3.6.1.2.1.2.2.1.10.1 1.3.6.1.2.1.2.2.1.10.1 1.3.6.1.2.1.2.2.1.10.9 Owner ------CLI Manager CLI

Page 185

Allied Telesis
Command Line Interface Users Guide

The following table describes significant fields shown above: Field Index OID Owner Desc ription An index that uniquely identifies the entry. Monitored variable OID. The entity that configured this entry.

show rmon alarm


The show rmon alarm User EXEC mode command displays alarm configuration.

Syntax
show rmon alarm number

Parameters number Specifies the alarm index. (Range: 1 - 65535) Default Configuration
This command has no default configuration.

Command Mode
User EXEC mode

User Guidelines
There are no user guidelines for this command.

Example
The following example displays RMON 1 alarms. Console> show rmon alarm 1 Alarm 1 ------OID: 1.3.6.1.2.1.2.2.1.10.1 Last sample Value: 878128 Interval: 30 Sample Type: delta Startup Alarm: rising Rising Threshold: 8700000 Falling Threshold: 78 Rising Event: 1 Falling Event: 1 Owner: CLI

Page 186 Not approved by Document Control. For review only.

RMON Commands

The following table describes the significant fields shown in the display: Field Alarm OID Last Sample Value Desc rip t io n Alarm index. Monitored variable OID. The statistic value during the last sampling period. For example, if the sample type is delta, this value is the difference between the samples at the beginning and end of the period. If the sample type is absolute, this value is the sampled value at the end of the period. The interval in seconds over which the data is sampled and compared with the rising and falling thresholds. The method of sampling the variable and calculating the value compared against the thresholds. If the value is absolute, the value of the variable is compared directly with the thresholds at the end of the sampling interval. If the value is delta, the value of the variable at the last sample is subtracted from the current value, and the difference compared with the thresholds. The alarm that may be sent when this entry is first set. If the first sample is greater than or equal to the rising threshold, and startup alarm is equal to rising or rising and falling, then a single rising alarm is generated. If the first sample is less than or equal to the falling threshold, and startup alarm is equal falling or rising and falling, then a single falling alarm is generated. A sampled statistic threshold. When the current sampled value is greater than or equal to this threshold, and the value at the last sampling interval is less than this threshold, a single event is generated. A sampled statistic threshold. When the current sampled value is less than or equal to this threshold, and the value at the last sampling interval is greater than this threshold, a single event is generated. The event index used when a rising threshold is crossed. The event index used when a falling threshold is crossed. The entity that configured this entry.

Interval Sample Type

Startup Alarm

Rising Threshold

Falling Threshold

Rising Event Falling Event Owner

rmon event
The rmon event Global Configuration mode command configures an event. Use the no form of this command to remove an event.

Syntax
rmon event index type [community text] [description text] [owner name] no rmon event index

Page 187

Allied Telesis
Command Line Interface Users Guide

Parameters index Specifies the event index. (Range: 1 - 65535) type Specifies the type of notification generated by the device about this event. Possible values: none,
log, trap, log-trap. community text If the specified notification type is trap, an SNMP trap is sent to the SNMP community specified by this octet string. (Range: 0-127 characters) description text Specifies a comment describing this event. (Range: 0-127 characters) name Specifies the name of the person who configured this event. If unspecified, the name is an empty string.

Default Configuration
This command has no default configuration.

Command Mode
Global Configuration mode

User Guidelines
If log is specified as the notification type, an entry is made in the log table for each event. If trap is specified, an SNMP trap is sent to one or more management stations.

Example
The following example configures an event identified as index 10 and for which the device generates a notification in the log table. Console(config)# rmon event 10 log

show rmon events


The show rmon events User EXEC mode command displays the RMON event table.

Syntax
show rmon events

Default Configuration
This command has no default configuration.

Command Mode
User EXEC mode

User Guidelines
There are no user guidelines for this command.

Page 188 Not approved by Document Control. For review only.

RMON Commands

Example
The following example displays the RMON event table. Console> show rmon events Index ----1 2 Description -------------Errors High Broadcast Type -------Log Log-Trap device Community --------Owner ------CLI Manager Last time sent -------------------Jan 18 2002 23:58:17 Jan 18 2002 23:59:48

The following table describes significant fields shown above: Field Index Description Type De scr ip tio n An index that uniquely identifies the event. A comment describing this event. The type of notification that the device generates about this event. Can have the following values: none, log, trap, log-trap. In the case of log, an entry is made in the log table for each event. In the case of trap, an SNMP trap is sent to one or more management stations. If an SNMP trap is to be sent, it is sent to the SNMP community specified by this octet string. The entity that configured this event. The time this entry last generated an event. If this entry has not generated any events, this value is zero.

Community Owner Last time sent

show rmon log


The show rmon log User EXEC mode command displays the RMON log table.

Syntax
show rmon log [event]

Parameters event Specifies the event index. (Range: 0 - 65535) Default Configuration
This command has no default configuration.

Command Mode
User EXEC mode

User Guidelines
There are no user guidelines for this command.

Page 189

Allied Telesis
Command Line Interface Users Guide

Example
The following example displays the RMON log table. Console> show rmon log Maximum table size: 500 Event ------1 1 2 Description -------------Errors Errors High Broadcast Time --------Jan 18 2002 23:48:19 Jan 18 2002 23:58:17 Jan 18 2002 23:59:48

Console> show rmon log Maximum table size: 500 (800 after reset) Event ------1 1 2 Description -------------Errors Errors High Broadcast Time --------Jan 18 2002 23:48:19 Jan 18 2002 23:58:17 Jan 18 2002 23:59:48

The following table describes the significant fields shown in the display: Field Event Description Time D escr ip tio n An index that uniquely identifies the event. A comment describing this event. The time this entry was created.

rmon table-size
The rmon table-size Global Configuration mode command configures the maximum size of RMON tables. Use the no form of this command to return to the default configuration.

Syntax
rmon table-size {history entries | log entries} no rmon table-size {history | log}

Parameters history entries Maximum number of history table entries. (Range: 20 -270) log entries Maximum number of log table entries. (Range: 20-100) Default Configuration
History table size is 270. Log table size is 200.

Page 190 Not approved by Document Control. For review only.

RMON Commands

Command Mode
Global Configuration mode

User Guidelines
The configured table size takes effect after the device is rebooted.

Example
The following example configures the maximum RMON history table sizes to 100 entries. Console(config)# rmon table-size history 100

Page 191

Allied Telesis
Command Line Interface Users Guide

Chapter 23.SNMP Commands


snmp-server community
The snmp-server community Global Configuration mode command configures the community access string to permit access to the SNMP protocol. Use the no form of this command to remove the specified community string.

Syntax
snmp-server community community [ro | rw | su] [ip-address][view view-name] snmp-server community-group community group-name [ip-address] no snmp-server community community [ip-address]

Parameters community Community string that acts like a password and permits access to the SNMP protocol.
(Range: 1-20 characters) ro Indicates read-only access (default). rwIndicates read-write access. suIndicates SNMP administrator access. ip-address Specifies the IP address of the management station. group-name Specifies the name of a previously defined group. A group defines the objects available to the community. (Range: 1-30 characters) view-name Specifies the name of a previously defined view. The view defines the objects available to the community. (Range: 1-30 characters)

Default Configuration
No communities are defined.

Command Mode
Global Configuration mode

User Guidelines
The view-name parameter cannot be specified for su, which has access to the whole MIB. The view-name parameter can be used to restrict the access rights of a community string. When it is specified: An internal security name is generated. The internal security name for SNMPv1 and SNMPv2 security models is mapped to an internal group name. The internal group name for SNMPv1 and SNMPv2 security models is mapped to a view-name (read-view and notify-view always, and for rw for write-view also) The group-name parameter can also be used to restrict the access rights of a community string. When it is specified: An internal security name is generated. The internal security name for SNMPv1 and SNMPv2 security models is mapped to the group name.

Page 192 Not approved by Document Control. For review only.

SNMP Commands

Example
The following example defines community access string public to permit administrative access to SNMP protocol at an administrative station with IP address 192.168.1.20. Console(config)# snmp-server community public su 192.168.1.20

snmp-server view
The snmp-server view Global Configuration mode command creates or updates a Simple Network Management Protocol (SNMP) server view entry. Use the no form of this command to remove a specified SNMP server view entry.

Syntax
snmp-server view view-name oid-tree {included | excluded} no snmp-server view view-name [oid-tree]

Parameters view-nameSpecifies the label for the view record that is being created or updated. The name is used to
reference the record. (Range: 1-30 characters) oid-treeSpecifies the object identifier of the ASN.1 subtree to be included or excluded from the view. To identify the subtree, specify a text string consisting of numbers, such as 1.3.6.2.4, or a word, such as system. Replace a single sub-identifier with the asterisk (*) wildcard to specify a subtree family; for example 1.3.*.4. includedIndicates that the view type is included. excludedIndicates that the view type is excluded.

Default Configuration
No view entry exists.

Command Mode
Global Configuration mode

User Guidelines
This command can be entered multiple times for the same view record. The number of views is limited to 64. No check is made to determine that a MIB node corresponds to the "starting portion" of the OID until the first wildcard.

Example
The following example creates a view that includes all objects in the MIB-II system group except for sysServices (System 7) and all objects for interface 1 in the MIB-II interface group. Console(config)# snmp-server view user-view system included Console(config)# snmp-server view user-view system.7 excluded Console(config)# snmp-server view user-view ifEntry.*.1 included

Page 193

Allied Telesis
Command Line Interface Users Guide

snmp-server group
The snmp-server group Global Configuration mode command configures a new Simple Management Protocol (SNMP) group or a table that maps SNMP users to SNMP views. Use the no form of this command to remove a specified SNMP group.

Syntax
snmp-server group groupname {v1 | v2 | v3 {noauth | auth | priv} [notify notifyview ] } [read readview] [write writeview] no snmp-server group groupname {v1 | v2 | v3 [noauth | auth | priv]}

Parameters groupnameSpecifies the name of the group. v1Indicates the SNMP Version 1 security model. v2Indicates the SNMP Version 2 security model. v3Indicates the SNMP Version 3 security model. noauthIndicates no authentication of a packet. Applicable only to the SNMP Version 3 security model. authIndicates authentication of a packet without encrypting it. Applicable only to the SNMP Version 3
security model. privIndicates authentication of a packet with encryption. Applicable only to the SNMP Version 3 security model. readviewSpecifies a string that is the name of the view that enables only viewing the contents of the agent. If unspecified, all objects except for the community-table and SNMPv3 user and access tables are available. writeviewSpecifies a string that is the name of the view that enables entering data and configuring the contents of the agent. If unspecified, nothing is defined for the write view. notifyviewSpecifies a string that is the name of the view that enables specifying an inform or a trap. If unspecified, nothing is defined for the notify view. Applicable only to the SNMP Version 3 security model.

Default Configuration
No group entry exists.

Command Mode
Global Configuration mode

User Guidelines
There are no user guidelines for this command.

Example
The following example attaches a group called user-group to SNMPv3 and assigns to the group the privacy security level and read access rights to a view called user-view. Console(config)# snmp-server group user-group v3 priv read user-view

snmp-server user
The snmp-server user Global Configuration mode command configures a new SNMP Version 3 user. Use the no form of this command to remove a user.

Page 194 Not approved by Document Control. For review only.

SNMP Commands

Syntax
snmp-server user username groupname [remote engineid-string] [ auth-md5 password | auth-sha password | auth-md5-key md5-des-keys | auth-sha-key sha-des-keys ] no snmp-server user username [remote engineid-string]

Parameters usernameSpecifies the name of the user on the host that connects to the agent. (Range: 1-30 characters) groupnameSpecifies the name of the group to which the user belongs. (Range: 1-30 characters) engineid-stringSpecifies the engine ID of the remote SNMP entity to which the user belongs. The engine ID
is a concatenated hexadecimal string. Each byte in the hexadecimal character string is two hexadecimal digits. Each byte can be separated by a period or colon. (Range: 5-32 characters) auth-md5 passwordIndicates the HMAC-MD5-96 authentication level. The user should enter a password for authentication and generation of a DES key for privacy. (Range: 1-32 characters) auth-sha passwordIndicates the HMAC-SHA-96 authentication level. The user should enter a password for authentication and generation of a DES key for privacy. (Range: 1-32 characters) auth-md5-key md5-des-keysIndicates the HMAC-MD5-96 authentication level. The user should enter a concatenated hexadecimal string of the MD5 key (MSB) and the privacy key (LSB). If authentication is only required, 16 bytes should be entered; if authentication and privacy are required, 32 bytes should be entered. Each byte in the hexadecimal character string is two hexadecimal digits. Each byte can be separated by a period or colon. (16 or 32 bytes) auth-sha-key sha-des-keysIndicates the HMAC-SHA-96 authentication level. The user should enter a concatenated hexadecimal string of the SHA key (MSB) and the privacy key (LSB). If authentication is only required, 20 bytes should be entered; if authentication and privacy are required, 36 bytes should be entered. Each byte in the hexadecimal character string is two hexadecimal digits. Each byte can be separated by a period or colon. (20 or 36 bytes)

Default Configuration
No group entry exists.

Command Mode
Global Configuration mode

User Guidelines
If auth-md5 or auth-sha is specified, both authentication and privacy are enabled for the user. When a show running-config Privileged EXEC mode command is entered, a line for this user will not be displayed. To see if this user has been added to the configuration, type the show snmp users Privileged EXEC mode command. An SNMP EngineID has to be defined to add SNMP users to the device. Changing or removing the SNMP EngineID value deletes SNMPv3 users from the devices database. The remote engineid designates the remote management station and should be defined to enable the device to receive informs.

Example
The following example configures an SNMPv3 user John in group user-group. Console(config)# snmp-server user John user-group

Page 195

Allied Telesis
Command Line Interface Users Guide

snmp-server engineID local


The snmp-server engineID local Global Configuration mode command specifies the Simple Network Management Protocol (SNMP) engineID on the local device. Use the no form of this command to remove the configured engine ID.

Syntax
snmp-server engineID local {engineid-string | default} no snmp-server engineID local

Parameters engineid-stringSpecifies a character string that identifies the engine ID. (Range: 5-32 characters) defaultThe engine ID is created automatically based on the device MAC address. Default Configuration
The engine ID is not configured. If SNMPv3 is enabled using this command, and the default is specified, the default engine ID is defined per standard as:

First 4 octets first bit = 1, the rest is IANA Enterprise number = 674. Fifth octet set to 3 to indicate the MAC address that follows. Last 6 octets MAC address of the device.

Command Mode
Global Configuration mode

User Guidelines
To use SNMPv3, you have to specify an engine ID for the device. You can specify your own ID or use a default string that is generated using the MAC address of the device. If the SNMPv3 engine ID is deleted or the configuration file is erased, SNMPv3 cannot be used. By default, SNMPv1/v2 are enabled on the device. SNMPv3 is enabled only by defining the Local Engine ID. If you want to specify your own ID, you do not have to specify the entire 32-character engine ID if it contains trailing zeros. Specify only the portion of the engine ID up to the point where just zeros remain in the value. For example, to configure an engine ID of 123400000000000000000000, you can specify snmp-server engineID local 1234. Since the engine ID should be unique within an administrative domain, the following is recommended: For a standalone device, use the default keyword to configure the engine ID. For a stackable system, configure the engine ID and verify its uniqueness. Changing the value of the engine ID has the following important side-effect. A user's password (entered on the command line) is converted to an MD5 or SHA security digest. This digest is based on both the password and the local engine ID. The users command line password is then destroyed, as required by RFC 2274. As a result, the security digests of SNMPv3 users become invalid if the local value of the engine ID change, and the users will have to be reconfigured. You cannot specify an engine ID that consists of all 0x0, all 0xF or 0x000000001.

Page 196 Not approved by Document Control. For review only.

SNMP Commands

The show running-config Privileged EXEC mode command does not display the SNMP engine ID configuration. To see the SNMP engine ID configuration, enter the snmp-server engineID local Global Configuration mode command.

Example
The following example enables SNMPv3 on the device and sets the local engine ID of the device to the default value. Console(config) # snmp-server engineID local default

snmp-server enable traps


The snmp-server enable traps Global Configuration mode command enables the device to send SNMP traps. Use the no form of this command to disable SNMP traps.

Syntax
snmp-server enable traps no snmp-server enable traps

Default Configuration
SNMP traps are enabled.

Command Mode
Global Configuration mode

User Guidelines
There are no user guidelines for this command.

Example
The following example enables SNMP traps. Console(config)# snmp-server enable traps

snmp-server filter
The snmp-server filter Global Configuration mode command creates or updates a Simple Network Management Protocol (SNMP) server filter entry. Use the no form of this command to remove the specified SNMP server filter entry.

Syntax
snmp-server filter filter-name oid-tree {included | excluded} no snmp-server filter filter-name [oid-tree]

Page 197

Allied Telesis
Command Line Interface Users Guide

Parameters filter-nameSpecifies the label for the filter record that is being updated or created. The name is used to
reference the record. (Range: 1-30 characters) oid-treeSpecifies the object identifier of the ASN.1 subtree to be included or excluded from the view. To identify the subtree, specify a text string consisting of numbers, such as 1.3.6.2.4, or a word, such as system. Replace a single subidentifier with the asterisk (*) wildcard to specify a subtree family; for example, 1.3.*.4. includedIndicates that the filter type is included. excludedIndicates that the filter type is excluded.

Default Configuration
No filter entry exists.

Command Mode
Global Configuration mode

User Guidelines
This command can be entered multiple times for the same filter record. Later lines take precedence when an object identifier is included in two or more lines.

Example
The following example creates a filter that includes all objects in the MIB-II system group except for sysServices (System 7) and all objects for interface 1 in the MIB-II interfaces group. Console(config)# snmp-server filter filter-name system included Console(config)# snmp-server filter filter-name system.7 excluded Console(config)# snmp-server filter filter-name ifEntry.*.1 included

snmp-server host
The snmp-server host Global Configuration mode command specifies the recipient of Simple Network Management Protocol Version 1 or Version 2 notifications. Use the no form of this command to remove the specified host.

Syntax
snmp-server host {ip-address | hostname} community-string [traps | informs] [1 | 2] [udp-port port] [filter filtername] [timeout seconds] [retries retries] no snmp-server host {ip-address | hostname} [traps | informs]

Page 198 Not approved by Document Control. For review only.

SNMP Commands

Parameters ip-addressSpecifies the IP address of the host (targeted recipient). hostnameSpecifies the name of the host. (Range:1-158 characters) community-stringSpecifies a password-like community string sent with the notification operation.
(Range: 1-20) trapsIndicates that SNMP traps are sent to this host. If unspecified, SNMPv2 traps are sent to the host. informsIndicates that SNMP informs are sent to this host. Not applicable to SNMPv1. 1Indicates that SNMPv1 traps will be used. 2Indicates that SNMPv2 traps will be used. If portSpecifies the UDP port of the host to use. If unspecified, the default UDP port number is 162. (Range:1-65535) filternameSpecifies a string that defines the filter for this host. If unspecified, nothing is filtered. (Range: 1-30 characters) secondsSpecifies the number of seconds to wait for an acknowledgment before resending informs. If unspecified, the default timeout period is 15 seconds. (Range: 1-300) retriesSpecifies the maximum number of times to resend an inform request. If unspecified, the default maximum number of retries is 3. (Range: 0-255)

Default Configuration
This command has no default configuration.

Command Mode
Global Configuration mode

User Guidelines
When configuring an SNMPv1 or SNMPv2 notification recipient, a notification view for that recipient is automatically generated for all the MIB. When configuring an SNMPv1 notification recipient, the Inform option cannot be selected. If a trap and inform are defined on the same target, and an inform was sent, the trap is not sent.

Example
The following example enables SNMP traps for host 10.1.1.1 with community string "management" using SNMPv2. Console(config)# snmp-server host 10.1.1.1 management 2

snmp-server v3-host
The snmp-server v3-host Global Configuration mode command specifies the recipient of Simple Network Management Protocol Version 3 notifications. Use the no form of this command to remove the specified host.

Syntax
snmp-server v3-host {ip-address | hostname} username [traps | informs] {noauth | auth | priv} [udp-port port] [filter filtername] [timeout seconds] [retries retries] no snmp-server host {ip-address | hostname} username [traps | informs]

Page 199

Allied Telesis
Command Line Interface Users Guide

Parameters ip-addressSpecifies the IP address of the host (targeted recipient). hostnameSpecifies the name of the host. (Range:1-158 characters) usernameSpecifies the name of the user to use to generate the notification. (Range: 1-24) trapsIndicates that SNMP traps are sent to this host. informsIndicates that SNMP informs are sent to this host. noauthIndicates no authentication of a packet. authIndicates authentication of a packet without encrypting it. privIndicates authentication of a packet with encryption. portSpecifies the UDP port of the host to use. If unspecified, the default UDP port number is 162.
(Range: 1-65535) filternameSpecifies a string that defines the filter for this host. If unspecified, nothing is filtered. (Range: 1-30 characters) secondsSpecifies the number of seconds to wait for an acknowledgment before resending informs. If unspecified, the default timeout period is 15 seconds. (Range: 1-300) retriesSpecifies the maximum number of times to resend an inform request. If unspecified, the default maximum number of retries is 3. (Range: 0-255)

Default Configuration
This command has no default configuration.

Command Mode
Global Configuration mode

User Guidelines
A user and notification view are not automatically created. Use the snmp-server user, snmp-server group and snmp-server view Global Configuration mode commands to generate a user, group and notify group, respectively.

Example
The following example configures an SNMPv3 host. Console(config)# snmp-server v3-host 192.168.0.20 john noauth

snmp-server trap authentication


The snmp-server trap authentication Global Configuration mode command enables the device to send SNMP traps when authentication fails. Use the no form of this command to disable SNMP failed authentication traps.

Syntax
snmp-server trap authentication no snmp-server trap authentication

Default Configuration
SNMP failed authentication traps are enabled.

Page 200 Not approved by Document Control. For review only.

SNMP Commands

Command Mode
Global Configuration mode

User Guidelines
There are no user guidelines for this command.

Example
The following example enables SNMP failed authentication traps. Console(config)# snmp-server trap authentication

snmp-server contact
The snmp-server contact Global Configuration mode command configures the system contact (sysContact) string. Use the no form of this command to remove system contact information.

Syntax
snmp-server contact text no snmp-server contact

Parameters text Specifies the string that describes system contact information. (Range: 0-160 characters) Default Configuration
This command has no default configuration.

Command Mode
Global Configuration mode

User Guidelines
Do not include spaces in the text string or place text that includes spaces inside quotation marks.

Example
The following example configures the system contact point called ATI_Technical_Support. console(config)# snmp-server contact ATI_Technical_Support

snmp-server location
The snmp-server location Global Configuration mode command configures the system location string. Use the no form of this command to remove the location string.

Syntax
snmp-server location text no snmp-server location

Page 201

Allied Telesis
Command Line Interface Users Guide

Parameters text Specifies a string that describes system location information. (Range: 0-160 characters) Default Configuration
This command has no default configuration.

Command Mode
Global Configuration mode

User Guidelines
Do not include spaces in the text string or place text that includes spaces inside quotation marks.

Example
The following example defines the device location as New_York. Console(config)# snmp-server location New_York

snmp-server set
The snmp-server set Global Configuration mode command defines the SNMP MIB value.

Syntax
snmp-server set variable-name name1 value1 [ name2 value2 ]

Parameters variable-name MIB variable name. name value List of name and value pairs. In the case of scalar MIBs, only a single pair of name values. In
the case of an entry in a table, at least one pair of name and value followed by one or more fields.

Default Configuration
This command has no default configuration.

Command Mode
Global Configuration mode

User Guidelines
Although the CLI can set any required configuration, there might be a situation where a SNMP user sets a MIB variable that does not have an equivalent command. In order to generate configuration files that support those situations, the snmp-server set command is used. This command is case-sensitive.

Example
The following example configures the scalar MIB sysName with the value ati. Console(config)# snmp-server set sysName sysname ati

Page 202 Not approved by Document Control. For review only.

SNMP Commands

show snmp
The show snmp Privileged EXEC mode command displays the SNMP status.

Syntax
show snmp

Default Configuration
This command has no default configuration.

Command Mode
Privileged EXEC mode

User Guidelines
There are no user guidelines for this command.

Example
The following example displays the SNMP communications status. Console# show snmp CommunityString ---------public private private CommunityAccess ---------read only read write su View name --------user-view Default DefaultSuper Group name ---------user-group IP address -------All 172.16.1.1 172.17.1.1 IP address ---------all

Community-string ---------------public Traps are enabled.

Authentication trap is enabled. Version 1,2 notifications Target Address -------------192.122.173.42 192.122.173.42 Type ----Trap Inform Community --------public public Version ------2 2 UDP Port ---162 162 Filter Name -----TO Sec --15 15 Retries ------3 3

Page 203

Allied Telesis
Command Line Interface Users Guide

Version 3 notifications Target Address -------------192.122.173.42 Type ----Inform Username --------Bob Security Level ------Priv UDP Port ---162 Filter Name -----TO Sec --15 Retries ------3

System Contact: Robert System Location: Marketing The following table describes significant fields shown above. Field Community-string Community-access IP Address Trap-Rec-Address Trap-Rec-Community Version Description Community access string to permit access to the SNMP protocol. Type of access - read-only, read-write, super access Management station IP Address. Targeted Recipient Statistics sent with the notification operation. SNMP version for the sent trap 1 or 2.

show snmp engineid


The show snmp engineID Privileged EXEC mode command displays the ID of the local Simple Network Management Protocol (SNMP) engine.

Syntax
show snmp engineID

Default Configuration
This command has no default configuration.

Command Mode
Privileged EXEC mode

User Guidelines
There are no user guidelines for this command.

Example
The following example displays the SNMP engine ID. Console# show snmp engineID Local SNMP engineID: 08009009020C0B099C075878

Page 204 Not approved by Document Control. For review only.

SNMP Commands

show snmp views


The show snmp views Privileged EXEC mode command displays the configuration of views.

Syntax
show snmp views [viewname]

Parameters viewname Specifies the name of the view. (Range: 1-30) Default Configuration
This command has no default configuration.

Command Mode
Privileged EXEC mode

User Guidelines
There are no user guidelines for this command.

Example
The following example displays the configuration of views. Console# show snmp views Name ----------user-view user-view user-view OID Tree ----------------------1.3.6.1.2.1.1 1.3.6.1.2.1.1.7 1.3.6.1.2.1.2.2.1.*.1 Type --------Included Excluded Included

show snmp groups


The show snmp groups Privileged EXEC mode command displays the configuration of groups.

Syntax
show snmp groups [groupname]

Parameters groupnameSpecifies the name of the group. (Range: 1-30) Default Configuration
This command has no default configuration.

Command Mode
Privileged EXEC mode

Page 205

Allied Telesis
Command Line Interface Users Guide

User Guidelines
There are no user guidelines for this command.

Example
The following example displays the configuration of views. Console# show snmp groups Name -------------user-group managers-group managers-group Security Model ----V3 V3 V3 Level ----priv priv priv Read ------Default Default Default Write ------"" Default "" Views Notify ------"" "" ""

The following table describes significant fields shown above. Field Name Security Model Security Level Views Read Description Name of the group. SNMP model in use (v1, v2 or v3). Authentication of a packet with encryption. Applicable only to the SNMP v3 security model. Name of the view that enables only viewing the contents of the agent. If unspecified, all objects except the community-table and SNMPv3 user and access tables are available. Name of the view that enables entering data and managing the contents of the agent. Name of the view that enables specifying an inform or a trap.

Write Notify

show snmp filters


The show snmp filters Privileged EXEC mode command displays the configuration of filters.

Syntax
show snmp filters [filtername]

Parameters filternameSpecifies the name of the filter. (Range: 1-30) Default Configuration
This command has no default configuration.

Command Mode
Privileged EXEC mode

Page 206 Not approved by Document Control. For review only.

SNMP Commands

User Guidelines
There are no user guidelines for this command.

Example
The following example displays the configuration of filters. Console# show snmp filters Name ----------user-filter user-filter user-filter OID Tree ----------------------1.3.6.1.2.1.1 1.3.6.1.2.1.1.7 1.3.6.1.2.1.2.2.1.*.1 Type --------Included Excluded Included

show snmp users


The show snmp users Privileged EXEC mode command displays the configuration of users.

Syntax
show snmp users [username]

Parameters usernameSpecifies the name of the user. (Range: 1-30) Default Configuration
This command has no default configuration.

Command Mode
Privileged EXEC mode

User Guidelines
There are no user guidelines for this command.

Example
The following example displays the configuration of users. Console# show snmp users Name -----John John Group name -----------user-group user-group Auth Method --------md5 md5 08009009020C0B099C075879 Remote -------------------------

Page 207

Allied Telesis
Command Line Interface Users Guide

Chapter 24.Spanning-Tree Commands


spanning-tree
The spanning-tree Global Configuration mode command enables spanning-tree functionality. Use the no form of this command to disable spanning-tree functionality.

Syntax
spanning-tree no spanning-tree

Default Configuration
Spanning-tree is enabled.

Command Modes
Global Configuration mode

User Guidelines
There are no user guidelines for this command.

Example
The following example enables spanning-tree functionality. Console(config)# spanning-tree

spanning-tree mode
The spanning-tree mode Global Configuration mode command configures the spanning-tree protocol. Use the no form of this command to return to the default configuration.

Syntax
spanning-tree mode {stp | rstp| mstp} no spanning-tree mode

Parameters stp Indicates that the Spanning Tree Protocol (STP) is enabled. rstp Indicates that the Rapid Spanning Tree Protocol (RSTP) is enabled. mstp Indicates that the Multiple Spanning Tree Protocol (RSTP) is enabled. Default Configuration
STP is enabled.

Page 208 Not approved by Document Control. For review only.

Spanning-Tree Commands

Command Modes
Global Configuration mode

User Guidelines
In RSTP mode, the device uses STP when the neighbor device uses STP. In MSTP mode, the device uses RSTP when the neighbor device uses RSTP and uses STP when the neighbor device uses STP.

Example
The following example configures the spanning-tree protocol to RSTP. console(config)# spanning-tree mode rstp

spanning-tree forward-time
The spanning-tree forward-time Global Configuration mode command configures the spanning-tree bridge forward time, which is the amount of time a port remains in the listening and learning states before entering the forwarding state. Use the no form of this command to return to the default configuration.

Syntax
spanning-tree forward-time seconds no spanning-tree forward-time

Parameters seconds Time in seconds. (Range: 4 - 30) Default Configuration


The default forwarding time for the IEEE Spanning Tree Protocol (STP) is 15 seconds.

Command Modes
Global Configuration mode

User Guidelines
When configuring the forwarding time, the following relationship should be kept: 2*(Forward-Time - 1) >= Max-Age

Example
The following example configures the spanning tree bridge forwarding time to 25 seconds. Console(config)# spanning-tree forward-time 25

spanning-tree hello-time
The spanning-tree hello-time Global Configuration mode command configures the spanning tree bridge hello time, which is how often the device Broadcasts hello messages to other devices. Use the no form of this command to return to the default configuration.

Page 209

Allied Telesis
Command Line Interface Users Guide

Syntax
spanning-tree hello-time seconds no spanning-tree hello-time

Parameters seconds Time in seconds. (Range: 1 - 10) Default Configuration


The default hello time for IEEE Spanning Tree Protocol (STP) is 2 seconds.

Command Modes
Global Configuration mode

User Guidelines
When configuring the hello time, the following relationship should be kept: Max-Age >= 2*(Hello-Time + 1)

Example
The following example configures spanning tree bridge hello time to 5 seconds. Console(config)# spanning-tree hello-time 5

spanning-tree max-age
The spanning-tree max-age Global Configuration mode command configures the spanning tree bridge maximum age. Use the no form of this command to return to the default configuration.

Syntax
spanning-tree max-age seconds no spanning-tree max-age

Parameters seconds Time in seconds. (Range: 6 - 40) Default Configuration


The default maximum age for IEEE Spanning Tree Protocol (STP) is 20 seconds.

Command Modes
Global Configuration mode

User Guidelines
When configuring the maximum age, the following relationships should be kept: 2*(Forward-Time - 1) >= Max-Age Max-Age >= 2*(Hello-Time + 1)

Page 210 Not approved by Document Control. For review only.

Spanning-Tree Commands

Example
The following example configures the spanning tree bridge maximum-age to 10 seconds. Console(config)# spanning-tree max-age 10

spanning-tree priority
The spanning-tree priority Global Configuration mode command configures the spanning tree priority of the device. The priority value is used to determine which bridge is elected as the root bridge. Use the no form of this command to return to the default configuration.

Syntax
spanning-tree priority priority no spanning-tree priority

Parameters priority Priority of the bridge. (Range: 0 - 61440 in steps of 4096) Default Configuration
The default bridge priority for IEEE Spanning Tree Protocol (STP) is 32768.

Command Modes
Global Configuration mode

User Guidelines
The bridge with the lowest priority is elected as the root bridge.

Example
The following example configures spanning tree priority to 12288. Console(config)# spanning-tree priority 12288

spanning-tree disable
The spanning-tree disable Interface Configuration mode command disables spanning tree on a specific port. Use the no form of this command to enable spanning tree on a port.

Syntax
spanning-tree disable no spanning-tree disable

Default Configuration
Spanning tree is enabled on all ports.

Command Modes
Interface Configuration (Ethernet, port-channel) mode

Page 211

Allied Telesis
Command Line Interface Users Guide

User Guidelines
There are no user guidelines for this command.

Example
The following example disables spanning-tree on Ethernet port 1/e5. Console(config)# interface ethernet 1/e5 Console(config-if)# spanning-tree disable

spanning-tree cost
The spanning-tree cost Interface Configuration mode command configures the spanning tree path cost for a port. Use the no form of this command to return to the default configuration.

Syntax
spanning-tree cost cost no spanning-tree cost

Parameters cost Path cost of the port (Range: 1 - 200,000,000) Default Configuration
Default path cost is determined by port speed and path cost method (long or short) as shown below: Interface Port-channel Gigabit Ethernet (1000 Mbps) Fast Ethernet (100 Mbps) Ethernet (10 Mbps) Long 20,000 20,000 200,000 2,000,000 Short 4 4 19 100

Command Modes
Interface Configuration (Ethernet, port-channel) mode

User Guidelines
The path cost method is configured using the spanning-tree pathcost method Global Configuration mode command.

Example
The following example configures the spanning-tree cost on Ethernet port 1/e15 to 35000. Console(config)# interface ethernet 1/e15 Console(config-if)# spanning-tree cost 35000

Page 212 Not approved by Document Control. For review only.

Spanning-Tree Commands

spanning-tree port-priority
The spanning-tree port-priority Interface Configuration mode command configures port priority. Use the no form of this command to return to the default configuration.

Syntax
spanning-tree port-priority priority no spanning-tree port-priority

Parameters priority The priority of the port. (Range: 0 - 240 in multiples of 16) Default Configuration
The default port priority for IEEE Spanning TreeProtocol (STP) is 128.

Command Modes
Interface Configuration (Ethernet, port-channel) mode

User Guidelines
There are no user guidelines for this command.

Example
The following example configures the spanning priority on Ethernet port 1/e15 to 96. Console(config)# interface ethernet 1/e15 Console(config-if)# spanning-tree port-priority 96

spanning-tree portfast
The spanning-tree portfast Interface Configuration mode command enables PortFast mode. In PortFast mode, the interface is immediately put into the forwarding state upon linkup without waiting for the standard forward time delay. Use the no form of this command to disable PortFast mode.

Syntax
spanning-tree portfast no spanning-tree portfast

Default Configuration
PortFast mode is disabled.

Command Modes
Interface Configuration (Ethernet, port-channel) mode

User Guidelines
This feature should be used only with interfaces connected to end stations. Otherwise, an accidental topology loop could cause a data packet loop and disrupt device and network operations.

Page 213

Allied Telesis
Command Line Interface Users Guide

Example

The following example enables PortFast on Ethernet port 1/e15. Console(config)# interface ethernet 1/e15 Console(config-if)# spanning-tree portfast

spanning-tree link-type
The spanning-tree link-type Interface Configuration mode command overrides the default link-type setting determined by the duplex mode of the port and enables Rapid Spanning Tree Protocol (RSTP) transitions to the forwarding state. Use the no form of this command to return to the default configuration.

Syntax
spanning-tree link-type {point-to-point | shared} no spanning-tree spanning-tree link-type

Parameters point-to-point Indicates that the port link type is point-to-point. shared Indicates that the port link type is shared. Default Configuration
The device derives the port link type from the duplex mode. A full-duplex port is considered a point-to-point link and a half-duplex port is considered a shared link.

Command Modes
Interface Configuration (Ethernet, port-channel) mode

User Guidelines
There are no user guidelines for this command.

Example

The following example enables shared spanning-tree on Ethernet port 1/e5. Console(config)# interface ethernet 1/e15 Console(config-if)# spanning-tree link-type shared

spanning-tree pathcost method


The spanning-tree pathcost method Global Configuration mode command sets the default path cost method. Use the no form of this command to return to the default configuration.

Syntax
spanning-tree pathcost method {long | short} no spanning-tree pathcost method

Page 214 Not approved by Document Control. For review only.

Spanning-Tree Commands

Parameters long Specifies port path costs with a range of 1-200,000,000 . short Specifies port path costs with a range of 0-65,535. Default Configuration
Short path cost method.

Command Mode
Global Configuration mode

User Guidelines
This command applies to all spanning tree instances on the device. The cost is set using the spanning-tree cost command.

Example
The following example sets the default path cost method to long. Console(config)# spanning-tree pathcost method long

spanning-tree bpdu
The spanning-tree bpdu Global Configuration mode command defines BPDU handling when the spanning tree is disabled globally or on a single interface. Use the no form of this command to return to the default configuration.

Syntax
spanning-tree bpdu {filtering | flooding}

Parameters filtering Filter BPDU packets when the spanning tree is disabled on an interface. flooding Flood BPDU packets when the spanning tree is disabled on an interface. Default Configuration
The default setting is flooding.

Command Modes
Global Configuration mode

User Guidelines
There are no user guidelines for this command.

Example

The following example defines BPDU packet flooding when the spanning-tree is disabled on an interface. Console(config)# spanning-tree bpdu flooding

Page 215

Allied Telesis
Command Line Interface Users Guide

spanning-tree guard root


The spanning-tree guard root Interface Configuration (Ethernet, port-channel) mode command enables root guard on all spanning tree instances on the interface. Root guard prevents the interface from becoming the root port of the device. Use the no form of this command to disable root guard on the interface.

Syntax
spanning-tree guard root no spanning-tree guard root

Default Configuration
Root guard is disabled.

Command Mode
Interface Configuration (Ethernet, port-channel) mode

User Guidelines
Root guard can be enabled when the device operates in STP, RSTP and MSTP. When root guard is enabled, the port changes to the alternate state if spanning-tree calculations selects the port as the root port.

Example
eThe following example prevents Ethernet port 1/e1 from being the root port of the device. Console(config) # interface ethernet 1/e1 Console(config-mst) # spanning-tree guard root

spanning-tree bpduguard
The spanning-tree bpduguard Interface Configuration (Ethernet, port-channel) mode command shutsdown an interface when it receives a bridge protocol data unit (BPDU). Use the no form of this command to restore the default configuration.

Syntax
spanning-tree bpduguard no spanning-tree bpduguard

Default Configuration
The default configuration is set to disabled.

Command Mode
Interface Configuration (Ethernet, port-channel) mode

User Guidelines
You can enable the command when the spanning tree is enabled (useful when the port is in the PortFast mode) or disabled.

Page 216 Not approved by Document Control. For review only.

Spanning-Tree Commands

Example
The following example shutsdown an interface when it receives a BPDU.

Console(config)# interface ethernet 1/e1 Console(config-if)# spanning-tree bpduguard

clear spanning-tree detected-protocols


The clear spanning-tree detected-protocols Privileged EXEC mode command restarts the protocol migration process (forces renegotiation with neighboring devices) on all interfaces or on a specified interface.

Syntax
clear spanning-tree detected-protocols [ethernet interface | port-channel port-channel-number]

Parameters interface A valid Ethernet port. port-channel-number A valid port-channel number. Default Configuration
This command has no default configuration.

Command Modes
Privileged EXEC mode

User Guidelines
This feature should be used only when working in RSTP or MSTP mode.

Example
The following example restarts the protocol migration process on Ethernet port 1/e11. Console# clear spanning-tree detected-protocols ethernet 1/e11

spanning-tree mst priority


The spanning-tree mst priority Global Configuration mode command configures the device priority for the specified spanning-tree instance. Use the no form of this command to return to the default configuration.

Syntax
spanning-tree mst instance-id priority priority no spanning-tree mst instance-id priority

Parameters instance -idID of the spanning -tree instance (Range: 1- 7 15). priorityDevice priority for the specified spanning-tree instance (Range: 0-61440 in multiples of 4096).

Page 217

Allied Telesis
Command Line Interface Users Guide

Default Configuration
The default bridge priority for IEEE Spanning Tree Protocol (STP) is 32768.

Command Mode
Global Configuration mode

User Guidelines The device with the lowest priority is selected as the root of the spanning tree.
Example The following example configures the spanning tree priority of instance 1 to 4096. Console (config) # spanning-tree mst 1 priority 4096

spanning-tree mst max-hops


The spanning-tree mst priority Global Configuration mode command configures the number of hops in an MST region before the BDPU is discarded and the port information is aged out. Use the no form of this command to return to the default configuration.

Syntax
spanning-tree mst max-hops hop-count no spanning-tree mst max-hops

Parameters hop-countNumber of hops in an MST region before the BDPU is discarded .(Range: 1-40) Default Configuration
The default number of hops is 20.

Command Mode
Global Configuration mode

User Guidelines
There are no user guidelines for this command.

Example
The following example configures the maximum number of hops that a packet travels in an MST region before it is discarded to 10. Console (config) # spanning-tree mst max-hops 10

spanning-tree mst port-priority


The spanning-tree mst port-priority Interface Configuration mode command configures port priority for the specified MST instance. Use the no form of this command to return to the default configuration.

Page 218 Not approved by Document Control. For review only.

Spanning-Tree Commands

Syntax
spanning-tree mst instance-id port-priority priority no spanning-tree mst instance-id port-priority

Parameters instance-IDID of the spanning tree instance. (Range: 1- 715) priorityThe port priority. (Range: 0 - 240 in multiples of 16) Default Configuration
The default port priority for IEEE Multiple Spanning Tree Protocol (MSTP) is 128.

Command Modes
Interface Configuration (Ethernet, port-channel) mode

User Guidelines
There are no user guidelines for this command.

Example
The following example configures the port priority of port g1 to 142. Console(config)# interface ethernet g1 Console(config-if)# spanning-tree mst 1 port-priority 142

spanning-tree mst cost


The spanning-tree mst cost Interface Configuration mode command configures the path cost for multiple spanning tree (MST) calculations. If a loop occurs, the spanning tree considers path cost when selecting an interface to put in the forwarding state. Use the no form of this command to return to the default configuration.

Syntax
spanning-tree mst instance-id cost cost no spanning-tree mst instance-id cost

Parameters instance-IDID of the spanning -tree instance (Range: 1- 715). costThe port path cost. (Range: 1 - 200,000,000) Default Configuration
Default path cost is determined by port speed and path cost method (long or short) as shown below: Interface Port-channel Gigabit Ethernet(1000 Mbps) Long 20,000 20,000 Short 4 4

Page 219

Allied Telesis
Command Line Interface Users Guide

Fast Ethernet (100 Mbps) Ethernet (10 Mbps)

200,000 2,000,000

19 100

Command Modes
Interface Configuration (Ethernet, port-channel) mode

User Guidelines
There are no user guidelines for this command.

Example
The following example configures the MSTP instance 1 path cost for Ethernet port 1/e9 to 4. Console(config) # interface ethernet 1/e9 Console(config-if) # spanning-tree mst 1 cost 4

spanning-tree mst configuration


The spanning-tree mst configuration Global Configuration mode command enables configuring an MST region by entering the Multiple Spanning Tree (MST) mode.

Syntax
spanning-tree mst configuration

Default Configuration
This command has no default configuration.

Command Mode
Global Configuration mode

User Guidelines
All devices in an MST region must have the same VLAN mapping, configuration revision number and name.

Example
The following example configures an MST region. Console(config)# spanning-tree mst configuration Console(config-mst) # instance 1 add vlan 10-20 Console(config-mst) # name region1 Console(config-mst) # revision 1

instance (mst)
The instance MST Configuration mode command maps VLANS to an MST instance.

Page 220 Not approved by Document Control. For review only.

Spanning-Tree Commands

Syntax
instance instance-id {add | remove} vlan vlan-range

Parameters instance-IDID of the MST instance (Range: 1-15). vlan-rangeVLANs to be added to or removed from the specified MST instance. To specify a range of
VLANs, use a hyphen. To specify a series of VLANs, use a comma. (Range: 1-4094).

Default Configuration
VLANs are mapped to the common and internal spanning tree (CIST) instance (instance 0).

Command Modes
MST Configuration mode

User Guidelines
All VLANs that are not explicitly mapped to an MST instance are mapped to the common and internal spanning tree (CIST) instance (instance 0) and cannot be unmapped from the CIST. For two or more devices to be in the same MST region, they must have the same VLAN mapping, the same configuration revision number, and the same name.

Example
The following example maps VLANs 10-20 to MST instance 1. Console(config)# spanning-tree mst configuration Console(config-mst)# instance 1 add vlan 10-20

name (mst)
The name MST Configuration mode command defines the configuration name. Use the no form of this command to return to the default setting.

Syntax
name string no name

Parameters stringMST configuration name. Case-sensitive (Range: 1-32 characters). Default Configuration
The default name is a bridge ID.

Command Mode
MST Configuration mode

Page 221

Allied Telesis
Command Line Interface Users Guide

User Guidelines
There are no user guidelines for this command.

Example
The following example defines the configuration name as region1. Console(config) # spanning-tree mst configuration Console(config-mst) # name region 1

revision (mst)
The revision MST configuration command defines the configuration revision number. Use the no form of this command to return to the default configuration.

Syntax
revision value no revision

Parameters valueConfiguration revision number (Range: 0-65535). Default Configuration


The default configuration revision number is 0.

Command Mode
MST Configuration mode

User Guidelines
There are no user guidelines for this command.

Example
The following example sets the configuration revision to 1. Console(config) # spanning-tree mst configuration Console(config-mst) # revision 1

show (mst)
The show MST Configuration mode command displays the current or pending MST region configuration.

Syntax
show {current | pending}

Parameters currentIndicates the current region configuration. pendingIndicates the pending region configuration.

Page 222 Not approved by Document Control. For review only.

Spanning-Tree Commands

Default Configuration
This command has no default configuration.

Command Mode
MST Configuration mode

User Guidelines
The pending MST region configuration takes effect only after entering the MST configuration mode.

Example
The following example displays a pending MST region configuration. Console(config-mst)# show pending Pending MST configuration Name: Region1 Revision: 1 Instance -------0 1 Vlans Mapped -----------1-9,21-4094 10-20 State ------Enabled Enabled

exit (mst)
The exit MST Configuration mode command exits the MST configuration mode and applies all configuration changes.

Syntax
exit

Default Configuration
This command has no default configuration.

Command Mode
MST Configuration mode

User Guidelines
There are no user guidelines for this command.

Example
The following example exits the MST configuration mode and saves changes. Console(config) # spanning-tree mst configuration Console(config-mst) # exit

Page 223

Allied Telesis
Command Line Interface Users Guide

abort (mst)
The abort MST Configuration mode command exits the MST configuration mode without applying the configuration changes.

Syntax
abort

Default Configuration
This command has no default configuration.

Command Mode
MST Configuration mode

User Guidelines
There are no user guidelines for this command.

Example
The following example exits the MST configuration mode without saving changes. Console(config) # spanning-tree mst configuration Console(config-mst) # abort

show spanning-tree
The show spanning-tree Privileged EXEC mode command shows spanning tree configuration.

Syntax
show spanning-tree [ethernet interface -number| port-channel port-channel-number] [instance instance-id] show spanning-tree [detail] [active | blockedports] [instance instance-id] show spanning-tree mst-configuration

Parameters detail Display detailed information. active Display active ports only. blockedports Display blocked ports only. mst-configuration Display the MST configuration identifier. interface-number Ethernet port number. port-channel-number Port channel index. instance-id ID associated with a spanning-tree instance. Default Configuration
This command has no default configuration.

Page 224 Not approved by Document Control. For review only.

Spanning-Tree Commands

Command Modes
Privileged EXEC mode

User Guidelines
There are no user guidelines for this command.

Examples
The following examples displays spanning-tree information. Console# show spanning-tree Spanning tree enabled mode RSTP Default port cost method: long Root ID Priority Address Path Cost Root Port Hello Time 2 sec Bridge ID Priority Address Hello Time 2 sec Interfaces Name ---1/1 1/2 1/3 1/4 1/5 State ------Enabled Enabled Disabled Enabled Enabled Prio.Nbr -------128.1 128.2 128.3 128.4 128.5 Cost ----20000 20000 20000 20000 20000 Sts --FWD FWD BLK DIS Role ---Root Desg ALTN PortFast -------No No No Type ---------P2p (RSTP) Shared (STP) eShared (STP) 32768 00:01:42:97:e0:00 20000 1 (1/e1) Max Age 20 sec 36864 00:02:4b:29:7a:00 Max Age 20 sec Forward Delay 15 sec Forward Delay 15 sec

Page 225

Allied Telesis
Command Line Interface Users Guide

Console# show spanning-tree Spanning tree enabled mode RSTP Default port cost method: long Root ID Priority Address Hello Time 2 sec Interfaces Name ---1/1 1/2 1/3 1/4 1/5 State ------Enabled Enabled Disabled Enabled Enabled Prio.Nbr -------128.1 128.2 128.3 128.4 128.5 Cost ----20000 20000 20000 20000 20000 Sts --FWD FWD FWD DIS Role ---Desg Desg Desg PortFast -------No No No Type ---------P2p (RSTP) Shared (STP) Shared (STP) 36864 00:02:4b:29:7a:00 Max Age 20 sec Forward Delay 15 sec

This switch is the root.

Console# show spanning-tree Spanning tree disabled (BPDU filtering) mode RSTP Default port cost method: long Root ID Priority Address Path Cost Root Port Hello Time N/A Bridge ID Priority Address Hello Time 2 sec Interfaces Name ---1/1 State ------Enabled Prio.Nbr -------128.1 Cost ----20000 Sts --Role ---PortFast -------Type ---N/A N/A N/A N/A Max Age N/A 36864 00:02:4b:29:7a:00 Max Age 20 sec Forward Delay 15 sec Forward Delay N/A

Page 226 Not approved by Document Control. For review only.

Spanning-Tree Commands

1/2 1/3 1/4 1/5

Enabled Disabled Enabled Enabled

128.2 128.3 128.4 128.5

20000 20000 20000 20000

Console# show spanning-tree active Spanning tree enabled mode RSTP Default port cost method: long Root ID Priority Address Path Cost Root Port Hello Time 2 sec Bridge ID Priority Address Hello Time 2 sec Interfaces Name ---1/1 1/2 1/4 State ------Enabled Enabled Enabled Prio.Nbr -------128.1 128.2 128.4 Cost ----20000 20000 20000 Sts --FWD FWD BLK Role ---Root Desg ALTN PortFast -------No No No Type ---------P2p (RSTP) Shared (STP) Shared (STP) 32768 00:01:42:97:e0:00 20000 1 (1/e1) Max Age 20 sec 36864 00:02:4b:29:7a:00 Max Age 20 sec Forward Delay 15 sec Forward Delay 15 sec

Console# show spanning-tree blockedports Spanning tree enabled mode RSTP Default port cost method: long Root ID Priority Address Path Cost Root Port Hello Time 2 sec 32768 00:01:42:97:e0:00 20000 1 (1/1) Max Age 20 sec Forward Delay 15 sec

Page 227

Allied Telesis
Command Line Interface Users Guide

Bridge ID

Priority Address Hello Time 2 sec

36864 00:02:4b:29:7a:00 Max Age 20 sec Forward Delay 15 sec

Interfaces Name ---1/4 State ------Enabled Prio.Nbr -------128.4 Cost ----19 Sts --BLK Role ---ALTN PortFast -------No Type ---------Shared (STP)

Console# show spanning-tree detail Spanning tree enabled mode RSTP Default port cost method: long Root ID Priority Address Path Cost Root Port Hello Time 2 sec Bridge ID Priority Address Hello Time 2 sec 36864 00:02:4b:29:7a:00 Max Age 20 sec Forward Delay 15 sec 32768 00:01:42:97:e0:00 20000 1 (1/e1) Max Age 20 sec Forward Delay 15 sec

Number of topology changes 2 last change occurred 2d18h ago Times: hold 1, topology change 35, notification 2 hello 2, max age 20, forward delay 15 Port 1 (1/e1) enabled State: Forwarding Port id: 128.1 Type: P2p (configured: auto) RSTP Designated bridge Priority: 32768 Designated port id: 128.25 Number of transitions to forwarding state: 1 BPDU: sent 2, received 120638 Role: Root Port cost: 20000 Port Fast: No (configured:no) Address: 00:01:42:97:e0:00 Designated path cost: 0

Page 228 Not approved by Document Control. For review only.

Spanning-Tree Commands

Port 2 (1/2) enabled State: Forwarding Port id: 128.2 Type: Shared (configured: auto) STP Designated bridge Priority: 32768 Designated port id: 128.2 Number of transitions to forwarding state: 1 BPDU: sent 2, received 170638 Port 3 (1/3) disabled State: N/A Port id: 128.3 Type: N/A (configured: auto) Designated bridge Priority: N/A Designated port id: N/A Number of transitions to forwarding state: N/A BPDU: sent N/A, received N/A Port 4 (1/4) enabled State: Blocking Port id: 128.4 Type: Shared (configured:auto) STP Designated bridge Priority: 28672 Designated port id: 128.25 Guard Root: Disabled Number of transitions to forwarding state: 1 BPDU: sent 2, received 120638 Port 5 (1/5) enabled State: Disabled Port id: 128.5 Type: N/A (configured: auto) Designated bridge Priority: N/A Designated port id: N/A Number of transitions to forwarding state: N/A BPDU: sent N/A, received N/A Role: N/A Port cost: 20000 Port Fast: N/A (configured:no) Address: N/A Designated path cost: N/A Role: Alternate Port cost: 20000 Port Fast: No (configured:no) Address: 00:30:94:41:62:c8 Designated path cost: 20000 BPDU Guard:Disabled Role: N/A Port cost: 20000 Port Fast: N/A (configured:no) Address: N/A Designated path cost: N/A Role: Designated Port cost: 20000 Port Fast: No (configured:no) Address: 00:02:4b:29:7a:00 Designated path cost: 20000

Page 229

Allied Telesis
Command Line Interface Users Guide

Console# show spanning-tree ethernet 1/e1 Port 1 (1/e1) enabled State: Forwarding Port id: 128.1 Type: P2p (configured: auto) RSTP Designated bridge Priority: 32768 Designated port id: 128.25 Number of transitions to forwarding state: 1 BPDU: sent 2, received 120638 Console# show spanning-tree mst-configuration Name: Region1 Revision: 1 Instance -------0 1 Vlans mapped -----------1-9, 21-4094 10-20 State ------Enabled Enabled Role: Root Port cost: 20000 Port Fast: No (configured:no) Address: 00:01:42:97:e0:00 Designated path cost: 0

Console# show spanning-tree Spanning tree enabled mode MSTP Default port cost method: long ###### MST 0 Vlans Mapped: 1-9, CST Root ID Priority Address Path Cost Root Port 32768 00:01:42:97:e0:00 20000 1 (1/e1) Max Age 20 sec Forward Delay 15 sec

Hello Time 2 sec IST Master ID Priority Address 32768

00:02:4b:29:7a:00 Max Age 20 sec Forward Delay 15 sec

This switch is the IST master. Hello Time 2 sec Max hops Interfaces 20

Page 230 Not approved by Document Control. For review only.

Spanning-Tree Commands

Name ---1/1 1/2 1/3 1/4

State ------Enabled Enabled Enabled Enabled

Prio.Nbr -------128.1 128.2 128.3 128.4

Cost ----20000 20000 20000 20000

Sts --FWD FWD FWD FWD

Role ---Root Desg Desg Desg

PortFast -------No No No No

Type ---------P2p Bound (RSTP) Shared Bound (STP) P2p P2p

###### MST 1 Vlans Mapped: 10-20 CST Root ID Priority Address Path Cost Root Port Rem hops Bridge ID Priority Address Interfaces Name ---1/1 1/2 1/3 1/4 State ------Enabled Enabled Enabled Enabled Prio.Nbr -------128.1 128.2 128.3 128.4 Cost ----20000 20000 20000 20000 Sts --FWD FWD BLK FWD Role ---Boun Boun Altn Desg PortFast -------No No No No Type ---------P2p Bound (RSTP) Shared Bound (STP) P2p P2p 24576 00:02:4b:29:89:76 20000 4 (1/4) 19 32768 00:02:4b:29:7a:00

Console# show spanning-tree detail Spanning tree enabled mode MSTP Default port cost method: long ###### MST 0 Vlans Mapped: 1-9, 21-4094 CST Root ID Priority Address Path Cost Root Port 32768 00:01:42:97:e0:00 20000 1 (1/1)

Page 231

Allied Telesis
Command Line Interface Users Guide

Hello Time 2 sec IST Master ID Priority Address 32768

Max Age 20 sec

Forward Delay 15 sec

00:02:4b:29:7a:00 Max Age 20 sec Forward Delay 15 sec

This switch is the IST master. Hello Time 2 sec Max hops 20

Number of topology changes 2 last change occurred 2d18h ago Times: hold 1, topology change 35, notification 2 hello 2, max age 20, forward delay 15 Port 1 (1/e1) enabled State: Forwarding Port id: 128.1 Type: P2p (configured: auto) Boundary RSTP Designated bridge Priority: 32768 Designated port id: 128.25 Number of transitions to forwarding state: 1 BPDU: sent 2, received 120638 Port 2 (1/e2) enabled State: Forwarding Port id: 128.2 Type: Shared (configured: auto) Boundary STP Designated bridge Priority: 32768 Designated port id: 128.2 Number of transitions to forwarding state: 1 BPDU: sent 2, received 170638 Port 3 (1/3) enabled State: Forwarding Port id: 128.3 Type: Shared (configured: auto) Internal Designated bridge Priority: 32768 Designated port id: 128.3 Number of transitions to forwarding state: 1 BPDU: sent 2, received 170638 Role: Designated Port cost: 20000 Port Fast: No (configured:no) Address: 00:02:4b:29:7a:00 Designated path cost: 20000 Role: Designated Port cost: 20000 Port Fast: No (configured:no) Address: 00:02:4b:29:7a:00 Designated path cost: 20000 Role: Root Port cost: 20000 Port Fast: No (configured:no) Address: 00:01:42:97:e0:00 Designated path cost: 0

Page 232 Not approved by Document Control. For review only.

Spanning-Tree Commands

Port 4 (1/4) enabled State: Forwarding Port id: 128.4 Type: Shared (configured: auto) Internal Designated bridge Priority: 32768 Designated port id: 128.2 Guard Root: Disabled Number of transitions to forwarding state: 1 BPDU: sent 2, received 170638 ###### MST 1 Vlans Mapped: 10-20 Root ID Priority Address Path Cost Port Cost Rem hops Bridge ID Priority Address 24576 00:02:4b:29:89:76 20000 4 (1/4) 19 32768 00:02:4b:29:7a:00 Role: Designated Port cost: 20000 Port Fast: No (configured:no) Address: 00:02:4b:29:7a:00 Designated cost: 20000 BPDU Guard: Disabled

Number of topology changes 2 last change occurred 1d9h ago Times: hold 1, topology change 2, notification 2 hello 2, max age 20, forward delay 15 Port 1 (1/1) enabled State: Forwarding Port id: 128.1 Type: P2p (configured: auto) Boundary RSTP Designated bridge Priority: 32768 Designated port id: 128.1 Guard Root: Disabled Number of transitions to forwarding state: 1 BPDU: sent 2, received 120638 Port 2 (1/2) enabled State: Forwarding Port id: 128.2 Type: Shared (configured: auto) Boundary STP Designated bridge Priority: 32768 Role: Designated Port cost: 20000 Port Fast: No (configured:no) Address: 00:02:4b:29:7a:00 Role: Boundary Port cost: 20000 Port Fast: No (configured:no) Address: 00:02:4b:29:7a:00 Designated path cost: 20000 BPDU Guard: Disabled

Page 233

Allied Telesis
Command Line Interface Users Guide

Designated port id: 128.2 Guard Root: Disabled Number of transitions to forwarding state: 1 BPDU: sent 2, received 170638 Port 3 (1/3) disabled State: Blocking Port id: 128.3 Type: Shared (configured: auto) Internal Designated bridge Priority: 32768 Designated port id: 128.78 Guard Root: Disabled Number of transitions to forwarding state: 1 BPDU: sent 2, received 170638 Port 4 (1/4) enabled State: Forwarding Port id: 128.4 Type: Shared (configured: auto) Internal Designated bridge Priority: 32768 Designated port id: 128.2 Guard Root: Disabled Number of transitions to forwarding state: 1 BPDU: sent 2, received 170638 Console# show spanning-tree Spanning tree enabled mode MSTP Default port cost method: long ###### MST 0 Vlans Mapped: 1-9 CST Root ID Priority Address Path Cost Root Port 32768 00:01:42:97:e0:00 20000 1 (1/1)

Designated cost: 20000 BPDU Guard: Disabled

Role: Alternate Port cost: 20000 Port Fast: No (configured:no) Address: 00:02:4b:29:1a:19 Designated cost: 20000 BPDU Guard: Disabled

Role: Designated Port cost: 20000 Port Fast: No (configured:no) Address: 00:02:4b:29:7a:00 Designated cost: 20000 BPDU Guard: Disabled

Hello Time 2 sec IST Master ID Priority 32768

Max Age 20 sec

Forward Delay 15 sec

Page 234 Not approved by Document Control. For review only.

Spanning-Tree Commands

Address Path Cost Rem hops Bridge ID Priority Address Max hops Console# show spanning-tree Spanning tree enabled mode MSTP Default port cost method: long ###### MST 0 Vlans Mapped: 1-9 CST Root ID Priority Address

00:02:4b:19:7a:00 10000 19 32768 00:02:4b:29:7a:00 Max Age 20 sec Forward Delay 15 sec 20

Hello Time 2 sec

32768 00:01:42:97:e0:00 Max Age 20 sec Forward Delay 15 sec

This switch is root for CST and IST master. Hello Time 2 sec Max hops 20

Page 235

Allied Telesis
Command Line Interface Users Guide

Chapter 25.SSH Commands


ip ssh port
The ip ssh port Global Configuration mode command specifies the port to be used by the SSH server. Use the no form of this command to return to the default configuration.

Syntax
ip ssh port port-number no ip ssh port

Parameters port-number Port number for use by the SSH server (Range: 1 - 65535). Default Configuration
The default port number is 22.

Command Mode
Global Configuration mode

User Guidelines
There are no user guidelines for this command.

Example
The following example specifies the port to be used by the SSH server as 8080. Console(config)# ip ssh port 8080

ip ssh server
The ip ssh server Global Configuration mode command enables the device to be configured from a SSH server. Use the no form of this command to disable this function.

Syntax
ip ssh server no ip ssh server

Default Configuration
Device configuration from a SSH server is enabled.

Command Mode
Global Configuration mode

Page 236 Not approved by Document Control. For review only.

SSH Commands

User Guidelines
If encryption keys are not generated, the SSH server is in standby until the keys are generated. To generate SSH server keys, use the crypto key generate dsa, and crypto key generate rsa Global Configuration mode commands.

Example
The following example enables configuring the device from a SSH server. Console(config)# ip ssh server

crypto key generate dsa


The crypto key generate dsa Global Configuration mode command generates DSA key pairs.

Syntax
crypto key generate dsa

Default Configuration
DSA key pairs do not exist.

Command Mode
Global Configuration mode

User Guidelines
DSA keys are generated in pairs: one public DSA key and one private DSA key. If the device already has DSA keys, a warning and prompt to replace the existing keys with new keys are displayed. This command is not saved in the device configuration; however, the keys generated by this command are saved in the private configuration, which is never displayed to the user or backed up on another device. DSA keys are saved to the backup master. This command may take a considerable period of time to execute.

Example
The following example generates DSA key pairs. Console(config)# crypto key generate dsa

crypto key generate rsa


The crypto key generate rsa Global Configuration mode command generates RSA key pairs.

Syntax
crypto key generate rsa

Default Configuration
RSA key pairs do not exist.

Page 237

Allied Telesis
Command Line Interface Users Guide

Command Mode
Global Configuration mode

User Guidelines
RSA keys are generated in pairs: one public RSA key and one private RSA key. If the device already has RSA keys, a warning and prompt to replace the existing keys with new keys are displayed. This command is not saved in the device configuration; however, the keys generated by this command are saved in the private configuration which is never displayed to the user or backed up on another device. RSA keys are saved to the backup master. This command may take a considerable period of time to execute.

Example
The following example generates RSA key pairs. Console(config)# crypto key generate rsa

ip ssh pubkey-auth
The ip ssh pubkey-auth Global Configuration mode command enables public key authentication for incoming SSH sessions. Use the no form of this command to disable this function.

Syntax
ip ssh pubkey-auth no ip ssh pubkey-auth

Default Configuration
Public Key authentication for incoming SSH sessions is disabled.

Command Mode
Global Configuration mode

User Guidelines
AAA authentication is independent

Example
The following example enables public key authentication for incoming SSH sessions. Console(config)# ip ssh pubkey-auth

crypto key pubkey-chain ssh


The crypto key pubkey-chain ssh Global Configuration mode command enters the SSH Public Key-chain Configuration mode. The mode is used to manually specify other device public keys such as SSH client public keys.

Page 238 Not approved by Document Control. For review only.

SSH Commands

Syntax
crypto key pubkey-chain ssh

Default Configuration
No keys are specified.

Command Mode
Global Configuration mode

User Guidelines
There are no user guidelines for this command.

Example
The following example enters the SSH Public Key-chain Configuration mode and manually configures the RSA key pair for SSH public key-chain bob. Console(config)# crypto key pubkey-chain ssh Console(config-pubkey-chain)# user-key bob Console(config-pubkey-key)# key-string rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCvTnRwPWl Al4kpqIw9GBRonZQZxjHKcqKL6rMlQ+ ZNXfZSkvHG+QusIZ/76ILmFT34v7u7ChFAE+ Vu4GRfpSwoQUvV35LqJJk67IOU/zfwOl1g kTwml75QR9gHujS6KwGN2QWXgh3ub8gDjTSq muSn/Wd05iDX2IExQWu08licglk02LYciz +Z4TrEU/9FJxwPiVQOjc+KBXuR0juNg5nFYsY 0ZCk0N/W9a/tnkm1shRE7Di71+w3fNiOA 6w9o44t6+AINEICBCCA4YcF6zMzaT1wefWwX6f+ Rmt5nhhqdAtN/4oJfce166DqVX1gWmN zNR4DYDvSzg0lDnwCAC8Qh Fingerprint: a4:16:46:23:5a:8d:1d:b5:37:59:eb:44:13:b9:33:e9

user-key
The user-key SSH Public Key-string Configuration mode command specifies which SSH public key is manually configured. Use the no form of this command to remove an SSH public key.

Syntax
user-key username {rsa | dsa} no user-key username

Page 239

Allied Telesis
Command Line Interface Users Guide

Parameters username Specifies the username of the remote SSH client. (Range: 1-48 characters) rsa Indicates the RSA key pair. dsa Indicates the DSA key pair. Default Configuration
No SSH public keys exist.

Command Mode
SSH Public Key-string Configuration mode

User Guidelines
Follow this command with the key-string SSH Public Key-String Configuration mode command to specify the key.

Example
The following example enables manually configuring an SSH public key for SSH public key-chain bob. Console(config)# crypto key pubkey-chain ssh Console(config-pubkey-chain)# user-key bob rsa Console(config-pubkey-key)# key-string row AAAAB3NzaC1yc2EAAAADAQABAAABAQCvTnRwPWl

key-string
The key-string SSH Public Key-string Configuration mode command manually specifies an SSH public key.

Syntax
key-string key-string row key-string

Parameters row Indicates the SSH public key row by row. key-stringSpecifies the key in UU-encoded DER format; UU-encoded DER format is the same format in the
authorized_keys file used by OpenSSH.

Default Configuration
No keys exist.

Command Mode
SSH Public Key-string Configuration mode

User Guidelines
Use the key-string SSH Public Key-string Configuration mode command to specify which SSH public key is to be interactively configured next. To complete the command, you must enter a row with no characters.

Page 240 Not approved by Document Control. For review only.

SSH Commands

Use the key-string row SSH Public Key-string Configuration mode command to specify the SSH public key row by row. Each row must begin with a key-string row command. This command is useful for configuration files.

Example
The following example enters public key strings for SSH public key client bob. Console(config)# crypto key pubkey-chain ssh Console(config-pubkey-chain)# user-key bob rsa Console(config-pubkey-key)# key-string AAAAB3NzaC1yc2EAAAADAQABAAABAQCvTnRwPWl Al4kpqIw9GBRonZQZxjHKcqKL6rMlQ+ ZNXfZSkvHG+QusIZ/76ILmFT34v7u7ChFAE+ Vu4GRfpSwoQUvV35LqJJk67IOU/zfwOl1g kTwml75QR9gHujS6KwGN2QWXgh3ub8gDjTSq muSn/Wd05iDX2IExQWu08licglk02LYciz +Z4TrEU/9FJxwPiVQOjc+KBXuR0juNg5nFYsY 0ZCk0N/W9a/tnkm1shRE7Di71+w3fNiOA 6w9o44t6+AINEICBCCA4YcF6zMzaT1wefWwX6f+ Rmt5nhhqdAtN/4oJfce166DqVX1gWmN zNR4DYDvSzg0lDnwCAC8Qh Fingerprint: a4:16:46:23:5a:8d:1d:b5:37:59:eb:44:13:b9:33:e9 Console(config)# crypto key pubkey-chain ssh Console(config-pubkey-chain)# user-key bob rsa Console(config-pubkey-key)# key-string row AAAAB3Nza Console(config-pubkey-key)# key-string row C1yc2

show ip ssh
The show ip ssh Privileged EXEC mode command displays the SSH server configuration.

Syntax
show ip ssh

Default Configuration
This command has no default configuration.

Command Mode
Privileged EXEC mode

User Guidelines
There are no user guidelines for this command.

Page 241

Allied Telesis
Command Line Interface Users Guide

Example
The following example displays the SSH server configuration. Console# show ip ssh SSH server enabled. Port: 22 RSA key was generated. DSA (DSS) key was generated. SSH Public Key Authentication is enabled. Active incoming sessions: IP address ---------172.16.0.1 SSH username -----------John Brown Version --------2.0 3 Cipher ------DES Auth Code ---------HMAC-SHA1

The following table describes significant fields shown above: Field IP address SSH username Version Cipher Auth Code D escr ip tio n Client address User name SSH version number Encryption type (3DES, Blowfish, RC4) Authentication Code (HMAC-MD5, HMAC-SHA1)

show crypto key mypubkey


The show crypto key mypubkey Privileged EXEC mode command displays the SSH public keys on the device.

Syntax
show crypto key mypubkey [rsa | dsa]

Parameters rsa Indicates the RSA key. dsa Indicates the DSA key. Default Configuration
This command has no default configuration.

Command Mode
Privileged EXEC mode

User Guidelines
There are no user guidelines for this command.

Page 242 Not approved by Document Control. For review only.

SSH Commands

Example
The following example displays the SSH public RSA keys on the device. Console# show crypto key mypubkey rsa RSA key data: 005C300D 06092A86 4886F70D 01010105 00034B00 30480241 00C5E23B 55D6AB22 04AEF1BA A54028A6 9ACC01C5 129D99E4 64CAB820 847EDAD9 DF0B4E4C 73A05DD2 BD62A8A9 FA603DD2 E2A8A6F8 98F76E28 D58AD221 B583D7A4 71020301 87685768 Fingerprint(Hex): 77:C7:19:85:98:19:27:96:C9:CC:83:C5:78:89:F8:86 Fingerprint(Bubble Babble): yteriuwt jgkljhglk yewiury hdskjfryt gfhkjglk

show crypto key pubkey-chain ssh


The show crypto key pubkey-chain ssh Privileged EXEC mode command displays SSH public keys stored on the device.

Syntax
show crypto key pubkey-chain ssh [username username] [fingerprint {bubble-babble | hex}]

Parameters username Specifies the remote SSH client username. bubble-babble Fingerprint in Bubble Babble format. hex Fingerprint in Hex format. Default Configuration
This command has no default configuration.

Command Mode
Privileged EXEC mode

User Guidelines
There are no user guidelines for this command.

Example
The following example displays SSH public keys stored on the device. Console# show crypto key pubkey-chain ssh Username -------bob john Fingerprint ----------------------------------------------9A:CC:01:C5:78:39:27:86:79:CC:23:C5:98:59:F1:86 98:F7:6E:28:F2:79:87:C8:18:F8:88:CC:F8:89:87:C8

Console# show crypto key pubkey-chain ssh username bob Username: bob

Page 243

Allied Telesis
Command Line Interface Users Guide

Key: 005C300D 06092A86 4886F70D 01010105 00034B00 30480241 00C5E23B 55D6AB22 04AEF1BA A54028A6 9ACC01C5 129D99E4 Fingerprint: 9A:CC:01:C5:78:39:27:86:79:CC:23:C5:98:59:F1:86

Page 244 Not approved by Document Control. For review only.

Syslog Commands

Chapter 26.Syslog Commands


logging on
The logging on Global Configuration mode command controls error message logging. This command sends debug or error messages to a logging process, which logs messages to designated locations asynchronously to the process that generated the messages. Use the no form of this command to disable the logging process.

Syntax
logging on no logging on

Default Configuration
Logging is enabled.

Command Mode
Global Configuration mode

User Guidelines
The logging process controls the distribution of logging messages at various destinations, such as the logging buffer, logging file or syslog server. Logging on and off at these destinations can be individually configured using the logging buffered, logging file, and logging Global Configuration mode commands. However, if the logging on command is disabled, no messages are sent to these destinations. Only the console receives messages.

Example
The following example enables logging error messages. Console(config)# logging on

logging
The logging Global Configuration mode command logs messages to a syslog server. Use the no form of this command to delete the syslog server with the specified address from the list of syslogs.

Syntax
logging {ip-address | hostname} [port port] [severity level] [facility facility] [description text] no logging {ip-address | hostname}

Page 245

Allied Telesis
Command Line Interface Users Guide

Parameters ip-address IP address of the host to be used as a syslog server. hostname Specifies the host name of the syslog server. (Range: 1-158 characters) port Specifies the port number for syslog messages. (Range: 1 - 65535) level Specifies the severity level of logged messages sent to the syslog servers. Possible values:
emergencies, alerts, critical, errors, warnings, notifications, informational and debugging. facility Specifies the facility that is indicated in the message. Possible values: local0, local1, local2, local3, local4, local5, local 6, local7. text Syslog server description. (Range: 1-64 characters)

Default Configuration
The default port number is 514. The default logging message level is informational. The default facility is local7.

Command Mode
Global Configuration mode

User Guidelines
Up to 8 syslog servers can be used. If no specific severity level is specified, the global values apply to each server.

Example
The following example limits logged messages sent to the syslog server with IP address 10.1.1.1 to severity level critical. Console(config)# logging 10.1.1.1 severity critical

logging console
The logging console Global Configuration mode command limits messages logged to the console based on severity. Use the no form of this command to disable logging to the console.

Syntax
logging console level no logging console

Parameters level Specifies the severity level of logged messages displayed on the console. Possible values:
emergencies, alerts, critical, errors, warnings, notifications, informational, debugging.

Default Configuration
The default severity level is informational.

Page 246 Not approved by Document Control. For review only.

Syslog Commands

Command Mode
Global Configuration mode

User Guidelines
There are no user guidelines for this command.

Example
The following example limits logging messages displayed on the console to severity level errors. Console(config)# logging console errors

logging buffered
The logging buffered Global Configuration mode command limits syslog messages displayed from an internal buffer based on severity. Use the no form of this command to cancel using the buffer.

Syntax
logging buffered level no logging buffered

Parameters level Specifies the severity level of messages logged in the buffer. Possible values: emergencies, alerts,
critical, errors, warnings, notifications, informational, debugging.

Default Configuration
The default severity level is informational.

Command Mode
Global Configuration mode

User Guidelines
All the syslog messages are logged to the internal buffer. This command limits the messages displayed to the user.

Example
The following example limits syslog messages displayed from an internal buffer based on severity level debugging. Console(config)# logging buffered debugging

logging buffered size


The logging buffered size Global Configuration mode command changes the number of syslog messages stored in the internal buffer. Use the no form of this command to return to the default configuration.

Page 247

Allied Telesis
Command Line Interface Users Guide

Syntax
logging buffered size number no logging buffered size

Parameters number Specifies the maximum number of messages stored in the history table. (Range: 20 - 400) Default Configuration
The default number of messages is 200.

Command Mode
Global Configuration mode

User Guidelines
This command takes effect only after Reset.

Example
The following example changes the number of syslog messages stored in the internal buffer to 300. Console(config)# logging buffered size 300

clear logging
The clear logging Privileged EXEC mode command clears messages from the internal logging buffer.

Syntax
clear logging

Default Configuration
This command has no default configuration.

Command Mode
Privileged EXEC mode

User Guidelines
There are no user guidelines for this command.

Example
The following example clears messages from the internal logging buffer. Console# clear logging Clear logging buffer [confirm]

Page 248 Not approved by Document Control. For review only.

Syslog Commands

logging file
The logging file Global Configuration mode command limits syslog messages sent to the logging file based on severity. Use the no form of this command to cancel using the buffer.

Syntax
logging file level no logging file

Parameters level Specifies the severity level of syslog messages sent to the logging file. Possible values:
emergencies, alerts, critical, errors, warnings, notifications, informational and debugging.

Default Configuration
The default severity level is errors.

Command Mode
Global Configuration mode

User Guidelines
There are no user guidelines for this command.

Example
The following example limits syslog messages sent to the logging file based on severity level alerts. Console(config)# logging file alerts

clear logging file


The clear logging file Privileged EXEC mode command clears messages from the logging file.

Syntax
clear logging file

Default Configuration
This command has no default configuration.

Command Mode
Privileged EXEC mode

User Guidelines
There are no user guidelines for this command.

Page 249

Allied Telesis
Command Line Interface Users Guide

Example
The following example clears messages from the logging file. Console# clear logging file Clear Logging File [confirm]

aaa logging
The aaa logging Global Configuration mode command enables logging AAA login events. Use the no form of this command to disable logging AAA login events.

Syntax
aaa logging login no aaa logging login

Parameters login Indicates logging messages related to successful login events, unsuccessful login events and other
login-related events.

Default Configuration
Logging AAA login events is enabled.

Command Mode
Global Configuration mode

User Guidelines
Other types of AAA events are not subject to this command.

Example
The following example enables logging messages related to AAA login events. Console(config)# aaa logging login

file-system logging
The file-system logging Global Configuration mode command enables logging file system events. Use the no form of this command to disable logging file system events.

Syntax
file-system logging copy no file-system logging copy file-system logging delete-rename no file-system logging delete-rename

Page 250 Not approved by Document Control. For review only.

Syslog Commands

Parameters copy Indicates logging messages related to file copy operations. delete-rename Indicates logging messages related to file deletion and renaming operations. Default Configuration
Logging file system events is enabled.

Command Mode
Global Configuration mode

User Guidelines
There are no user guidelines for this command.

Example
The following example enables logging messages related to file copy operations. Console(config)# file-system logging copy

management logging
The management logging Global Configuration mode command enables logging management Access List (ACL) events. Use the no form of this command to disable logging management Access List events.

Syntax
management logging deny no management logging deny

Parameters deny Indicates logging messages related to deny actions of management ACLs. Default Configuration
Logging management ACL events is enabled.

Command Mode
Global Configuration mode

User Guidelines
Other types of management ACL events are not subject to this command.

Example
The following example enables logging messages related to deny actions of management ACLs. Console(config)# management logging deny

Page 251

Allied Telesis
Command Line Interface Users Guide

show logging
The show logging Privileged EXEC mode command displays the state of logging and the syslog messages stored in the internal buffer.

Syntax
show logging

Default Configuration
This command has no default configuration.

Command Mode
Privileged EXEC mode

User Guidelines
There are no user guidelines for this command.

Example
The following example displays the state of logging and the syslog messages stored in the internal buffer. Console# show logging Logging is enabled. Console logging: level debugging. Console Messages: 0 Dropped (severity). Buffer logging: level debugging. Buffer Messages: 11 Logged, 200 Max. File logging: level notifications. File Messages: 0 Dropped (severity). Syslog server 192.180.2.27 logging: errors. Messages: 6 Dropped (severity). Syslog server 192.180.2.28 logging: errors. Messages: 6 Dropped (severity). 2 messages were not logged (resources) Application filtering control Application ----------AAA File system File system Management ACL Event ----Login Copy Delete-Rename Deny Status -----Enabled Enabled Enabled Enabled

Buffer log: 11-Aug-2004 15:41:43: %LINK-3-UPDOWN: Interface FastEthernet0/0, changed state to up 11-Aug-2004 15:41:43: %LINK-3-UPDOWN: Interface Ethernet1/0, changed state to up 11-Aug-2004 15:41:43: %LINK-3-UPDOWN: Interface Ethernet1/1, changed state to up

Page 252 Not approved by Document Control. For review only.

Syslog Commands

11-Aug-2004 15:41:43: %LINK-3-UPDOWN: Interface Ethernet1/2, changed state to up 11-Aug-2004 15:41:43: %LINK-3-UPDOWN: Interface Ethernet1/3, changed state to up 11-Aug-2004 15:41:43: %SYS-5-CONFIG_I: Configured from memory by console 11-Aug-2004 15:41:39: %LINEPROTO-5-UPDOWN: Line protocol on Interface FastEthernet0/0, changed state to up 11-Aug-2004 15:41:39: %LINEPROTO-5-UPDOWN: Line protocol on Interface Ethernet1/0, changed state to down 11-Aug-2004 15:41:39: %LINEPROTO-5-UPDOWN: Line protocol on Interface Ethernet1/1, changed state to down 11-Aug-2004 15:41:39: %LINEPROTO-5-UPDOWN: Line protocol on Interface Ethernet1/2, changed state to down 11-Aug-2004 15:41:39: %LINEPROTO-5-UPDOWN: Line protocol on Interface Ethernet1/3, changed state to down

Console# show logging Logging is enabled. Console Logging: Level info. Console Messages: 223 Dropped. Buffer Logging: Level info. Buffer Messages: 20 Logged, 6 Displayed, 20 Max. File Logging: Level error. File Messages: 27 Logged, 1089 Dropped. SysLog server 192.168.1.101 Port: 514. Logging: info. Messages: 216 Dropped. 3 messages were not logged. Application filtering control Application ----------AAA File system File system Management ACL Event ----Login Copy Delete-Rename Deny Status -----Enabled Enabled Enabled Enabled

Page 253

Allied Telesis
Command Line Interface Users Guide

29-Nov-2007 17:46:02 :%LINK-I-Up: 29-Nov-2007 17:46:02 :%LINK-I-Up:

2/e16 Vlan 1 3/e14 Vlan 1

29-Nov-2007 17:45:59 :%LINK-W-Down: 29-Nov-2007 17:45:59 :%LINK-W-Down:

29-Nov-2007 17:36:58 :%AAA-I-CONNECT: New http connection for user Admin, source 192.168.1.96 destination 192.168.1.25 ACCEPTED 29-Nov-2007 17:36:36 :%AAA-W-REJECT: New http connection for user manager, sourc e 192.168.1.96 destination 192.168.1.25 REJECTED console#

show logging file


The show logging file Privileged EXEC mode command displays the state of logging and the syslog messages stored in the logging file.

Syntax
show logging file

Default Configuration
This command has no default configuration.

Command Mode
Privileged EXEC mode

User Guidelines
There are no user guidelines for this command.

Page 254 Not approved by Document Control. For review only.

Syslog Commands

Example
The following example displays the logging state and the syslog messages stored in the logging file. Console# show logging file Logging is enabled. Console logging: level debugging. Console Messages: 0 Dropped (severity). Buffer logging: level debugging. Buffer Messages: 11 Logged, 200 Max. File logging: level notifications. File Messages: 0 Dropped (severity). Syslog server 192.180.2.27 logging: errors. Messages: 6 Dropped (severity). Syslog server 192.180.2.28 logging: errors. Messages: 6 Dropped (severity). 2 messages were not logged (resources) Application filtering control Application ----------AAA File system File system Management ACL Event ----Login Copy Delete-Rename Deny Status -----Enabled Enabled Enabled Enabled

Buffer log: 11-Aug-2004 15:41:43: %LINK-3-UPDOWN: Interface FastEthernet0/0, changed state to up 11-Aug-2004 15:41:43: %LINK-3-UPDOWN: Interface Ethernet1/0, changed state to up 11-Aug-2004 15:41:43: %LINK-3-UPDOWN: Interface Ethernet1/1, changed state to up 11-Aug-2004 15:41:43: %LINK-3-UPDOWN: Interface Ethernet1/2, changed state to up 11-Aug-2004 15:41:43: %LINK-3-UPDOWN: Interface Ethernet1/3, changed state to up 11-Aug-2004 15:41:43: %SYS-5-CONFIG_I: Configured from memory by console 11-Aug-2004 15:41:39: %LINEPROTO-5-UPDOWN: Line protocol on Interface FastEthernet0/0, changed state to up 11-Aug-2004 15:41:39: %LINEPROTO-5-UPDOWN: Line protocol on Interface Ethernet1/0, changed state to down 11-Aug-2004 15:41:39: %LINEPROTO-5-UPDOWN: Line protocol on Interface Ethernet1/1, changed state to down 11-Aug-2004 15:41:39: %LINEPROTO-5-UPDOWN: Line protocol on Interface Ethernet1/2, changed state to down 11-Aug-2004 15:41:39: %LINEPROTO-5-UPDOWN: Line protocol on Interface Ethernet1/3, changed state to down

Page 255

Allied Telesis
Command Line Interface Users Guide

Console# show logging file Logging is enabled. Console Logging: Level info. Console Messages: 226 Dropped. Buffer Logging: Level info. Buffer Messages: 20 Logged, 6 Displayed, 20 Max. File Logging: Level error. File Messages: 27 Logged, 1092 Dropped. SysLog server 192.168.1.101 Port: 514. Logging: info. Messages: 219 Dropped. 3 messages were not logged Application filtering control Application ----------AAA File system File system Management ACL Event ----Login Copy Delete-Rename Deny Status -----Enabled Enabled Enabled Enabled

29-Nov-2007 15:14:32 :%Box-E-STCK-EXCEP_HNDLR: Lost connection with unit 2 reaso n 0x20097. Unit will be rebooted.

show syslog-servers
The show syslog-servers Privileged EXEC mode command displays the settings of the syslog servers.

Syntax
show syslog-servers

Default Configuration
This command has no default configuration.

Command Mode
Privileged EXEC mode

User Guidelines
There are no user guidelines for this command.

Example
The following example displays the settings of the syslog servers. Console# show syslog-servers Device Configuration

Page 256 Not approved by Document Control. For review only.

Syslog Commands

IP address -----------192.180.2.27 192.180.2.28

Port ---514 514

Severity ------------Informational Warning

Facility -------local7 local7

Description -----------

Page 257

Allied Telesis
Command Line Interface Users Guide

Chapter 27.TACACS+ Commands


tacacs-server host
The tacacs-server host Global Configuration mode command specifies a TACACS+ host. Use the no form of this command to delete the specified name or address.

Syntax
tacacs-server host {ip-address | hostname} [single-connection] [port port-number] [timeout timeout] [key keystring] [source source] [priority priority] no tacacs-server host {ip-address | hostname}

Parameters ip-address IP address of the TACACS+ server. hostname Host name of the TACACS+ server. (Range: 1 - 158 characters) single-connection Indicates a single-connection. Rather than have the device open and close a TCP
connection to the daemon each time it must communicate, the single-connection option maintains a single open connection between the device and the daemon. port-number Specifies a server port number. (Range: 0 - 65535) timeout Specifies the timeout value in seconds. (Range: 1 - 30) key-string Specifies the authentication and encryption key for all TACACS+ communications between the device and the TACACS+ server. This key must match the encryption used on the TACACS+ daemon. To specify an empty string, enter "". (Range: 0 - 128 characters) source Specifies the source IP address to use for the communication. 0.0.0.0 indicates a request to use the IP address of the outgoing IP interface. priority Determines the order in which the TACACS+ servers are used, where 0 is the highest priority. (Range: 0 - 65535)

Default Configuration
No TACACS+ host is specified. If no port number is specified, default port number 49 is used. If no host-specific timeout, key-string or source value is specified, the global value is used. If no TACACS+ server priority is specified, default priority 0 is used.

Command Mode
Global Configuration mode

User Guidelines
Multiple tacacs-server host commands can be used to specify multiple hosts.

Page 258 Not approved by Document Control. For review only.

TACACS+ Commands

Example
The following example specifies a TACACS+ host. Console(config)# tacacs-server host 172.16.1.1

tacacs-server key
The tacacs-server key Global Configuration mode command sets the authentication encryption key used for all TACACS+ communications between the device and the TACACS+ daemon. Use the no form of this command to disable the key.

Syntax
tacacs-server key key-string no tacacs-server key

Parameters key-string Specifies the authentication and encryption key for all TACACS+ communications between the
device and the TACACS+ server. This key must match the encryption used on the TACACS+ daemon. (Range: 0-128 characters)

Default Configuration
Empty string.

Command Mode
Global Configuration mode

User Guidelines
There are no user guidelines for this command.

Example
The following example sets the authentication encryption key. Console(config)# tacacs-server key ati-s

tacacs-server timeout
The tacacs-server timeout Global Configuration mode command sets the interval during which the device waits for a TACACS+ server to reply. Use the no form of this command to return to the default configuration.

Syntax
tacacs-server timeout timeout no tacacs-server timeout

Parameters timeout Specifies the timeout value in seconds. (Range: 1 - 30)

Page 259

Allied Telesis
Command Line Interface Users Guide

Default Configuration
5 seconds

Command Mode
Global Configuration mode

User Guidelines
There are no user guidelines for this command.

Example
The following example sets the timeout value to 30. Console(config)# tacacs-server timeout 30

tacacs-server source-ip
The tacacs-server source-ip Global Configuration mode command configures the source IP address to be used for communication with TACACS+ servers. Use the no form of this command to return to the default configuration.

Syntax
tacacs-server source-ip source no tacacs-server source-ip source

Parameters source Specifies the source IP address. Default Configuration


The source IP address is the address of the outgoing IP interface.

Command Mode
Global Configuration mode

User Guidelines
N/A

Example
The following example specifies the source IP address. Console(config)# tacacs-server source-ip 172.16.8.1

show tacacs
The show tacacs Privileged EXEC mode command displays configuration and statistical information about a TACACS+ server.

Page 260 Not approved by Document Control. For review only.

TACACS+ Commands

Syntax
show tacacs [ip-address]

Parameters ip-address Name or IP address of the TACACS+ server. Default Configuration


This command has no default configuration.

Command Mode
Privileged EXEC mode

User Guidelines
There are no user guidelines for this command.

Example
The following example displays configuration and statistical information about a TACACS+ server. Console# show tacacs Device Configuration -------------------IP address ---------172.16.1.1 Global values ------------TimeOut: 3 Device Configuration --------------------Source IP: 172.16.8.1 Status -----Connected Port ---49 Single Connection ----------------No TimeOut ------Global Source IP --------Global Priority -------1

Page 261

Allied Telesis
Command Line Interface Users Guide

Chapter 28.System Management Commands


ping
The ping User EXEC mode command sends ICMP echo request packets to another node on the network.

Syntax
ping {ip-address | hostname } [size packet_size] [count packet_count] [timeout time_out]

Parameters ip-address IP address to ping. hostname Host name to ping. (Range: 1-158 characters) packet_size Number of bytes in a packet. The actual packet size is eight bytes larger than the specified
size specified because the device adds header information. (Range: 56 - 1472 bytes) packet_count Number of packets to send. If 0 is entered, it pings until stopped. (Range: 0-65535 packets) time_out Timeout in milliseconds to wait for each reply. (Range: 50 - 65535 milliseconds)

Default Configuration
Default packet size is 56 bytes. Default number of packets to send is 4. Default timeout value is 2000 milliseconds.

Command Mode
User EXEC mode

User Guidelines The hostname must be a fully qualified DNS name. A fully qualified DNS name has a period at the end. Press Esc to stop pinging. Following are examples of unsuccessful pinging: Destination does not respond. If the host does not respond, a no answer from host appears in ten
seconds.

Destination unreachable. The gateway for this destination indicates that the destination is unreachable. Network or host unreachable. The device found no corresponding entry in the route table.

Page 262 Not approved by Document Control. For review only.

System Management Commands

Example
The following example displays pinging results: Console> ping 10.1.1.1 Pinging 10.1.1.1 with 64 bytes of data: 64 64 64 64 bytes bytes bytes bytes from from from from 10.1.1.1: 10.1.1.1: 10.1.1.1: 10.1.1.1: icmp_seq=0. icmp_seq=1. icmp_seq=2. icmp_seq=3. time=11 ms time=8 ms time=8 ms time=7 ms

----10.1.1.1 PING Statistics---4 packets transmitted, 4 packets received, 0% packet loss round-trip (ms) min/avg/max = 7/8/11 Console> ping yahoo.com. Pinging yahoo.com 66.218.71.198 with 64 bytes of data: 64 64 64 64 bytes bytes bytes bytes from from from from 10.1.1.1: 10.1.1.1: 10.1.1.1: 10.1.1.1: icmp_seq=0. icmp_seq=1. icmp_seq=2. icmp_seq=3. time=11 ms time=8 ms time=8 ms time=7 ms

----10.1.1.1 PING Statistics---4 packets transmitted, 4 packets received, 0% packet loss round-trip (ms) min/avg/max = 7/8/11 A sample of this list follows. Note that the Ctrl-shift-6 sequence appears as ^^ on the screen. Console> Ctrl-shift-6 ? [Special telnet escape help] ^^ B sends telnet BREAK ^^ C sends telnet IP ^^ H sends telnet EC ^^ O sends telnet AO ^^ T sends telnet AYT ^^ U sends telnet EL Ctrl-shift-6 x suspends the session (return to system command prompt) Several concurrent Telnet sessions can be opened and switched. To open a subsequent session, the current connection has to be suspended by pressing the escape sequence keys (Ctrl-shift-6) and x to return to the system command prompt. Then open a new connection with the Telnet User EXEC mode command.

Page 263

Allied Telesis
Command Line Interface Users Guide

reload
The reload Privileged EXEC mode command reloads the operating system.

Syntax
reload

Default Configuration
This command has no default configuration.

Command Mode
Privileged EXEC mode

User Guidelines
Caution should be exercised when resetting the device, to ensure that no other activity is being performed. In particular, the user should verify that no configuration files are being downloaded at the time of reset.

Example
The following example reloads the operating system. Console# reload This command will reset the whole system and disconnect your current session. Do you want to continue (y/n) [n]?

resume
Syntax
resume [connection]

Default Configuration
The default connection number is that of the most recent connection.

Command Mode
User EXEC mode

User Guidelines
There are no user guidelines for this command.

Example
The following command switches to open Telnet session number 1. Console> resume 1

Page 264 Not approved by Document Control. For review only.

System Management Commands

hostname
The hostname Global Configuration mode command specifies or modifies the device host name. Use the no form of this command to remove the existing host name.

Syntax
hostname name no hostname

Parameters name The host name. of the device. (Range: 1-158 characters) Default Configuration
This command has no default configuration.

Command Mode
Global Configuration mode

User Guidelines
There are no user guidelines for this command.

Example
The following example specifies the device host name. Console(config)# hostname Marvell Marvell(config)#

stack master
Note This command is operational in the AT-S94/24, AT-S94/24POE, AT-S94/48 and AT-S94/48POE devices. The stack master Global Configuration mode command enables forcing the selection of a stack master. Use the no form of this command to return to the default configuration.

Syntax
stack master unit unit no stack master

Parameters unit Unit number of the new master (Range: 1-2) Default Configuration
Disables forcing the selection of a stack master.

Page 265

Allied Telesis
Command Line Interface Users Guide

Command Mode
Global Configuration mode

User Guidelines
This command is not relevant to standalone devices. The following algorithm is used to select a unit as the master:

If only one master-enabled unit is in the stack (1 or 2), it becomes the master. If a unit configured as a forced master, it becomes the master. If a forced master unit is removed from a stack and placed in a different stack with another forced master unit, both are considered to be forced, and the election criteria continue as follows:

The unit with the longer up-time is elected master. Units are considered to have the same up-time if they were powered up within ten minutes of each other. If both forced master units have the same up-time, Unit 1 is elected.

Example
The following example selects Unit 2 as the stack master. Console(config)# stack master unit 2

stack reload
Note This command is operational in the AT-S94/24, AT-S94/24POE, AT-S94/48 and AT-S94/48POE devices. The stack reload Privileged EXEC mode command reloads stack members.

Syntax
stack reload [unit unit]

Parameters unit Number of the unit to be reloaded (Range: 1-6) Default Configuration
All units are reloaded.

Command Modes
Privileged EXEC mode

User Guidelines
This command is not relevant to standalone devices. If no unit is specified, all units are reloaded.

Page 266 Not approved by Document Control. For review only.

System Management Commands

Example
The following example reloads Unit 2 of the stack. Console(config)# stack reload unit 2

stack change unit-id


Note This command is operational in the AT-S94/24, AT-S94/24POE, AT-S94/48 and AT-S94/48POE devices. The stack change unit-id Global Configuration mode command is used to change the Unit ID of a specific unit.

Syntax
stack change unit-id unit-number to new-unit-number

Parameters unit-number Specifies the current number of the unit. (Range: 1-6) new-unit-number Specifies the new number of the unit. (Range: 1-6) Default Configuration
The automatically configured unit number is assigned.

Command Modes
Global Configuration mode

User Guidelines
This command is not relevant to standalone devices. The command takes effect only after resetting the device.

Example
This example changes Unit Number 6 to Unit Number 5. The command takes effect only after resetting the device. Console# config Console(config)# stack change unit-id 6 to 5

show stack
Note This command is operational in the AT-S94/24, AT-S94/24POE, AT-S94/48 and AT-S94/48POE devices. The show stack User EXEC mode command displays information about the status of a stack.

Page 267

Allied Telesis
Command Line Interface Users Guide

Syntax
show stack [unit unit]

Parameters unit Specifies the number of the unit. (Range: 1-6) Default Configuration
This command has no default configuration.

Command Mode
User EXEC mode

User Guidelines
This command is not relevant to standalone devices.

Example
The following example displays stack status.. Console> show stack Unit ---1 2 3 Unit ---1 MAC Address ----------------00:15:77:74:64:40 00:15:77:66:3e:80 00:01:02:03:04:05 Unit Id After Reset Software -------v1.1.0.23 v1.1.0.23 v1.1.0.23 Master -------Enabled Enabled Disabled Uplink -----2 3 1 Downlink -------3 1 2 Status -----Master Backup Slave

Topology is Ring

------------1

2
3

2 3

console# show stack 1 Unit: 1 MAC address: 00:15:77:74:64:40 Master: Enabled. Product: AT -S94/48. Software: v1.1.0.23 Uplink unit: 2 Downlink unit: 3. Status: Master Active image: image-2. Selected for next boot: image-2.

Page 268 Not approved by Document Control. For review only.

System Management Commands

Topology is Ring Unit Num After Reset: Console> show stack Unit ---1 2 3 4 5 6 Unit ---1 1 MAC Address ----------------10:20:30:40:50:60 00:00:00:00:48:05 00:00:f4:48:01:00 00:15:77:37:33:e0 00:30:00:00:30:00 00:00:f4:48:0a:00 Unit Id After Reset Software -------v1.1.0.29 v1.1.0.29 v1.1.0.29 v1.1.0.29 v1.1.0.29 v1.1.0.29 Master -------Forced Enabled Disabled Disabled Disabled Disabled Uplink -----6 1 2 3 4 5 Downlink -------2 3 4 5 6 1 Status -----master backup slave slave slave slave 1

Topology is Ring

-------------

2
3 4 5 6

2 3 4 5 6

console# console# show stack 1 Unit: 1 MAC address: 10:20:30:40:50:60 Master: Forced. Product: AT-S94/48. Software: v1.1.0.29 Uplink unit: 6 Downlink unit: 2. Status: master Active image: image2. Selected for next boot: image2. Topology is Ring Unit Num After Reset: console# 1

show users
The show users User EXEC mode command displays information about the active users.

Page 269

Allied Telesis
Command Line Interface Users Guide

Syntax
show users

Default Configuration
This command has no default configuration.

Command Mode
User EXEC mode

User Guidelines
There are no user guidelines for this command.

Example
The following example displays information about the active users. Console show users Username ---------Bob John Robert Betty Protocol ----------Serial SSH HTTP Telnet 172.16.0.1 172.16.0.8 172.16.1.7 Location ------------

Console show users Username ---------manager Admin Bob bill console# Protocol ----------Serial HTTP Telnet Telnet Location -----------0.0.0 192.168.1.960. 192.168.1.120 192.168.1.101

show sessions
The show sessions User EXEC mode command lists open Telnet sessions.

Syntax
show sessions

Default Configuration
There is no default configuration for this command.

Page 270 Not approved by Document Control. For review only.

System Management Commands

Command Mode
User EXEC mode

User Guidelines
There are no user guidelines for this command.

Example
The following example lists open Telnet sessions. Console> show sessions Connection ---------1 2 Host ------------Remote device 172.16.1.2 Address ---------172.16.1.1 172.16.1.2 Port ----23 23 Byte ---89 8

The following table describes significant fields shown above. Field Connection Host Address Port Byte D escr ip tio n Connection number. Remote host to which the device is connected through a Telnet session. IP address of the remote host. Telnet TCP port number Number of unread bytes for the user to see on the connection.

show system
The show system User EXEC mode command displays system information.

Syntax
show system [unit unit]

Parameters unit Specifies the number of the unit. (Range: 1-6) Default Configuration
This command has no default configuration.

Command Mode
User EXEC mode

User Guidelines
There are no user guidelines for this command.

Page 271

Allied Telesis
Command Line Interface Users Guide

Example
The following example displays the system information. Console# show system unit 1 System Description: System Up Time (days, hour:min:sec): System Contact: System Name: System Location: System MAC Address: System Object ID: Serial number: Type: Main Power Supply Status: Unit ---1 2 3 Unit ---1 2 3 Serial number ---------1 2 3t: 1 Type -------------AT 8000 S/48 AT 8000 S/24 AT 8000 S/24 POE Up time -------------00,03:38:12 00,03:34:44 00,03:36:34 00:31:c7:19:13:00 1.3.6.1.4.1.207.1.4.144 154 AT-8000GS/24POE OK Stack 24-port 10/100/1000 Ethernet Switch with PoE 00.02:28:29

show system id
The show system id Privileged EXEC mode command displays the system identity information.

Page 272 Not approved by Document Control. For review only.

System Management Commands

Syntax
show system id [unit unit]

Parameters unit unit Unit number. Default Configuration


This command has no default configuration.

Command Mode
Privileged EXEC mode

User Guidelines
There are no user guidelines for this command.

Example
The following example displays the system information. Console> show system id Service Tag: 89788978 Serial number: 8936589782 Asset tag: 7843678957 Unit -------------------1 2 Service tag -------------------89788978 34254675 Serial number -------------------8936589782 3216523877

Console> show system id Service Tag: 89788978 Serial number: 8936589782 Unit ------1 2 Serial number -------------8936589782 3216523877

show version
The show version User EXEC mode command displays system version information.

Page 273

Allied Telesis
Command Line Interface Users Guide

Syntax
show version [unit unit]

Parameters unit Specifies the number of the unit. (Range: 1-6) Default Configuration
This command has no default configuration.

Command Mode
User EXEC mode

User Guidelines
There are no user guidelines for this command.

Example
The following example displays system version information (only for demonstration purposes). Console> show version Unit ---1 2 3 4 5 6 console# . Console> show version SW version 1.0.0.0 Boot version 1.0.0.0 HW version 1.0.0 Unit ---1 2 SW version ---------1.0.0.0 1.0.0.0 Boot version -----------2.178 2.178 HW version ---------1.0.0 1.0.0 (date 23-Jul-2004 time 17:34:19) (date 11-Jan-2004 time 11:48:21) SW version ---------v1.1.0.29 v1.1.0.29 v1.1.0.29 v1.1.0.29 v1.1.0.29 v1.1.0.29 Boot version -----------1.0.1.06 1.0.1.06 1.0.1.06 1.0.1.06 1.0.1.06 1.0.1.06 HW version ---------01.00.00 01.00.00 01.00.00 01.00.00 01.00.00 01.00.00

Page 274 Not approved by Document Control. For review only.

System Management Commands

set system
The set system Priviledged EXEC mode command activates/deactivates features.

Syntax
set system qos {active | inactive} policy-based-vlans {active | inactive}

Parameters qos active Activate QoS. qos inactive Deactivate QoS. policy-based-vlans active Activate Policy based VLANs. policy-based-vlans inactive Deactivate Policy based VLANs. Default Configuration
This command has no default configuration.

Command Mode
Priviledged EXEC mode

User Guidelines
After executing the command, the startup-config is deleted and the device is rebooted. It is highly recommended to backup the startup-config before executing this command.

Example
The following example deactivate features. Console> set system qos inactive policy-based-vlans active

Page 275

Allied Telesis
Command Line Interface Users Guide

Chapter 29.User Interface Commands


enable
The enable User EXEC mode command enters the Privileged EXEC mode.

Syntax
enable [privilege-level]

Parameters privilege-level Privilege level to enter the system. (Range: 1 - 15) Default Configuration
The default privilege level is 15.

Command Mode
User EXEC mode

User Guidelines There are no user guidelines for this command. Example
The following example enters Privileged EXEC mode: Console> enable enter password: Console#

disable
The disable Privileged EXEC mode command returns to the User EXEC mode.

Syntax
disable [privilege-level]

Parameters privilege-level Privilege level to enter the system. (Range: 1 - 15) Default Configuration
The default privilege level is 1.

Page 276 Not approved by Document Control. For review only.

User Interface Commands

Command Mode
Privileged EXEC mode

User Guidelines
There are no user guidelines for this command.

Example
The following example returns to Users EXEC mode. Console# disable Console>

login
The login User EXEC mode command changes a login username.

Syntax
login

Default Configuration
This command has no default configuration.

Command Mode
User EXEC mode

User Guidelines
There are no user guidelines for this command.

Example
The following example enters Privileged EXEC mode and logs in with username admin. Console> login User Name:admin Password:***** Console#

configure
The configure Privileged EXEC mode command enters the Global Configuration mode.

Syntax
configure

Default Configuration
This command has no default configuration.

Page 277

Allied Telesis
Command Line Interface Users Guide

Command Mode
Privileged EXEC mode

User Guidelines
There are no user guidelines for this command.

Example
The following example enters Global Configuration mode. Console# configure Console(config)#

exit (Configuration)
The exit command exits any configuration mode to the next highest mode in the CLI mode hierarchy.

Syntax
exit

Default Configuration
This command has no default configuration.

Command Mode
All configuration modes

User Guidelines
There are no user guidelines for this command.

Example
The following example changes the configuration mode from Interface Configuration mode to Privileged EXEC mode. Console(config-if)# exit Console(config)# exit Console#

exit
The exit Privileged/User EXEC mode command closes an active terminal session by logging off the device.

Syntax
exit

Default Configuration
This command has no default configuration.

Page 278 Not approved by Document Control. For review only.

User Interface Commands

Command Mode
Privileged and User EXEC modes

User Guidelines
There are no user guidelines for this command.

Example
The following example closes an active terminal session. Console> exit

end
The end command ends the current configuration session and returns to the Privileged EXEC mode.

Syntax
end

Default Configuration
This command has no default configuration.

Command Mode
All configuration modes.

User Guidelines
There are no user guidelines for this command.

Example
The following example changes from Global Configuration mode to Privileged EXEC mode. Console(config)# end Console#

help
The help command displays a brief description of the help system.

Syntax
help

Default Configuration
This command has no default configuration.

Command Mode
All command modes

Page 279

Allied Telesis
Command Line Interface Users Guide

User Guidelines
There are no user guidelines for this command.

Example
The following example describes the help system. Console# help Help may be requested at any point in a command by entering a question mark '?'. If nothing matches the currently entered incomplete command, the help list is empty. This indicates that for a query at this point, there is no command matching the current input. If the request is within a command, enter backspace and erase the entered characters to a point where the request results in a display. Help is provided when: 1. There is a valid command and a help request is made for entering a parameter or argument (e.g. 'show ?'). All possible parameters or arguments for the entered command are displayed. 2. An abbreviated argument is entered and a help request is made for arguments matching the input (e.g. 'show pr?').

terminal datadump
The terminal data-dump User EXEC mode command enables dumping all the output of a show command without prompting. Use the no form of this command to disable dumping.

Syntax
terminal datadump no terminal datadump

Default Configuration
Dumping is disabled.

Command Mode
User EXEC mode

User Guidelines
By default, a More prompt is displayed when the output contains more lines than can be displayed on the screen. Pressing the Enter key displays the next line; pressing the Spacebar displays the next screen of output. The datadump command enables dumping all output immediately after entering the show command. This command is relevant only for the current session.

Example
This example dumps all output immediately after entering a show command. Console> terminal datadump

Page 280 Not approved by Document Control. For review only.

User Interface Commands

show history
The show history User EXEC mode command lists the commands entered in the current session.

Syntax
show history

Default Configuration
This command has no default configuration.

Command Mode
User EXEC mode
User Guidelines

The buffer includes executed and unexecuted commands. Commands are listed from the first to the most recent command. The buffer remains unchanged when entering into and returning from configuration modes.

Example
The following example displays all the commands entered while in the current Privileged EXEC mode. Console# show version SW version 3.131 (date 23-Jul-2004 time 17:34:19) HW version 1.0.0 Console# show clock 15:29:03 Jun 17 2004 Console# show history show version show clock show history 3 commands were logged (buffer size is 10)

show privilege
The show privilege Privileged/User EXEC mode command displays the current privilege level.

Syntax
show privilege

Default Configuration
This command has no default configuration.

Command Mode
Privileged and User EXEC modes

Page 281

Allied Telesis
Command Line Interface Users Guide

User Guidelines
There are no user guidelines for this command.

Example
The following example displays the current privilege level for the Privileged EXEC mode. Console# show privilege Current privilege level is 15

Page 282 Not approved by Document Control. For review only.

VLAN Commands

Chapter 30.VLAN Commands


vlan database
The vlan database Global Configuration mode command enters the VLAN Configuration mode.

Syntax
vlan database

Default Configuration
This command has no default configuration.

Command Mode
Global Configuration mode

User Guidelines
There are no user guidelines for this command.

Example
The following example enters the VLAN database mode. Console(config)# vlan database Console(config-vlan)#

vlan
The vlan VLAN Configuration mode command creates a VLAN. Use the no form of this command to delete a VLAN.

Syntax
vlan vlan-range no vlan vlan-range

Parameters vlan-range Specifies a list of VLAN IDs to be added. Separate nonconsecutive VLAN IDs with a comma
and no spaces; a hyphen designates a range of IDs.

Default Configuration
This command has no default configuration.

Command Mode
VLAN Configuration mode

Page 283

Allied Telesis
Command Line Interface Users Guide

User Guidelines
There are no user guidelines for this command.

Example
The following example VLAN number 1972 is created. console(config)# vlan database console(config-vlan)# vlan 1972 console(config-vlan)#

default-vlan disable
The default-vlan disable VLAN Configuration mode command disables the default VLAN functionality. Use the no form of this command to enable the default VLAN functionality.

Syntax
default-vlan disable no default-vlan disable

Default Configuration
Enabled.

Command Mode
VLAN Configuration mode

User Guidelines
There are no user guidelines for this command.

Example
console(config)# default-vlan disable console(default-vlan disable)#

default-vlan vlan
The default-vlan vlan VLAN Configuration mode command defines the default VLAN. Use the no form of this command to return to default.

Syntax
default-vlan vlan vlan-id no default-vlan vlan

Parameters vlan-id VLAN ID of the default VLAN

Page 284 Not approved by Document Control. For review only.

VLAN Commands

Default Configuration
1

Command Mode
VLAN Configuration mode

User Guidelines
There are no user guidelines for this command. Note After running the command, the device must be reset.

Example
console(config-vlan)# default-vlan vlan 1 console(config-vlan)#

interface vlan
The interface vlan Global Configuration mode command enters the Interface Configuration (VLAN) mode.

Syntax
interface vlan vlan-id

Parameters vlan-id Specifies an existing VLAN ID. Default Configuration


This command has no default configuration.

Command Mode
Global Configuration mode

User Guidelines
In case the VLAN doesn't exist (ghost VLAN), only partial list of the commands are available under the interface VLAN context. The commands supported for non-existant VLANs are: 1) IGMP snooping control 2) Bridge Multicast configuration

Page 285

Allied Telesis
Command Line Interface Users Guide

Example
In the following example, for VLAN 1, the address is 131.108.1.27 and the subnet mask is 255.255.255.0: console(config)# interface vlan 1 console(config-if)# ip address 131.108.1.27 255.255.255.0

interface range vlan


The interface range vlan Global Configuration mode command enables simultaneously configuring multiple VLANs.

Syntax
interface range vlan {vlan-range | all}

Parameters vlan-range Specifies a list of VLAN IDs to be added. Separate nonconsecutive VLAN IDs with a comma
and no spaces; a hyphen designates a range of IDs. all All existing static VLANs.

Default Configuration
This command has no default configuration.

Command Mode
Global Configuration mode

User Guidelines
Commands under the interface range context are executed independently on each interface in the range. If the command returns an error on one of the interfaces, an error message is displayed and execution of the command continues on the other interfaces.

Example
The following example groups VLANs 221, 228 and 889 to receive the same command. Console(config)# interface range vlan 221-228,889 Console(config-if)#

name
The name Interface Configuration mode command adds a name to a VLAN. Use the no form of this command to remove the VLAN name.

Syntax
name string no name

Page 286 Not approved by Document Control. For review only.

VLAN Commands

Parameters string Unique name to be associated with this VLAN. (Range: 1-32 characters) Default Configuration
No name is defined.

Command Mode
Interface Configuration (VLAN) mode. Cannot be configured for a range of interfaces (range context).

User Guidelines
There are no user guidelines for this command.

Example
The following example gives VLAN number 19 the name Marketing. Console(config)# interface vlan 19 Console(config-if)# name Marketing

switchport protected
The switchport protected Interface Configuration mode command enables Private VLAN Edge, by overriding the FDB decision, and sends all Unicast, Multicast and Broadcast traffic to an uplink port. Use the no form of this command to disable overriding the FDB decisiond.

Syntax
switchport protected {ethernet port | port-channel port-channel-number } no switchport protected

Parameters port Specifies the uplink Ethernet port. port-channel-number Specifies the uplink port-channel. Default Configuration
Switchport protected is disabled.

Command Mode
Interface Configuration (Ethernet, port-channel) mode

User Guidelines
Private VLAN Edge (PVE) supports private communication by isolating PVE-defined ports and ensuring that all Unicast, Broadcast and Multicast traffic from these ports is only forwarded to uplink port(s). PVE requires only one VLAN on each device, but not on every port; this reduces the number of VLANs required by the device. Private VLANs and the default VLAN function simultaneously in the same device. The uplink must be a GE port.

Page 287

Allied Telesis
Command Line Interface Users Guide

Example
This example configures ethernet port 1/e8 as a protected port, so that all traffic is sent to its uplink (ethernet port 1/e9). Console(config)# interface ethernet 1/e8 Console(config-if)# switchport forbidden vlan add 234-256 Console(config-if)# exit Console(config)# interface ethernet 1/e9 Console(config-if)# switchport protected ethernet 1/g1

switchport mode
The switchport mode Interface Configuration mode command configures the VLAN membership mode of a port. Use the no form of this command to return to the default configuration.

Syntax
switchport mode {access | trunk | general} no switchport mode

Parameters access Indicates an untagged layer 2 VLAN port. trunk Indicates a trunking layer 2 VLAN port. general Indicates a full 802-1q supported VLAN port. Default Configuration
All ports are in access mode, and belong to the default VLAN (whose VID=1).

Command Mode
Interface Configuration (Ethernet, port-channel) mode

User Guidelines
There are no user guidelines.

Example
The following example configures Ethernet port 1/e16 as an untagged layer 2 VLAN port. Console(config)# interface ethernet 1/e16 Console(config-if)# switchport mode access

Page 288 Not approved by Document Control. For review only.

VLAN Commands

switchport access vlan


The switchport access vlan Interface Configuration mode command configures the VLAN ID when the interface is in access mode. Use the no form of this command to return to the default configuration.

Syntax
switchport access vlan {vlan-id } no switchport access vlan

Parameters vlan-id Specifies the ID of the VLAN to which the port is configured. Default Configuration
All ports belong to VLAN 1.

Command Mode
Interface configuration (Ethernet, port-channel) mode

User Guidelines
The command automatically removes the port from the previous VLAN and adds it to the new VLAN.

Example
The following example configures a VLAN ID of 23 to the untagged layer 2 VLAN Ethernet port 1/e16. Console(config)# interface ethernet 1/e16 Console(config-if)# switchport access vlan 23

switchport trunk allowed vlan


The switchport trunk allowed vlan Interface Configuration mode command adds or removes VLANs to or from a trunk port.

Syntax
switchport trunk allowed vlan {add vlan-list | remove vlan-list }

Parameters add vlan-list List of VLAN IDs to be added. Separate nonconsecutive VLAN IDs with a comma and no
spaces. A hyphen designates a range of IDs. remove vlan-list List of VLAN IDs to be removed. Separate nonconsecutive VLAN IDs with a comma and no spaces. A hyphen designates a range of IDs.

Default Configuration
This command has no default configuration.

Page 289

Allied Telesis
Command Line Interface Users Guide

Command Mode
Interface Configuration (Ethernet, port-channel) mode

User Guidelines
There are no user guidelines for this command.

Example
The following example adds VLANs 1, 2, 5 to 6 to the allowed list of Ethernet port 1/e16. Console(config)# interface ethernet 1/e16 console(config-if)# switchport trunk allowed vlan add 1-2,5-6

switchport trunk native vlan


The switchport trunk native vlan Interface Configuration mode command defines the native VLAN when the interface is in trunk mode. Use the no form of this command to return to the default configuration.

Syntax
switchport trunk native vlan vlan-id no switchport trunk native vlan

Parameters vlan-id Specifies the ID of the native VLAN. Default Configuration


VID=1.

Command Mode
Interface Configuration (Ethernet, port-channel) mode

User Guidelines
The command adds the port as a member in the VLAN. If the port is already a member in the VLAN (not as a native), it should be first removed from the VLAN.

Example
The following example configures VLAN number 123 as the native VLAN when Ethernet port 1/e16 is in trunk mode. Console(config)# interface ethernet 1/e16 Console(config-if)# switchport trunk native vlan 123

switchport general allowed vlan


The switchport general allowed vlan Interface Configuration mode command adds or removes VLANs from a general port.

Page 290 Not approved by Document Control. For review only.

VLAN Commands

Syntax
switchport general allowed vlan add vlan-list [tagged | untagged] switchport general allowed vlan remove vlan-list

Parameters add vlan-list Specifies the list of VLAN IDs to be added. Separate nonconsecutive VLAN IDs with a comma
and no spaces. A hyphen designates a range of IDs. remove vlan-list Specifies the list of VLAN IDs to be removed. Separate nonconsecutive VLAN IDs with a comma and no spaces. A hyphen designates a range of IDs. tagged Indicates that the port transmits tagged packets for the VLANs. untagged Indicates that the port transmits untagged packets for the VLANs.

Default Configuration
If the port is added to a VLAN without specifying tagged or untagged, the default setting is tagged.

Command Mode
Interface Configuration (Ethernet, port-channel) mode

User Guidelines
This command enables changing the egress rule (e.g., from tagged to untagged) without first removing the VLAN from the list.

Example
The following example adds VLANs 2, 5, and 6 to the allowed list of Ethernet port 1/e16 . Console(config)# interface ethernet 1/e16 Console(config-if)# switchport general allowed vlan add 2,5-6 tagged

switchport general pvid


The switchport general pvid Interface Configuration mode command configures the PVID when the interface is in general mode. Use the no form of this command to return to the default configuration.

Syntax
switchport general pvid vlan-id no switchport general pvid

Parameters vlan-id Specifies the PVID (Port VLAN ID). Default Configuration
If the default VLAN is enabled, PVID = 1. Otherwise, PVID=4095.

Command Mode
Interface Configuration (Ethernet, port-channel) mode

Page 291

Allied Telesis
Command Line Interface Users Guide

User Guidelines
There are no user guidelines for this command.

Example
The following example configures the PVID for Ethernet port 1/e16, when the interface is in general mode. Console(config)# interface ethernet 1/e16 Console(config-if)# switchport general pvid 234

switchport general ingress-filtering disable


The switchport general ingress-filtering disable Interface Configuration mode command disables the ingress filtering of a port. Use the no form of this command to enable the ingress filtering of a port.

Syntax
switchport general ingress-filtering disable no switchport general ingress-filtering disable

Parameters This command has no keywords or arguments. Default Configuration


Ingress filtering is enabled.

Command Mode
Interface Configuration (Ethernet, port-channel) mode

User Guidelines
There are no user guidelines for this command.

Example
The following example disables the ingress filtering of a port. Console(config)# switchport general ingress-filtering disable

switchport general acceptable-frame-type tagged-only


The switchport general acceptable-frame-type tagged-only Interface Configuration mode command discards untagged frames at ingress. Use the no form of this command to return to the default configuration.

Syntax
switchport general acceptable-frame-type tagged-only no switchport general acceptable-frame-type tagged-only

Default Configuration
All frame types are accepted at ingress.

Page 292 Not approved by Document Control. For review only.

VLAN Commands

Command Mode
Interface Configuration (Ethernet, port-channel) mode

User Guidelines
There are no user guidelines for this command.

Example
The following example configures Ethernet port 1/e16 to discard untagged frames at ingress. Console(config)# interface ethernet 1/e16 Console(config-if)# switchport general acceptable-frame-type tagged-only

switchport general acceptable-frame-type tagged-only


The switchport general acceptable-frame-type tagged-only Interface Configuration mode command discards untagged frames at ingress. Use the no form of this command to return to the default configuration.

Syntax
switchport general acceptable-frame-type tagged-only no switchport general acceptable-frame-type tagged-only

Default Configuration
All frame types are accepted at ingress.

Command Mode
Interface Configuration (Ethernet, port-channel) mode

User Guidelines
There are no user guidelines for this command.

Example
The following example configures Ethernet port 1/e16 to discard untagged frames at ingress. Console(config)# interface ethernet 1/e16 Console(config-if)# switchport general acceptable-frame-type tagged-only

switchport general map macs-group vlan


The switchport general map macs-group vlan interface configuration mode command sets a mac-based classification rule. Use the no form of this command to delete a classification.

Syntax
switchport general map macs-group group vlan vlan-id no switchport general map macs-group group

Page 293

Allied Telesis
Command Line Interface Users Guide

Default Configuration
This command has no default configuration.

Command Mode
Interface Configuration (Ethernet, port-channel) mode

User Guidelines
MAC based VLAN rules cannot contain overlapping ranges on the same interface. The priority between VLAN classification rules is:

MAC based VLAN (Best match between the rules) PVID The interface must be in General Mode to configure a MAC-based classification rule.
Example

The following example sets a mac-based classification rule. console(config)# vlan database console(config-vlan)# map mac 00:08:78:32:98:78 9 macs-group 1 interface ethernet e17 console(config-vlan)# exit console(config)# interface ethernet 1/e17 console(config-if)# switchport mode general console(config-if)# switchport general map macs-group 1 vlan 2

map mac macs-group


The map mac macs-group VLAN Configuration mode command maps a MAC address or a range of MAC addresses to a group of MAC addresses. Use the no form of this command to delete a map.

Syntax
map mac mac-address {prefix-mask | host} macs-group group no map mac mac-address {prefix-mask | host}

mac-address Specifies the MAC address to be entered to the group. prefix-mask Specifies the Mask bits. The format is the MAC address format. host Specifies all 1s mask. group Specifies the group number. (Range: 1-2147483647)

Default Configuration
This command has no default configuration.

Command Mode
VLAN Configuration mode

User Guidelines
There are no user guidelines for this command.

Page 294 Not approved by Document Control. For review only.

VLAN Commands

Example

The following example maps a MAC address or a range of MAC addresses to a group of MAC addresses. console(config)# vlan database console(config-vlan)# map mac 00:08:78:32:98:78 9 macs-group 1 interface ethernet e17

show vlan macs-group


The show vlan macs-group privileged EXEC command displays MAC group information.

Syntax
show vlan macs-group

Default Configuration
This command has no default configuration.

Command Mode
Privileged EXEC mode

User Guidelines
There are no user guidelines for this command.

Example
The following example displays macs-groups information Console# show vlan macs-groups MAC Address Mask --------------------------0060.704C.73FF FFFF.FFFF.0000 0060.704D.73FF FFFF.FFFF.0000

Group ID -------1 1

switchport forbidden vlan


The switchport forbidden vlan Interface Configuration mode command forbids adding specific VLANs to a port. Use the no form of this command to return to the default configuration.

Syntax
switchport forbidden vlan {add vlan-list | remove vlan-list}

Parameters add vlan-list Specifies the list of VLAN IDs to be added. Separate nonconsecutive VLAN IDs with a comma
and no spaces. A hyphen designates a range of IDs. remove vlan-list Specifies the list of VLAN IDs to be removed. Separate nonconsecutive VLAN IDs with a comma and no spaces. A hyphen designates a range of IDs.

Page 295

Allied Telesis
Command Line Interface Users Guide

Default Configuration
All VLANs are allowed.

Command Mode
Interface Configuration (Ethernet, port-channel) mode

User Guidelines
This command can be used to prevent GVRP from automatically making the specified VLANs active on the selected ports.

Example
The following example forbids adding VLAN IDs 234 to 256 to Ethernet port 1/e16. Console(config)# interface ethernet 1/e16 Console(config-if)# switchport forbidden vlan add 234-256

ip internal-usage-vlan
The ip internal-usage-vlan Interface Configuration mode command reserves a VLAN as the internal usage VLAN of an interface. Use the no form of this command to return to the default configuration.

Syntax
ip internal-usage-vlan vlan-id no ip internal-usage-vlan

Parameters vlan-id Specifies the ID of the internal usage VLAN. Default Configuration
The software reserves a VLAN as the internal usage VLAN of an interface.

Command Mode
Interface Configuration (Ethernet, port-channel) mode

User Guidelines
An internal usage VLAN is required when an IP interface is configured on an Ethernet port or port-channel. This command enables the user to configure the internal usage VLAN of a port. If an internal usage VLAN is not configured and the user wants to configure an IP interface, an unused VLAN is selected by the software. If the software selected a VLAN for internal use and the user wants to use that VLAN as a static or dynamic VLAN, the user should do one of the following:

Remove the IP interface. Create the VLAN and recreate the IP interface. Use this command to explicitly configure a different VLAN as the internal usage VLAN.

Page 296 Not approved by Document Control. For review only.

VLAN Commands

Example
The following example reserves an unused VLAN as the internal usage VLAN of ethernet port 1/e8. Console# config Console(config)# interface ethernet 1/e8 Console(config-if)# ip internal-usage-vlan

Page 297

Allied Telesis
Command Line Interface Users Guide

show vlan
The show vlan Privileged EXEC mode command displays VLAN information.

Syntax
show vlan [tag vlan-id | name vlan-name ]

Parameters vlan-id specifies a VLAN ID vlan-name Specifies a VLAN name string. (Range: 1 - 32 characters) Default Configuration
This command has no default configuration.

Command Mode
Privileged EXEC mode

User Guidelines
There are no user guidelines for this command.

Example
The following example displays all VLAN information. Console# show vlan VLAN ---1 10 11 20 21 30 31 91 3978 Name ------default VLAN0010 VLAN0011 VLAN0020 VLAN0021 VLAN0030 VLAN0031 VLAN0011 Guest VLAN 1/e1-e2 1/e17 Ports -------1/e1-e2, 2/e1-e4 1/e3-e4 1/e1-e2 1/e3-e4 Type ---other dynamic static static static static static static guest Authorization ------------Required Required Required Required Required Required Required Not Required -

show vlan internal usage


The show vlan internal usage Privileged EXEC mode command displays a list of VLANs used internally by the device.

Syntax
show vlan internal usage

Page 298 Not approved by Document Control. For review only.

VLAN Commands

Default Configuration
This command has no default configuration.

Command Mode
Privileged EXEC mode

User Guidelines
There are no user guidelines for this command.

Example
The following example displays VLANs used internally by the device. Console# show vlan internal usage VLAN ---1007 1008 1009 Usage --------Eth 1/e21 Eth 1/e22 Eth 1/e23 IP address ---------Active Inactive Active Reserved -------No Yes Yes

show interfaces switchport


The show interfaces switchport Privileged EXEC mode command displays the switchport configuration.

Syntax
show interfaces switchport {ethernet interface | port-channel port-channel-number}

Parameters interface A valid Ethernet port number. port-channel-number A valid port-channel number. Default Configuration
This command has no default configuration.

Command Mode
Privileged EXEC mode

User Guidelines
There are no user guidelines for this command.

Page 299

Allied Telesis
Command Line Interface Users Guide

Example
The following example displays the switchport configuration for Ethernet port 1/e1. Console# show interface switchport ethernet 1/e1 Port 1/e1: VLAN Membership mode: General Operating parameters: PVID: 1 (default) Ingress Filtering: Enabled Acceptable Frame Type: All GVRP status: Enabled Protected: Enabled, Uplink is 1/e9. Port 1/e1 is member in: Vlan ---1 8 11 19 72 Name ------default VLAN008 VLAN011 IPv6 VLAN VLAN0072 Egress rule ----------untagged tagged tagged untagged untagged Type ------System Dynamic Static Static Static

Static configuration: PVID: 1 (default) Ingress Filtering: Enabled Acceptable Frame Type: All Port 1/e1 is statically configured to: Vlan ---1 11 19 72 Name ------default VLAN011 IPv6 VLAN VLAN0072 Egress rule ----------untagged tagged untagged untagged

Forbidden VLANS: VLAN ---Name ----

Page 300 Not approved by Document Control. For review only.

VLAN Commands

73

out

Console show interface switchport ethernet 1/e2 Port 1/e2: VLAN Membership mode: General Operating parameters: PVID: 4095 (discard vlan) Ingress Filtering: Enabled Acceptable Frame Type: All Port 1/e1 is member in: Vlan ---91 Name -----------IP Telephony Egress rule ----------tagged Type -----Static

Static configuration: PVID: 8 Ingress Filtering: Disabled Acceptable Frame Type: All Port 1/e2 is statically configured to: Vlan ---8 91 Name -----------VLAN0072 IP Telephony Egress rule ----------untagged tagged

Forbidden VLANS: VLAN ---73 Port 2/e19 Static configuration: PVID: 2922 Ingress Filtering: Enabled Name ---out

Page 301

Allied Telesis
Command Line Interface Users Guide

Acceptable Frame Type: Untagged GVRP status: Disabled

Page 302 Not approved by Document Control. For review only.

Web Server Commands

Chapter 31.Web Server Commands


ip http server
The ip http server Global Configuration mode command enables configuring the device from a browser. Use the no form of this command to disable this function.

Syntax
ip http server no ip http server

Default Configuration
HTTP server is enabled.

Command Mode
Global Configuration mode

User Guidelines
Only a user with access level 15 can use the Web server.

Example
The following example enables configuring the device from a browser. Console(config)# ip http server

ip http port
The ip http port Global Configuration mode command specifies the TCP port to be used by the Web browser interface. Use the no form of this command to return to the default configuration.

Syntax
ip http port port-number no ip http port

Parameters port-number Port number for use by the HTTP server. (Range: 0 - 65535) Default Configuration
The default port number is 80.

Command Mode
Global Configuration mode

Page 303

Allied Telesis
Command Line Interface Users Guide

User Guidelines
Use the crypto certificate generate Global Configuration mode command to generate an HTTPS certificate. Specifying 0 as the port number effectively disables HTTP access to the device.

Example
The following example configures the http port number to 100. Console(config)# ip http port 100

ip http exec-timeout
The ip http port Global Configuration mode command specifies the TCP port to be used by the Web browser interface. Use the no form of this command to return to the default configuration.

Syntax
ip http exec-timeout minutes [seconds] no ip http exec-timeout

Parameters minutes Integer that specifies the number of minutes. seconds Additional time intervals in seconds. Default Configuration
The default is 10 minutes.

Command Mode
Global Configuration mode

User Guidelines
This command also configures the exec-timeout for HTTPS in case the HTTPS timeout was not set. To specify no timeout, enter the ip https exec-timeout 0 0 command.

ip https server
The ip https server Global Configuration mode command enables configuring the device from a secured browser. Use the no form of this command to return to the default configuration.

Syntax
ip https server no ip https server

Default Configuration
Disabled.

Page 304 Not approved by Document Control. For review only.

Web Server Commands

Command Mode
Global Configuration mode

User Guidelines
Use the crypto certificate generate Global Configuration mode command to generate an HTTPS certificate.

Example
The following example enables configuring the device from a secured browser. Console(config)# ip https server

ip https port
The ip https port Global Configuration mode command specifies the TCP port used by the server to configure the device through the Web browser. Use the no form of this command to return to the default configuration.

Syntax
ip https port port-number no ip https port

Parameters port-number Port number to be used by the HTTP server. (Range: 1 - 65535) Default Configuration
The default port number is 443.

Command Mode
Global Configuration mode

User Guidelines
Specifying 0 as the port number effectively disables HTTP access to the device.

Example
The following example configures the https port number to 100. Console(config)# ip https port 100

ip https exec-timeout
iThe ip https exec-timeout Global Configuration mode command sets the interval for the system wait for user input in https sessions, before automatic logoff. Use the no form of this command to restore the default configuration.

Syntax
ip https exec-timeout minutes [seconds] no ip https exec-timeout

Page 305

Allied Telesis
Command Line Interface Users Guide

Parameters minutes Integer that specifies the number of minutes. (Range: 1 - 65535) seconds Additional time intervals in seconds. (Range: 0-59) Default Configuration
The default configuration is the exec-timeout set by the ip http exec-timeout command.

Command Mode
Global Configuration mode

User Guidelines
To specify no timeout, enter the ip https exec-timeout 0 0 command.

Example
The following example configures sets the interval for the system to 1hour. Console(config)# ip https exec-timeout 60

crypto certificate generate


The crypto certificate generate Global Configuration mode command generates a self-signed HTTPS certificate.

Syntax
crypto certificate [number] generate [key-generate length][cn common- name][ou organization-unit][or organization] [loc location] [st state] [cu country] [duration days]

Parameters number Specifies the certificate number. (Range: 1 - 2) key-generate Regenerate the SSL RSA key. length Specifies the SSL RSA key length. (Range: 512 - 2048) common- name Specifies the fully qualified URL or IP address of the device.
(Range: 1 - 64) organization Specifies the organization name. (Range: 1 - 64) organization-unit Specifies the organization-unit or department name.(Range: 1 - 64) location Specifies the location or city name. (Range: 1 - 64) state Specifies the state or province name. (Range: 1 - 64) country Specifies the country name. (Range: 2 - 2) days Specifies number of days certification is valid. (Range: 30 - 3650)

Default Configuration
The Certificate and SSLs RSA key pairs do not exist. If no certificate number is specified, the default certificate number is 1. If no RSA key length is specified, the default length is 1024.

Page 306 Not approved by Document Control. For review only.

Web Server Commands

If no URL or IP address is specified, the default common name is the lowest IP address of the device at the time that the certificate is generated. If the number of days is not specified, the default period of time that the certification is valid is 365 days.

Command Mode
Global Configuration mode

User Guidelines
The command is not saved in the device configuration; however, the certificate and keys generated by this command are saved in the private configuration (which is never displayed to the user or backed up to another device). Use this command to generate a self-signed certificate for the device. If the RSA keys do not exist, parameter key-generate must be used.

Example
The following example regenerates an HTTPS certificate. Console(config)# crypto certificate 1 generate key-generate

crypto certificate request


The crypto certificate request Privileged EXEC mode command generates and displays certificate requests for HTTPS.

Syntax
crypto certificate number request [cn common- name ][ou organization-unit][or organization] [loc location] [st state] [cu country]

Parameters number Specifies the certificate number. (Range: 1 - 2) common- name Specifies the fully qualified URL or IP address of the device.
(Range: 1- 64) organization-unit Specifies the organization-unit or department name. (Range: 1- 64) organization Specifies the organization name. (Range: 1- 64) location Specifies the location or city name. (Range: 1- 64) state Specifies the state or province name. (Range: 1- 64) country Specifies the country name. (Range: 1- 2)

Default Configuration
There is no default configuration for this command.

Command Mode
Privileged EXEC mode

Page 307

Allied Telesis
Command Line Interface Users Guide

User Guidelines
Use this command to export a certificate request to a Certification Authority. The certificate request is generated in Base64-encoded X.509 format. Before generating a certificate request you must first generate a self-signed certificate using the crypto certificate generate Global Configuration mode command. Be aware that you have to reenter the certificate fields. After receiving the certificate from the Certification Authority, use the crypto certificate import Global Configuration mode command to import the certificate into the device. This certificate replaces the self-signed certificate.

Example
The following example generates and displays a certificate request for HTTPS. Console# crypto certificate 1 request -----BEGIN CERTIFICATE REQUEST----MIwTCCASoCAQAwYjELMAkGA1UEBhMCUFAxCzAJBgNVBAgTAkNDMQswCQYDVQQH EwRDEMMAoGA1UEChMDZGxkMQwwCgYDVQQLEwNkbGQxCzAJBgNVBAMTAmxkMRAw DgKoZIhvcNAQkBFgFsMIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQC8ecwQ HdML0831i0fh/F0MV/Kib6Sz5p+3nUUenbfHp/igVPmFM+1nbqTDekb2ymCu6K aKvEbVLF9F2LmM7VPjDBb9bb4jnxkvwW/wzDLvW2rsy5NPmH1QVl+8Ubx3GyCm /oW93BSOFwxwEsP58kf+sPYPy+/8wwmoNtDwIDAQABoB8wHQYJKoZIhvcNAQkH MRDjEyMwgICCAgICAICAgIMA0GCSqGSIb3DQEBBAUAA4GBAGb8UgIx7rB05m+2 m5ZZPhIwl8ARSPXwhVdJexFjbnmvcacqjPG8pIiRV6LkxryGF2bVU3jKEipcZa g+uNpyTkDt3ZVU72pjz/fa8TF0n3 -----END CERTIFICATE REQUEST----CN= router.gm.com 0= General Motors C= US

crypto certificate import


The crypto certificate import Global Configuration mode command imports a certificate signed by the Certification Authority for HTTPS.

Syntax
crypto certificate number import

Parameters number Specifies the certificate number. (Range: 1 - 2) Default Configuration


This command has no default configuration.

Command Mode
Global Configuration mode

Page 308 Not approved by Document Control. For review only.

Web Server Commands

User Guidelines
Use this command to enter an external certificate (signed by Certification Authority) to the device. To end the session, enter an empty line. The imported certificate must be based on a certificate request created by the crypto certificate request Privileged EXEC mode command. If the public key found in the certificate does not match the device's SSL RSA key, the command fails. This command is not saved in the device configuration; however, the certificate imported by this command is saved in the private configuration (which is never displayed to the user or backed up to another device).

Example
The following example imports a certificate signed by Certification Authority for HTTPS. Console(config)# crypto certificate 1 import -----BEGIN CERTIFICATE----dHmUgUm9vdCBDZXJ0aWZpZXIwXDANBgkqhkiG9w0BAQEFAANLADBIAkEAp4HS nnH/xQSGA2ffkRBwU2XIxb7n8VPsTm1xyJ1t11a1GaqchfMqqe0kmfhcoHSWr yf1FpD0MWOTgDAwIDAQABo4IBojCCAZ4wEwYJKwYBBAGCNxQCBAYeBABDAEEw CwR0PBAQDAgFGMA8GA1UdEwEB/wQFMAMBAf8wHQYDVR0OBBYEFAf4MT9BRD47 ZvKBAEL9Ggp+6MIIBNgYDVR0fBIIBLTCCASkwgdKggc+ggcyGgclsZGFwOi8v L0VByb3h5JTIwU29mdHdhcmUlMjBSb290JTIwQ2VydGlmaWVyLENOPXNlcnZl -----END CERTIFICATE----Certificate imported successfully. Issued to: router.gm.com Issued by: www.verisign.com Valid from: 8/9/2003 to 8/9/2004 Subject: CN= router.gm.com, 0= General Motors, C= US Finger print: DC789788 DC88A988 127897BC BB789788

ip https certificate
The ip https certificate Global Configuration mode command configures the active certificate for HTTPS. Use the no form of this command to return to the default configuration.

Syntax
ip https certificate number no ip https certificate

Parameters number Specifies the certificate number. (Range: 1 - 2) Default Configuration


Certificate number 1.

Page 309

Allied Telesis
Command Line Interface Users Guide

Command Mode
Global Configuration mode

User Guidelines
The crypto certificate generate command should be used to generate HTTPS certificates.

Example
The following example configures the active certificate for HTTPS. Console(config)# ip https certificate 1

show crypto certificate mycertificate


The show crypto certificate mycertificate Privileged EXEC mode command displays the SSH certificates of the device.

Syntax
show crypto certificate mycertificate [number]

Parameters number Specifies the certificate number. (Range: 1- 2) Default Configuration


This command has no default configuration.

Command Mode
Privileged EXEC mode

User Guidelines
There are no user guidelines for this command.

Example
The following example displays the certificate. Console# show crypto certificate mycertificate 1 -----BEGIN CERTIFICATE----dHmUgUm9vdCBDZXJ0aWZpZXIwXDANBgkqhkiG9w0BAQEFAANLADBIAkEAp4HS nnH/xQSGA2ffkRBwU2XIxb7n8VPsTm1xyJ1t11a1GaqchfMqqe0kmfhcoHSWr yf1FpD0MWOTgDAwIDAQABo4IBojCCAZ4wEwYJKwYBBAGCNxQCBAYeBABDAEEw CwR0PBAQDAgFGMA8GA1UdEwEB/wQFMAMBAf8wHQYDVR0OBBYEFAf4MT9BRD47 ZvKBAEL9Ggp+6MIIBNgYDVR0fBIIBLTCCASkwgdKggc+ggcyGgclsZGFwOi8v L0VByb3h5JTIwU29mdHdhcmUlMjBSb290JTIwQ2VydGlmaWVyLENOPXNlcnZl -----END CERTIFICATE-----

Page 310 Not approved by Document Control. For review only.

Web Server Commands

Issued by: www.verisign.com Valid from: 8/9/2003 to 8/9/2004 Subject: CN= router.gm.com, 0= General Motors, C= US Finger print: DC789788 DC88A988 127897BC BB789788

show ip http
The show ip http Privileged EXEC mode command displays the HTTP server configuration.

Syntax
show ip http

Default Configuration
This command has no default configuration.

Command Mode
Privileged EXEC mode

User Guidelines
There are no user guidelines for this command.

Example
The following example displays the HTTP server configuration. Console# show ip http HTTP server enabled. Port: 80

show ip https
The show ip https Privileged EXEC mode command displays the HTTPS server configuration.

Syntax
show ip https

Default Configuration
This command has no default configuration.

Command Mode
Privileged EXEC mode

User Guidelines
There are no user guidelines for this command.

Page 311

Allied Telesis
Command Line Interface Users Guide

Example
The following example displays the HTTP server configuration. Console# show ip https HTTPS server enabled. Port: 443 Certificate 1 is active Issued by: www.verisign.com Valid from: 8/9/2004 to 8/9/2005 Subject: CN= router.gm.com, 0= General Motors, C= US Finger print: DC789788 DC88A988 127897BC BB789788 Certificate 2 is inactive Issued by: self-signed Valid from: 8/9/2004 to 8/9/2005 Subject: CN= router.gm.com, 0= General Motors, C= US Finger print: 1873B936 88DC3411 BC8932EF 782134BA

Page 312 Not approved by Document Control. For review only.

802.1x Commands

Chapter 32.802.1x Commands


aaa authentication dot1x
The aaa authentication dot1x Global Configuration mode command specifies one or more authentication, authorization, and accounting (AAA) methods for use on interfaces running IEEE 802.1X. Use the no form of this command to return to the default configuration.

Syntax
aaa authentication dot1x default method1 [method2...] no aaa authentication dot1x default

Parameters method1 [method2...] At least one from the following table:


Keyword Radius None Description Uses the list of all RADIUS servers for authentication Uses no authentication

Default Configuration
No authentication method is defined.

Command Mode
Global Configuration mode

User Guidelines
Additional methods of authentication are used only if the previous method returns an error and not if the request for authentication is denied. To ensure that authentication succeeds even if all methods return an error, specify none as the final method in the command line. The RADIUS server must support MD-5 challenge and EAP type frames.

Example
The following example uses the aaa authentication dot1x default command with no authentication. Console(config)# aaa authentication dot1x default none

dot1x system-auth-control
The dot1x system-auth-control Global Configuration mode command enables 802.1x globally. Use the no form of this command to return to the default configuration.

Syntax
dot1x system-auth-control

Page 313

Allied Telesis
Command Line Interface Users Guide

no dot1x system-auth-control

Default Configuration
802.1x is disabled globally.

Command Modes
Global Configuration mode

User Guidelines
There are no user guidelines for this command.

Example
The following example enables 802.1x globally. Console(config)# dot1x system-auth-control

dot1x port-control
The dot1x port-control Interface Configuration mode command enables manually controlling the authorization state of the port. Use the no form of this command to return to the default configuration.

Syntax
dot1x port-control {auto | force-authorized | force-unauthorized} no dot1x port-control

Parameters auto Enables 802.1X authentication on the interface and causes the port to transition to the authorized or
unauthorized state based on the 802.1X authentication exchange between the port and the client. force-authorized Disables 802.1X authentication on the interface and causes the port to transition to the authorized state without any authentication exchange required. The port resends and receives normal traffic without 802.1X-based authentication of the client. force-unauthorized Denies all access through this interface by forcing the port to transition to the unauthorized state and ignoring all attempts by the client to authenticate. The device cannot provide authentication services to the client through the interface.

Default Configuration
Port is in the force-authorized state

Command Mode
Interface Configuration (Ethernet)

User Guidelines
It is recommended to disable spanning tree or to enable spanning-tree PortFast mode on 802.1x edge ports (ports in auto state that are connected to end stations), in order to get immediately to the forwarding state after successful authentication.

Page 314 Not approved by Document Control. For review only.

802.1x Commands

Example
The following example enables 802.1X authentication on Ethernet port 1/e16. Console(config)# interface ethernet 1/e16 Console(config-if)# dot1x port-control auto

dot1x re-authentication
The dot1x re-authentication Interface Configuration mode command enables periodic re-authentication of the client. Use the no form of this command to return to the default configuration.

Syntax
dot1x re-authentication no dot1x re-authentication

Default Configuration
Periodic re-authentication is disabled.

Command Mode
Interface Configuration (Ethernet)

User Guidelines
There are no user guidelines for this command.

Example
The following example enables periodic re-authentication of the client. Console(config)# interface ethernet 1/e16 Console(config-if)# dot1x re-authentication

dot1x timeout re-authperiod


The dot1x timeout re-authperiod Interface Configuration mode command sets the number of seconds between re-authentication attempts. Use the no form of this command to return to the default configuration.

Syntax
dot1x timeout re-authperiod seconds no dot1x timeout re-authperiod

Parameters seconds Number of seconds between re-authentication attempts. (Range: 300 - 4294967295) Default Configuration
Re-authentication period is 3600 seconds.

Page 315

Allied Telesis
Command Line Interface Users Guide

Command Mode
Interface Configuration (Ethernet) mode

User Guidelines
There are no user guidelines for this command.

Example
The following example sets the number of seconds between re-authentication attempts, to 300. Console(config)# interface ethernet 1/e16 Console(config-if)# dot1x timeout re-authperiod 300

dot1x re-authenticate
The dot1x re-authenticate Privileged EXEC mode command manually initiates a re-authentication of all 802.1Xenabled ports or the specified 802.1X-enabled port.

Syntax
dot1x re-authenticate [ethernet interface]

Parameters interface Valid Ethernet port. (Full syntax: unit/port) Default Configuration
This command has no default configuration.

Command Mode
Privileged EXEC mode

User Guidelines
There are no user guidelines for this command.

Example
The following example manually initiates a re-authentication of 802.1X-enabled Ethernet port 1/e16. Console# dot1x re-authenticate ethernet 1/e16

dot1x timeout quiet-period


The dot1x timeout quiet-period Interface Configuration mode command sets the number of seconds that the device remains in the quiet state following a failed authentication exchange (for example, the client provided an invalid password). Use the no form of this command to return to the default configuration.

Syntax
dot1x timeout quiet-period seconds no dot1x timeout quiet-period

Page 316 Not approved by Document Control. For review only.

802.1x Commands

Parameters seconds Specifies the time in seconds that the device remains in the quiet state following a failed
authentication exchange with the client. (Range: 0 - 65535 seconds)

Default Configuration
Quiet period is 60 seconds.

Command Mode
Interface Configuration (Ethernet) mode

User Guidelines
During the quiet period, the device does not accept or initiate authentication requests. The default value of this command should only be changed to adjust for unusual circumstances, such as unreliable links or specific behavioral problems with certain clients and authentication servers. To provide a faster response time to the user, a smaller number than the default value should be entered.

Example
The following example sets the number of seconds that the device remains in the quiet state following a failed authentication exchange to 3600. Console(config)# interface ethernet 1/e16 Console(config-if)# dot1x timeout quiet-period 3600

dot1x timeout tx-period


The dot1x timeout tx-period Interface Configuration mode command sets the number of seconds that the device waits for a response to an Extensible Authentication Protocol (EAP)-request/identity frame from the client before resending the request. Use the no form of this command to return to the default configuration.

Syntax
dot1x timeout tx-period seconds no dot1x timeout tx-period

Parameters seconds Specifies the time in seconds that the device waits for a response to an EAP-request/identity
frame from the client before resending the request. (Range: 30-65535 seconds)

Default Configuration
Timeout period is 30 seconds.

Command Mode
Interface Configuration (Ethernet) mode

Page 317

Allied Telesis
Command Line Interface Users Guide

User Guidelines
The default value of this command should be changed only to adjust for unusual circumstances, such as unreliable links or specific behavioral problems with certain clients. and authentication servers

Example
The following command sets the number of seconds that the device waits for a response to an EAP-request/ identity frame, to 3600 seconds. Console(config)# interface ethernet 1/e16 Console(config-if)# dot1x timeout tx-period 3600

dot1x max-req
The dot1x max-req Interface Configuration mode command sets the maximum number of times that the device sends an Extensible Authentication Protocol (EAP)-request/identity frame (assuming that no response is received) to the client, before restarting the authentication process. Use the no form of this command to return to the default configuration.

Syntax
dot1x max-req count no dot1x max-req

Parameters count Number of times that the device sends an EAP-request/identity frame before restarting the
authentication process. (Range: 1-10)

Default Configuration
The default number of times is 2.

Command Mode
Interface Configuration (Ethernet) mode

User Guidelines
The default value of this command should be changed only to adjust for unusual circumstances, such as unreliable links or specific behavioral problems with certain clients. and authentication servers

Example
The following example sets the number of times that the device sends an EAP-request/identity frame to 6 . Console(config)# interface ethernet 1/e16 Console(config-if)# dot1x max-req 6

dot1x timeout supp-timeout


The dot1x timeout supp-timeout Interface Configuration mode command sets the time for the retransmission of an Extensible Authentication Protocol (EAP)-request frame to the client. Use the no form of this command to return to the default configuration.

Page 318 Not approved by Document Control. For review only.

802.1x Commands

Syntax
dot1x timeout supp-timeout seconds no dot1x timeout supp-timeout

Parameters seconds Time in seconds that the device waits for a response to an EAP-request frame from the client
before resending the request. (Range: 1- 65535 seconds)

Default Configuration
Default timeout period is 30 seconds.

Command Mode
Interface configuration (Ethernet) mode

User Guidelines
The default value of this command should be changed only to adjust for unusual circumstances, such as unreliable links or specific behavioral problems with certain clients. and authentication servers

Example
The following example sets the timeout period before retransmitting an EAP-request frame to the client to 3600 seconds. Console(config-if)# dot1x timeout supp-timeout 3600

dot1x timeout server-timeout


The dot1x timeout server-timeout Interface Configuration mode command sets the time that the device waits for a response from the authentication server. Use the no form of this command to return to the default configuration.

Syntax
dot1x timeout server-timeout seconds no dot1x timeout server-timeout

Parameters seconds Time in seconds that the device waits for a response from the authentication server.
(Range: 1-65535 seconds)

Default Configuration
The timeout period is 30 seconds.

Command Mode
Interface configuration (Ethernet) mode

Page 319

Allied Telesis
Command Line Interface Users Guide

User Guidelines
The actual timeout can be determined by comparing the dot1x timeout server-timeout value and the result of multiplying the radius-server retransmit value with the radius-server timeout value and selecting the lower of the two values.

Example
The following example sets the time for the retransmission of packets to the authentication server to 3600 seconds. Console(config-if)# dot1x timeout server-timeout 3600

show dot1x
The show dot1x Privileged EXEC mode command displays the 802.1X status of the device or specified interface.

Syntax
show dot1x [ethernet interface]

Parameters interface Valid Ethernet port. (Full syntax: unit/port) Default Configuration
This command has no default configuration.

Command Mode
Privileged EXEC mode

User Guidelines
There are no user guidelines for this command.

Example
The following example displays the status of 802.1X-enabled Ethernet ports. Console# show dot1x 802.1x is disabled Port ---1/e1 1/e2 1/e3 1/e4 Admin Mode ---------Auto Auto Auto Auto Oper Mode --------Authorized Authorized Authorized Authorized Reauth Control ------Enabled Enabled Enabled Enabled Reauth Period -----3600 3600 3600 3600 Username -------Bob John Clark Bill

Page 320 Not approved by Document Control. For review only.

802.1x Commands

1/e5

Force-auth

Unauthorized*

Disabled

3600

n/a

* Port is down or not present. console# Console# show dot1x ethernet 1/e1 802.1x is enabled. Port ---1/e1 Admin Mode ---------Auto Oper Mode --------Unauthorized Reauth Control ------Enabled Reauth Period -----3600 Username -------n/a

Quiet period: 60 Seconds Tx period:30 Seconds Max req: 2 Supplicant timeout: 30 Seconds Server timeout: 30 Seconds Session Time (HH:MM:SS): 00:00:00 MAC Address: 00:00:00:00:00:00 Authentication Method: Remote Termination Cause: Reauthentication failed Authenticator State Machine State: CONNECTING Backend State Machine State: IDLE Authentication success: 0 Authentication fails: 0

Console# show dot1x 802.1x is enabled

Page 321

Allied Telesis
Command Line Interface Users Guide

Port ---1/e1 1/e2 1/e3 1/e4 1/e5

Admin Mode ---------Auto Auto Auto Force-auth Force-auth

Oper Mode --------Authorized Authorized Unauthorized Authorized Unauthorized*

Reauth Control ------Ena Ena Ena Dis Dis

Reauth Period -----3600 3600 3600 3600 3600

Username -------Bob John Clark n/a n/a

* Port is down or not present. Console# show dot1x ethernet 1/e3 802.1x is enabled. Port ---1/e3 Admin Mode ---------Auto Oper Mode --------Unauthorized Reauth Control ------Ena Reauth Period -----3600 Username -------Clark

Quiet period: 60 Seconds Tx period:30 Seconds Max req: 2 Supplicant timeout: 30 Seconds Server timeout: 30 Seconds Session Time (HH:MM:SS): 08:19:17 MAC Address: 00:08:78:32:98:78 Authentication Method: Remote Termination Cause: Supplicant logoff Authenticator State Machine State: HELD Backend State Machine State: IDLE Authentication success: 9 Authentication fails: 1

Page 322 Not approved by Document Control. For review only.

802.1x Commands

The following table describes significant fields shown above: Field Port Admin mode Oper mode Reauth Control Reauth Period Username Description The port number. The port admin mode. Possible values: Force-auth, Force-unauth, Auto. The port oper mode. Possible values: Authorized, Unauthorized or Down. Reauthentication control. Reauthentication period. The username representing the identity of the Supplicant. This field shows the username in case the port control is auto. If the port is Authorized, it shows the username of the current user. If the port is unauthorized it shows the last user that was authenticated successfully. The number of seconds that the device remains in the quiet state following a failed authentication exchange (for example, the client provided an invalid password). The number of seconds that the device waits for a response to an Extensible Authentication Protocol (EAP)-request/identity frame from the client before resending the request. The maximum number of times that the device sends an Extensible Authentication Protocol (EAP)-request frame (assuming that no response is received) to the client before restarting the authentication process. Time in seconds the switch waits for a response to an EAP-request frame from the client before resending the request. Time in seconds the switch waits for a response from the authentication server before resending the request. The amount of time the user is logged in. The supplicant MAC address. The authentication method used to establish the session. The reason for the session termination. The current value of the Authenticator PAE state machine and of the Backend state machine. The number of times the state machine received a Success message from the Authentication Server. The number of times the state machine received a Failure message from the Authentication Server.

Quiet period

Tx period

Max req

Supplicant timeout Server timeout Session Time MAC address Authentication Method Termination Cause State Authentication success Authentication fails

show dot1x users


The show dot1x users Privileged EXEC mode command displays active 802.1X authenticated users for the device.

Syntax
show dot1x users [username username]

Page 323

Allied Telesis
Command Line Interface Users Guide

Parameters username Supplicant username (Range: 1-160 characters) Default Configuration


This command has no default configuration.

Command Mode
Privileged EXEC mode

User Guidelines
There are no user guidelines for this command.

Example
The following example displays 802.1X users. Console# show dot1x users Port ----1/e1 1/e2 Username -------Bob John Session Time -----------1d:03:08.58 08:19:17 Auth Method ----------Remote None MAC Address -------------0008:3b79:8787 0008:3b89:3127

Console# show dot1x users username Bob Username: Bob Port ----1/e1 Username -------Bob Session Time -----------1d:03:08.58 Auth Method ----------Remote MAC Address -------------0008:3b79:8787

The following table describes significant fields shown above: Field Port Username Session Time Authentication Method MAC Address Description The port number. The username representing the identity of the Supplicant. The period of time the Supplicant is connected to the system. Authentication method used by the Supplicant to open the session. MAC address of the Supplicant.

show dot1x statistics


The show dot1x statistics Privileged EXEC mode command displays 802.1X statistics for the specified interface.

Page 324 Not approved by Document Control. For review only.

802.1x Commands

Syntax
show dot1x statistics ethernet interface

Parameters interface Valid Ethernet port. (Full syntax: unit/port) Default Configuration
This command has no default configuration.

Command Mode
Privileged EXEC mode

User Guidelines
There are no user guidelines for this command.

Example
The following example displays 802.1X statistics for the specified interface. Console# show dot1x statistics ethernet 1/e1 EapolFramesRx: 11 EapolFramesTx: 12 EapolStartFramesRx: 12 EapolLogoffFramesRx: 1 EapolRespIdFramesRx: 3 EapolRespFramesRx: 6 EapolReqIdFramesTx: 3 EapolReqFramesTx: 6 InvalidEapolFramesRx: 0 EapLengthErrorFramesRx: 0 LastEapolFrameVersion: 1 LastEapolFrameSource: 00:08:78:32:98:78

Page 325

Allied Telesis
Command Line Interface Users Guide

The following table describes the significant fields shown in the display: Field EapolFramesRx EapolFramesTx EapolStartFramesRx EapolLogoffFramesRx EapolRespIdFramesRx EapolRespFramesRx EapolReqIdFramesTx EapolReqFramesTx InvalidEapolFramesRx EapLengthErrorFramesRx LastEapolFrameVersion LastEapolFrameSource Description The number of valid EAPOL frames of any type that have been received by this Authenticator. The number of EAPOL frames of any type that have been transmitted by this Authenticator. The number of EAPOL Start frames that have been received by this Authenticator. The number of EAPOL Logoff frames that have been received by this Authenticator. The number of EAP Resp/Id frames that have been received by this Authenticator. The number of valid EAP Response frames (other than Resp/Id frames) that have been received by this Authenticator. The number of EAP Req/Id frames that have been transmitted by this Authenticator. The number of EAP Request frames (other than Rq/Id frames) that have been transmitted by this Authenticator. The number of EAPOL frames that have been received by this Authenticator in which the frame type is not recognized. The number of EAPOL frames that have been received by this Authenticator in which the Packet Body Length field is invalid. The protocol version number carried in the most recently received EAPOL frame. The source MAC address carried in the most recently received EAPOL frame.

dot1x auth-not-req
The dot1x auth-not-req Interface Configuration (VLAN) mode command enables unauthorized devices access to the VLAN. Use the no form of this command to disable access to the VLAN.

Syntax
dot1x auth-not-req no dot1x auth-not-req

Default Configuration
Access is enabled.

Command Mode
Interface Configuration (VLAN) mode

Page 326 Not approved by Document Control. For review only.

802.1x Commands

User Guidelines
An access port cannot be a member in an unauthenticated VLAN. The native VLAN of a trunk port cannot be an unauthenticated VLAN. For a general port, the PVID can be an unauthenticated VLAN (although only tagged packets would be accepted in the unauthorized state.)

Example
The following example enables access to the VLAN to unauthorized devices. Console(config)# interface vlan 5 Console(config-if)# dot1x auth-not-req

dot1x guest-vlan
The dot1x guest-vlan Interface Configuration mode command defines a guest VLAN. Use the no form of this command to return to the default configuration.

Syntax
dot1x guest-vlan no dot1x guest-vlan

Default Configuration
No VLAN is defined as a guest VLAN.

Command Mode
Interface Configuration (VLAN) mode

User Guidelines
Use the dot1x guest-vlan enable Interface Configuration mode command to enable unauthorized users on an interface to access the guest VLAN. If the guest VLAN is defined and enabled, the port automatically joins the guest VLAN when the port is unauthorized and leaves it when the port becomes authorized. To be able to join or leave the guest VLAN, the port should not be a static member of the guest VLAN.

Example
The following example defines VLAN 2 as a guest VLAN. Console# Console# configure Console(config)# vlan database Console(config-vlan)# vlan 2 Console(config-vlan)# exit Console(config)# interface vlan 2 Console(config-if)# dot1x guest-vlan

Page 327

Allied Telesis
Command Line Interface Users Guide

dot1x single-host-violation
The dot1x single-host-violation Interface Configuration (Ethernet) mode command configures the action to be taken, when a station whose MAC address is not the supplicant MAC address, attempts to access the interface. Use the no form of this command to restore defaults.

Syntax
dot1x single-host-violation {forward | disgard | disgard-shutdown [ trap seconds ] no port dot1x single-host-violation

Parameters forward Forwards frames with source addresses that are not the supplicant address, but does not learn
the source addresses. discard Discards frames with source addresses that are not the supplicant address. discard-shutdown Discards frames with source addresses that are not the supplicant address. The port is also shut down. trap seconds Indicates that SNMP traps are sent. Specifies the minimum amount of time in seconds between consecutive traps. (Range: 1- 1000000)

Default Configuration
Frames with source addresses that are not the supplicant address are discarded. No traps are sent.

Command Mode
Interface Configuration (Ethernet) mode

User Guidelines
The command is relevant when multiple hosts is disabled and the user has been successfully authenticated.

Example
The following example forwards frames with source addresses that are not the supplicant address and sends consecutive traps at intervals of 100 seconds. Console(config)# interface ethernet 1/16 Console(config-if)# dot1x single-host-violation forward trap 100

dot1x mac-authentication
The mac-authentication Interface Configuration mode command enables authentication based on the station's MAC address. Use the no form of this command to disable MAC authentication.

Syntax
dot1x mac-authentication {mac-only | mac-and-802.1x} no dot1x mac-authentication

Page 328 Not approved by Document Control. For review only.

802.1x Commands

Parameters mac-only Enable authentication based on the station's MAC address only. 802.1X frames are ignored. mac-and-802.1x Enable 802.1X authentication and MAC address authentication on the interface. Default Configuration
Disabled.

Command Mode
Interface configuration (Ethernet)

User Guidelines
Guest VLAN must be enabled when MAC authentication is enabled. Static MAC addresses can't be authorized. Do not change authenticated MAC address to static address. It is not recommended to delete authenticated MAC addresses. Reauthentication must be enabled when working in this mode.

Example
The following example enables authentication based on the station's MAC address. Console# configure Console(config)# interface ethernet 1/e1 Console(config-if)# dot1x mac-authentication

show dot1x advanced


The show dot1x advanced privileged EXEC mode command displays 802.1X advanced features for the switch or for the specified interface.

Syntax
show dot1x advanced

Parameters interface Ethernet interface. Default Configuration


This command has no default configuration.

Command Mode
Privileged EXEC

User Guidelines
There are no user guidelines for this command.

Example

Page 329

Allied Telesis
Command Line Interface Users Guide

The following example displays 802.1X advanced features for the switch. Console# show dot1x advanced

Guest VLAN: 3978 Unauthenticated VLANs: 91,92

Interface --------1/1 1/2

Multiple Hosts -------------Disabled Enabled

Guest VLAN ---------Enabled Disabled

MAC Authentication ---------MAC-and-802.1X Disabled

Console# show dot1x advanced ethernet 1/1 Guest VLAN: 2 Unauthenticated VLANs: 91,92

Interface --------1/1 1/2

Multiple Hosts -------------Disabled Enabled

Guest VLAN ---------Enabled Disabled

MAC Authentication ---------MAC-and-802.1X Disabled

Single host parameters Violation action: Discard Trap: Enabled Trap frequency: 100 Status: Single-host locked Violations since last trap: 9

dot1x guest-vlan enable


The dot1x guest-vlan enable Interface Configuration mode command enables unauthorized users on the interface access to the Guest VLAN. Use the no form of this command to disable access.

Syntax
dot1x guest-vlan enable no dot1x guest-vlan enable

Page 330 Not approved by Document Control. For review only.

802.1x Commands

Default Configuration
Disabled.

Command Mode
Interface Configuration (Ethernet) mode

User Guidelines
A device can have only one global guest VLAN. The guest VLAN is defined using the dot1x guest-vlan Interface Configuration mode command.

Example
The following example enables unauthorized users on Ethernet port 1/e1 to access the guest VLAN. Console# configure Console(config)# interface ethernet 1/e1 Console(config-if)# dot1x guest-vlan enable

Page 331

Allied Telesis
Command Line Interface Users Guide

Index
A aaa authentication dot1x 313 aaa authentication dot1x default 313 aaa authentication enable 25 aaa authentication login 24 aaa logging 250 abort (mst) 224 autobaud 132 B back-pressure 88 boot system 69, 75 bridge address 34 bridge aging-time 38 bridge multicast address 35 bridge multicast filtering 34 bridge multicast forbidden address 36 bridge multicast forbidden forward-all 38 bridge multicast forward-all 37 C channel-group 153 clear bridge 39 clear counters 89 clear gvrp statistics 106 clear logging 248 clear logging file 249 clear spanning-tree detected-protocol 217 CLI Command Conventions 11 CLI Command Modes 5 clock set 52 clock source 52 clock summer-time 54 clock timezone 53 Command Completion 10 configure 277 Contacting Allied Telesis 4 copy 65, 72, 74 crypto certificate generate 306

crypto certificate import 308 crypto certificate request 307 crypto key generate dsa 237 crypto key generate rsa 237 crypto key pubkey-chain ssh 238 D delete 68, 74 deny (Management) 146 description 84 disable 276 Document Conventions 3 dot1x guest-vlan 327, 328 dot1x guest-vlan enable 330 dot1x max-req 318 dot1x port-control 314 dot1x re-authenticate 316 dot1x re-authentication 315 dot1x system-auto-control 313 dot1x timeout quiet-period 316 dot1x timeout re-authperiod 315 dot1x timeout server-timeout 319 dot1x timeout supp-timeout 318 dot1x timeout tx-period 317 duplex 85 E Editing Features 9 enable 276 enable authentication 27 end 279 Entering Commands 9 exec-timeout 133 exit 278 exit (Configuration) 278 exit (mst) 223 F file-system logging 250 flowcontrol 86 G garp timer 104 Global Configuration Mode 6 gvrp enable (Global) 103

Page 332

Index

gvrp enable (Interface) 103 gvrp registration-forbid 105 gvrp vlan-creation-forbid 105 H help 279 history 133 history size 134 hostname 265 how bootvar 71 I instance (mst) 220 Intended Audience 2 Interface Configuration Mode 7 interface ethernet 82 interface port-channel 152 interface range ethernet 82 interface range port-channel 152 interface range vlan 286 interface vlan 284, 285 ip address 119 ip address-dhcp 119 ip default-gateway 120 ip http authentication 27 ip http port 303 ip http server 303 ip https authentication 28 ip https certificate 309 ip https port 305 ip https server 304 ip igmp snooping (Global) 110 ip igmp snooping (Interface) 110 ip igmp snooping host-time-out 112, 113, 114 ip igmp snooping leave-time-out 115 ip igmp snooping mrouter learn-pim-dvmrp 111 ip igmp snooping mrouter-time-out 114 ip internal-usage-vlan 296 ip ssh port 236 ip ssh pubkey-auth 238 ip ssh server 236

K Keyboard Shortcuts 10 key-string 240 L line 131 logging 245 logging buffered 247 logging buffered size 247 logging console 246 logging file 249 logging on 245 login 277 login authentication 26 M management access-class 146 management access-list 144 management logging 251 map mac macs-group 294 mdix 87 N name 286 name (mst) 221 negotiation 86 P password 30 permit (Management) 145 ping 262 port monitor 155 port security 39 port security max 41 port security mode 40 port security routed secure-address 41 port storm-control broadcast enable 100 port storm-control broadcast rate 101 port storm-control include-multicast (IC) 95, 99 power inline 157 power inline powered-device 157 power inline priority 158 power inline traps enable 159 power inline usage-threshold 159

Page 333

Allied Telesis
Command Line Interface Users Guide

Preface 1 priority-queue out num-of-queues 165 Privileged EXEC Mode 5 Q qos 164 qos cos 170 qos map dscp-queue 169 qos trust (Global) 170 R radius-server deadtime 175 radius-server host 172 radius-server key 173 radius-server retransmit 173 radius-server source-ip 174 radius-server timeout 175 rate-limit 165 reload 264 revision (mst) 222 rmon alarm 184 rmon collection history 180 rmon event 187 rmon table-size 190 S set interface active 90 show (mst) 222 show authentication methods 29 show bridge address-table 42 show bridge address-table count 44, 45 show bridge address-table static 43 show bridge multicast address-table 45 show bridge multicast filtering 47 show clock 61 show copper-ports cable-length 150 show copper-ports tdr 149 show crypto certificate mycertificate 310 show crypto key mypubkey 242 show crypto key pubkey-chain ssh 243 show dot1x 320 show dot1x advanced 331 show dot1x statistics 324 show dot1x users 323

show gvrp configuration 106 show gvrp error-statistics 108 show gvrp statistics 107 show history 281 show interfaces advertise 90 show interfaces counters 95 show interfaces description 94 show interfaces port-channel 153 show interfaces status 93 show interfaces switchport 299 show ip http 311 show ip https 311 show ip igmp snooping groups 118 show ip igmp snooping interface 117 show ip igmp snooping mrouter 116 show ip interface 121 show ip ssh 241 show line 135 show logging 252 show logging file 253 show management access-class 148 show management access-list 147 show ports security 49 show ports security addresses 50 show ports storm-control 102 show power inline 160 show privilege 281 show qos 164 show qos interface 166 show qos map 170 show radius-servers 176 show rmon alarm 186 show rmon alarm-table 185 show rmon collection history 180 show rmon events 188 show rmon history 181 show rmon log 189 show rmon statistics 178 show running-config 69, 76 show sessions 270 show snmp 203

Page 334

Index

show snmp engineID 204 show snmp filters 206 show snmp groups 205 show snmp users 207 show snmp views 205 show sntp configuration 62 show sntp status 63 show spanning-tree 224 show stack 267 show startup-config 70, 76 show syslog-servers 256 show system 271 show tacacs 260 show users 269 show version 273 show vlan 298 show vlan internal usage 298 show vlan macs-group 295 shutdown 83 snmp-server community 192 snmp-server contact 201 snmp-server enable traps 197 snmp-server engineID local 196 snmp-server filter 197 snmp-server group 194 snmp-server host 198 snmp-server location 201 snmp-server set 202 snmp-server trap authentication 200 snmp-server user 194 snmp-server v3-host 199 snmp-server view 193 sntp anycast client enable 58 sntp authenticate 56 sntp authentication-key 55 sntp broadcast client enable 57 sntp client enable (Interface) 59 sntp client poll timer 57 sntp server 60 sntp trusted-key 56 sntp unicast client enable 59

sntp unicast client poll 60 spanning-tree 208 spanning-tree bpdu 215 spanning-tree cost 212, 213 spanning-tree disable 211 spanning-tree forward-time 209 spanning-tree hello-time 209 spanning-tree link-type 214 spanning-tree max-age 210 spanning-tree mode 208 spanning-tree mst configuration 220 spanning-tree mst cost 219 spanning-tree mst max-hops 218 spanning-tree mst port-priority 218 spanning-tree mst priority 217 spanning-tree pathcost method 214 spanning-tree portfast 213 spanning-tree port-priority 213 spanning-tree priority 211 speed 84, 131 stack change unit-id 267 stack master 265 stack reload 266 Starting the CLI 8 switchport access vlan 289 switchport forbidden vlan 295 switchport general acceptable-frame-type tagged-only 293 switchport general allowed vlan 290 switchport general map macs-group vlan 293 switchport general pvid 291 switchport mode 288 switchport protected 287 switchport trunk allowed vlan 289 switchport trunk native vlan 290 T tacacs-server host 258 tacacs-server key 259 tacacs-server source-ip 260 tacacs-server timeout 259 Terminal Command Buffer 9

Page 335

Allied Telesis
Command Line Interface Users Guide

terminal history 134 terminal history size 135 test copper-port tdr 149 traffic-shape 166 U User EXEC Mode 5 user-key 239 username 30 V vlan 283 vlan database 283 W wrr-queue cos-map 167

Page 336

You might also like