Page 1
TL-SG3210/TL-SG3216/TL-SG3424/TL-SG3424P
JetStream L2 Managed Switch
REV3.0.0
1910011092
Page 2
COPYRIGHT & TRADEMARKS
Specifications are subject to change without notice. is a registered trademark of
TP-LINK TECHNOLOGIES CO., LTD. Other brands and product names are trademarks or
registered trademarks of their respective holders.
No part of the specifications may be reproduced in any form or by any means or used to make any
derivative such as translation, transformation, or adaptation without permission from TP-LINK
TECHNOLOGIES CO., LTD. Copyright © 2014 TP-LINK TECHNOLOGIES CO., LTD. All rights
reserved.
http://www.tp-link.com
I
Page 3
CONTENTS
Preface .............................................................................................................. 1
Chapter 1 Using the CLI ......................................................................................... 4
1.1 Accessing the CLI............................................................................................................. 4
1.1.1 Logon by a console port ........................................................................................ 4
1.1.2 Configuring the Privileged EXEC Mode Password ................................................ 6
1.1.3 Logon by Telnet ...................................................................................................... 7
1.1.4 Logon by SSH ....................................................................................................... 11
1.2 CLI Command Modes .................................................................................................... 16
1.3 Security Levels ............................................................................................................... 18
1.4 Conventions .................................................................................................................... 18
1.4.1 Format Conventions ............................................................................................. 18
1.4.2 Special Characters ............................................................................................... 19
1.4.3 Parameter Format ................................................................................................ 19
Chapter 2 User Interface ...................................................................................... 20
enable ...................................................................................................................................... 20
service password-encryption .................................................................................................. 20
enable password ..................................................................................................................... 21
enable secret ........................................................................................................................... 22
disable ..................................................................................................................................... 23
configure .................................................................................................................................. 23
exit ........................................................................................................................................... 23
end........................................................................................................................................... 24
history ...................................................................................................................................... 24
history clear ............................................................................................................................. 25
Chapter 3 IEEE 802.1Q VLAN Commands .......................................................... 26
vlan .......................................................................................................................................... 26
interface vlan ........................................................................................................................... 26
name ....................................................................................................................................... 27
switchport mode ...................................................................................................................... 27
switchport access vlan ............................................................................................................ 28
switchport trunk allowed vlan .................................................................................................. 28
switchport general allowed vlan .............................................................................................. 29
switchport pvid ........................................................................................................................ 30
II
Page 4
show vlan summary ................................................................................................................ 30
show vlan brief ........................................................................................................................ 31
show vlan ................................................................................................................................ 31
Chapter 4 MAC-based VLAN Commands ............................................................ 32
mac-vlan mac-address ............................................................................................................ 32
show mac-vlan ........................................................................................................................ 32
Chapter 5 Protocol-based VLAN Commands ....................................................... 34
protocol-vlan template ............................................................................................................. 34
protocol-vlan vlan .................................................................................................................... 35
protocol-vlan group ................................................................................................................. 35
show protocol-vlan template ................................................................................................... 36
show protocol-vlan vlan........................................................................................................... 36
Chapter 6 Voice VLAN Commands ...................................................................... 37
voice vlan ................................................................................................................................ 37
voice vlan aging time ............................................................................................................... 37
voice vlan priority .................................................................................................................... 38
voice vlan mac-address .......................................................................................................... 38
switchport voice vlan mode ..................................................................................................... 39
switchport voice vlan security ................................................................................................. 40
show voice vlan ....................................................................................................................... 40
show voice vlan oui ................................................................................................................. 41
show voice vlan switchport ..................................................................................................... 41
Chapter 7 GVRP Commands ............................................................................... 42
gvrp(global) ............................................................................................................................. 42
gvrp(interface) ......................................................................................................................... 42
gvrp registration ...................................................................................................................... 43
gvrp timer ................................................................................................................................ 43
show gvrp global ..................................................................................................................... 44
show gvrp interface ................................................................................................................. 45
Chapter 8 Etherchannel Commands .................................................................... 46
channel-group ......................................................................................................................... 46
port-channel load-balance ...................................................................................................... 47
lacp system-priority ................................................................................................................. 47
lacp port-priority ...................................................................................................................... 48
III
Page 5
show etherchannel .................................................................................................................. 48
show etherchannel load-balance ............................................................................................ 49
show lacp ................................................................................................................................ 49
show lacp sys-id ...................................................................................................................... 50
Chapter 9 User Manage Commands .................................................................... 51
user name (password) ............................................................................................................ 51
user name (secret) .................................................................................................................. 52
user access-control ip-based .................................................................................................. 53
user access-control mac-based .............................................................................................. 54
user access-control port-based............................................................................................... 54
user max-number .................................................................................................................... 55
user idle-timeout ...................................................................................................................... 56
line ........................................................................................................................................... 56
password ................................................................................................................................. 57
login ......................................................................................................................................... 58
login local ................................................................................................................................ 59
show user account-list............................................................................................................. 59
show user configuration .......................................................................................................... 60
Chapter 10 Binding Table Commands .................................................................... 61
ip source binding ..................................................................................................................... 61
ip source binding index ........................................................................................................... 62
ip dhcp snooping ..................................................................................................................... 63
ip dhcp snooping global .......................................................................................................... 63
ip dhcp snooping information option ....................................................................................... 64
ip dhcp snooping information strategy .................................................................................... 65
ip dhcp snooping information remote-id .................................................................................. 65
ip dhcp snooping information circuit-id ................................................................................... 66
ip dhcp snooping trust ............................................................................................................. 67
ip dhcp snooping mac-verify ................................................................................................... 67
ip dhcp snooping limit rate ...................................................................................................... 68
ip dhcp snooping decline ........................................................................................................ 68
show ip source binding............................................................................................................ 69
show ip dhcp snooping............................................................................................................ 69
show ip dhcp snooping information ........................................................................................ 70
show ip dhcp snooping interface gigabitEthernet ................................................................... 70
Chapter 11 ARP Inspection Commands ................................................................ 72
IV
Page 6
ip arp inspection(global) .......................................................................................................... 72
ip arp inspection trust .............................................................................................................. 72
ip arp inspection(interface) ...................................................................................................... 73
ip arp inspection limit-rate ....................................................................................................... 74
ip arp inspection recover ......................................................................................................... 74
show ip arp inspection............................................................................................................. 75
show ip arp inspection interface.............................................................................................. 75
show ip arp inspection statistics .............................................................................................. 76
clear ip arp inspection statistics .............................................................................................. 76
Chapter 12 DoS Defend Command ....................................................................... 77
ip dos-prevent ......................................................................................................................... 77
ip dos-prevent type .................................................................................................................. 77
show ip dos-prevent ................................................................................................................ 78
Chapter 13 IEEE 802.1X Commands ..................................................................... 79
dot1x system-auth-control ....................................................................................................... 79
dot1x auth-method .................................................................................................................. 79
dot1x guest-vlan(global) .......................................................................................................... 80
dot1x quiet-period ................................................................................................................... 81
dot1x timeout ........................................................................................................................... 81
dot1x max-reauth-req .............................................................................................................. 82
dot1x ........................................................................................................................................ 82
dot1x guest-vlan(interface) ..................................................................................................... 83
dot1x port-control .................................................................................................................... 83
dot1x port-method ................................................................................................................... 84
radius ....................................................................................................................................... 85
radius server-account .............................................................................................................. 86
show dot1x global ................................................................................................................... 87
show dot1x interface ............................................................................................................... 87
show radius accounting .......................................................................................................... 88
show radius authentication ..................................................................................................... 88
Chapter 14 System Log Commands ...................................................................... 89
logging buffer ........................................................................................................................... 89
logging file flash ...................................................................................................................... 90
logging file flash frequency ..................................................................................................... 90
logging file flash level .............................................................................................................. 91
clear logging ............................................................................................................................ 91
V
Page 7
logging host index ................................................................................................................... 92
show logging local-config ........................................................................................................ 93
show logging loghost ............................................................................................................... 93
show logging buffer ................................................................................................................. 94
show logging flash ................................................................................................................... 94
Chapter 15 SSH Commands .................................................................................. 96
ip ssh server ............................................................................................................................ 96
ip ssh version .......................................................................................................................... 96
ip ssh timeout .......................................................................................................................... 97
ip ssh max-client ..................................................................................................................... 97
ip ssh download ...................................................................................................................... 98
show ip ssh .............................................................................................................................. 98
Chapter 16 SSL Commands ................................................................................ 100
ip http secure-server ............................................................................................................. 100
ip http secure-server download certificate ............................................................................ 100
ip http secure-server download key ...................................................................................... 101
show ip http secure-server .................................................................................................... 102
Chapter 17 MAC Address Commands ................................................................. 103
mac address-table static ....................................................................................................... 103
mac address-table aging-time ............................................................................................... 104
mac address-table filtering .................................................................................................... 104
mac address-table max-mac-count....................................................................................... 105
show mac address-table ....................................................................................................... 106
show mac address-table aging-time ..................................................................................... 106
show mac address-table max-mac-count interface gigabitEthernet .................................... 107
show mac address-table interface gigabitEthernet ............................................................... 107
show mac address-table count ............................................................................................. 108
show mac address-table address ......................................................................................... 108
show mac address-table vlan ............................................................................................... 109
Chapter 18 System Configuration Commands ...................................................... 110
system-time manual ............................................................................................................... 110
system-time ntp ...................................................................................................................... 110
system-time dst predefined .................................................................................................... 112
system-time dst date .............................................................................................................. 113
system-time dst recurring ....................................................................................................... 114
VI
Page 8
hostname ................................................................................................................................ 115
location ................................................................................................................................... 115
contact-info ............................................................................................................................. 11 6
ip management-vlan ............................................................................................................... 116
ip address ............................................................................................................................... 117
ip address-alloc dhcp ............................................................................................................. 117
ip address-alloc bootp ............................................................................................................ 118
reset ....................................................................................................................................... 118
reboot ..................................................................................................................................... 119
copy running-config startup-config ......................................................................................... 119
copy startup-config tftp ........................................................................................................... 119
copy tftp startup-config .......................................................................................................... 120
firmware upgrade .................................................................................................................. 121
ping ........................................................................................................................................ 121
tracert .................................................................................................................................... 122
show system-time ................................................................................................................. 123
show system-time dst ............................................................................................................ 124
show system-time ntp ........................................................................................................... 124
show system-info .................................................................................................................. 124
show running-config .............................................................................................................. 125
show cable-diagnostics interface .......................................................................................... 125
Chapter 19 IPv6 Address Configuration Commands ............................................ 127
ipv6 enable ............................................................................................................................ 127
ipv6 address autoconfig ........................................................................................................ 127
ipv6 address link-local ........................................................................................................... 128
ipv6 address dhcp ................................................................................................................. 128
ipv6 address ra ...................................................................................................................... 129
ipv6 address eui-64 ............................................................................................................... 130
ipv6 address .......................................................................................................................... 130
show ipv6 interface vlan ........................................................................................................ 131
Chapter 20 Ethernet Configuration Commands ................................................... 132
interface gigabitEthernet ....................................................................................................... 132
interface range gigabitEthernet ............................................................................................. 132
description ............................................................................................................................. 133
shutdown ............................................................................................................................... 133
flow-control ............................................................................................................................ 134
VII
Page 9
media-type ............................................................................................................................. 134
duplex .................................................................................................................................... 135
speed ..................................................................................................................................... 136
storm-control broadcast ........................................................................................................ 136
storm-control multicast .......................................................................................................... 137
storm-control unicast ............................................................................................................. 138
bandwidth .............................................................................................................................. 138
clear counters ........................................................................................................................ 139
show interface status ............................................................................................................ 140
show interface counters ........................................................................................................ 140
show interface description .................................................................................................... 141
show interface flowcontrol ..................................................................................................... 141
show interface configuration ................................................................................................. 142
show storm-control ................................................................................................................ 142
show bandwidth..................................................................................................................... 143
Chapter 21 QoS Commands ................................................................................ 144
qos ......................................................................................................................................... 144
qos dscp ................................................................................................................................ 144
qos queue cos-map ............................................................................................................... 145
qos queue dscp-map ............................................................................................................. 146
qos queue mode ................................................................................................................... 147
show qos interface ................................................................................................................ 148
show qos cos-map ................................................................................................................ 148
show qos dscp-map .............................................................................................................. 149
show qos queue mode .......................................................................................................... 149
show qos status..................................................................................................................... 150
Chapter 22 Port Mirror Commands ...................................................................... 151
monitor session destination interface ................................................................................... 151
monitor session source interface .......................................................................................... 152
show monitor session ............................................................................................................ 153
Chapter 23 Port Isolation Commands .................................................................. 154
port isolation .......................................................................................................................... 154
show port isolation interface ................................................................................................. 154
Chapter 24 Loopback Detection Commands ....................................................... 156
loopback-detection(global) .................................................................................................... 156
VIII
Page 10
loopback-detection interval ................................................................................................... 156
loopback-detection recovery-time ......................................................................................... 157
loopback-detection(interface) ................................................................................................ 157
loopback-detection config ..................................................................................................... 158
loopback-detection recover ................................................................................................... 158
show loopback-detection global ............................................................................................ 159
show loopback-detection interface ....................................................................................... 159
Chapter 25 PoE Commands ................................................................................ 161
power inline consumption (global) ........................................................................................ 161
power inline disconnect-method ........................................................................................... 161
power profile .......................................................................................................................... 162
power time-range .................................................................................................................. 163
power holiday ........................................................................................................................ 164
absolute ................................................................................................................................. 164
periodic .................................................................................................................................. 165
holiday ................................................................................................................................... 166
power inline consumption(interface) ..................................................................................... 166
power inline priority ............................................................................................................... 167
power inline supply ................................................................................................................ 168
power inline profile ................................................................................................................ 168
power inline time-range ......................................................................................................... 169
show power inline .................................................................................................................. 169
show power inline configuration interface ............................................................................. 170
show power inline information interface ................................................................................ 170
show power profile ................................................................................................................ 170
show power holiday ............................................................................................................... 171
show power time-range ......................................................................................................... 171
Chapter 26 ACL Commands ................................................................................ 172
time-range ............................................................................................................................. 172
absolute ................................................................................................................................. 172
periodic .................................................................................................................................. 173
holiday ................................................................................................................................... 174
holiday(global) ....................................................................................................................... 174
access-list create .................................................................................................................. 175
mac access-list ...................................................................................................................... 175
access-list standard .............................................................................................................. 176
IX
Page 11
access-list extended .............................................................................................................. 177
rule......................................................................................................................................... 178
access-list policy name ......................................................................................................... 179
access-list policy action......................................................................................................... 180
redirect interface ................................................................................................................... 180
redirect vlan ........................................................................................................................... 181
s-condition ............................................................................................................................. 181
s-mirror .................................................................................................................................. 182
qos-remark ............................................................................................................................ 182
access-list bind(interface) ..................................................................................................... 183
access-list bind(vlan) ............................................................................................................. 184
show time-range .................................................................................................................... 184
show holiday.......................................................................................................................... 184
show access-list .................................................................................................................... 185
show access-list policy .......................................................................................................... 185
show access-list bind ............................................................................................................ 186
Chapter 27 MSTP Commands ............................................................................. 187
spanning-tree(global) ............................................................................................................ 187
spanning-tree(interface) ........................................................................................................ 187
spanning-tree common-config .............................................................................................. 188
spanning-tree mode .............................................................................................................. 189
spanning-tree mst configuration ............................................................................................ 189
instance ................................................................................................................................. 190
name ..................................................................................................................................... 191
revision .................................................................................................................................. 191
spanning-tree mst instance ................................................................................................... 192
spanning-tree mst ................................................................................................................. 192
spanning-tree priority ............................................................................................................ 193
spanning-tree tc-defend ........................................................................................................ 194
spanning-tree timer ............................................................................................................... 194
spanning-tree hold-count ...................................................................................................... 195
spanning-tree max-hops ....................................................................................................... 196
spanning-tree bpdufilter ........................................................................................................ 196
spanning-tree bpduguard ...................................................................................................... 197
spanning-tree guard loop ...................................................................................................... 197
spanning-tree guard root ....................................................................................................... 198
spanning-tree guard tc .......................................................................................................... 198
X
Page 12
spanning-tree mcheck ........................................................................................................... 199
show spanning-tree active .................................................................................................... 199
show spanning-tree bridge .................................................................................................... 200
show spanning-tree interface ................................................................................................ 200
show spanning-tree interface-security .................................................................................. 201
show spanning-tree mst ........................................................................................................ 201
Chapter 28 IGMP Snooping Commands .............................................................. 203
ip igmp snooping(global) ....................................................................................................... 203
ip igmp snooping(interface) ................................................................................................... 203
ip igmp snooping immediate-leave ....................................................................................... 204
ip igmp snooping drop-unknown ........................................................................................... 204
ip igmp snooping vlan-config ................................................................................................ 205
ip igmp snooping multi-vlan-config ....................................................................................... 206
ip igmp snooping filter add-id ................................................................................................ 207
ip igmp snooping filter(global) ............................................................................................... 208
ip igmp snooping filter(interface) ........................................................................................... 208
ip igmp snooping filter maxgroup .......................................................................................... 209
ip igmp snooping filter mode ................................................................................................. 209
show ip igmp snooping.......................................................................................................... 210
show ip igmp snooping interface........................................................................................... 210
show ip igmp snooping vlan ................................................................................................... 211
show ip igmp snooping multi-vlan ......................................................................................... 212
show ip igmp snooping groups ............................................................................................. 212
show ip igmp snooping filter .................................................................................................. 213
Chapter 29 MLD Snooping Commands ............................................................... 214
ipv6 mld snooping ................................................................................................................. 214
ipv6 mld snooping router-aging-time .................................................................................... 214
ipv6 mld snooping member-aging-time ................................................................................. 215
ipv6 mld snooping report-suppression .................................................................................. 215
ipv6 mld snooping unknown-filter.......................................................................................... 216
ipv6 mld snooping last-listener query-inteval ........................................................................ 216
ipv6 mld snooping last-listener query-count ......................................................................... 217
ipv6 mld snooping multicast-vlan .......................................................................................... 217
ipv6 mld snooping multicast-vlan vlan-id .............................................................................. 218
ipv6 mld snooping vlan.......................................................................................................... 218
ipv6 mld snooping vlan router-aging-time ............................................................................. 219
XI
Page 13
ipv6 mld snooping vlan member-aging-time ......................................................................... 219
ipv6 mld snooping vlan immediate-leave .............................................................................. 220
ipv6 mld snooping vlan mrouter ............................................................................................ 220
ipv6 mld snooping vlan static ................................................................................................ 221
ipv6 mld snooping querier vlan ............................................................................................. 221
ipv6 mld snooping querier vlan max-response-time ............................................................. 222
ipv6 mld snooping querier vlan query-interval ...................................................................... 223
ipv6 mld snooping querier vlan query-source ....................................................................... 223
ipv6 mld snooping filter(global) ............................................................................................. 224
ipv6 mld snooping filter(interface) ......................................................................................... 224
ipv6 mld snooping filter-mode ............................................................................................... 225
ipv6 mld snooping filter-id ..................................................................................................... 225
ipv6 mld snooping max-group ............................................................................................... 226
clear ipv6 mld snooping statistics ......................................................................................... 226
show ipv6 mld snooping ........................................................................................................ 227
show ipv6 mld snooping vlan ................................................................................................ 227
show ipv6 mld snooping static-mcast ................................................................................... 228
show ipv6 mld snooping group ............................................................................................. 228
show ipv6 mld snooping filter ................................................................................................ 228
show ipv6 mld snooping interface ......................................................................................... 229
show ipv6 mld snooping interface filter ................................................................................. 229
show ipv6 mld snooping querier ........................................................................................... 230
show ipv6 mld snooping statistics ......................................................................................... 230
Chapter 30 SNMP Commands ............................................................................. 231
snmp-server .......................................................................................................................... 231
snmp-server view .................................................................................................................. 231
snmp-server group ................................................................................................................ 232
snmp-server user .................................................................................................................. 233
snmp-server community ........................................................................................................ 235
snmp-server host .................................................................................................................. 235
snmp-server engineID ........................................................................................................... 237
snmp-server traps snmp ....................................................................................................... 238
snmp-server traps link-status ................................................................................................ 238
snmp-server traps ................................................................................................................. 239
snmp-server traps mac ......................................................................................................... 240
snmp-server traps vlan .......................................................................................................... 241
rmon history ........................................................................................................................... 241
XII
Page 14
rmon event ............................................................................................................................ 242
rmon alarm ............................................................................................................................ 243
show snmp-server ................................................................................................................. 245
show snmp-server view......................................................................................................... 245
show snmp-server group ...................................................................................................... 245
show snmp-server user ......................................................................................................... 246
show snmp-server community .............................................................................................. 246
show snmp-server host ......................................................................................................... 247
show snmp-server engineID ................................................................................................. 247
show rmon history ................................................................................................................. 247
show rmon event ................................................................................................................... 248
show rmon alarm ................................................................................................................... 248
Chapter 31 LLDP Commands .............................................................................. 250
lldp ......................................................................................................................................... 250
lldp hold-multiplier ................................................................................................................. 250
lldp timer ................................................................................................................................ 251
lldp med-fast-count ................................................................................................................ 252
lldp receive ............................................................................................................................ 252
lldp transmit ........................................................................................................................... 253
lldp snmp-trap ........................................................................................................................ 253
lldp tlv-select .......................................................................................................................... 254
lldp med-location ................................................................................................................... 255
lldp med-status ...................................................................................................................... 255
lldp med-tlv-select ................................................................................................................. 256
show lldp ............................................................................................................................... 257
show lldp interface ................................................................................................................ 257
show lldp local-information interface ..................................................................................... 258
show lldp neighbor-information interface .............................................................................. 258
show lldp traffic interface ....................................................................................................... 259
Chapter 32 Cluster Commands ............................................................................ 260
cluster ndp ............................................................................................................................. 260
cluster ntdp ............................................................................................................................ 261
cluster explore ....................................................................................................................... 262
cluster .................................................................................................................................... 262
cluster candidate ................................................................................................................... 263
cluster individual .................................................................................................................... 263
XIII
Page 15
show cluster ndp ................................................................................................................... 264
show cluster ntdp .................................................................................................................. 264
show cluster neighbour ......................................................................................................... 265
show cluster manage role ..................................................................................................... 265
XIV
Page 16
Preface
This Guide is intended for network administrator to provide referenced information about CLI
(Command Line Interface). The switch mentioned in this Guide stands for
TL-SG3210/TL-SG3216/TL-SG3424/TL-SG3424P without any explanation. The commands in this
guilde apply to these four models if not specially noted, and TL-SG3424 is taken as an example
model in the example commands.
Overview of this Guide
Chapter 1: Using the CLI
Provide information about how to use the CLI, CLI Command Modes, Security Levels and some
Conventions.
Chapter 2: User Interface
Provide information about the commands used to switch between five CLI Command Modes.
Chapter 3: IEEE 802.1Q VLAN Commands
Provide information about the commands used for configuring IEEE 802.1Q VLAN.
Chapter 4: MAC-Based VLAN Commands
Provide information about the commands used for configuring MAC-Based VLAN.
Chapter 5: Protocol-Based VLAN Commands
Provide information about the commands used for configuring Protocol-Based VLAN.
Chapter 6: Voice VLAN Commands
Provide information about the commands used for configuring Voice VLAN.
Chapter 7: GVRP Commands
Provide information about the commands used for configuring GVRP (GARP VLAN registration
protocol).
Chapter 8: Etherchannel Commands
Provide information about the commands used for configuring LAG (Link Aggregation Group) and
LACP (Link Aggregation Control Protocol).
Chapter 9: User Manage Commands
Provide information about the commands used for user management.
Chapter 10: Binding Table Commands
Provide information about the commands used for binding the IP address, MAC address, VLAN
and the connected Port number of the Host together. Besides it also provide information about the
commands used for monitoring the process of the Host obtaining the IP address from DHCP server,
1
Page 17
and record the IP address, MAC address, VLAN and the connected Port number of the Host for
automatic binding.
Chapter 11: ARP Inspection Commands
Provide information about the commands used for protecting the switch from the ARP cheating or
ARP Attack.
Chapter 12: DoS Defend Command
Provide information about the commands used for DoS defend and detecting the DoS attack.
Chapter 13: IEEE 802.1X Commands
Provide information about the commands used for configuring IEEE 802.1X function.
Chapter 14: System Log Commands
Provide information about the commands used for configuring system log.
Chapter 15: SSH Commands
Provide information about the commands used for configuring and managing SSH (Security Shell).
Chapter 16: SSL Commands
Provide information about the commands used for configuring and managing SSL (Secure Sockets
Layer).
Chapter 17: MAC Address Commands
Provide information about the commands used for Address configuration.
Chapter 18: System Configuration Commands
Provide information about the commands used for configuring the System information and System
IP, reboot and reset the switch, upgrade the switch system and commands used for cable test.
Chapter 19: IPv6 Address Configuration Commands
Provide information about the commands used for configuring the System IPv6 addresses.
Chapter 20: Ethernet Configuration Commands
Provide information about the commands used for configuring the Bandwidth Control, Negotiation
Mode, and Storm Control for Ethernet ports.
Chapter 21: QoS Commands
Provide information about the commands used for configuring the QoS function.
Chapter 22: Port Mirror Commands
Provide information about the commands used for configuring the Port Mirror function.
Chapter 23: Port Isolation Commands
Provide information about the commands used for configuring the Port Isolation function.
Chapter 24: Loopback Detection Commands
Provide information about the commands used for configuring the Loopback Detection function.
2
Page 18
Chapter 25: PoE Commands
Provide information about the commands used for configuring PoE function.
Chapter 26: ACL Commands
Provide information about the commands used for configuring the ACL (Access Control List).
Chapter 27: MSTP Commands
Provide information about the commands used for configuring the MSTP (Multiple Spanning Tree
Protocol).
Chapter 28: IGMP Snooping Commands
Provide information about the commands used for configuring the IGMP Snooping (Internet Group
Management Protocol Snooping).
Chapter 29: MLD Snooping Commands
Provide information about the commands used for configuring the MLD Snooping (Multicast
Listener Discovery Snooping).
Chapter 30: SNMP Commands
Provide information about the commands used for configuring the SNMP (Simple Network
Management Protocol) functions.
Chapter 31: LLDP Commands
Provide information about the commands used for configuring LLDP function.
Chapter 32: Cluster Commands
Provide information about the commands used for configuring the Cluster Management function.
3
Page 19
Chapter 1 Using the CLI
1.1 Accessing the CLI
You can log on to the switch and access the CLI by the following two methods:
1. Log on to the switch by the console port on the switch.
2. Log on to the switch remotely by a Telnet or SSH connection through an Ethernet port.
1.1.1 Logon by a console port
To log on to the switch by the console port on the switch, please take the following steps:
1. Connect the PCs or Terminals to the console port on the switch by a provided cable.
2. Click Start →
open the Hyper Terminal as the Figure 1-1 shown.
All Programs → Accessories→ Communications → Hyper Terminal to
Figure 1-1 Open
3. The Connection Description Window will prompt as Figure 1-2 shown. Enter a name into
the Name field and click OK.
Hyper Terminal
4
Page 20
Figure 1-2 Connection Description
4. Select the port to connect in Figure 1-3, and click OK.
Figure 1-3 Select the port to connect
5. Configure the port selected in the step above as the following Figure 1-4 shown.
Configure Bits per second as 38400, Data bits as 8, Parity as None, Stop bits as 1,
Flow control as None, and then click OK.
5
Page 21
Figure 1-4 Port Settings
6. The DOS prompt” TL-SG3424>” will appear after pressing the Enter button as Figure 1-5
shown. It indicates that you can use the CLI now.
Figure 1-5 Log in the Switch
1.1.2 Configuring the Privileged EXEC Mode Password
To configure the switch remotely by a Telnet or SSH connection, please set a password for entering
the Privileged EXEC Mode through the console connection first. Follow the steps in
1.1.1 Logon
by a console port to log on to the switch, and then follow the steps shown in Figure 1-6 to
configure the Privileged EXEC Mode password.
6
Page 22
Figure 1-6 Configure the Privileged EXEC Mode Password
1.1.3 Logon by Telnet
To successfully create Telnet connection, firstly CLI commands about configuring Telnet login
mode, login authentication information and Privileged EXEC Mode password should be configured
through Console connection.
Telnet login has the following two modes, you can choose one according to your needs:
Login local Mode: It requires username and password, which are both admin by default.
Login Mode: It requires no username and password, but a connection password is required.
Note:
Before Telnet login, you are required to configure Telnet login mode and login authentication
information through console connection.
Login Local Mode
Firstly, enter the Privileged EXEC Mode password set in
1.1.2 Configuring the Priviledged EXEC
Mode Password and configure the Telnet login mode as “login local” in the prompted DOS screen
shown in Figure 1-7.
Figure 1-7 Configure login local mode
7
Page 23
Now, you can logon by Telnet in login local mode.
1. Make sure the switch and the PC are in the same LAN. Click Start → Run to open the Run
window, and type cmd in the prompt Run window as Figure 1-8 and click OK.
Figure 1-8 Run Window
2. Open Telnet and type telnet 192.168.0.1 in the command prompt shown as Figure 1-9, and
press the Enter button.
Figure 1-9 Connecting to the Switch
3. Type the default user name and password admin/admin, then press the Enter button so as to
enter User EXEC Mode.
Figure 1-11 Enter into the User EXEC Mode
Now you can manage your switch with CLI commands through Telnet connection.
8
Page 24
4. Type enable command to enter Privileged EXEC Mode. A password that you have set through
Console port connection is required. Here the password is set as 123.
Figure 1-12 Enter into the Privileged EXEC Mode
Login Mode
Firstly enter the Privileged EXEC Mode password set in
1.1.2 Configuring the Priviledged EXEC
Mode Password and configure the Telnet login mode as “login” and the connection password and
456 in the prompted DOS screen shown in Figure 1-13.
Figure 1-13 Configure login mode
Now, you can logon by Telnet in login mode:
1. Open Telnet and type telnet 192.168.0.1 in the command prompt shown as Figure 1-14, and
press the Enter button.
9
Page 25
Figure 1-14 Connecting to the Switch
2. You are prompted to enter the connection password 456 you have set through Console port
connection, and then you are in User EXEC Mode.
Figure 1-16 Enter into the User EXEC Mode
1. When entering enable command to access Privileged EXEC Mode, you are required to give
the password 123 you have set through Console port connection.
Figure 1-17 Enter into the Privileged EXEC Mode
10
Page 26
Now you can manage your switch with CLI commands through Telnet connection.
Note:
You can refer to Chapter 9 User Manage Commands
for detailed commands information of the
Telnet connection configuration.
1.1.4 Logon by SSH
To log on by SSH, a Putty client software is recommended. There are two authentication modes to
set up an SSH connection:
Password Authentication Mode: It requires username and password, which are both admin by
default.
Key Authentication Mode: It requires a public key for the switch and a private key for the SSH
client software. You can generate the public key and the private key through Putty Key Generator.
Note:
Before SSH login, please follow the steps shown in Figure 1-16 to enable the SSH function through
console connection.
Figure 1-16 Enable SSH function
Password Authentication Mode
1. Open the software to log on to the interface of PuTTY. Enter the IP address of the switch into
Host Name field; keep the default value 22 in the Port field; select SSH as the Connection
type.
11
Page 27
Figure 1-17 SSH Connection Config
2. Click the Open button in the above figure to log on to the switch. Enter the login user name
and password to log on the switch, and then enter the Privileged EXEC Mode password, so
you can continue to configure the switch.
Figure 1-18 Log on the Switch
Key Authentication Mode
1. Select the key type and key length, and generate SSH key.
12
Page 28
Figure 1-19 Generate SSH Key
Note:
1. The key length is in the range of 256 to 3072 bits.
2. During the key generation, randomly moving the mouse quickly can accelerate the key
generation.
2. After the key is successfully generated, please save the public key and private key to a TFTP
server.
13
Page 29
Figure 1-20 Save the Generated Key
3. Log on to the switch by the console port, and download the public key file from the TFTP
server to the switch, as the following figure shows:
Figure 1-21 Download the Public Key
Note:
1. The key type should accord with the type of the key file.
2. The SSH key downloading can not be interrupted.
14
Page 30
4. After the public key is loaded, please log on to the interface of PuTTY and enter the IP address
for login.
Figure 1-22 SSH Connection Config
5. Click Browse to load the private key file to SSH client software and click Open.
Figure 1-23 Load the Private Key
15
Page 31
User EXEC
Primary mode once it
is connected with the
switch (except that the switch is
command to access
ommand to enter this
command to access
User EXEC Mode
……
VLAN Configuration Mode
After successful authentication, please enter the login user name. If you log on to the switch
without entering password, it indicates that the key has been successfully loaded.
Figure 1-24 Log on the Switch
1.2 CLI Command Modes
The CLI is divided into different command modes: User EXEC Mode, Privileged EXEC Mode,
Global Configuration Mode, Interface Configuration Mode and VLAN Configuration Mode. Interface
Configuration Mode can also be divided into Interface gigabitEthernet, Interface link-aggregation
and some other modes, which is shown as the following diagram.
Interface Configuration Mode
Interface gigabitEthernet
Interface link-aggregation
Interface range gigabitEthernet
password
Interface range link-aggregation
Interface vlan
Privileged EXEC
Mode
Global Configuration
Mode
The following table gives detailed information about the Accessing path, Prompt of each mode and
how to exit the current mode and access the next mode.
Mode Accessing Path Prompt Logout or Access the next mode
Use the exit command to disconnect the
Mode
TL-SG3424>
switch.
connected through the Console port).
Use the enable
Privileged EXEC mode.
Use the enable
Privileged
EXEC Mode
c
mode from User EXEC
mode.
TL-SG3424#
16
Enter the disable or the exit command
to return to User EXEC mode.
Enter configure
Global Configuration mode.
Page 32
command to enter this
e gigabitEthernet
command to access interface
enter this mode from
Global Configuration
command to
A port number must be specified in the
command to enter this
command to
Mode Accessing Path Prompt Logout or Access the next mode
Use the exit or the end command or
press Ctrl+Z to return to Privileged
EXEC mode.
Use the interface gigabitEthernet port
or interface rang
port-list
Configuration mode.
Use the vlan vlan-list to access VLAN
Configuration mode.
Global
Configuration
Mode
Use the configure
mode from Privileged
EXEC mode.
TL-SG3424 (config)#
Interface
Configuration
Mode
VLAN
Configuration
Mode
Use the interface
gigabitEthernet port
or interface range
gigabitEthernet
port-list command to
mode.
Use the vlan vlan-list
mode from Global
Configuration mode.
TL-SG3424
(config-if)# or
TL-SG3424
(config-if-range)#
TL-SG3424
(config-vlan)#
Use the end command or press Ctrl+Z
to return to Privileged EXEC mode.
Enter the exit or the #
return to Global Configuration mode.
interface command.
Use the end command or press Ctrl+Z
to return to Privileged EXEC mode.
Enter the exit or the #
return to Global configuration mode.
Note:
1. The user is automatically in User EXEC Mode after the connection between the PC and
the switch is established by a console port or by a telnet connection.
2. Each command mode has its own set of specific commands. To configure some
commands, you should access the corresponding command mode firstly.
Global Configuration Mode: In this mode, global commands are provided, such as
the Spanning Tree, Schedule Mode and so on.
Interface Configuration Mode: In this mode, users can configure one or several
ports, different ports corresponds to different commands
a). Interface gigabitEthernet: Configure parameters for an Ethernet port, such as
Duplex-mode, flow control status.
b). Interface range gigabitEthernet: The commands contained are the same as that
of the Interface gigabiteEthernet. Configure parameters for several Ethernet
ports.
c). Interface link-aggregation: Configure parameters for a link-aggregation, such as
broadcast storm.
d). Interface range link-aggregation: Configure parameters for multi-trunks.
e). Interface vlan: Configure parameters for the vlan-port.
17
Page 33
Vlan Configuration Mode: In this mode, users can create a VLAN and add a
specified port to the VLAN.
3. Some commands are global, that means they can be performed in all modes:
show: Displays all information of switch, for example: statistic information, port
information, VLAN information.
history: Displays the commands history.
1.3 Security Levels
This switch’s security is divided into two levels: User level and Admin level.
User level only allows users to do some simple operations in User EXEC Mode; Admin level allows
you to monitor, configure and manage the switch in Privileged EXEC Mode, Global Configuration
Mode, Interface Configuration Mode and VLAN Configuration Mode.
For logging on remotely by Telnet or SSH, you need a username and password (both admin by
default) to get the privilege to the User level. Guest users are restricted to access the CLI. Users
can enter Privileged EXEC mode from User EXEC mode by using the enable command and
entering a Privileged EXEC mode password. Please connect to the switch by console port to
configure the Privileged EXEC mode password.
For logging on by console port, you can enter the User EXEC mode directly. Users can enter
Privileged EXEC mode from User EXEC mode by using the enable command. In default case, no
password is needed. In Global Configuration Mode, you can configure password for Admin level by
enable password command. Once password is configured, you are required to enter it to access
Privileged EXEC mode.
1.4 Conventions
1.4.1 Format Conventions
The following conventions are used in this Guide:
Items in square brackets [ ] are optional
Items in braces { } are required
Alternative items are grouped in braces and separated by vertical bars. For example: speed
{10 | 100 | 1000 }
Bold indicates an unalterable keyword. For example: show logging
18
Page 34
Normal Font indicates a constant (several options are enumerated and only one can be
selected). For example: switchport type { access | trunk | general }
Italic Font indicates a variable (an actual value must be assigned). For example: bridge
aging-time aging-time
1.4.2 Special Characters
You should pay attentions to the description below if the variable is a character string:
These six characters ” < > , \ & cannot be input.
If a blank is contained in a character string, single or double quotation marks should be used,
for example ’hello world’, ”hello world”, and the words in the quotation marks will be identified
as a string. Otherwise, the words will be identified as several strings.
1.4.3 Parameter Format
Some parameters must be entered in special formats which are shown as follows:
MAC Address must be entered in the format of xx:xx:xx:xx:xx:xx
One or several values can be typed for a port-list or a vlan-list using comma to separate. Use a
hyphen to designate a range of values, for instance,1/0/1,1/0/3-5,1/0/7 indicates choosing port
1/0/1,1/0/3,1/0/4,1/0/5,1/0/7.
The port number should format as 1/0/3, meaning unit/slot/port. The unit number is always 1,
and slot number is always 0 and the port number is a variable (an actual value must be
assigned).
19
Page 35
Chapter 2 User Interface
enable
Description
The enable command is used to access Privileged EXEC Mode from User
EXEC Mode.
Syntax
enable
Command Mode
User EXEC Mode
Example
If you have set the password to access Privileged EXEC Mode from User EXEC
Mode:
TL-SG3424> enable
Enter password：
TL-SG3424#
service password-encryption
Description
The service password-encryption command is used to encrypt the password
when the password is defined or when the configuration is written, using the
symmetric encryption algorithm. Encryption prevents the password from being
readable in the configuration file. To disable the global encryption function,
please use no service password-encryption command.
Syntax
service password-encryption
no service password-encryption
Command Mode
Global Configuration Mode
Example
Enable the global encryption function:
TL-SG3424(config)# service password-encryption
20
Page 36
enable password
Description
The enable password command is used to set or change the password for
users to access Privileged EXEC Mode from User EXEC Mode. To remove the
password, please use no enable password command. This command uses the
symmetric encryption.
Syntax
enable password { [ 0 ] password | 7 encrypted-password }
no enable password
Parameter
0 —— Specify the encryption type. 0 indicates that an unencrypted password will
follow. By default, the encryption type is 0.
password —— Super password, a string from 1 to 31 alphanumeric characters
or symbols. The password is case sensitive, allows digits, English letters (case
sensitive), underlines and sixteen special characters ( !$%'()*,-./[]{|} ). By default,
it is empty.
7 —— Indicates a symmetric encrypted password with fixed length will follow.
encrypted-password —— A symmetric encrypted password with fixed length,
which you can copy from another switch’s configuration file. After the encrypted
password is configured, you should use the corresponding unencrypted
password if you re-enter this mode.
Command Mode
Global Configuration Mode
User Guidelines
If the password you configured here is unencrypted and the global encryption
function is enabled in service password-encryption
configuration file will be displayed in the symmetric encrypted form.
, the password in the
Example
Set the super password as “admin” and unencrypted to access Privileged EXEC
Mode from User EXEC Mode:
TL-SG3424(config)#enable password 0 admin
21
Page 37
enable secret
Description
The enable secret command is used to set a secret password, which is using an
MD5 encryption algorithm, for users to access Privileged EXEC Mode from User
EXEC Mode. To return to the default configuration, please use no enable secret
command. This command uses the MD5 encryption.
Syntax
enable secret { [ 0 ] password | 5 encrypted-password }
no enable secret
Parameter
0 —— Specify the encryption type. 0 indicates that an unencrypted password will
follow. By default, the encryption type is 0.
password —— Super password, a string from 1 to 31 alphanumeric characters
or symbols. The password is case sensitive, allows digits, English letters (case
sensitive), underlines and sixteen special characters ( !$%'()*,-./[]{|} ). By default,
it is empty. The password in the configuration file will be displayed in the MD5
encrypted form.
5 —— Indicates an MD5 encrypted password with fixed length will follow.
encrypted-password —— An MD5 encrypted password with fixed length, which
you can copy from another switch’s configuration file. After the encrypted
password is configured, you should use the corresponding unencrypted
password if you re-enter this mode.
Command Mode
Global Configuration Mode
User Guidelines
If both the enable password and enable secret are defined, you must enter the
password set in enable secret.
Example
Set the secret password as “admin” and unencrypted to access Privileged EXEC
Mode from User EXEC Mode. The password will be displayed in the encrypted
form.
TL-SG3424(config)#enable secret 0 admin
22
Page 38
disable
Description
Syntax
Command Mode
Example
The disable command is used to return to User EXEC Mode from Privileged
EXEC Mode.
disable
Privileged EXEC Mode
Return to User EXEC Mode from Privileged EXEC Mode:
TL-SG3424# disable
TL-SG3424>
configure
Description
Syntax
Command Mode
Example
The configure command is used to access Global Configuration Mode from
Privileged EXEC Mode.
configure
Privileged EXEC Mode
Access Global Configuration Mode from Privileged EXEC Mode:
TL-SG3424# configure
TL-SG3424 (config)#
exit
Description
The exit command is used to return to the previous Mode from the current
Mode.
Syntax
exit
23
Page 39
end
Command Mode
Any Configuration Mode
Example
Return to Global Configuration Mode from Interface Configuration Mode, and
then return to Privileged EXEC Mode:
TL-SG3424(config-if)# exit
TL-SG3424(config)# exit
TL-SG3424#
Description
The end command is used to return to Privileged EXEC Mode.
Syntax
Command Mode
Example
history
Description
end
Any Configuration Mode
Return to Privileged EXEC Mode from Interface Configuration Mode:
TL-SG3424(config-if)# end
TL-SG3424#
The history command is used to show the latest 20 commands you entered in
the current mode since the switch is powered.
Syntax
history
Command Mode
Privileged EXEC Mode and any Configuration Mode
Example
Show the commands you have entered in the current mode:
24
Page 40
TL-SG3424 (config)# history
history clear
Description
The history clear command is used to clear the commands you have entered in
the current mode, therefore these commands will not be shown next time you
use the history command.
Syntax
history clear
Command Mode
Privileged EXEC Mode and any Configuration Mode
1 history
Example
Clear the commands you have entered in the current mode:
TL-SG3424 (config)#history clear
25
Page 41
Chapter 3 IEEE 802.1Q VLAN Commands
VLAN (Virtual Local Area Network) technology is developed for the switch to divide the LAN into
multiple logical LANs flexibly. Hosts in the same VLAN can communicate with each other,
regardless of their physical locations. VLAN can enhance performance by conserving bandwidth,
and improve security by limiting traffic to specific domains.
vlan
Description
The vlan command is used to create IEEE 802.1Q VLAN and enter VLAN
Configuration Mode. To delete the IEEE 802.1Q VLAN, please use no vlan
command.
Syntax
vlan vlan-list
no vlan vlan-list
Parameter
vlan-list —— Specify IEEE 802.1Q VLAN ID list, ranging from 2 to 4094, in the
format of 2-3, 5. It is multi-optional.
Command Mode
Global Configuration Mode
Example
Create VLAN 2-10 and VLAN 100:
TL-SG3424(config)# vlan 2-10,100
Delete VLAN 2:
TL-SG3424(config)# no vlan 2
interface vlan
Description
The interface vlan command is used to create VLAN Interface and enter
Interface VLAN Mode. To delete VLAN Interface, please use no interface vlan
command.
Syntax
interface vlan vlan-id
no interface vlan vlan-id
26
Page 42
Parameter
Command Mode
Example
name
Description
Syntax
vlan-id —— Specify IEEE 802.1Q VLAN ID, ranging from 1 to 4094.
Global Configuration Mode
Create VLAN Interface 2:
TL-SG3424(config)# interface vlan 2
The name command is used to assign a description to a VLAN. To clear the
description, please use no name command.
name descript
no name
Parameter
descript ——String to describe the VLAN, which contains 16 characters at most.
Command Mode
VLAN Configuration Mode（VLAN）
Example
Specify the name of VLAN 2 as “group1”:
TL-SG3424(config)# vlan 2
TL-SG3424(config-vlan)# name group1
switchport mode
Description
The switchport mode command is used to configure the Link Type for the ports.
Syntax
switchport mode { access | trunk | general }
Parameter
access | trunk | general —— Link Types. There are three Link Types for the
ports.
27
Page 43
Command Mode
Interface Configuration Mode (interface gigabitEthernet / interface range
gigabitEthernet)
Example
Specify the Link Type of port 3 as trunk:
TL-SG3424(config)# interface gigabitEthernet 1/0/3
TL-SG3424(config-if)# switchport mode trunk
switchport access vlan
Description
The switchport access vlan command is used to add the desired Access port
to IEEE 802.1Q VLAN. To remove the specified port/ports from the
corresponding VLAN, please use no switchport access vlan command.
Syntax
switchport access vlan vlan-id
no switchport access vlan
Parameter
vlan-id —— Specify IEEE 802.1Q VLAN ID, ranging from 2 to 4094.
Command Mode
Interface Configuration Mode (interface gigabitEthernet / interface range
gigabitEthernet)
Example
Specify the Link Type of port 3 as access and add it to VLAN 2:
TL-SG3424(config)# interface gigabitEthernet 1/0/3
TL-SG3424(config-if)# switchport mode access
TL-SG3424(config-if)# switchport access vlan 2
switchport trunk allowed vlan
Description
The switchport trunk allowed vlan command is used to add the desired Trunk
port to IEEE 802.1Q VLAN. To delete the corresponding VLAN(s), please use no
switchport trunk allowed vlan command.
Syntax
switchport trunk allowed vlan vlan-list
28
Page 44
no switchport trunk allowed vlan vlan-list
Parameter
vlan-list —— Specify IEEE 802.1Q VLAN ID list, ranging from 2 to 4094, in the
format of 2-3, 5. It is multi-optional.
Command Mode
Interface Configuration Mode (interface gigabitEthernet / interface range
gigabitEthernet)
Example
Specify the Link Type of port 2 as trunk and add it to VLAN 2:
TL-SG3424(config)# interface gigabitEthernet 1/0/2
TL-SG3424(config-if)# switchport mode trunk
TL-SG3424(config-if)# switchport trunk allowed vlan 2
switchport general allowed vlan
Description
The switchport general allowed vlan command is used to add the desired
General port to IEEE 802.1Q VLAN and specify the egress rule. To delete the
corresponding VLAN(s), please use no switchport general allowed vlan
command.
Syntax
switchport general allowed vlan vlan-list { tagged | untagged }
no switchport general allowed vlan vlan-list
Parameter
vlan-list —— Specify IEEE 802.1Q VLAN ID list, ranging from 2 to 4094, in the
format of 2-3, 5. It is multi-optional.
tagged | untagged —— Egress rule，untagged or tagged. Tagged: All packets
forwarded by the port are tagged. The packets contain VLAN information.
Untagged: Packets forwarded by the port are untagged.
Command Mode
Interface Configuration Mode (interface gigabitEthernet / interface range
gigabitEthernet)
Example
Specify the Link Type of port 4 as general, then add it to VLAN 2 and configure
the egress rule of port 4 as tagged:
TL-SG3424(config)# interface gigabitEthernet 1/0/4
TL-SG3424(config-if)# switchport mode general
29
Page 45
TL-SG3424(config-if)# switchport general allowed vlan 2 tagged
switchport pvid
Description
The switchport pvid command is used to configure the PVID for the switch
ports.
Syntax
switchport pvid vlan-id
Parameter
vlan-id —— Specify IEEE 802.1Q VLAN ID, ranging from 1 to 4094.
Command Mode
Interface Configuration Mode (interface gigabitEthernet / interface range
gigabitEthernet)
Example
Specify the PVID of port 3 as 1:
TL-SG3424(config)# interface gigabitEthernet 1/0/3
TL-SG3424(config-if)# switchport pvid 1
show vlan summary
Description
The show vlan summary command is used to display the summarized
information of IEEE 802.1Q VLAN.
Syntax
show vlan summary
Command Mode
Privileged EXEC Mode and Any Configuration Mode
Example
Display the summarized information of IEEE 802.1Q VLAN:
TL-SG3424(config)# show vlan summary
30
Page 46
show vlan brief
Description
The show vlan brief command is used to display the brief information of IEEE
802.1Q VLAN.
Syntax
show vlan brief
Command Mode
Privileged EXEC Mode and Any Configuration Mode
Example
Display the brief information of IEEE 802.1Q VLAN:
TL-SG3424(config)# show vlan brief
show vlan
Description
Syntax
Parameter
Command Mode
Example
The show vlan command is used to display the detailed information of the
specified IEEE 802.1Q VLAN.
show vlan [ id vlan-list ]
vlan-list —— Specify IEEE 802.1Q VLAN ID, ranging from 1 to 4094. It is
multi-optional. By default, the detailed information of all VLANs will be displayed.
Privileged EXEC Mode and Any Configuration Mode
Display the detailed information of all VLANs:
TL-SG3424(config)# show vlan
Display the detailed information of VLAN 2:
TL-SG3424(config)# show vlan id 2
Display the detailed information of VLAN 3-10:
TL-SG3424(config)# show vlan id 3-10
31
Page 47
Chapter 4 MAC-based VLAN Commands
MAC-based VLAN (Virtual Local Area Network) is the way to classify the VLANs based on MAC
Address. A MAC address corresponds to a VLAN ID. The untagged packets and the priority-tagged
packets sourced from the MAC address will be tagged with this VLAN ID.
mac-vlan mac-address
Description
The mac-vlan mac-address command is used to create a MAC-based VLAN
entry. To delete MAC-based VLAN entry, please use the no mac-vlan
mac-address command.
Syntax
mac-vlan mac-address mac-addr vlan vlan-id [ description descript ]
no mac-vlan mac-address mac-addr
Parameter
mac-addr —— MAC address, in the format of XX:XX:XX:XX:XX:XX.
vlan-id —— Specify IEEE 802.1Q VLAN ID, ranging from 1 to 4094.
descript —— Give a description of the MAC-based VLAN entry for identification,
which contains 8 characters at most.
Command Mode
Global Configuration Mode
Example
Add an entry whose MAC address is 00:11:11:01:01:12 to VLAN 2, then name
the MAC-base entry as “TP”:
TL-SG3424(config)# mac-vlan mac-address 00:11:11:01:01:12 vlan 2
description TP
show mac-vlan
Description
The show mac-vlan command is used to display the information of the
MAC-based VLAN. MAC address and VLAN ID can be used to filter the
displayed information.
Syntax
show mac-vlan { all | mac-address mac-addr | vlan vlan-id }
32
Page 48
Command Mode
Privileged EXEC Mode and Any Configuration Mode
Parameter
mac-addr —— MAC address, in the format of XX:XX:XX:XX:XX:XX.
vlan-id —— Specify IEEE 802.1Q VLAN ID, ranging from 1 to 4094.
Example
Display the MAC-based VLAN table:
TL-SG3424(config)# show mac-vlan all
Display the MAC-based VLAN information of the entry whose MAC address is
00:11:11:01:01:12:
TL-SG3424(config)# show mac-vlan mac-address 00:11:11:01:01:12
Display the MAC-based VLAN information of the entry whose VLAN ID is 4:
TL-SG3424(config)# show mac-vlan vlan 4
33
Page 49
Chapter 5 Protocol-based VLAN Commands
Protocol-based VLAN (Virtual Local Area Network) is the way to classify VLANs based on
Protocols. A Protocol corresponds to a VLAN ID. The untagged packets and the priority-tagged
packets matching the protocol template will be tagged with this VLAN ID.
protocol-vlan template
Description
The protocol-vlan template command is used to create Protocol-based VLAN
template. To delete Protocol-based VLAN template, please use no
protocol-vlan template command.
Syntax
protocol-vlan template name protocol-name ether-type type frame { 802_3 |
ether_2 | snap | llc }
no protocol-vlan template template-idx
Parameter
protocol-name —— Give a name to the Protocol-based VLAN Template, which
contains 8 characters at most.
type —— The Ethernet protocol type in the protocol template, composed of 4
Hex integers.
802_3 | ether_2 | snap | llc —— The frame type with 802_3, ether_2, snap, and
llc options.
template-idx —— The number of the Protocol-based VLAN Template. You can
get the template corresponding to the number by the
template command.
Command Mode
Global Configuration Mode
Example
Create a Protocol-based VLAN template named “TP” whose Ethernet protocol
type is 0x2024 and frame type is EthernetII:
TL-SG3424(config)# protocol-vlan template name TP ether-type 2024 frame
show protocol-vlan
ether_2
34
Page 50
protocol-vlan vlan
Description
The protocol-vlan vlan command is used to create a Protocol-based VLAN. To
delete a Protocol-based VLAN, please use no protocol-vlan command.
Syntax
protocol-vlan vlan vlan-id { template template-idx }
no protocol-vlan vlan group-idx
Parameter
vlan-vid —— Specify IEEE 802.1Q VLAN ID, ranging from 1-4094.
template-idx ——The number of the Protocol-based VLAN Template. You can
get the template corresponding to the number by the
template command.
group-idx ——The number of the Protocol-based VLAN entry. You can get the
Protocol-based VLAN entry corresponding to the number by the
protocol-vlan vlan command.
show protocol-vlan
show
Command Mode
Global Configuration Mode
Example
Create Protocol-based VLAN 2 and bind it with Protocol-based VLAN Template
3:
TL-SG3424(config)# protocol-vlan vlan 2 template 3
protocol-vlan group
Description
The protocol-vlan group command is used to create a Protocol-based VLAN
group. To delete a Protocol-based VLAN group, please use no protocol-vlan
group command.
Syntax
protocol-vlan group group-id
no protocol-vlan group group-id
Parameter
group-id ——The number of the Protocol-based VLAN entry. You can get the
Protocol-based VLAN entry corresponding to the number by the show
protocol-vlan vlan command.
35
Page 51
Command Mode
Interface Configuration Mode (interface gigabitEthernet / interface range
gigabitEthernet)
Example
Create Protocol-based VLAN group 2 which is binding with port 3:
TL-SG3424(config)# interface gigabitEthernet 1/0/3
TL-SG3424(config-if)# protocol-vlan group 2
show protocol-vlan template
Description
The show protocol-vlan template command is used to display the information
of the Protocol-based VLAN templates.
Syntax
show protocol-vlan template
Command Mode
Privileged EXEC Mode and Any Configuration Mode
Example
Display the information of the Protocol-based VLAN templates:
TL-SG3424(config)# show protocol-vlan template
show protocol-vlan vlan
Description
The show protocol-vlan vlan command is used to display the information about
Protocol-based VLAN entry.
Syntax
show protocol-vlan vlan
Command Mode
Privileged EXEC Mode and Any Configuration Mode
Example
Display information of the Protocol-based VLAN entry:
TL-SG3424(config)# show protocol-vlan vlan
36
Page 52
Chapter 6 Voice VLAN Commands
Voice VLANs are configured specially for voice data stream. By configuring Voice VLANs and
adding the ports with voice devices attached to voice VLANs, you can perform QoS-related
configuration for voice data, ensuring the transmission priority of voice data stream and voice
quality.
voice vlan
Description
The voice vlan command is used to enable Voice VLAN function. To disable
Voice VLAN function, please use no voice vlan command.
Syntax
voice vlan vlan-id
no voice vlan
Parameter
vlan-id —— Specify IEEE 802.1Q VLAN ID, ranging from 2 to 4094.
Command Mode
Global Configuration Mode
Example
Enable the Voice VLAN function for VLAN 10:
TL-SG3424(config)# voice vlan 10
voice vlan aging time
Description
Syntax
The voice vlan aging time command is used to set the aging time for a voice
VLAN. To restore to the default aging time for the Voice VLAN, please use no
voice vlan aging time command. By default, the aging time is 1440 minutes.
voice vlan aging time time
no voice vlan aging time
37
Page 53
Parameter
time ——Aging time (in minutes) to be set for the Voice VLAN. It ranges from 1
to 43200.
Command Mode
Global Configuration Mode
Example
Set the aging time for the Voice VLAN as 1 minute:
TL-SG3424(config)# voice vlan aging time 1
voice vlan priority
Description
The voice vlan priority command is used to configure the priority for the Voice
VLAN. To restore to the default priority, please use no voice vlan priority
command. By default, the priority value is 6.
Syntax
voice vlan priority pri
no voice vlan priority
Parameter
pri —— Priority, ranging from 0 to 7.
Command Mode
Global Configuration Mode
Example
Configure the priority of the Voice VLAN as 5:
TL-SG3424(config)# voice vlan priority 5
voice vlan mac-address
Description
The voice vlan mac-address command is used to create Voice VLAN OUI. To
delete the specified Voice VLAN OUI, please use no voice vlan mac-address
command.
38
Page 54
Syntax
voice vlan mac-address mac-addr mask mask [ description descript ]
no voice vlan mac-address mac-addr
Parameter
mac-addr —— The OUI address of the voice device, in the format of
XX:XX:XX:XX:XX:XX.
mask —— The OUI address mask of the voice device, in the format of
XX:XX:XX:XX:XX:XX.
descript ——Give a description to the OUI for identification which contains 16
characters at most.
Command Mode
Global Configuration Mode
Example
Create a Voice VLAN OUI described as TP-Phone with the OUI address
00:11:11:11:11:11 and the mask address FF:FF:FF:00:00:00:
TL-SG3424(config)# voice vlan mac-address 00:11:11:11:11:11 mask
FF:FF:FF:00:00:00 description TP-Phone
switchport voice vlan mode
Description
The switchport voice vlan mode command is used to configure the Voice
VLAN mode for the Ethernet port.
Syntax
switchport voice vlan mode { manual | auto }
Parameter
manual | auto —— Port mode.
Command Mode
Interface Configuration Mode (interface gigabitEthernet / interface range
gigabitEthernet)
Example
Configure the port 3 to operate in the auto voice VLAN mode:
39
Page 55
TL-SG3424(config)# interface gigabitEthernet 1/0/3
TL-SG3424(config-if)# switchport voice vlan mode auto
switchport voice vlan security
Description
The switchport voice vlan security command is used to enable the Voice
VLAN security feature. To disable the Voice VLAN security feature, please use
no switchport voice vlan security command.
Syntax
switchport voice vlan security
no switchport voice vlan security
Command Mode
Interface Configuration Mode (interface gigabitEthernet / interface range
gigabitEthernet)
Example
Enable port 3 for the Voice VLAN security feature:
TL-SG3424(config)# interface gigabitEthernet 1/0/3
TL-SG3424(config-if)# switchport voice vlan security
show voice vlan
Description
The show voice vlan command is used to display the global configuration
information of Voice VLAN.
Syntax
show voice vlan
Command Mode
Privileged EXEC Mode and Any Configuration Mode
Example
Display the configuration information of Voice VLAN globally:
TL-SG3424(config)# show voice vlan
40
Page 56
show voice vlan oui
Description
The show voice vlan oui command is used to display the configuration
information of Voice VLAN OUI.
Syntax
show voice vlan oui
Command Mode
Privileged EXEC Mode and Any Configuration Mode
Example
Display the configuration information of Voice VLAN OUI:
TL-SG3424(config)# show voice vlan oui
show voice vlan switchport
Description
The show voice vlan switchport command is used to display the Voice VLAN
configuration information of all ports or a specified port.
Syntax
show voice vlan switchport [ gigabitEthernet port ]
Parameter
port —— The Ethernet port number.
Command Mode
Privileged EXEC Mode and Any Configuration Mode
Example
Display the Voice VLAN configuration information of all ports:
TL-SG3424(config)# show voice vlan switchport
Display the Voice VLAN configuration information of port 2:
TL-SG3424(config)# show voice vlan switchport gigabitEthernet 1/0/2
41
Page 57
Chapter 7 GVRP Commands
GVRP (GARP VLAN registration protocol) is an implementation of GARP (generic attribute
registration protocol). GVRP allows the switch to automatically add or remove the VLANs via the
dynamic VLAN registration information and propagate the local VLAN registration information to
other switches, without having to individually configure each VLAN.
gvrp(global)
Description
The gvrp command is used to enable the GVRP function globally. To disable the
GVRP function, please use no gvrp command.
Syntax
gvrp
no gvrp
Command Mode
Global Configuration Mode
Example
Enable the GVRP function globally:
TL-SG3424(config)# gvrp
gvrp(interface)
Description
The gvrp command is used to enable the GVRP function for the desired port. To
disable the GVRP function of this port, please use no gvrp command. The
GVRP feature can only be enabled for the trunk-type ports.
Syntax
gvrp
no gvrp
Command Mode
Interface Configuration Mode (interface gigabitEthernet / interface range
gigabitEthernet)
42
Page 58
Example
Enable the GVRP function for ports 2-6:
TL-SG3424(config)# interface range gigabitEthernet 1/0/2-6
TL-SG3424(config-if-range)# gvrp
gvrp registration
Description
The gvrp registration command is used to configure the GVRP registration type
on the desired port. To restore to the default value, please use no gvrp
registration command.
Syntax
gvrp registration { normal | fixed | forbidden }
no gvrp registration
Parameter
normal | fixed | forbidden —— Registration mode. By default, the registration
mode is “normal”.
Command Mode
Interface Configuration Mode (interface gigabitEthernet / interface range
gigabitEthernet)
Example
Configure the GVRP registration mode on ports 2-6 to fixed:
TL-SG3424(config)# interface range gigabitEthernet 1/0/2-6
TL-SG3424(config-if-range)# gvrp registration fixed
gvrp timer
Description
The gvrp timer command is used to set a GVRP timer for the desired port. To
restore to the default setting of a GARP timer, please use no gvrp timer
command.
Syntax
gvrp timer { leaveall | join | leave } value
43
Page 59
no gvrp timer [ leaveall | join | leave ]
Parameter
leaveall | join | leave —— They are the three timers: leaveall, join and leave.
Once the LeaveAll Timer is set, the port with GVRP enabled can send a LeaveAll
message after the timer times out, so that other GARP ports can re-register all
the attribute information. After that, the LeaveAll timer will start to begin a new
cycle. To guarantee the transmission of the Join messages, a GARP port sends
each Join message two times. The Join Timer is used to define the interval
between the two sending operations of each Join message. Once the Leave
Timer is set, the GARP port receiving a Leave message will start its Leave timer,
and deregister the attribute information if it does not receive a Join message
again before the timer times out.
value ——The value of the timer. The LeaveAll Timer ranges from 1000 to 30000
centiseconds and the default value is 1000. The Join Timer ranges from 20 to
1000 centiseconds and the default value is 20. The Leave Timer ranges from 60
to 3000 centiseconds and the default value is 60.
Command Mode
Interface Configuration Mode (interface gigabitEthernet / interface range
gigabitEthernet)
Example
Set the GARP leaveall timer of port 6 to 2000 centiseconds and restore to the
join timer of it to the default value:
TL-SG3424(config)# interface gigabitEthernet 1/0/6
TL-SG3424(config-if)# gvrp timer leaveall 2000
TL-SG3424(config-if)# no gvrp timer join
show gvrp global
Description
The show gvrp global command is used to display the global GVRP status.
Syntax
show gvrp global
Command Mode
Privileged EXEC Mode and Any Configuration Mode
44
Page 60
Example
Display the global GVRP status:
TL-SG3424(config)# show gvrp global
show gvrp interface
Description
The show gvrp interface command is used to display the GVRP configuration
information of all ports or a specified Ethernet port.
Syntax
show gvrp interface [ gigabitEthernet port ]
Parameter
port ——The Ethernet port number.
Command Mode
Privileged EXEC Mode and Any Configuration Mode
Example
Display the GVRP configuration information of all Ethernet ports:
TL-SG3424(config)# show gvrp interface
Display the GVRP configuration information of port 2:
TL-SG3424(config)# show gvrp interface gigabitEthernet 1/0/2
45
Page 61
Chapter 8 Etherchannel Commands
Etherchannel Commands are used to configure LAG and LACP function.
LAG (Link Aggregation Group) is to combine a number of ports together to make a single
high-bandwidth data path, which can highly extend the bandwidth. The bandwidth of the LAG is the
sum of bandwidth of its member port.
LACP (Link Aggregation Control Protocol) is defined in IEEE802.3ad and enables the dynamic link
aggregation and disaggregation by exchanging LACP packets with its partner. The switch can
dynamically group similarly configured ports into a single logical link, which will highly extend the
bandwidth and flexibly balance the load.
channel-group
Description
The channel-group command is used to add a port to the EtherChannel Group
and configure its mode. To delete the port from the EtherChannel Group, please
use no channel-group command.
Syntax
channel-group num mode { on | active | passive }
no channel-group
Parameter
num —— The number of the EtherChannel Group, ranging from 1 to 8.
on —— Enable the static LAG.
active —— Enable the active LACP mode.
passive —— Enable the passive LACP mode.
Command Mode
Interface Configuration Mode (interface gigabitEthernet / interface range
gigabitEthernet)
Example
Add ports 2-4 to EtherChannel Group 1 and enable the static LAG:
TL-SG3424(config)# interface range gigabitEthernet 1/0/2-4
TL-SG3424(config-if-range)# channel-group 1 mode on
46
Page 62
port-channel load-balance
Description
The port-channel load-balance command is used to configure the Aggregate
Arithmetic for LAG. To return to the default configurations, please use no
port-channel load-balance command.
Syntax
port-channel load-balance { src-dst-mac | src-dst-ip }
no port-channel load-balance
Parameter
src-dst-mac —— The source and destination MAC address. When this option is
selected, the Aggregate Arithmetic will be based on the source and destination
MAC addresses of the packets. The Aggregate Arithmetic for LAG is
“src-dst-mac” by default.
src-dst-ip—— The source and destination IP address. When this option is
selected, the Aggregate Arithmetic will be based on the source and destination
IP addresses of the packets.
Command Mode
Global Configuration Mode
Example
Configure the Aggregate Arithmetic for LAG as “src-dst-mac”:
TL-SG3424(config)# port-channel load-balance src-dst-mac
lacp system-priority
Description
The lacp system-priority command is used to configure the LACP system
priority globally. To return to the default configurations, please use no lacp
system-priority command.
Syntax
lacp system-priority pri
no lacp system-priority
Parameter
pri —— The system priority, ranging from 0 to 65535. It is 32768 by default.
47
Page 63
Command Mode
Global Configuration Mode
Example
Configure the LACP system priority as 1024 globally:
TL-SG3424(config)# lacp system-priority 1024
lacp port-priority
Description
The lacp port-priority command is used to configure the LACP port priority for
specified ports. To return to the default configurations, please use no lacp
port-priority command.
Syntax
lacp port-priority pri
no lacp port-priority
Parameter
pri —— The port priority, ranging from 0 to 65535. It is 32768 by default.
Command Mode
Interface Configuration Mode (interface gigabitEthernet / interface range
gigabitEthernet)
Example
Configure the LACP port priority as 1024 for ports 1-3:
TL-SG3424(config)# interface range gigabitEthernet 1/0/1-3
TL-SG3424(config-if-range)# lacp port-priority 1024
Configure the LACP port priority as 2048 for port 4:
TL-SG3424(config)# interface gigabitEthernet 1/0/4
TL-SG3424(config-if)# lacp port-priority 2048
show etherchannel
Description
The show etherchannel command is used to display the EtherChannel
information.
48
Page 64
Syntax
show etherchannel [ channel-group-num ] { detail | summary }
Parameter
channel-group-num —— The EtherChannel Group number, ranging from 1 to 8.
By default, it is empty, and will display the information of all EtherChannel
Groups.
detail —— The detailed information of EtherChannel.
summary —— The EtherChannel information in summary.
Command Mode
Privileged EXEC Mode and Any Configuration Mode
Example
Display the detailed information of EtherChannel Group 1:
TL-SG3424(config)# show etherchannel 1 detail
show etherchannel load-balance
Description
The show etherchannel load-balance command is used to display the
Aggregate Arithmetic of LAG.
Syntax
show etherchannel load-balance
Command Mode
Privileged EXEC Mode and Any Configuration Mode
Example
Display the Aggregate Arithmetic of LAG:
TL-SG3424(config)# show etherchannel load-balance
show lacp
Description
The show lacp command is used to display the LACP information for a specified
EtherChannel Group.
Syntax
show lacp [ channel-group-num ] { internal | neighbor }
49
Page 65
Parameter
channel-group-num —— The EtherChannel Group number, ranging from 1 to 8.
By default, it is empty, and will display the information of all LACP groups.
internal —— The internal LACP information.
neighbor —— The neighbor LACP information.
Command Mode
Privileged EXEC Mode and Any Configuration Mode
Example
Display the internal LACP information of EtherChannel Group 1:
TL-SG3424(config)# show lacp 1 internal
show lacp sys-id
Description
The show lacp sys-id command is used to display the LACP system priority
globally.
Syntax
show lacp sys-id
Command Mode
Privileged EXEC Mode and Any Configuration Mode
Example
Display the LACP system priority:
TL-SG3424(config)# show lacp sys-id
50
Page 66
Chapter 9 User Manage Commands
User Manage Commands are used to manage the user’s logging information by Web, Telnet or
SSH, so as to protect the settings of the switch from being randomly changed.
user name (password)
Description
The user name command is used to add a new user or modify the existed users’
information. To delete the existed users, please use no user name command.
This command uses the symmetric encryption.
Syntax
user name name [ privilege admin | guest ] password { [ 0 ] password | 7
encrypted-password }
no user name name
Parameter
name ——Type a name for users' login, which contains 16 characters at most,
composed of digits, English letters and under dashes only.
admin | guest —— Access level. “Admin” means that you can edit, modify and
view all the settings of different functions. “Guest” means that you can only view
the settings without the right to edit and modify. It is “admin” by default.
0 —— Specify the encryption type. 0 indicates that an unencrypted password will
follow. By default, the encryption type is 0.
password —— Users’ login password, a string from 1 to 31 alphanumeric
characters or symbols. The password is case sensitive, allows digits, English
letters (case sensitive), underlines and sixteen special characters
( !$%'()*,-./[]{|} ). By default, it is empty.
7 —— Indicates a symmetric encrypted password with fixed length will follow.
encrypted-password —— A symmetric encrypted password with fixed length,
which you can copy from another switch’s configuration file. After the encrypted
password is configured, you should use the corresponding unencrypted
password if you re-enter this mode.
Command Mode
Global Configuration Mode
51
Page 67
User Guidelines
1. If the password you configured here is unencrypted and the global
encryption function is enabled in service password-encryption
password in the configuration file will be displayed in the symmetric
encrypted form.
2. If you change the password of the current user in a telnet or console
connection, the connection will be cut off and the newly configured
password is required for the re-login.
Example
Add and enable a new admin user named “tplink”, of which the password is
“admin” and unencrypted:
TL-SG3424(config)#user name tplink privilege admin password 0 admin
user name (secret)
Description
, the
The user name command is used to add a new user or modify the existed users’
information. To delete the existed users, please use no user name command.
This command uses the MD5 encryption.
Syntax
user name name [ privilege admin | guest ] secret { [ 0 ] password | 5
encrypted-password }
no user name name
Parameter
name ——Type a name for users' login, which contains 16 characters at most,
composed of digits, English letters and under dashes only.
admin | guest —— Access level. “Admin” means that you can edit, modify and
view all the settings of different functions. “Guest” means that you can only view
the settings without the right to edit and modify. It is “admin” by default.
0 —— Specify the encryption type. 0 indicates that an unencrypted password will
follow. By default, the encryption type is 0.
password ——Users’ login password, a string from 1 to 31 alphanumeric
characters or symbols. The password is case sensitive, allows digits, English
letters (case sensitive), underlines and sixteen special characters
52
Page 68
( !$%'()*,-./[]{|} ). By default, it is empty. The password will be saved to the
configuration file using the MD5 encrypted algorithm.
5 —— Indicates an MD5 encrypted password with fixed length will follow.
encrypted-password —— An MD5 encrypted password with fixed length, which
you can copy from another switch’s configuration file.
Command Mode
Global Configuration Mode
User Guidelines
1. If both the user name (password) and user name (secret) are defined,
you must enter the password set in user name (secret).
2. If you change the password of the current user in a telnet or console
connection, the connection will be cut off and the newly configured
password is required for the re-login.
Example
Add and enable a new admin user named “tplink”, of which the password is
“admin”. The password will be displayed in the encrypted form.
TL-SG3424(config)#user name tplink privilege admin secret 0 admin
user access-control ip-based
Description
The user access-control ip-based command is used to limit the IP-range of the
users for login. Only the users within the IP-range you set here are allowed to
login. To cancel the user access limit, please use no user access-control
command.
Syntax
user access-control ip-based ip-addr ip-mask
no user access-control
Parameter
ip-addr —— The source IP address. Only the users within the IP-range you set
here are allowed for login.
ip-mask ——The subnet mask of the IP address.
53
Page 69
Command Mode
Global Configuration Mode
Example
Enable the access-control of the user whose IP address is 192.168.0.148:
TL-SG3424(config)# user access-control ip-based 192.168.0.148
255.255.255.255
user access-control mac-based
Description
The user access-control mac-based command is used to limit the MAC
Address of the users for login. Only the user with this MAC Address you set here
is allowed to login. To cancel the user access limit, please use no user
access-control command.
Syntax
user access-control mac-based mac-addr
no user access-control
Parameter
mac-addr —— The source MAC address. Only the user with this MAC Address
is allowed to login.
Command Mode
Global Configuration Mode
Example
Configure that only the user whose MAC address is 00:00:13:0A:00:01 is
allowed to login:
TL-SG3424(config)# user access-control mac-based 00:00:13:0A:00:01
user access-control port-based
Description
The user access-control port-based command is used to limit the ports for
Only the users connected to these ports you set here are allowed to login.
login.
To cancel the user access limit, please use no user access-control command.
54
Page 70
Syntax
user access-control port-based interface { gigabitEthernet port | range
gigabitEthernet port-list }
no user access-control
Parameter
port —— The Ethernet port number.
port-list ——The list group of Ethernet ports, in the format of 1/0/1-4. You can
appoint 5 ports at most.
Command Mode
Global Configuration Mode
Example
Configure that only the users connected to ports 2-6 are allowed to login:
TL-SG3424(config)# user access-control port-based interface range
gigabitEthernet 1/0/2-6
user max-number
Description
The user max-number command is used to configure the maximum login user
numbers at the same time. To cancel the limit on login numbers, please use no
user max-number command.
Syntax
user max-number admin-num guest-num
no user max-number
Parameter
admin-num ——The maximum number of the users allowed to log on as Admin,
ranging from 1 to 16. The total number of Admin and Guest should be less than
16.
guest-num ——The maximum number of the users allowed to log on as Guest,
ranging from 0 to 15. The total number of Admin and Guest should be less than
16.
Command Mode
Global Configuration Mode
55
Page 71
Example
Configure the maximum number of users’ login as Admin and Guest as 5 and 3:
TL-SG3424(config)# user max-num 5 3
user idle-timeout
Description
The user idle-timeout command is used to configure the timeout time of the
switch. To restore to the default timeout time, please use no user idle-timeout
command.
Syntax
user idle-timeout minutes
no user idle-timeout
line
Parameter
minutes ——The timeout time, ranging from 5 to 30 in minutes. The value is 10
by default.
Command Mode
Global Configuration Mode
Example
Configure the timeout time of the switch as 15 minutes:
TL-SG3424(config)# user idle-timeout 15
Description
The line command is used to enter the Line Configuration Mode and make
related configuration for the desired user(s), including the login mode and
Syntax
password configurations.
line [ console linenum | vty startlinenum endlinenum ]
56
Page 72
Parameter
linenum —— The number of users allowed to login through console port. Its
value is 0 in general as there is only one console port on a switch.
startlinenum ——The start serial number of the login user selected to configure
the login mode and password, ranging from 0 to 15. 0 means the first login user
number, 1 means the second, and the rest can be done in the same manner.
endlinenum ——The end serial number of the login user selected to configure
the login mode and password, ranging from 0 to 15. 0 means the first login user
number, 1 means the second, and the rest can be done in the same manner.
Command Mode
Global Configuration Mode
Example
Enter the Console port configuration mode and configure the console port 0:
password
Description
Syntax
Parameter
TL-SG3424(config)# line console 0
Enter the Virtual Terminal configuration mode so as to prepare further
configurations such as password and login mode for virtual terminal 0 to 5:
TL-SG3424(config)# line vty 0 5
The password command is used to configure the connection password. To clear
the password, please use no password command.
password { [ 0 ] password | 7 encrypted-password }
no password
0 —— Specify the encryption type. 0 indicates that an unencrypted password will
follow. By default, the encryption type is 0.
password —— Connection password, a string from 1 to 31 alphanumeric
characters or symbols. The password is case sensitive, allows digits, English
letters (case sensitive), underlines and sixteen special characters
( !$%'()*,-./[]{|} ). By default, it is empty.
7 —— Indicates a symmetric encrypted password with fixed length will follow.
57
Page 73
encrypted-password —— A symmetric encrypted password with fixed length,
which you can copy from another switch’s configuration file. After the encrypted
password is configured, you should use the corresponding unencrypted
password if you re-enter this mode.
Command Mode
Line Configuration Mode
User Guidelines
If the password you configured here is unencrypted and the global encryption
login
function is enabled in service password-encryption
configuration file will be displayed in the symmetric encrypted form.
Example
Configure the connection password of Console port connection 0 as “tplink” and
unencrypted:
TL-SG3424(config)#line console 0
TL-SG3424(config-line)#password 0 tplink
Configure the connection password of virtual terminal connection 0-5 as “tplink”
and unencrypted:
TL-SG3424(config)#line vty 0 5
TL-SG3424(config-line)#password 0 tplink
, the password in the
Description
The login command is used to configure the login of a switch without using the
default user name and password. At this situation, a connection password must
be set for virtual terminal connection.
Syntax
login
Command Mode
Line Configuration Mode
Example
Configure the login of Console port connection 0 as login mode:
TL-SG3424(config)# line console 0
58
Page 74
TL-SG3424(config-line)# login
Configure the login of virtual terminal connection 0-5 as login mode:
TL-SG3424(config)# line vty 0 5
TL-SG3424(config-line)# login
login local
Description
The login local command is used to configure the login of a switch with the user
name and password.
Syntax
login local
Command Mode
Line Configuration Mode
Example
Configure the login of virtual terminal connection 0-5 as login local mode:
TL-SG3424(config)# line vty 0 5
TL-SG3424(config-line)# login local
Configure the login of Console port connection 0 as login local mode:
TL-SG3424(config)# line console 0
TL-SG3424(config-line)# login local
show user account-list
Description
The show user account-list command is used to display the information of the
current users.
Syntax
show user account-list
Command Mode
Privileged EXEC Mode and Any Configuration Mode
59
Page 75
Example
Display the information of the current users:
TL-SG3424(config)# show user account-list
show user configuration
Description
The user configuration command is used to display the security configuration
information of the users, including access-control, max-number and the
idle-timeout, etc.
Syntax
show user configuration
Command Mode
Privileged EXEC Mode and Any Configuration Mode
Example
Display the security configuration information of the users:
TL-SG3424(config)# show user configuration
60
Page 76
Chapter 10 Binding Table Commands
You can bind the IP address, MAC address, VLAN and the connected Port number of the Host
together, which can be the condition for the ARP Inspection to filter the packets.
ip source binding
Description
The ip source binding command is used to bind the IP address, MAC address,
VLAN ID and the Port number together manually.
address, MAC address, VLAN ID and the Port number together in the condition
that you have got the related information of the Hosts in the LAN. To delete the
IP-MAC–VID-PORT entry from the binding table, please use no ip source
binding index command.
Syntax
ip source binding hostname ip-addr mac-addr vlan vid interface
gigabitEthernet port { none | arp-detection } [ forced-source { arp-scanning |
dhcp-snooping }]
no ip source binding index idx
Parameter
hostname ——The Host Name, which contains 20 characters at most.
ip-addr —— The IP Address of the Host.
mac-addr —— The MAC Address of the Host.
You can manually bind the IP
vid ——The VLAN ID needed to be bound, ranging from 1 to 4094.
port ——The number of Ethernet port connected to the Host.
none | arp-detection——The protect type for the entry. arp-detection indicates
ARP detection; none indicates applying none.
forced-source —— The source of the binding entry can be specified as
arp-scanning or dhcp-snooping. It is multi-optional.
idx —— The entry number needed to be deleted, ranging from 1 to 200. You can
use the show ip source binding
the entry number is the actual number in the binding table not arranged in an
order.
command to get the idx. Pay attention to that,
61
Page 77
Command Mode
Global Configuration Mode
Example
Bind an entry with the IP 192.168.0.1, MAC 00:00:00:00:00:01, VLAN ID 2 and
Port number 5 manually. And then enable the entry for the ARP detection:
TL-SG3424(config)# ip source binding host1 192.168.0.1 00:00:00:00:00:01
vlan 2 interface gigabitEthernet 1/0/5 arp-detection
Delete the IP-MAC –VID-PORT entry with the index 5:
TL-SG3424(config)# no ip source binding index 5
ip source binding index
Description
The ip source binding index command is used to modify the existing entry of ip
source binding.
Syntax
ip source binding index idx {hostname hostname | mac mac-addr | vlan
vlan-id | interface gigabitEthernet port | none | arp-detection }
Parameter
idx ——The entry number needed to be modified. You can use the show ip
source binding command to get the idx. Pay attention that the entry number is
the actual number in the binding table which is not displayed in an arranged
order.
hostname ——The modified Host Name, which contains 20 characters at most.
mac-addr —— The modified MAC address of the Host.
vlan-id ——The modified VLAN ID, ranging from 1 to 4094.
port —— The modified number of port connected to the Host.
none | arp-detection ——The modified protect type for the entry. “none” indicates
applying none; “arp-detection” indicates ARP detection.
Command Mode
Global Configuration Mode
62
Page 78
Example
Modify the hostname as “tp-link” of the entry with the index 1:
TL-SG3424(config)#ip source binding index 1 hostname tp-link
ip dhcp snooping
Description
The ip dhcp snooping command is used to enable DHCP-Snooping function
globally. To disable DHCP-Snooping function globally, please use no ip dhcp
snooping command. DHCP Snooping functions to monitor the process of the
Host obtaining the IP address from DHCP server, and record the IP address,
MAC address, VLAN and the connected Port number of the Host for automatic
binding. The switch can also propagate the control information and the network
parameters via the Option 82 field to provide more information for the Host.
Syntax
ip dhcp snooping
no ip dhcp snooping
Command Mode
Global Configuration Mode
Example
Enable the DHCP-Snooping function globally:
TL-SG3424(config)# ip dhcp snooping
ip dhcp snooping global
Description
The ip dhcp snooping global command is configure DHCP-Snooping globally.
Syntax
To restore to the default value, please use no ip dhcp snooping global
command.
ip dhcp snooping global [ global-rate global-rate ] [ dec-threshold
dec-threshold ] [ dec-rate dec-rate ]
no ip dhcp snooping global
63
Page 79
Parameter
global-rate —— The value to specify the maximum amount of DHCP messages
that can be forwarded by the switch per second. The excessive messages will be
discarded. The options are 0/10/20/30/40/50 (packet/second).By default, it is 0
standing for disable.
dec-threshold ——The value to specify the minimum transmission rate of the
Decline packets to trigger the Decline protection for the specific port. The options
are 0/5/10/15/20/25/30 (packet/second).By default, it is 0 standing for disable.
dec-rate ——The value to specify the Decline Flow Control. The traffic flow of
the corresponding port will be limited to be this value if the transmission rate of
the Decline packets exceeds the Decline Threshold. The options are
5/10/15/20/25/30 (packet/second). By default, it is 5.
Command Mode
Global Configuration Mode
Example
Configure the Global Flow Control as 30pps, the Decline Threshold as 20 pps,
and decline Flow Control as 20 pps for DHCP Snooping:
TL-SG3424(config)# ip dhcp snooping global global-rate 30 dec-threshold 20
dec-rate 20
ip dhcp snooping information option
Description
The ip dhcp snooping information option command is used to enable the
Option 82 function of DHCP Snooping. To disable the Option 82 function, please
use no ip dhcp snooping information option command.
Syntax
ip dhcp snooping information option
no ip dhcp snooping information option
Command Mode
Global Configuration Mode
Example
Enable the Option 82 function of DHCP Snooping:
64
Page 80
TL-SG3424(config)# ip dhcp snooping information option
ip dhcp snooping information strategy
Description
The ip dhcp snooping information strategy command is used to select the
operation for the Option 82 field of the DHCP request packets from the Host. To
restore to the default option, please use no ip dhcp snooping information
strategy command.
Syntax
ip dhcp snooping information strategy strategy
no ip dhcp snooping information strategy
Parameter
strategy —— The operations for Option 82 field of the DHCP request packets
from the Host, including three types:
keep: Indicates to keep the Option 82 field of the packets. It is the default option;
replace: Indicates to replace the Option 82 field of the packets with the switch
defined one;
drop: Indicates to discard the packets including the Option 82 field
Command Mode
Global Configuration Mode
Example
Replace the Option 82 field of the packets with the switch defined one and then
send out:
TL-SG3424(config)# ip dhcp snooping information strategy replace
ip dhcp snooping information remote-id
Description
The ip dhcp snooping information remote-id command is used to enable and
configure the customized sub-option Remote ID for the Option 82. To return to
default Remote ID for the Option 82, please use no ip dhcp snooping
information remote-id command.
65
Page 81
Syntax
ip dhcp snooping information remote-id string
no ip dhcp snooping information remote-id
Parameter
string ——Enter the sub-option Remote ID, which contains 32 characters at
most.
Command Mode
Global Configuration Mode
Example
Enable and configure the customized sub-option Remote ID for the Option 82 as
tplink:
TL-SG3424(config)# ip dhcp snooping information remote-id tplink
ip dhcp snooping information circuit-id
Description
The ip dhcp snooping information circuit-id command is used to enable and
configure the customized sub-option Circuit ID for the Option 82. To return to the
default Circuit ID for the Option 82, please use no ip dhcp snooping
information circuit-id command.
Syntax
ip dhcp snooping information circuit-id string
no ip dhcp snooping information circuit-id
Parameter
string ——Enter the sub-option Circuit ID, which contains 32 characters at most.
Command Mode
Global Configuration Mode
Example
Enable and configure the customized sub-option Circuit ID for the Option 82 as
tplink:
TL-SG3424(config)# ip dhcp snooping information circuit-id tplink
66
Page 82
ip dhcp snooping trust
Description
The ip dhcp snooping trust command is used to configure a port to be a
Trusted Port. Only the Trusted Port can receive the DHCP packets from DHCP
servers. To turn the port back to a distrusted port, please use no ip dhcp
snooping trust command.
Syntax
ip dhcp snooping trust
no ip dhcp snooping trust
Command Mode
Interface Configuration Mode (interface gigabitEthernet / interface range
gigabitEthernet)
Example
Configure port 2 to be a Trusted Port:
TL-SG3424(config)# interface gigabitEthernet 1/0/2
TL-SG3424(config-if)# ip dhcp snooping trust
ip dhcp snooping mac-verify
Description
The ip dhcp snooping mac-verify command is used to enable the MAC Verify
feature. To disable the MAC Verify feature, please use no ip dhcp snooping
mac-verify command. There are two fields of the DHCP packet containing the
MAC address of the Host. The MAC Verify feature is to compare the two fields
and discard the packet if the two fields are different.
Syntax
ip dhcp snooping mac-verify
no ip dhcp snooping mac-verify
Command Mode
Interface Configuration Mode (interface gigabitEthernet / interface range
gigabitEthernet)
67
Page 83
Example
Enable the MAC Verify feature for port 2:
TL-SG3424(config)# interface gigabitEthernet 1/0/2
TL-SG3424(config-if)# ip dhcp snooping mac-verify
ip dhcp snooping limit rate
Description
The ip dhcp snooping limit rate command is used to enable the Flow Control
feature for the DHCP packets. The excessive DHCP packets will be discarded.
To restore to the default configuration, please use no ip dhcp snooping limit
rate command.
Syntax
ip dhcp snooping limit rate value
no ip dhcp snooping limit rate
Parameter
value —— The value of Flow Control. The options are
0/5/10/15/20/25/30(packet/second). The default value is 0, which stands for
disable.
Command Mode
Interface Configuration Mode (interface gigabitEthernet / interface range
gigabitEthernet)
Example
Set the Flow Control of port 2 as 20 pps:
TL-SG3424(config)# interface gigabitEthernet 1/0/2
TL-SG3424(config-if)# ip dhcp snooping limit rate 20
ip dhcp snooping decline
Description
The ip dhcp snooping decline command is used to enable the Decline Protect
feature. To disable the Decline Protect feature, please use no ip dhcp
snooping decline command.
68
Page 84
Syntax
ip dhcp snooping decline
no ip dhcp snooping decline
Command Mode
Interface Configuration Mode (interface gigabitEthernet / interface range
gigabitEthernet)
Example
Enable the Decline Protect feature of port 2:
TL-SG3424(config)# interface gigabitEthernet 1/0/2
TL-SG3424(config-if)# ip dhcp snooping decline
show ip source binding
Description
The show ip source binding command is used to display the
IP-MAC-VID-PORT binding table.
Syntax
show ip source binding
Command Mode
Privileged EXEC Mode and Any Configuration Mode
Example
Display the IP-MAC-VID-PORT binding table:
TL-SG3424(config)# show ip source binding
show ip dhcp snooping
Description
The show ip dhcp snooping command is used to display the running status of
DHCP-Snooping.
Syntax
show ip dhcp snooping
69
Page 85
Command Mode
Privileged EXEC Mode and Any Configuration Mode
Example
Display the running status of DHCP-Snooping:
TL-SG3424# show ip dhcp snooping
show ip dhcp snooping information
Description
The show ip dhcp snooping information command is used to display the
Option 82 configuration status of DHCP-Snooping.
Syntax
show ip dhcp snooping information
Command Mode
Privileged EXEC Mode and Any Configuration Mode
Example
Display the Option 82 configuration status of DHCP-Snooping:
TL-SG3424# show ip dhcp snooping information
show ip dhcp snooping interface gigabitEthernet
Description
The show ip dhcp snooping interface gigabitEthernet command is used to
display the DHCP-Snooping configuration of desired Gigabit Ethernet ports.
Syntax
show ip dhcp snooping interface gigabitEthernet [ port ]
Parameters
port ——The Ethernet port number.
Command Mode
Privileged EXEC Mode and Any Configuration Mode
70
Page 86
Example
Display the DHCP-Snooping configuration of port 2:
TL-SG3424# show ip dhcp snooping interface gigabitEthernet 1/0/2
71
Page 87
Chapter 11 ARP Inspection Commands
ARP (Address Resolution Protocol) Detect function is to protect the switch from the ARP cheating,
such as the Network Gateway Spoofing and Man-In-The-Middle Attack, etc.
ip arp inspection(global)
Description
The ip arp inspection command is used to enable the ARP Detection function
globally. To disable the ARP Detection function, please use no ip arp detection
command.
Syntax
ip arp inspection
no ip arp inspection
Command Mode
Global Configuration Mode
Example
Enable the ARP Detection function globally:
TL-SG3424(config)# ip arp inspection
ip arp inspection trust
Description
The ip arp inspection trust command is used to configure the port for which the
ARP Detect function is unnecessary as the Trusted Port. To clear the Trusted
Port list, please use no ip arp detection trust command. The specific ports,
such as up-linked port, routing port and LAG port, should be set as Trusted Port.
Syntax
To ensure the normal communication of the switch, please configure the ARP
Trusted Port before enabling the ARP Detect function.
ip arp inspection trust
no ip arp inspection trust
72
Page 88
Command Mode
Interface Configuration Mode (interface gigabitEthernet / interface range
gigabitEthernet)
Example
Configure the ports 2-5 as the Trusted Port:
TL-SG3424(config)# interface range gigabitEthernet 1/0/2-5
TL-SG3424(config-if-range)# ip arp inspection trust
ip arp inspection(interface)
Description
The ip arp inspection command is used to enable the ARP Defend function. To
disable the ARP detection function, please use no ip arp inspection command.
ARP Attack flood produces lots of ARP Packets, which will occupy the bandwidth
and slow the network speed extremely. With the ARP Defend enabled, the
switch can terminate receiving the ARP packets for 300 seconds when the
transmission speed of the legal ARP packet on the port exceeds the defined
value so as to avoid ARP Attack flood.
Syntax
ip arp inspection
no ip arp inspection
Command Mode
Interface Configuration Mode (interface gigabitEthernet / interface range
gigabitEthernet)
Example
Enable the arp defend function for ports 2-6:
TL-SG3424(config)# interface range gigabitEthernet 1/0/2-6
TL-SG3424(config-if-range)# ip arp inspection
73
Page 89
ip arp inspection limit-rate
Description
The ip arp inspection limit-rate command is used to configure the ARP speed
of a specified port. To restore to the default speed, please use no ip arp
inspection limit-rate command.
Syntax
ip arp inspection limit-rate value
no ip arp inspection limit-rate
Parameter
value ——The value to specify the maximum amount of the received ARP
packets per second, ranging from 10 to 100 in pps(packet/second). By default,
the value is 15.
Command Mode
Interface Configuration Mode (interface gigabitEthernet / interface range
gigabitEthernet)
Example
Configure the maximum amount of the received ARP packets per second as 50
pps for port 5:
TL-SG3424(config)# interface gigabitEthernet 1/0/5
TL-SG3424(config-if)# ip arp inspection limit-rate 50
ip arp inspection recover
Description
The ip arp inspection recover command is used to restore to the port to the
ARP transmit status from the ARP filter status.
Syntax
ip arp inspection recover
Command Mode
Interface Configuration Mode (interface gigabitEthernet / interface range
gigabitEthernet)
74
Page 90
Example
Restore port 5 to the ARP transmit status:
TL-SG3424(config)# interface gigabitEthernet 1/0/5
TL-SG3424(config-if)# ip arp inspection recover
show ip arp inspection
Description
The show ip arp inspection command is used to display the ARP detection
global configuration including the enable/disable status and the Trusted Port list.
Syntax
show ip arp inspection
Command Mode
Privileged EXEC Mode and Any Configuration Mode
Example
Display the ARP detection configuration globally:
TL-SG3424(config)# show ip arp inspection
show ip arp inspection interface
Description
The show ip arp inspection interface command is used to display the interface
configuration of ARP detection.
Syntax
show ip arp inspection interface [ gigabitEthernet port ]
Parameter
port ——The Ethernet port number.
Command Mode
Privileged EXEC Mode and Any Configuration Mode
Example
Display the configuration of all the ports:
75
Page 91
TL-SG3424(config)# show ip arp inspection interface
Display the configuration of port 2:
TL-SG3424(config)# show ip arp inspection interface gigabitEthernet 1/0/2
show ip arp inspection statistics
Description
The show ip arp inspection statistics command is used to display the number
of the illegal ARP packets received.
Syntax
show ip arp inspection statistics
Command Mode
Privileged EXEC Mode and Any Configuration Mode
Example
Display the number of the illegal ARP packets received:
TL-SG3424(config)# show ip arp inspection statistics
clear ip arp inspection statistics
Description
The clear ip arp inspection statistics command is used to clear the statistic of
the illegal ARP packets received.
Syntax
clear ip arp inspection statistics
Command Mode
Privileged EXEC Mode and Any Configuration Mode
Example
Clear the statistic of the illegal ARP packets received:
TL-SG3424(config)# clear ip arp inspection statistics
76
Page 92
Chapter 12 DoS Defend Command
DoS (Denial of Service) Attack is to occupy the network bandwidth maliciously by the network
attackers or the evil programs sending a lot of service requests to the Host. With the DoS Defend
enabled, the switch can analyze the specific field of the received packets and provide the defend
measures to ensure the normal working of the local network.
ip dos-prevent
Description
The ip dos-prevent command is used to enable the DoS defend function
globally. To disable the DoS defend function, please use no ip dos-prevent
command.
Syntax
ip dos-prevent
no ip dos-prevent
Command Mode
Global Configuration Mode
Example
Enable the DoS defend function globally:
TL-SG3424(config)# ip dos-prevent
ip dos-prevent type
Description
The ip dos-prevent type command is used to select the DoS Defend Type. To
Syntax
disable the corresponding Defend Type, please use no ip dos-prevent type
command.
ip dos-prevent type { land | scan-synfin | xma-scan | null-scan | port-less-1024 |
blat | ping-flood | syn-flood }
no ip dos-prevent type { land | scan-synfin | xma-scan | null-scan |
port-less-1024 | blat | ping-flood | syn-flood }
77
Page 93
Parameter
land —— Land attack.
scan-synfin —— Scan SYNFIN attack.
xma-scan —— Xma Scan attack.
null-scan —— NULL Scan attack.
port-less-1024 ——The SYN packets whose Source Port less than 1024.
blat —— Blat attack.
ping-flood —— Ping flooding attack. With the ping flood attack enabled, the
switch will limit automatically the forwarding speed of ping packets to 512K when
attacked by ping flood.
syn-flood —— SYN/SYN-ACK flooding attack. With the syn-flood attack enabled,
the switch will limit automatically the forwarding speed of ping packets to 512K
when attacked by syn-flood.
Command Mode
Global Configuration Mode
Example
Enable the DoS Defend Type named Land attack:
TL-SG3424(config)# ip dos-prevent type land
show ip dos-prevent
Description
The show ip dos-prevent command is used to display the DoS information of
the detected DoS attack, including enable/disable status, the DoS Defend Type.
Syntax
show ip dos-prevent
Command Mode
Privileged EXEC Mode and Any Configuration Mode
Example
Display the DoS information of the detected DoS attack globally:
TL-SG3424(config)# show ip dos-prevent
78
Page 94
Chapter 13 IEEE 802.1X Commands
IEEE 802.1X function is to provide an access control for LAN ports via the authentication. Only the
supplicant passing the authentication can access the LAN.
dot1x system-auth-control
Description
The dot1x system-auth-control command is used to enable the IEEE 802.1X
function globally. To disable the IEEE 802.1X function, please use no dot1x
system-auth-control command.
Syntax
dot1x system-auth-control
no dot1x system-auth-control
Command Mode
Global Configuration Mode
Example
Enable the IEEE 802.1X function:
TL-SG3424(config)# dot1x system-auth-control
dot1x auth-method
Description
The dot1x auth-method command is used to configure the Authentication
Method of IEEE 802.1X and the default 802.1x authentication method is
“eap-md5”. To restore to the default 802.1x authentication method, please use
no dot1x auth-method command.
Syntax
dot1x auth-method { pap | eap-md5 }
no dot1x auth-method
Parameter
pap | eap-md5 ——Authentication Methods.
79
Page 95
pap: IEEE 802.1X authentication system uses extensible authentication protocol
(EAP) to exchange information between the switch and the client. The
transmission of EAP packets is terminated at the switch and the EAP packets
are converted to the other protocol (such as RADIUS) packets for transmission
eap-md5: IEEE 802.1X authentication system uses extensible authentication
protocol (EAP) to exchange information between the switch and the client. The
EAP protocol packets with authentication data can be encapsulated in the
advanced protocol (such as RADIUS) packets to be transmitted to the
authentication server.
Command Mode
Global Configuration Mode
Example
Configure the Authentication Method of IEEE 802.1X as pap:
TL-SG3424(config)# dot1x auth-method pap
dot1x guest-vlan(global)
Description
The dot1x guest-vlan command is used to enable the Guest VLAN function
globally. To disable the Guest VLAN function, please use no dot1x guest-vlan
command.
Syntax
dot1x guest-vlan vid
no dot1x guest-vlan
Parameter
vid ——The VLAN ID needed to enable the Guest VLAN function, ranging from 1
to 4094.
The supplicants in the Guest VLAN can access the specified network
source.
Command Mode
Global Configuration Mode
Example
Enable the Guest VLAN function for VLAN 5:
TL-SG3424(config)# dot1x guest-vlan 5
80
Page 96
dot1x quiet-period
Description
The dot1x quiet-period command is used to enable the quiet-period function.
To disable the function, please use no dot1x quiet-period command.
Syntax
dot1x quiet-period
no dot1x quiet-period
Command Mode
Global Configuration Mode
Example
Enable the quiet-period function:
TL-SG3424(config)# dot1x quiet-period
dot1x timeout
Description
The dot1x timeout command is used to configure the quiet period and the
supplicant timeout. To restore to the default, please use no dot1x timeout
command.
Syntax
dot1x timeout { quiet-period time | reauth-period time }
no dot1x timeout { quiet-period | reauth-period }
Parameter
quiet-period time ——The value for Quiet Period, ranging from 1 to 999 in
seconds. By default, it is 10. Once the supplicant failed to the 802.1X
Authentication, then the switch will not respond to the authentication request
from the same supplicant during the Quiet Period.
reauth-period time ——The maximum time for the switch to wait for the
response from supplicant before resending a request to the supplicant., ranging
from 1 to 9 in second. By default, it is 3.
Command Mode
Global Configuration Mode
81
Page 97
Example
Configure the quiet period as 100 seconds:
TL-SG3424(config)# dot1x timeout quiet-period 100
dot1x max-reauth-req
Description
The dot1x max-reauth-req command is used to configure the maximum
transfer times of the repeated authentication request when the server cannot be
connected. To restore to the default value, please use no dot1x max-reauth-req
command.
Syntax
dot1x max-reauth-req times
Parameter
Command Mode
Example
dot1x
no dot1x max-reauth-req
times ——The maximum transfer times of the repeated authentication request,
ranging from 1 to 9 in times. By default, the value is 3.
Global Configuration Mode
Configure the maximum transfer times of the repeated authentication request as
5:
TL-SG3424(config)# dot1x max-reauth-req 5
Description
The dot1x command is used to enable the IEEE 802.1X function for a specified
port. To disable the IEEE 802.1X function for a specified port, please use no
dot1x command.
Syntax
dot1x
no dot1x
82
Page 98
Command Mode
Interface Configuration Mode (interface gigabitEthernet / interface range
gigabitEthernet)
Example
Enable the IEEE 802.1X function for port 1:
TL-SG3424(config)# interface gigabitEthernet 1/0/1
TL-SG3424(config-if)# dot1x
dot1x guest-vlan(interface)
Description
The dot1x guest-vlan command is used to enable the guest VLAN function for a
specified port. To disable the Guest VLAN function for a specified port, please
use no dot1x guest-vlan command. Please ensure that the Control Type of the
corresponding port is port-based before enabling the guest VLAN function for it.
Syntax
dot1x guest-vlan
no dot1x guest-vlan
Command Mode
Interface Configuration Mode (interface gigabitEthernet / interface range
gigabitEthernet)
Example
Enable the Guest VLAN function for port 2:
TL-SG3424(config)# interface gigabitEthernet 1/0/2
TL-SG3424(config-if)# dot1x guest-vlan
dot1x port-control
Description
The dot1x port-control command is used to configure the control mode of IEEE
802.1X for the specified port. By default, the control mode is “auto”. To restore to
the default configuration, please use no dot1x port-control command.
83
Page 99
Syntax
dot1x port-control { auto | authorized-force | unauthorized-force }
no dot1x port-control
Parameter
auto | authorized-force | unauthorized-force —— The Control Mode for the port.
auto:
In this mode, the port will normally work only after passing the 802.1X
Authentication.
authorized-force: In this mode, the port can work normally without passing the
802.1X Authentication.
unauthorized-force: In this mode, the port is forbidden working for its fixed
unauthorized status.
Command Mode
Interface Configuration Mode (interface gigabitEthernet / interface range
gigabitEthernet)
Example
Configure the Control Mode for port 1 as authorized-force:
TL-SG3424(config)# interface gigabitEthernet 1/0/1
TL-SG3424(config-if)# dot1x port-control authorized-force
dot1x port-method
Description
The dot1x port-method command is used to configure the control type of IEEE
802.1X for the specified port. By default, the control type is “mac-based”. To
restore to the default configuration, please use no dot1x port-method
command.
Syntax
dot1x port-method { mac-based | port-based }
no dot1x port-method
Parameter
mac-based | port-based ——The control type for the port.
mac-based: Any client connected to the port should pass the 802.1X
authentication for access.
84
Page 100
Command Mode
Example
radius
Description
port-based: All the clients connected to the port can access the network on the
condition that any one of the clients has passed the 802.1X Authentication.
Interface Configuration Mode (interface gigabitEthernet / interface range
gigabitEthernet)
Configure the Control Type for port 1 as port-based:
TL-SG3424(config)# interface gigabitEthernet 1/0/1
TL-SG3424(config-if)# dot1x port-method port-based
The radius command is used to configure the parameters of radius.
Syntax
radius { [auth-pri ip] [auth-sec ip] [auth-port port] [acct-pri ip] [acct-sec ip]
[acct-port port] [auth-key { [ 0 ] password | 7 encrypted-password } ] [acct-key
{ [ 0 ] password | 7 encrypted-password] } }
no radius { auth-port | auth-key | auth-pri | auth-sec | acct-port | acct-key |
acct-pri | acct-sec }
Parameter
auth-pri ip —— The IP address of the authentication server.
auth-sec ip —— The IP address of the alternative authentication server.
auth-port port ——The UDP port of authentication server(s) ranging from 1 to
65535. The default value is 1812.
acct-pri ip —— The IP address of the accounting server.
acct-sec ip —— The IP address of the alternative accounting server.
acct-port port —— The UDP port of accounting server(s) ranging from 1 to
65535. The default value is 1813.
auth-key { [ 0 ] password | 7 encrypted-password } —— 0 and 7 are the
encryption type. 0 indicates that an unencrypted password will follow. 7 indicates
that a symmetric encrypted password with a fixed length will follow. By default,
the encryption type is 0. “password“ is the shared password for the switch and
the authentication servers to exchange messages which contains 31 characters
85
Loading...