TL-SG3109/TL-SL3428/TL-SL3452 Gigabit Managed Switch Family CLI Reference Guide
Page 10
This chapter describes how to start using the CLI and describes implemented command editing features to assist
in using the CLI.
1.1CLI Command Modes
1.1.1Introduction
To assist in configuring the device, the Command Line Interface (CLI) is divided into different command modes.
Each command mode has its own set of specific commands. Entering a question mark "?" at the system prompt
(console prompt) displays a list of commands available for that particular command mode.
From each mode, a specific command is used to navigate from one command mode to another. The standard
order to access the modes is as follows: User EXEC mode, Privileged EXEC mode, Global Configuration mode,
and Interface Configuration mode. The following figure illustrates the command mode access path.
When starting a session, the initial mode is the User EXEC mode. Only a limited subset of commands is available
in User EXEC mode. This level is reserved for tasks that do not change the configuration. To enter the next level,
the Privileged EXEC mode, a password is required.
The Privileged EXEC mode gives access to commands that are restricted on User EXEC mode and provides
access to the device Configuration mode.
The Global Configuration mode manages the device configuration on a global level.
TL-SG3109/TL-SL3428/TL-SL3452 Gigabit Managed Switch Family CLI Reference Guide
Page 11
The Interface Configuration mode configures specific interfaces in the device.
1.1.2User EXEC Mode
After logging into the device, the user is automatically in User EXEC command mode unless the user is defined as
a privileged user. In general, the User EXEC commands allow the user to perform basic tests, and list system
information.
The user-level prompt consists of the device host name followed by the angle bracket (>).
Console>
The default host name is Console unless it has been changed using the hostname command in the Global Configuration mode.
1.1.3Privileged EXEC Mode
Privileged access is password protected to prevent unauthorized use because many of the privileged commands
set operating system parameters. The password is not displayed on the screen and is case sensitive.
Privileged users enter directly into the Privileged EXEC mode. To enter the Privileged EXEC mode from the User
EXEC mode, perform the following steps:
1.At the prompt enter the enable command and press <Enter>. A password prompt is displayed.
2.Enter the password and press <Enter>. The password is displayed as *. The Privileged EXEC mode prompt
is displayed. The Privileged EXEC mode prompt consists of the device host name followed by #.
Console#
To return from the Privileged EXEC mode to the User EXEC mode, use the disable command. The following
example illustrates how to access the Privileged EXEC mode and return to the User EXEC mode:
Console>
Enter Password: ******
Console#
Console#
Console>
The exit command is used to return from any mode to the previous mode except when returning to the User
EXEC mode from the Privileged EXEC mode. For example, the exit command is used to return from the Interface
Configuration mode to the Global Configuration mode.
enable
disable
1.1.4Global Configuration Mode
TL-SG3109/TL-SL3428/TL-SL3452 Gigabit Managed Switch Family CLI Reference Guide
Page 12
Global Configuration mode commands apply to features that affect the system as a whole, rather than just a specific interface. The configure Privileged EXEC mode command is used to enter the Global Configuration mode.
To enter the Global Configuration mode perform the following steps:
1.At the Privileged EXEC mode prompt enter the configure command and press <Enter>. The Global Configu-
ration mode prompt is displayed. The Global Configuration mode prompt consists of the device host name
followed by (config) and #.
Console(config)#
To return from the Global Configuration mode to the Privileged EXEC mode, the user can use one of the following
commands:
•exit
•end
•<Ctrl+Z>
The following example illustrates how to access the Global Configuration mode and return to the Privileged EXEC
mode:
Console#
Console#
Console(config)#
Console#
configure
exit
1.1.5Interface Configuration and Specific Configuration Modes
Interface Configuration mode commands modify specific interface operations. The following are the Interface Configuration modes:
•Line Interface — Contains commands to configure the management connections. These include commands
such as line timeout settings, etc. The line Global Configuration mode command is used to enter the Line
Configuration command mode.
•VLAN Database — Contains commands to create a VLAN as a whole. The vlan database Global Configura-
tion mode command is used to enter the VLAN Database Interface Configuration mode.
•Management Access List — Contains commands to define management access-lists. The management
access-list Global Configuration mode command is used to enter the Management Access List Configuration
mode.
•Ethernet — Contains commands to manage port configuration. The interface ethernet Global Configuration
mode command is used to enter the Interface Configuration mode to configure an Ethernet type interface.
•Port Channel — Contains commands to configure port-channels, for example, assigning ports to a port-
channel. Most of these commands are the same as the commands in the Ethernet interface mode, and are
used to manage the member ports as a single entity. The interface port-channel Global Configuration mode
command is used to enter the Port Channel Interface Configuration mode.
•SSH Public Key-chain — Contains commands to manually specify other device SSH public keys. The
crypto key pubkey-chain ssh Global Configuration mode command is used to enter the SSH Public Key-
chain Configuration mode.
•QoS — Contains commands related to service definitions. The qos Global Configuration mode command is
used to enter the QoS services configuration mode.
•MAC Access-List — Configures conditions required to allow traffic based on MAC addresses. The mac
TL-SG3109/TL-SL3428/TL-SL3452 Gigabit Managed Switch Family CLI Reference Guide
Page 13
access-list Global Configuration mode command is used to enter the MAC access-list configuration mode..
1.2Starting the CLI
The device can be managed over a direct connection to the device console port or via a Telnet connection. The
device is managed by entering command keywords and parameters at the prompt. Using the device commandline interface (CLI) is very similar to entering commands on a UNIX system.
If access is via a Telnet connection, ensure that the device has a defined IP address, corresponding management
access is granted, and the workstation used to access the device is connected to the device prior to using CLI
commands.
Note
The following steps are for use on the console line only.
To start using the CLI, perform the following steps:
1.Connect the DB9 null-modem or cross over cable to the RS-232 serial port of the device to the RS-232 serial
port of the terminal or computer running the terminal emulation application.
Note
The default data rate is 38400.
a) Set the data format to 8 data bits, 1 stop bit, and no parity.
b) Set Flow Control to none.
c) Under Properties, select VT100 for Emulation mode.
d) Select Terminal keys for Function, Arrow, and Ctrl keys. Ensure that the setting is for Terminal keys
(not Windows keys).
Note
When using HyperTerminal with Microsoft® Windows 2000,ensure that Windows® 2000 Service Pack 2
or later is installed.With Windows 2000 Service Pack 2, the arrow keys function properly in
HyperTerminal’s VT100 emulation. Go to www.microsoft.com for information on Windows 2000 service
packs.
2.Enter the following commands to begin the configuration procedure:
Console>
Console#
enable
configure
Console(config)#
3.Configure the device and enter the necessary commands to complete the required tasks.
4.When finished, exit the session with the exit command.
When a different user is required to log onto the system, use the login Privileged EXEC mode command. This
effectively logs off the current user and logs on the new user.
1.3Editing Features
TL-SG3109/TL-SL3428/TL-SL3452 Gigabit Managed Switch Family CLI Reference Guide
Page 14
1.3.1Entering Commands
A CLI command is a series of keywords and arguments. Keywords identify a command, and arguments specify
configuration parameters. For example, in the command show interfaces status ethernet e8, show, interfaces
and status are keywords, ethernet is an argument that specifies the interface type, and 8 specifies the port.
To enter commands that require parameters, enter the required parameters after the command keyword. For
example, to set a password for the administrator, enter:
Console(config)#
When working with the CLI, the command options are not displayed. The command is not selected from a menu,
but is manually entered. To see what commands are available in each mode or within an interface configuration,
the CLI does provide a method of displaying the available commands, the command syntax requirements and in
some instances parameters required to complete the command. The standard command to request help is ?.
There are two instances where help information can be displayed:
•Keyword lookup — The character ? is entered in place of a command. A list of all valid commands and cor-
responding help messages are is displayed.
•Partial keyword lookup — If a command is incomplete and or the character ? is entered in place of a
parameter. The matched keyword or parameters for this command are displayed.
To assist in using the CLI, there is an assortment of editing features. The following features are described:
•Terminal Command Buffer
•Command Completion
•Keyboard Shortcuts
username
admin
password
smith
1.3.1.1Terminal Command Buffer
Every time a command is entered in the CLI, it is recorded on an internally managed Command History buffer.
Commands stored in the buffer are maintained on a First In First Out (FIFO) basis. These commands can be
recalled, reviewed, modified, and reissued. This buffer is not preserved across device resets.
KeywordDescription
Up-arrow key
Ctrl+P
Down-arrow keyReturns to more recent commands in the history buffer after recalling com-
By default, the history buffer system is enabled, but it can be disabled at any time. For information about the command syntax to enable or disable the history buffer, see history.
There is a standard default number of commands that are stored in the buffer. The standard number of 10 commands can be increased to 216. By configuring 0, the effect is the same as disabling the history buffer system. For
information about the command syntax for configuring the command history buffer, see history size.
To display the history buffer, see show history.
Recalls commands in the history buffer, beginning with the most recent command. Repeats the key sequence to recall successively older commands.
mands with the up-arrow key. Repeating the key sequence will recall successively more recent commands.
1.3.1.2Negating the Effect of Commands
TL-SG3109/TL-SL3428/TL-SL3452 Gigabit Managed Switch Family CLI Reference Guide
Page 15
For many configuration commands, the prefix keyword no can be entered to cancel the effect of a command or
reset the configuration to the default value. This guide describes the negation effect for all applicable commands.
1.3.1.3Command Completion
If the command entered is incomplete, invalid or has missing or invalid parameters, then the appropriate error
message is displayed. This assists in entering the correct command. By pressing the <Tab> button, an incomplete
command is entered. If the characters already entered are not enough for the system to identify a single matching
command, press ? to display the available commands matching the characters already entered.
1.3.1.4Keyboard Shortcuts
The CLI has a range of keyboard shortcuts to assist in editing the CLI commands. The following table describes
the CLI shortcuts.
Keyboard KeyDescription
Up-arrow keyRecalls commands from the history buffer, beginning with the most recent command.
Repeat the key sequence to recall successively older commands.
Down-arrow keyReturns the most recent commands from the history buffer after recalling commands with
the up arrow key. Repeating the key sequence will recall successively more recent commands.
Ctrl+AMoves the cursor to the beginning of the command line.
Ctrl+EMoves the cursor to the end of the command line.
Ctrl+Z / EndReturns back to the Privileged EXEC mode from any configuration mode.
Backspace keyDeletes one character left to the cursor position.
1.3.1.5CLI Command Conventions
When entering commands there are certain command entry standards that apply to all commands. The following
table describes the command conventions.
ConventionDescription
[ ]In a command line, square brackets indicates an optional entry.
{ }In a command line, curly brackets indicate a selection of compulsory parameters sepa-
rated by the | character. One option must be selected. For example: flowcontrol {auto|on|off} means that for the flowcontrol command either auto, on or off must be
selected.
Italic fontIndicates a parameter.
<Enter> Any individual key on the keyboard. For example click <Enter>.
Ctrl+F4Any combination keys pressed simultaneously on the keyboard.
Screen Display
TL-SG3109/TL-SL3428/TL-SL3452 Gigabit Managed Switch Family CLI Reference Guide
Page 16
Indicates system messages and prompts appearing on the console.
allWhen a parameter is required to define a range of ports or parameters and all is an
option, the default for the command is all when no parameters are defined. For example, the command interface range port-channel has the option of either entering a
range of channels, or selecting all. When the command is entered without a parameter,
it automatically defaults to all.
TL-SG3109/TL-SL3428/TL-SL3452 Gigabit Managed Switch Family CLI Reference Guide
Page 17
aaa authentication login
The aaa authentication login Global Configuration mode command defines login authentication. To return to the
default configuration, use the no form of this command.
default — Uses the listed authentication methods that follow this argument as the default list of methods
•
when a user logs in.
•list-name — Character string used to name the list of authentication methods activated when a user logs in.
(Range: 1-12 characters).
•method1 [method2...] — Specify at least one from the following table:
KeywordDescription
enableUses the enable password for authentication.
lineUses the line password for authentication.
localUses the local username database for authentication.
noneUses no authentication.
radiusUses the list of all RADIUS servers for authentication.
Default Configuration
The local user database is checked. This has the same effect as the command aaa authentication login list-
name local.
Note
On the console, login succeeds without any authentication check if the authentication method is not
defined.
Command Mode
Global Configuration mode
User Guidelines
TL-SG3109/TL-SL3428/TL-SL3452 Gigabit Managed Switch Family CLI Reference Guide
Page 18
The default and optional list names created with the aaa authentication login command are used with the login
authentication command.
Create a list by entering the aaa authentication login list-name method command for a particular protocol, where
list-name is any character string used to name this list. The method argument identifies the list of methods that the
authentication algorithm tries, in the given sequence.
The additional methods of authentication are used only if the previous method returns an error, not if it fails. To
ensure that the authentication succeeds even if all methods return an error, specify none as the final method in
the command line.
Example
The following example configures the authentication login.
Console(config)#
aaa authentication login default radius local enable none
aaa authentication enable
TL-SG3109/TL-SL3428/TL-SL3452 Gigabit Managed Switch Family CLI Reference Guide
Page 19
The aaaauthentication enable Global Configuration mode command defines authentication method lists for
accessing higher privilege levels. To return to the default configuration, use the no form of this command.
no aaa authentication enable {default | list-name}
Parameters
default — Uses the listed authentication methods that follow this argument as the default list of methods,
•
when using higher privilege levels.
•list-name — Character string used to name the list of authentication methods activated, when using access
higher privilege levels (Range: 1-12 characters).
•method1 [method2...] — Specify at least one from the following table:
KeywordDescription
enableUses the enable password for authentication.
lineUses the line password for authentication.
noneUses no authentication.
radiusUses the list of all RADIUS servers for authentication. Uses username $enabx$.,
where x is the privilege level.
Default Configuration
If the default list is not set, only the enable password is checked. This has the same effect as the command aaa
authentication enable default enable.
On the console, the enable password is used if it exists. If no password is set, the process still succeeds. This has
the same effect as using the command aaa authentication enable default enable none.
Command Mode
Global Configuration mode
User Guidelines
The default and optional list names created with the aaa authentication enable command are used with the
enable authentication command.
The additional methods of authentication are used only if the previous method returns an error, not if it fails. To
ensure that the authentication succeeds even if all methods return an error, specify none as the final method in
the command line.
All aaa authentication enable default requests sent by the device to a RADIUS server include the username
$enabx$., where x is the requested privilege level.
Example
TL-SG3109/TL-SL3428/TL-SL3452 Gigabit Managed Switch Family CLI Reference Guide
Page 20
The following example sets the enable password for authentication when accessing higher privilege levels.
Console(config)#
aaa authentication enable default enable
login authentication
TL-SG3109/TL-SL3428/TL-SL3452 Gigabit Managed Switch Family CLI Reference Guide
Page 21
The login authentication Line Configuration mode command specifies the login authentication method list for a
remote telnet or console. To return to the default configuration specified by the aaa authentication login command, use the no form of this command.
Syntax
login authentication {default | list-name}
no login authentication
Parameters
default — Uses the default list created with the aaa authentication login command.
•
•list-name — Uses the indicated list created with the aaa authentication login command.
Default Configuration
Uses the default set with the command aaa authentication login.
Command Mode
Line Configuration mode
User Guidelines
Changing login authentication from default to another value may disconnect the telnet session.
Example
The following example specifies the default authentication method for a console.
Console(config)#
Console(config-line)#
line console
login authentication default
enable authentication
TL-SG3109/TL-SL3428/TL-SL3452 Gigabit Managed Switch Family CLI Reference Guide
Page 22
The enable authentication Line Configuration mode command specifies the authentication method list when
accessing a higher privilege level from a remote telnet or console. To return to the default configuration specified
by the aaa authentication enable command, use the no form of this command.
Syntax
enable authentication {default | list-name}
no enable authentication
Parameters
default — Uses the default list created with the aaa authentication enable command.
•
•list-name — Uses the indicated list created with the aaa authentication enable command.
Default Configuration
Uses the default set with the aaa authentication enable command.
Command Mode
Line Configuration mode
User Guidelines
There are no user guidelines for this command.
Example
The following example specifies the default authentication method when accessing a higher privilege level from a
console.
Console(config)#
Console(config-line)#
line console
enable authentication default
ip http authentication
TL-SG3109/TL-SL3428/TL-SL3452 Gigabit Managed Switch Family CLI Reference Guide
Page 23
The ip http authentication Global Configuration mode command specifies authentication methods for HTTP
server users. To return to the default configuration, use the no form of this command.
Syntax
ip http authentication method1 [method2...]
no ip http authentication
Parameters
method1 [method2...] — Specify at least one from the following table:
•
KeywordDescription
localUses the local username database for authentication.
noneUses no authentication.
radiusUses the list of all RADIUS servers for authentication.
Default Configuration
The local user database is checked. This has the same effect as the command ip http authentication local.
Command Mode
Global Configuration mode
User Guidelines
The additional methods of authentication are used only if the previous method returns an error, not if it fails. To
ensure that the authentication succeeds even if all methods return an error, specify none as the final method in
the command line.
Example
The following example configures the HTTP authentication.
Console(config)#
ip http authentication radius local
ip https authentication
TL-SG3109/TL-SL3428/TL-SL3452 Gigabit Managed Switch Family CLI Reference Guide
Page 24
The ip https authentication Global Configuration mode command specifies authentication methods for HTTPS
server users. To return to the default configuration, use the no form of this command.
Syntax
ip https authentication method1 [method2...]
no ip https authentication
Parameters
method1 [method2...] — Specify at least one from the following table:
•
KeywordSource or destination
localUses the local username database for authentication.
noneUses no authentication.
radiusUses the list of all RADIUS servers for authentication.
Default Configuration
The local user database is checked. This has the same effect as the command ip https authentication local.
Command Mode
Global Configuration mode
User Guidelines
The additional methods of authentication are used only if the previous method returns an error, not if it fails. To
ensure that the authentication succeeds even if all methods return an error, specify none as the final method in
the command line.
Example
The following example configures HTTPS authentication.
Console(config)#
ip https authentication radius local
show authentication methods
TL-SG3109/TL-SL3428/TL-SL3452 Gigabit Managed Switch Family CLI Reference Guide
Page 25
The show authentication methods Privileged EXEC mode command displays information about the authentication methods.
Syntax
show authentication methods
Default Configuration
This command has no default configuration.
Command Mode
Privileged EXEC mode
User Guidelines
There are no user guidelines for this command.
Example
The following example displays the authentication configuration.
Console#
Login Authentication Method Lists
---------------------------------
Default: Radius, Local, Line
Console_Login:
Enable Authentication Method Lists
----------------------------------
Default: Radius, Enable
Console_Enable:
LineLogin Method ListEnable Method List
-------------------------------------------------
ConsoleConsole_LoginConsole_Enable
TelnetDefaultDefault
SSHDefaultDefault
http: Radius, Local
https: Radius, Local
dot1x: Radius
show authentication methods
Line, None
Enable, None
password
TL-SG3109/TL-SL3428/TL-SL3452 Gigabit Managed Switch Family CLI Reference Guide
Page 26
The password Line Configuration mode command specifies a password on a line. To remove the password, use
the no form of this command.
Syntax
password password [encrypted]
no password
Parameters
password — Password for this level (Range: 1-159 characters).
•
•encrypted — Encrypted password to be entered, copied from another device configuration.
Default Configuration
No password is defined.
Command Mode
Line Configuration mode
User Guidelines
If a password is defined as encrypted, the required password length is 32 characters.
Example
The following example specifies password secret on a console.
Console(config)#
Console(config-line)#
line console
password
secret
enable password
TL-SG3109/TL-SL3428/TL-SL3452 Gigabit Managed Switch Family CLI Reference Guide
Page 27
The enable password Global Configuration mode command sets a local password to control access to user and
privilege levels. To remove the password requirement, use the no form of this command.
password — Password for this level (Range: 1-159 characters).
•
•level — Level for which the password applies. If not specified the level is 15
(Range: 1-15).
•encrypted — Encrypted password entered, copied from another device configuration.
Default Configuration
No enable password is defined.
Command Mode
Global Configuration mode
User Guidelines
There are no user guidelines for this command.
Example
The following example sets local level 15 password secret to control access to user and privilege levels.
Console(config)#
enable password level
15 secret
username
TL-SG3109/TL-SL3428/TL-SL3452 Gigabit Managed Switch Family CLI Reference Guide
Page 28
The username Global Configuration mode command creates a user account in the local database. To remove a
user name, use the no form of this command.
Syntax
username name [password password] [level level] [encrypted]
no username name
Parameters
name — The name of the user (Range: 1- 20 characters).
•
•password — The authentication password for the user (Range: 1-159 characters).
•level — The user level (Range: 1-15).
•encrypted — Encrypted password entered, copied from another device configuration.
Default Configuration
No user is defined.
Command Mode
Global Configuration mode
User Guidelines
User account can be created without a password.
Example
The following example configures user bob with password lee and user level 15 to the system.
Console(config)#
username
bob
password
lee
level
15
Section 3.Address Table Commands
TL-SG3109/TL-SL3428/TL-SL3452 Gigabit Managed Switch Family CLI Reference Guide
Page 29
bridge address
The bridge address Interface Configuration (VLAN) mode command adds a MAC-layer station source address to
the bridge table. To delete the MAC address, use the no form of this command.