INFORMATION IN THIS DOCUMENT IS PROVIDED IN CONNECTION WITH INTEL PRODUCTS. NO LICENSE, EXPRESS OR IMPLIED, BY ESTOPPEL OR
OTHERWISE, TO ANY INTELLECTUAL PROPERTY RIGHTS IS GRANTED BY THIS DOCUMENT. EXCEPT AS PROVIDED IN INTEL'S TERMS AND CONDITIONS OF
SALE FOR SUCH PRODUCTS, INTEL ASSUMES NO LIABILITY WHATSOEVER AND INTEL DISCLAIMS ANY EXPRESS OR IMPLIED WARRANTY, RELATING TO
SALE AND/OR USE OF INTEL PRODUCTS INCLUDING LIABILITY OR WARRANTIES RELATING TO FITNESS FOR A PARTICULAR PURPOSE, MERCHANTABILITY,
OR INFRINGEMENT OF ANY PATENT, COPYRIGHT OR OTHER INTELLECTUAL PROPERTY RIGHT.
A "Mission Critical Application" is any application in which failure of the Intel Product could result, directly or indirectly, in personal injury or death. SHOULD
YOU PURCHASE OR USE INTEL'S PRODUCTS FOR ANY SUCH MISSION CRITICAL APPLICATION, YOU SHALL INDEMNIFY AND HOLD INTEL AND ITS
SUBSIDIARIES, SUBCONTRACTORS AND AFFILIATES, AND THE DIRECTORS, OFFICERS, AND EMPLOYEES OF EACH, HARMLESS AGAINST ALL CLAIMS
COSTS, DAMAGES, AND EXPENSES AND REASONABLE ATTORNEYS' FEES ARISING OUT OF, DIRECTLY OR INDIRECTLY, ANY CLAIM OF PRODUCT LIABILITY,
PERSONAL INJURY, OR DEATH ARISING IN ANY WAY OUT OF SUCH MISSION CRITICAL APPLICATION, WHETHER OR NOT INTEL OR ITS SUBCONTRACTOR
WAS NEGLIGENT IN THE DESIGN, MANUFACTURE, OR WARNING OF THE INTEL PRODUCT OR ANY OF ITS PARTS.
Intel may make changes to specifications and product descriptions at any time, without notice. Designers must not rely on the absence or characteristics of
any features or instructions marked "reserved" or "undefined". Intel reserves these for future definition and shall have no responsibility whatsoever for
conflicts or incompatibilities arising from future changes to them. The information here is subject to change without notice. Do not finalize a design with
this information.
The products described in this document may contain design defects or errors known as errata which may cause the product to deviate from published
specifications. Current characterized errata are available on request.
Contact your local Intel sales office or your distributor to obtain the latest specifications and before placing your product order.
Copies of documents which have an order number and are referenced in this document, or other Intel literature, may be obtained by calling 1-800-5484725, or go to: http://www.intel.com/design/literature.htm
Intel and the Intel logo are trademarks of Intel Corporation in the U.S. and/or other countries.
*Other names and brands may be claimed as the property of others.
This manual describes the command line interface (CLI) task information for the Intel®
True Scale Fabric Switches 12200, 12300, and 12800.
This manual is organized as follows:
This section describes the intended audience and technical support.
Section 2.0 describes the 12000 switch CLI commands.
1.1Intended Audience
This manual is intended to provide network administrators and other qualified
personnel a reference for the command line interface of the Intel
switches.
True Scale Fabric Switches 12000 Series User Guide
®
True Scale Fabric Switches 12000 Series Release Notes
®
True Scale Fabric Switch 12200 Release Notes
1.3Documentation Conventions
This guide uses the following documentation conventions:
• Note: provides additional information.
• Caution: indicates the presence of a hazard that has the potential of causing
damage to data or equipment.
• Warning: indicates the presence of a hazard that has the potential of causing
personal injury.
• Text in blue font indicates a hyperlink (jump) to a figure, table, or section in this
guide, and links to Web sites are also shown in blue. For example:
— Table 2 lists problems related to the user interface and remote agent.
— See “Installation Checklist” on page 6.
— For more information, visit www.intel.com.
• Text in bold font indicates user interface elements such as a menu items, buttons,
check boxes, or column headings. For example:
— Click the Start button, point to Programs, point to Accessories, and then
click Command Prompt.
— Under Notification Options, select the Warning Alarms check box.
• Text in
For example:
• Key names and key strokes are indicated with UPPERCASE:
Courier font indicates a file name, directory path, or command line text.
— To return to the root directory from anywhere in the file structure:
— Enter the following command:
— Press CTRL+P.
cd /root and press ENTER.
Type
sh ./install.bin
®
12000 series
July 2015Reference Guide
Order Number: G91931004US5
True Scale Fabric Switches 12000 Series CLI
— Press the UP ARROW key.
• Text in italics indicates terms, emphasis, variables, or document titles. For
example:
— For a complete listing of license agreements, refer to the Intel Software End
User License Agreement.
— What are shortcut keys?
— To enter the date type mm/dd/yyyy (where mm is the month, dd is the day,
and yyyy is the year).
• Topic titles between quotation marks identify related topics either within this
manual or in the online help throughout this document.
1.4Laser Safety Information
This product may use Class 1 laser optical transceivers to communicate over the fiber
optic conductors. The U.S. Department of Health and Human Services (DHHS) does not
consider Class 1 lasers to be hazardous. The International Electrotechnical Commission
(IEC) 825 Laser Safety Standard requires labeling in English, German, Finnish, and
French stating that the product uses Class 1 lasers. Because it is impractical to label the
transceivers, the following label is provided in this manual.
The assemblies used in the switch chassis are ESD sensitive. Observe ESD handling
procedures when handling any assembly used in the switch chassis.
1.6License Agreements
Refer to the Intel® Software End User License Agreement for a complete listing of all
license agreements affecting this product.
1.7Technical Support
Intel True Scale Technical Support for products under warranty is available during local
standard working hours excluding Intel Observed Holidays. For customers with
extended service, consult your plan for available hours. For Support information, see
the Support link at
This section details the usage of the Command Line Interface (CLI) feature for the
®
Intel
12000 family of switches:
®
• The Intel
• The Intel
• The Intel
— 12800-040
— 12800-120
— 12800-180
— 12800-360
The CLI allows the user to perform remote configuration and management tasks, that
in many respects mirrors the functionality of the Chassis Viewer GUI.
The CLI is accessed via a terminal attached to the RS232 port(s) or via the OOB
management port using Telnet and secure shell (SSH) of:
• The 12200 chassis
• The 12300 chassis
• The SEEB module(s) of the 12800 series
12200
®
12300
®
12800 Series:
Accessing the CLI through the serial port does not require a login and password (unless
configured to do so) 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.
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 using Telnet and SSH, 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.
• Can disable user login and passwords. This would allow all users administrator-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.
July 2015Reference Guide
Order Number: G91931004US7
True Scale Fabric Switches 12000 Series CLI
2.2Commands 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.
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.
12000 Series CLI
SubnetManagement:
IB 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 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.
CaptureInfo:
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
showLastScpRetCode Display the return code from the last SCP Firmware Push
fwVersion Display Firmware revisions
bootQuery Query boot image information
bootSelect Change boot selection
2.3Online Help
The online help for the CLI provides, for each command, all necessary information to
successfully execute the command. For example, typing
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.
help list (can also type list
2.4Keyboard 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.
2.4.1Accessing the CLI
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>
July 2015Reference Guide
Order Number: G91931004US9
True Scale Fabric Switches 12000 Series CLI
2. The system prompts for a user name. The CLI has the following default user
names:
Type the appropriate password and press Enter. The system responds with:
Welcome to the <SWITCH> CLI. Type 'list' for the list of commands.
2.5Groups and Commands
This section lists all CLI functional groups along with the commands for each group.
The commands for all 12000 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
the user would execute the
2.5.1General
help <GROUP NAME> command. For more specific command information,
help <COMMAND NAME> command.
12000 Series CLI
2.5.1.1help
Displays help information for a specific command.
Syntax
help [command]
Options
command – The command to display help for.
Sample Output
-> help list
NAME
list
SYNOPSIS
list [group] [-noprompt]
DESCRIPTION
List available commands.
OPTIONS
group - List the commands in that particular group
To get help on a particular command type: <command name> help.
For convenience purposes you can also type: help <command name>
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.
In each help description, items in brackets (e.g. [<command>] in this help description)
represent optional parameters. User selectable input is indicated by items within the '
and '
text that needs to be entered. When there is more than one choice, the options are
specified within '
characters.
2.5.1.2list
Displays a list of all valid commands.
Syntax
list [all] [group] [-noprompt] [-verbose]
Options
all – List the commands for all groups.
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.
<'
>' symbols(e.g. <command>). Text outside the '<' and '>' characters is the actual
{' and '}' characters, where the options are separated by '|'
July 2015Reference Guide
Order Number: G91931004US11
True Scale Fabric Switches 12000 Series CLI
Log Log file display and configuration
IbSwitchInfo InfiniBand port configuration and statistics
TimeManagement Display and configure the system time
Snmp Snmp configuration commands.
Type the name of the group you want to list or return to exit:
Notes
Use '
list all' to display brief help for all available commands.
Use '
list all -verbose' to display verbose help for all commands.
Use '
list -noprompt' to display the list of command groups.
admin admin 0 13:19:03 07/11/2008 09:41:20 07/11/2008 serial 0.0.0.0
12000 Series CLI
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: user name 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
• ip address: ip address of the user (if applicable)
2.5.1.7broadcast
Write a message to all active CLI sessions
Syntax
broadcast msg
Options
msg – Message (Note: the message text must be encapsulated in quotes "".
-> 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.5.1.8swapBsDel
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.5.1.9setTermWidth
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.
2.5.1.10getTermWidth
Displays the terminal width for text formatting purposes.
Syntax
getTermWidth
July 2015Reference Guide
Order Number: G91931004US15
True Scale Fabric Switches 12000 Series CLI
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.
2.5.1.11prompt
Set the CLI prompt (global for all active CLI sessions).
Syntax
prompt str
Options
12000 Series CLI
str – The new prompt.
Sample Output
prompt -> "12300->"
12300->
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, asterisk, comma,
parenthesis or semicolon it must be enclosed with double quotes “”. For example: “
prompt*”. Also, if a prompt is not accepted try to enclose it with double quotes. In
order for some FastFabric Tools to function correctly, the prompt must end in “
trailing space).
2.5.1.12case
Display or change the case sensitivity for the command interpreter for the CLI session.
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.
2.5.1.13showLastRetCode
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.
2.5.1.14echo
Echoes text back to the output.
Syntax
echo [<text> ...]
Options
[<text> ...] – Text to be echoed..
Sample Output
-> 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.
2.5.1.15rlogin
Creates I/O terminal to local cards.
Syntax
rlogin [hostName]
July 2015Reference Guide
Order Number: G91931004US17
True Scale Fabric Switches 12000 Series CLI
Options
hostName – The name of the device to connect.
Sample Output
-> rlogin Slave
Notes
This command allows users to open a terminal to local I/O devices within the chassis.
The command
2.5.1.16rcmd
Creates I/O terminal to local cards.
Syntax
rcmd [hostName]
Options
hostName – The name of the device to connect.
12000 Series CLI
rcmd is an alias of rlogin. See also hostShow.
Sample Output
-> rcmd Slave
Notes
This command allows users to open a terminal to local I/O devices within the chassis.
The command rcmd is an alias of rlogin. See also hostShow.
2.5.1.17resetCard
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 101 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.
Use this command to change to the 'operator' account, or to the 'admin' account. The
minimum password length is 8 characters. The maximum length is 40 characters.
2.5.1.20passwd
Change users password(s).
Syntax
passwd [user name]
Options
user name – 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.5.1.21userAdd
Add a user account.
July 2015Reference Guide
Order Number: G91931004US19
True Scale Fabric Switches 12000 Series CLI
Syntax
userAdd [role] [user name] [password]
Options
role – Can be either admin or operator.
user name – 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
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.5.1.25loginMode
Allows the user to change the user interface authentication requirements.
July 2015Reference Guide
Order Number: G91931004US21
True Scale Fabric Switches 12000 Series CLI
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:
0 - Username and password required
1 - Password is not required
2 - Username / password are not required
3 - LDAP Authentication
When user names are disabled, all users will be logged on as the administrative user.
There is no way to change this behavior.
2.5.1.26setldapSvrIpAddr
Modify the LDAP Server IP Address.
Syntax
setldapSvrIpAddr [ipaddress]
12000 Series CLI
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
Notes
This sets the LDAP server ip address. The LDAP server will be contacted for remote
authentication.
2.5.1.27setldapSvrPort
Modify the LDAP Server Port.
Syntax
setldapSvrPort [port]
Options
port – The port of the LDAP server to be authenticated.
Sample Output
-> setldapSvrPort 389
Notes
Sets the LDAP server port. The LDAP server will be contacted for remote
authentication.
--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
-> idleTimeoutSet --all 700
Timeout is set to 700 seconds.
Notes
Displays the system idle timeouts for the GUI and CLI interfaces. If set to zero, the
timeout is disabled.
2.5.1.29idleTimeoutSet
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.
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.
2.5.1.30sessionTimeoutDisable
Disable the idle timeout for the current CLI session.
July 2015Reference Guide
Order Number: G91931004US23
True Scale Fabric Switches 12000 Series CLI
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).
2.5.1.31sessionTimeoutEnable
Enable the idle timeout for the CLI session.
Syntax
12000 Series CLI
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).
2.5.1.32loginMsgGet
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.
Displays the current login welcome message for the CLI. This message can be
customized with the
2.5.1.33loginMsgSet
Set the CLI login message for this device.
Syntax
loginMsgSet [message] [-clear]
Options
message – The login message (should be encapsulated in quotes “ “).
-clear – Clear welcome message.
Sample Output
-> loginMsgSet "Be certain to logout when you are finished using the CLI."
Welcome message set successfully
loginMsgSet command.
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
2.5.1.34loginNameGet
Display the name of the device displayed when logged into via telnet.
Syntax
loginNameGet
Options
None.
Sample Output
-> loginNameGet
login-name: Switch1
Notes
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.
2.5.1.35loginNameSet
loginMsgGet command.
Modify the string displayed to users prior to attempting a login for a new CLI session.
Syntax
loginNameSet [option]
July 2015Reference Guide
Order Number: G91931004US25
True Scale Fabric Switches 12000 Series CLI
Options
name – Set the login name.
-clear – Clear the login name.
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. The current name can be viewed
with the
loginNameGet command.
2.5.1.36serialAuthGet
Displays the current serial authentication status.
Syntax
serialAuthGet
12000 Series CLI
Options
None.
Sample Output
-> serialAuthGet
Serial authentication is currently disabled.
Notes
Displays whether user login and authentication is required on the serial console of the
system.
2.5.1.37serialAuthSet
Enable or disable authentication on the systems serial console.
Syntax
serialAuthSet [enable]
Options
enable – Boolean value to enable or disable serial authentication.
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.
Exit and re-login for the setting to take effect. The login mode must be set to 0 or 1 for
authentication to take place on the serial port.
2.5.1.38uiConfig
View or configure the user interfaces to this device.
telnet – Enable/disable access to the device via telnet..
https – Enable or disable https access.
http – Enable or disable http access.
ftp – Enable or disable ftp access.
snmp – Enable or disable SNMP access.
Sample Output
-> uiconfig -telnet 0
Successfully modified configuration.
Option Value
-----------------------
telnet 0
http 1
https 0
ftp 1
snmp 1
Notes
There are several access methods for this device. With no arguments, this command
displays which access methods are available, and whether each method is enabled or
disabled.
This command can also be used to enable or disable various access methods. Use '
-
<proto> 0' to disable a protocol, and '-<proto> 1' to enable. Multiple operations
may be specified in a single command.
A reboot is not required for this command. Depending on the specific method, it may
take 5-10 seconds for the changes. Note that existing connections (for example a
telnet session) will not be affected by disabling the underlying access method.
Any access method supported by the device (but not listed here) cannot be configured
and is always enabled.
July 2015Reference Guide
Order Number: G91931004US27