Qlogic SilverStorm 9000, SilverStorm 9024, SilverStorm 9020, SilverStorm 9040, SilverStorm 9080 Reference Manual
...
SilverStorm 9000
CLI Reference Guide
D000025-002 Rev. A
S
Information furnished in this manual is believed to be accurate and reliable. However, QLogic Corporation assumes no
responsibility for its use, nor for any infringements of patents or other rights of third parties which may result from its
use. QLogic Corporation reserves the right to change product specifications at any time without notice. Applications
described in this document for any of these products are for illustrative purposes only. QLogic Corporation makes no
representation nor warranty that such applications are suitable for the specified use without further testing or
modification. QLogic Corporation assumes no responsibility for any errors that may appear in this document.
Document Revision History
Revision A, August 30, 2008
Changes Sections Affected
© 2008 QLogic Corporation. All Rights Reserved Worldwide.
QLogic Corporation, 26650 Aliso Viejo Parkway, Aliso Viejo, CA 92656, (800) 662-4471 or (949) 389-6000
Page ii D000025-002 Rev. A
First Published: September 2007
Table of Contents
1 Introduction
Intended Audience . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-1
License Agreements. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-1
Technical Support. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-2
Availability . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-2
Contact Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-2
2 Switch Command Line Interface
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-1
Commands and Functional Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-2
Online Help. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-4
Keyboard Shortcuts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-4
Accessing the CLI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-4
Groups and Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-5
General . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-5
Chassis . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-28
Network . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-33
Firmware . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-39
Subnet Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-47
Log. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-74
Key Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-80
IbSwitchInfo. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-82
TimeManagement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-99
SNMP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-103
Capture . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-109
3 Virtual I/O Command Line Interface
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1
Commands and Functional Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1
Online Help. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-3
Keyboard Shortcuts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-3
Accessing the VIO CLI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-3
Groups and Commands . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-4
General . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-4
D000025-002 Rev. A Page iii
SilverStorm 9000 CLI Reference Guide
Linecard. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-4
Firmware . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-13
Log. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-16
Capture . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-16
FibreChannel. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-19
Ethernet. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-45
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-88
S
Page iv D000025-002 Rev. A
1 Introduction
This manual describes the command line interface (CLI) task information for the
SilverStorm™ 9024 and Silverstom Multi-Protocol Fabric Director (MPFD) family
of switches.
This manual is organized as follows:
Section 1 describes the intended audience and technical support.
Section 2 describes the 9000 switch CLI commands.
Section 3 describes all the Virtual I/O (EVIC and FVIC) CLI commands.
Intended Audience
This manual is intended to provide network administrators and other qualified
personnel a reference for the command line interface of the SilverStorm 9000 series
switches.
License Agreements
Refer to the QLogic Software End User License Agreement for a complete listing
of all license agreements affecting this product.
D000025-002 Rev. A 1-1
1 – Introduction
Technical Support
Technical Support
Customers should contact their authorized maintenance provider for technical
support of their QLogic switch products. QLogic-direct customers may contact
QLogic Technical Support; others will be redirected to their authorized
maintenance provider.
Visit the QLogic support Web site listed in Contact Information for the latest
firmware and software updates.
Availability
QLogic Technical Support for products under warranty is available during local
standard working hours excluding QLogic Observed Holidays.
Contact Information
Support Headquarters QLogic Corporation
S
4601 Dean Lakes Blvd.
Shakopee, MN 55379
USA
QLogic Web Site www.qlogic.com
Technical Support Web Site support.qlogic.com
Technical Support Email support@qlogic.com
Technical Training Email tech.training@qlogic.com
North American Region
Email support@qlogic.com
Phone +1-952-932-4040
Fax +1 952-687-2504
All other regions of the world
QLogic Support Web Site www.support.qlogic.com
1-2 D000025-002 Rev. A
2 Switch Command Line
Interface
Overview
This section details the usage of the Command Line Interface (CLI) feature for the
SilverStorm 9000 family of switches:
The SilverStorm 9024
The SilverStorm 9000 Multi-protocol Fabric Director (MPFD) Series:
SilverStorm 9020
SilverStorm 9040
SilverStorm 9080
SilverStorm 9120
SilverStorm 9240
The CLI allows the user to perform remote configuration and management tasks,
which in many respects mirrors the functionality of the Chassis Viewer GUI.
The CLI is accessed via a terminal attached to the switch spine module(s) RS232
port(s) or via the OOB management port using Telnet and secure shell (SSH). For
a standalone switch, the user would Telnet to the IP address(es) of the unit. Once
connected, the CLI works as any telnet session does.
To access the CLI, a login and password is required. There are two user modes,
operator and administrator with the following access privileges:
Operator:
Read only access.
Administrator:
Read and write Access.
Reboot access.
Can change operator and administrator passwords.
D000025-002 Rev. A 2-1
2 – Switch Command Line Interface
Commands and Functional Groups
Can disable user login and passwords. This would allow all users
admin-level access without the need for a user name or password.
Can view all current user sessions
Can access all of the commands executed from any open operator
session.
Can log out any open user sessions
Can send messages to the open user sessions
The CLI allows multiple users to be logged in simultaneously. However, some
commands will be locked to a user(s) if another user is executing the same
command.
The CLI is also accessible through the RS232 serial port of the switch. Accessing
the CLI through the serial port never requires a login and password and defaults to
administrator privileges. Providing access through the serial port means that users
will always have access to the switch, even if Telnet and SSH are not functioning.
S
Commands and Functional Groups
The list of available commands can be accessed by typing list. To keep the list
short, the commands are grouped into functional groups, which are:
General:
General commands for user management and CLI configuration.
Deprecated:
Commands that have been deprecated.
The Deprecated group contains CLI commands that have been replaced or
are to be removed. Please use the new command where appropriate.
Chassis:
Chassis management commands. (FRU info, fan/power supply state, etc).
Network:
Ethernet interface management commands.
Firmware:
Provides commands for updating the firmware via a File Transfer Protocol
(FTP) server or Secure Copy Protocol (SCP) (if using SSH to access the
Bridge Module). The switch has the ability to store the location of the firmware
files for future upgrades. Additionally, the Firmware functional group includes
commands for viewing the current firmware revisions and for changing the
boot image.
2-2 D000025-002 Rev. A
A
2 – Switch Command Line Interface
Commands and Functional Groups
SubnetManagement:
InfiniBand subnet manager configuration and management.
Log:
Provides commands for viewing log files as well as configuring logging
parameters.
KeyManagement:
License key management.
IbSwitchInfo:
Provides commands for displaying InfiniBand (IB) statistics for all IB ports on
the switch, as well as for configuring port statistic thresholds.
TimeManagement:
Provides commands for retrieving and setting the current system time, as well
as commands for setting the time zone and daylight saving time parameters.
Snmp:
Provides commands for configuring SNMP trap destinations and security
parameters required to access the switch from an SNMP manager.
Capture:
Provides commands for capturing switch-specific information for the purposes
of analysis and debugging.
To list commands within a functional group, simply type in the functional group name.
For example, to list all of the firmware commands, type list Firmware. The system
would display the following:
-> list Firmware
fwUpdateSlot Update units firmware
fwUpdateChassis Update units firmware
fwListFiles List the contents of the firmware ramdisk
fwShowUpdateParams Display firmware default update parameters
fwSetUpdateParams Configure firmware default update parameters
showCapability Display the capabilities/features
showLastScpRetCode Display the return code from the last SCP Firmware Push
fwVersion Display Firmware revisions
bootQuery Query boot image information
bootSelect Change boot selection
D000025-002 Rev. A 2-3
2 – Switch Command Line Interface
Online Help
Online Help
The online help for the CLI provides, for each command, all necessary information
to successfully execute the command. For example, typing help list (can also type
list help) displays the following information for the list command:
NAME
list
SYNOPSIS
list [group] [-noprompt] [-verbose]
DESCRIPTION
List available commands.
OPTIONS
group - List the commands in that particular group
-noprompt - Just list the command groups.
-verbose - Print full help for each command, instead of summary.
NOTES
Specify the group name or use 'all' to list all available commands.
S
Keyboard Shortcuts
The CLI keeps a history of recently executed commands. This history is
available via the Up and Down arrow keys.
Users may edit the current command with the Left and Right arrow keys.
Tab completion: pressing the Tab key after typing at least one character
either completes a command or lists all the available commands that begin
with the characters already typed.
Accessing the CLI
NOTE: The CLI can be accessed via Telnet, SSH, or through the switch RS232
serial port. The following instructions use Telnet.
1. Telnet to the IP address of the switch (the default IP address is 192.168.100.9)
with the following command:
telnet <IP ADDRESS>
2. The system prompts for a username. The CLI has the following default user
names:
Operator access: operator
Administrator access: admin
Type the appropriate username and press Enter.
2-4 D000025-002 Rev. A
A
3. The system prompts for a password. The CLI has the following default
passwords:
Operator access: operpass
Administrator access: adminpass
Type the appropriate password and press Enter. The system responds with:
Welcome to the <SWITCH> CLI. Type 'list' for the list of
commands.
Groups and Commands
The following section lists all CLI functional groups along with the commands for
each group. Commands for all 9000 switches are listed. Any commands specific to
a switch(es) is noted. For more specific information for each functional group, the
user would execute the help <GROUP NAME> command. For more specific
command information, the user would execute the help <COMMAND NAME>
command.
2 – Switch Command Line Interface
Groups and Commands
General
help
Displays help information for a specific command.
Syntax:
help [command]
Options:
[command]
The command to display help for.
D000025-002 Rev. A 2-5
2 – Switch Command Line Interface
Groups and Commands
Sample Output:
-> help list
NAME
list
SYNOPSIS
list [group] [-noprompt]
DESCRIPTION
List available commands.
OPTIONS
group - List the commands in that particular group
-noprompt - Just list the command groups.
NOTES: General Help
Type list or ? for the list of commands.
S
To get help on a particular command type: commandname help.
For convienence purposes you can also type: help commandname
Use the Up and Down arrow keys to browse command history, Left and Right arrow
keys to edit the current command and the Tab key for tab completion of a command.
Two alternate key bindings exist for the backspace and delete keys. If these keys
are not responding as expected use the swapBsDel command to swap the
bindings.
Commands are grouped into subcategories. To list the commands in a subcategory
type in the category heading. Category headings are identified by starting with a
capital letter. For example, to list all the commands that handle log configuration
type Log.
list
Displays a list of all valid commands.
Syntax:
list [group] [-noprompt] [-verbose]
2-6 D000025-002 Rev. A
A
Options:
group
Displays a list of commands for a particular group
-noprompt
Displays a list of the command groups only.
-verbose
Print full help for each command, instead of summary.
Sample Output:
list
List of Valid Commands:
General General commands for user management and CLI configuration.
Deprecated These commands have been deprecated
Network Snmp configuration commands.
Firmware Update firmware and display current revision levels.
Log Log file display and configuration
IbSwitchInfo InfiniBand port configuration and statistics
TimeManagement Display and configure the system time
Snmp Snmp configuration commands.
Ethernet Provides commands for managing the Ethernet interface.
2 – Switch Command Line Interface
Groups and Commands
Type the name of the group you want to list or return to exit:
NOTES: Specify the group name or use the option all to list all available commands.
To get a full list of commands and all help text, user list all -verbose.
history
Displays the command history for this session.
Syntax:
history
Options:
None.
D000025-002 Rev. A 2-7
2 – Switch Command Line Interface
Groups and Commands
Sample Output:
-> history
command history [30 max lines]:
list
Deprecated
Network
Firmware
Log
IbSwitchInfo
TimeManagement
Snmp
Ethernet
help
list
history
reboot
Reboots the device.
S
Syntax:
reboot [now][-m][slot n][-s][-n][all]
Options:
now
Does not prompt the user before rebooting.
-m
Reboot Master (local) Spine 1 (non-disruptive).
slot n
reset specific device where n = slotNumber (disruptive).
-s
Reboot Slave (remote) Spine 2.
-n
Reboot Slave (remote) management card only (non-disruptive)
all
Reboot All local devices (excludes -n/-m/-s).
Sample Output:
-> reboot
Disruptive reboot selected
Proceed with reboot? [N]
2-8 D000025-002 Rev. A
A
NOTES: You may reboot the local (Master) Spine or the remote (Slave) Spine with
one or multiple arguments.
Non-disruptive arguments will not interfere with switch traffic.
Providing the argument all performs disruptive reboot of all present Spines and
cards.
If rebooting the local device from telnet, ssh, etc., you will have to reconnect after
rebooting.
Default (no arguments) reboots local device disruptively after prompt.
See also: 'resetCard', 'showInventory'.
killCliSession
Terminates an existing CLI session
Syntax:
killCliSession sessionNumber
2 – Switch Command Line Interface
Groups and Commands
Options:
sessionNumber
The sessionNumber that is returned from the who command.
Sample Output:
-> killCliSession
must supply session number
NOTES: This command logs out remote sessions. Use 'who' to obtain the list of
active sessions.
who
Displays currently active CLI sessions.
Syntax:
who
Options:
None.
D000025-002 Rev. A 2-9
2 – Switch Command Line Interface
Groups and Commands
Sample Output:
user role index logged in last cmd type ip address
--------------------------------------------------------------------------------------------------admin admin 0 13:19:03 07/11/2008 09:41:20 07/11/2008 serial 0.0.0.0
NOTES: Displays a list of currently active CLI sessions. Note that a session can
be 'active', but no user information available (in most cases, this indicates the
session is waiting for the user to enter login information).
For each session the following information is displayed:
user: username of the logged in user
role: security role of the user
index: internal session index
logged in: timestamp of when the user logged in
last cmd: timestamp of the users last command
type: method used to connect to the system
S
ip address: ip address of the user (if applicable)
broadcast
Write a message to all active CLI sessions
Syntax:
broadcast msg
Options:
msg
Message (Note: the message text must be encapsulated in quotes "".
Sample Output:
-> broadcast "The system will be rebooted in 5 minutes."
NOTES: Writes the supplied message to all other active CLI sessions. The message
to be written must be encapsulated in quotes, and non-empty.
2-10 D000025-002 Rev. A
A
swapBsDel
Swaps the backspace and delete character key bindings.
Syntax:
swapBsDel
Options:
None.
Sample Output:
-> swapBsDel
NOTES: Terminals may bind the backspace and delete key bindings differently.
This command swaps two commonly used bindings, which allow the user to use
the backspace and delete keys properly without having to adjust their terminal
settings. Backspace and delete swapping is persistently maintained per user (i.e.
each login account can have a separate binding).
2 – Switch Command Line Interface
Groups and Commands
setTermWidth
Change the terminal width for text formatting purposes.
Syntax:
setTermWidth width
Options:
width
Width of the user’s terminal window. Minimum width is 20 characters.
Sample Output:
-> setTermWidth 100
NOTES: Allows modification of the terminal width used for text formatting purposes.
Note that not all commands adhere to this setting. The minimum width is 20
characters.
D000025-002 Rev. A 2-11
2 – Switch Command Line Interface
Groups and Commands
getTermWidth
Displays the terminal width for text formatting purposes.
Syntax:
getTermWidth
Options:
None.
Sample Output:
-> getTermWidth
Current terminal width: 80 characters.
NOTES: Displays the terminal width used for text formatting purposes. Note that
not all commands adhere to this setting.
S
prompt
Set the CLI prompt (global for all active CLI sessions).
Syntax:
prompt str
Options:
str
The new prompt.
Sample Output:
prompt -> "9024->"
9024->
NOTES: This changes the prompt for all CLI sessions. The prompt may not exceed
11 characters and is not saved across reboots. If the prompt contains a space,
asterick, comma, parenthesis or semicolon it must be enclosed with double quotes
". For example: "*a prompt*". Also, if a prompt is not accepted try to enclose it with
double quotes.
2-12 D000025-002 Rev. A
2 – Switch Command Line Interface
A
case
Display or change the case sensitivity for the command interpreter for the CLI session.
Syntax:
case [off | on]
Options:
off | on
Turn case sensitivity off or on.
Sample Output:
-> case off
Case sensitivity is now off
NOTES: This displays or changes the case sensitivity for the command interpreter
for the CLI session. If an option is not specified the current case sensitivity is
displayed, otherwise the case sensitivity is turned on or off depending on the
specified option. When case sensitivity is on, the CLI input must match the exact
character case (lower and upper case) as specified in the help text. When case
sensitivity is turned off, the input may be any combination of upper and lower case.
Groups and Commands
showLastRetCode
Display the return code from the last executed command.
Syntax:
showLastRetCode [-brief]
Options:
-brief
Displays just the numeric value of the return code.
Sample Output:
-> showLastRetCode
Last Exit Code: 0: Success
NOTES: This allows for automated systems to determine if a command was
successful or not.
D000025-002 Rev. A 2-13
2 – Switch Command Line Interface
Groups and Commands
echo
Echoes text back to the output..
Syntax:
echo [<text> ...]
Options:
[<text> ...]
Text to be echoed..
Sample Output:
MasterSpine1-> echo test
test
NOTES: This echoes the text for each argument back to the output. If there are
multiple arguments they are separated by spaces.
S
rlogin
Creates I/O terminal to local cards.
Syntax:
rlogin [hostName]
Options:
hostName
The name of the device to connect to.
Sample Output:
-> rlogin slot2
NOTES: This command allows users to open a terminal to local I/O devices within
the chassis/hemisphere. The command rcmd is an alias of rlogin. See also
hostShow.
2-14 D000025-002 Rev. A
A
rcmd
Creates I/O terminal to local cards.
Syntax:
rcmd [hostName]
Options:
hostName
The name of the device to connect.
Sample Output:
-> rcmd Host1
NOTES: This command allows users to open a terminal to local I/O devices within
the chassis/hemisphere. The command rcmd is an alias of rlogin. See also
hostShow.
2 – Switch Command Line Interface
Groups and Commands
resetCard
Reboot a specific slot in the chassis.
Syntax:
resetCard n [now]
Options:
n
Chassis slot number.
now
No prompt before resetting the card.
Sample Output:
-> resetCard 2 now
NOTES: If you reset the switch you are connected to you will have to reconnect.
You can find out the valid slots for this device with the 'showInventory' command.
logout
Logout of the current CLI session.
Syntax:
logout
D000025-002 Rev. A 2-15
2 – Switch Command Line Interface
Groups and Commands
Options:
None.
Sample Output:
logout
user
Change user accounts.
Syntax:
user [user]
Options:
[user]
Name of user account to change to.
S
Sample Output:
-> user operator
User changed to: operator
NOTES: Use this command to change to the 'operator' account, or to the 'admin'
account.
passwd
Change users password(s).
Syntax:
passwd [username]
Options:
[username]
Name of the user whose password needs to be changed.
Sample Output:
-> passwd operator1
User password changed successfully
NOTES: Allows the modification of the user's password.
2-16 D000025-002 Rev. A
A
userAdd
Add a user account.
Syntax:
userAdd [role] [username] [password]
Options:
[role]
Can be either admin or operator.
[username]
The name of the user to be added.
[password]
Optional password. If not supplied the default password for that role is used.
Sample Output:
-> userAdd admin Bob
User added: Bob
Password is set to the default password for this role: admin
2 – Switch Command Line Interface
Groups and Commands
userRem
Remove a user account.
Syntax:
userRem [username]
Options:
username
Name of the user to be removed.
Sample Output:
-> userRem Bob
User deleted: Bob
userListShow
List all user accounts for this device.
Syntax:
userListShow
D000025-002 Rev. A 2-17
2 – Switch Command Line Interface
Groups and Commands
Options:
None.
Sample Output:
-> userListShow
username role
operator1 operator
USERID admin
Bob admin
sshKey
Syntax:
sshKey <cmd> [-u <username>] [<input>]
Options:
show
Displays the SSH public keys in the users authorized_keys file.
add “<key>”
Add key to the users authorized_keys file. Must be enclosed within double-quotes
("<key>").
rem <index>
Remove key at <index> for the user.
rem -all
Remove all keys for the usern.
-u <username>
Perform the operation on the user <username> (for admins only).
S
Sample Output:
-> sshKey show
Index Key
---------------------------------- 1 "ssh-rsa AAAAB3NzaC1yc2EAAAABIwAAAQEArNiSexu30rZjs1HAXbDBwTgJgcxLF..."
NOTES: Adds, displays, and removes SSH public keys for individual users. Users
with administrative privileges may use the -u option to manage keys for other users.
2-18 D000025-002 Rev. A
A
loginMode
Allows the user to change the user interface authentication requirements.
Syntax:
loginMode [mode]
Options:
[mode]
Determines how users are able to login.
Sample Output:
-> loginMode 1
Mode successfully changed to: 1 = Password is not required
NOTES: This command displays or changes how users are authenticated when
connecting to the GUI or CLI. With no parameters, the current login mode is
displayed. The login mode can be changed by specifying a single integer parameter
indicating which of the following modes should become active:
2 – Switch Command Line Interface
Groups and Commands
0 - Username and password required
1 - Password is not required
2 - Username / password are not required
3 - LDAP Authentication
When usernames are disabled, all users will be logged on as the administrative
user. There is no way to change this behavior.
setldapSvrIpAddr
Modify the LDAP Server IP Address.
Syntax:
setldapSvrIpAddr [ipaddress]
Options:
[ipaddress]
The IP address of the ldap server you wish to set to authenticate in the format
"192.168.0.1"
Sample Output:
-> setldapSvrIpAddr 192.168.0.29
D000025-002 Rev. A 2-19
2 – Switch Command Line Interface
Groups and Commands
NOTES: This sets the ldap server ip address. The ldap server will be contacted for
remote authentication.
setldapSvrPort
Modify the LDAP Server Port.
Syntax:
setldapSvrPort [port]
Options:
[port]
The port of the LDAP server to be authenticated.
Sample Output:
-> setldapSvrPort 389
S
NOTES: Sets the LDAP server port. The LDAP server will be contacted for remote
authentication.
idleTimeoutGet
Retrieves the UI idle timeout value.
Syntax:
idleTimeoutGet [--all] [--cli] [--gui]
Options:
--all
Display all timeouts. This is the default if no options are specified.
--cli
Display the timeout for CLI sessions.
--gui
Display the timeout for GUI sessions.
Sample Output:
-> idleTimeoutGet
Timeout is 600 seconds.
NOTES: Displays the system idle timeouts for the GUI and CLI interfaces. If set to
zero, the timeout is disabled.
2-20 D000025-002 Rev. A
A
idleTimeoutSet
Set the UI idle timeout value.
Syntax:
idleTimeoutSet [--all | --cli | --gui] seconds]
Options:
[seconds]
Idle timeout value (in seconds).
--all
Set the idle timeout for both the CLI and the GUI to the same value.
--cli
Set the idle timeout for the CLI. This is the default if no identifier is specified.
--gui
Set the idle timeout for the GUI.
2 – Switch Command Line Interface
Groups and Commands
Sample Output:
-> idleTimeoutSet --all 700
Timeout is set to 700 seconds.
NOTES: Modifies the idle timeout for the CLI or GUI interfaces. Timeouts are in
number of seconds, with zero meaning the timeout is disabled.
sessionTimeoutDisable
Disable the idle timeout for the current CLI session.
Syntax:
sessionTimeoutDisable
Options:
None.
Sample Output:
-> sessionTimeoutDisable
Disabled session idle timeout.
NOTES: Disables the idle timeout for the current CLI session. This value does not
persist across instances of the session (i.e., each time you log on, it will default back
to the system default value).
D000025-002 Rev. A 2-21
2 – Switch Command Line Interface
Groups and Commands
sessionTimeoutEnable
Enable the idle timeout for the CLI session.
Syntax:
sessionTimeoutEnable
Options:
None.
Sample Output:
-> sessionTimeoutEnable
Enabled session idle timeout.
NOTES: Enables the idle timeout for the current CLI session. This value does not
persist across instances of the session (i.e., with each log on, it defaults back to the
system default value).
S
loginMsgGet
Displays the CLI login message for this device.
Syntax:
loginMsgGet
Options:
None.
Sample Output:
-> loginMsgGet
Welcome message: Be certain to logout when you are finished using the
CLI.
NOTES: Displays the current login welcome message for the CLI. This message
can be customized with the loginMsgSet command.
loginMsgSet
Set the CLI login message for this device.
Syntax:
loginMsgSet [message]
2-22 D000025-002 Rev. A
2 – Switch Command Line Interface
A
Options:
[message]
The login message (should be encapsulated in quotes “ “).
Sample Output:
-> loginMsgSet "Be certain to logout when you are finished using the
CLI."
Welcome message set successfully
NOTES: This command can be used to modify the welcome message displayed
when logging onto the CLI. The current message can be viewed with the
loginMsgGet command.
loginNameGet
Display the name of the device displayed when logged into via telnet.
Syntax:
loginNameGet
Groups and Commands
Options:
None.
Sample Output:
-> loginNameGet
login-name: Switch1
NOTE: The login name is an arbitrary string displayed prior to a user attempting a
login to a new CLI session. This command displays the current value of this string.
loginNameSet
Modify the string displayed to users prior to attempting a login for a new CLI session.
Syntax:
loginNameSet <text string>
Options:
None.
D000025-002 Rev. A 2-23
2 – Switch Command Line Interface
Groups and Commands
Sample Output:
-> loginNameSet Switch1
login-name set successfully
NOTES: The login name is an arbitrary string displayed prior to a user attempting
a login to a new CLI session. This command modifies this string.
serialAuthGet
Displays the current serial authentication status.
Syntax:
serialAuthGet
Options:
None.
S
Sample Output:
-> serialAuthGet
Serial authentication is currently disabled.
NOTES: Displays whether user login and authentication is required on the serial
console of the system.
serialAuthSet
Enable or disable authentication on the systems serial console.
Syntax:
serialAuthSet [enable]
Options:
[enable]
Boolean value to enable or disable serial authentication.
Sample Output:
-> serialAuthSet 1
Serial authentication set to enabled.
NOTES: This command is used to enable or disable user authentication on the
serial console. Use 1 as the only parameter to enable authentication, or 0 to disable
authentication.
2-24 D000025-002 Rev. A
Loading...