HP MPX200 User Manual
HP MPX200 Multifunction Router Remote Command Line Interface
User Guide
Abstract
This document describes how to use the Remote Command Line Interface (Remote CLI or simply RCLI) to configure and manage
the HP MPX200 Multifunction Router. It is intended for personnel who are responsible for installing and servicing an HP MPX200
Multifunction Router and the SAN equipment to which it is attached.
HP Part Number: 5697-2510
Published: March 2013
Edition: 3
© Copyright 2012–2013 Hewlett-Packard Development Company, L.P.
Confidential computer software. Valid license from HP required for possession, use or copying. Consistent with FAR 12.211 and 12.212, Commercial
Computer Software, Computer Software Documentation, and Technical Data for Commercial Items are licensed to the U.S. Government under
vendor's standard commercial license.
The information contained herein is subject to change without notice. The only warranties for HP products and services are set forth in the express
warranty statements accompanying such products and services. Nothing herein should be construed as constituting an additional warranty. HP shall
not be liable for technical or editorial errors or omissions contained herein.
Acknowledgments
Microsoft® and Windows® are U.S. registered trademarks of Microsoft Corporation.
UNIX® is a registered trademark of The Open Group.
Contents
1 Getting started...........................................................................................7
Firmware requirements..............................................................................................................7
Obtaining help........................................................................................................................7
Command line scripting.............................................................................................................7
Generating script files...........................................................................................................7
Executing script files ............................................................................................................8
Saving script files.................................................................................................................8
Sample script files................................................................................................................8
Generating a script using a csv file from a spreadsheet.............................................................9
CLI usage................................................................................................................................9
Command line syntax.........................................................................................................10
Abbreviating keywords.......................................................................................................10
Input persistence................................................................................................................10
Controlling access..................................................................................................................11
Physical security.................................................................................................................11
Password-based access control............................................................................................11
2 General keywords....................................................................................12
General keywords..................................................................................................................12
-blade..............................................................................................................................12
-dmpw..............................................................................................................................12
-echo................................................................................................................................12
-help................................................................................................................................12
-ip....................................................................................................................................13
-pw..................................................................................................................................13
-quiet................................................................................................................................13
-result...............................................................................................................................13
-show_only_error................................................................................................................14
-textfile.............................................................................................................................14
3 Command reference.................................................................................15
?..........................................................................................................................................15
add fcip_route........................................................................................................................15
add initiator...........................................................................................................................17
add lunmask..........................................................................................................................18
add notification......................................................................................................................19
clear display..........................................................................................................................20
clear log...............................................................................................................................20
connect system.......................................................................................................................21
create host.............................................................................................................................21
destroy host...........................................................................................................................21
disable beacon......................................................................................................................22
disable fc_port.......................................................................................................................22
disable io_statistics.................................................................................................................22
disable iscsi_port....................................................................................................................24
discover iscsi_target................................................................................................................24
enable beacon.......................................................................................................................24
enable fc_port........................................................................................................................25
enable iscsi_port....................................................................................................................25
execute script.........................................................................................................................25
find system.............................................................................................................................26
generate script.......................................................................................................................26
Contents 3
help......................................................................................................................................27
list array................................................................................................................................27
list host..................................................................................................................................28
list initiator.............................................................................................................................28
list log...................................................................................................................................29
list lun...................................................................................................................................29
list presented..........................................................................................................................30
list target...............................................................................................................................30
list vlan.................................................................................................................................30
list vp_group..........................................................................................................................31
login iscsi_target....................................................................................................................31
logout iscsi_target...................................................................................................................32
map global_iscsi_target...........................................................................................................32
map target.............................................................................................................................33
merge csv..............................................................................................................................34
modify fcip_route....................................................................................................................34
modify host............................................................................................................................36
modify initiator.......................................................................................................................37
modify migration....................................................................................................................37
modify notification..................................................................................................................38
ping system............................................................................................................................39
reboot system.........................................................................................................................39
register system........................................................................................................................39
remove array.........................................................................................................................40
remove fcip_route...................................................................................................................41
remove initiator......................................................................................................................41
remove lunmask.....................................................................................................................41
remove notification.................................................................................................................43
remove target.........................................................................................................................43
report log..............................................................................................................................43
rescan system.........................................................................................................................44
reset_factory system................................................................................................................44
restore fru_config....................................................................................................................45
retval system..........................................................................................................................45
save capture_file....................................................................................................................46
save fru_config.......................................................................................................................46
save log................................................................................................................................47
save script.............................................................................................................................47
script csv...............................................................................................................................47
set append............................................................................................................................48
set array................................................................................................................................49
set chassis.............................................................................................................................50
set fc.....................................................................................................................................51
set fc_adv..............................................................................................................................51
set features............................................................................................................................52
set iscsi.................................................................................................................................52
set iscsi_adv..........................................................................................................................53
set isns..................................................................................................................................54
set mgmt...............................................................................................................................55
set notification........................................................................................................................56
set ntp...................................................................................................................................57
set password..........................................................................................................................58
set presented..........................................................................................................................58
set snmp................................................................................................................................59
set system..............................................................................................................................60
4 Contents
set time.................................................................................................................................61
set vlan.................................................................................................................................62
set vp_group..........................................................................................................................62
show append.........................................................................................................................63
show array............................................................................................................................63
show chassis..........................................................................................................................64
show fc.................................................................................................................................65
show fc_adv..........................................................................................................................66
show fc_statistics....................................................................................................................66
show fcip_route......................................................................................................................66
show fcip_statistics..................................................................................................................67
show features.........................................................................................................................68
show host..............................................................................................................................69
show initiator.........................................................................................................................69
show io_statistics....................................................................................................................70
show iscsi..............................................................................................................................71
show iscsi_adv.......................................................................................................................72
show iscsi_statistics.................................................................................................................72
show isns..............................................................................................................................74
show lun...............................................................................................................................74
show lunmask........................................................................................................................75
show mgmt............................................................................................................................77
show notification....................................................................................................................78
show ntp...............................................................................................................................78
show performance..................................................................................................................78
show presented......................................................................................................................79
show snmp............................................................................................................................79
show status............................................................................................................................80
show system...........................................................................................................................80
show target............................................................................................................................81
show time..............................................................................................................................81
show vlan..............................................................................................................................81
show vp_group......................................................................................................................82
show zone.............................................................................................................................82
test notification.......................................................................................................................83
tracert system.........................................................................................................................83
unmap global_iscsi_target.......................................................................................................84
unmap target.........................................................................................................................84
unregister system....................................................................................................................85
update firmware.....................................................................................................................85
version system........................................................................................................................85
view log................................................................................................................................86
wait time...............................................................................................................................87
4 Data Migration commands........................................................................89
acknowledge migration...........................................................................................................89
add dm_group.......................................................................................................................89
add dml................................................................................................................................90
add migration........................................................................................................................91
clear dm_log.........................................................................................................................94
clear dm_report......................................................................................................................94
list dm_group.........................................................................................................................94
list dm_log.............................................................................................................................95
list migration..........................................................................................................................95
modify dm_group...................................................................................................................96
Contents 5
pause migration.....................................................................................................................96
remove dm_group...................................................................................................................96
remove dml............................................................................................................................97
remove migration....................................................................................................................98
report dm_log........................................................................................................................98
resume migration....................................................................................................................98
save dm_log..........................................................................................................................98
save dm_report......................................................................................................................99
show dm_group.....................................................................................................................99
show dml............................................................................................................................100
show migration....................................................................................................................101
start migration......................................................................................................................102
stop migration......................................................................................................................102
upload dm_report.................................................................................................................103
view dm_log........................................................................................................................103
5 Support and other resources....................................................................105
Contacting HP......................................................................................................................105
Related information...............................................................................................................105
Typographic conventions.......................................................................................................105
6 Documentation feedback.........................................................................107
A Commands by category..........................................................................108
B API error codes......................................................................................112
Glossary..................................................................................................114
Index.......................................................................................................117
6 Contents
1 Getting started
This chapter provides information to help you get started using the Remote CLI utility.
For instructions to install the Remote CLI, see the Readme file for the utility.
Firmware requirements
Some RCLI router management commands or their keywords require that you install a minimum
version of the router firmware. If a minimum firmware version is required, it is noted in the description
of that specific command or keyword. All data migration commands require that the router is
running firmware Version 3.2.3.0 or later.
Obtaining help
To view a summary of all available commands, enter the ? command.
The command syntax is action item and may be followed by one or more keywords.
To view a detailed description of a specific command, enter the command as action item with
the -help keyword. For example:
c:\> rcli show system -help
Command line scripting
All commands supported by Remote CLI accept all required inputs from the same command line
that runs the program. This ability allows you to use any scripting language that can run a command
line, including Microsoft batch files, Linux shell scripts, and higher level scripting languages such
as Perl or Python.
Applications for command line scripting include:
• Preparing and testing operations during the day, which enables you to run operations faster
and without errors at night.
• Repetitively performing complex operations with fewer operator errors.
• Collecting performance data over time to find the least busy time to schedule maintenance.
• Use of the broadcast function to collect data from all routers in the local network.
Remote CLI accepts command input from a file and generates script files that you can edit and
execute. In general, the generated scripts contain more command content than is needed, requiring
you to delete some unwanted content, but avoiding the necessity of manually adding new content.
Generating script files
Remote CLI can generate the following types of script files:
• save script Collects the current router settings and produces a script with the Remote CLI
commands needed to reconfigure the router after resetting it to the factory defaults
• generate script -mask Produces a script that applies LUN masks for every available
LUN to every available initiator
• generate script -present Produces a script that creates a presented target for every
target
For more information, see “generate script” (page 26).
Firmware requirements 7
Executing script files
The execute script command accepts a text file containing a series of Remote CLI commands
to be run in sequence.
For more information, see “execute script” (page 25).
Saving script files
After you finish setting up a new router, or whenever you save an FRU image, HP recommends
that you save the configuration script. The save script command saves an editable text file
containing a series of commands that can configure a router that has been reset to factory settings
For more information, see “save script” (page 47).
Sample script files
Remote CLI provides sample scripts for Python and other scripting languages. You can use some
of these sample scripts with little or no modification. To view examples of the Remote CLI script
files, go to the install_dir\examples folder. The default installation directories are:
• For Microsoft Windows:
C:\Program Files\QLogic Corporation\iSR-rcli\examples
• For Linux:
/usr/share/doc/qlogic_rcli/examples
Table 1 (page 8) lists and describes the Remote CLI sample script folders that are included in the
installation.
Table 1 Remote CLI sample scripts
DescriptionFolder name
check_fcip_port_speed
iostats
load_firmware
This folder contains a Perl script that produces a list of hard-coded router IP
addresses and reboots each router in turn. After the reboot is complete, the script
retrieves the FCIP route information, stops if the port speed is exactly 100Mb,
and then continues to the next router. This script requires some modification for
use.
This folder contains a Python script that finds the hard-coded IP address of a
router and periodically collects performance data. To provide a continuous
display of the current values, leave this script running in a command prompt to
clear and refresh the window each time.
This script also captures output in a collection of csv files suitable for import
into a spreadsheet program such as Microsoft Excel. It produces one file for
each port and for each LUN. After data has been collected, you can use the
merge csv command to combine all csv files into a summary csv file. See
“merge csv” (page 34). You can import the summary csv file into a spreadsheet
to produce graphs of usage over time, so that maintenance operations can be
scheduled for times when the network is less busy.
This folder contains scripts for automatically loading firmware on all MPX200s
in a local network subnet. After loading new firmware, this script restarts the
routers, obtains and verifies the firmware version number of each, and generates
log files that include router serial numbers.
monitor
8 Getting started
This folder contains both Linux and Windows scripts that periodically collect and
display data from a specified router:
• monitor.sh—Collects temperature data. This script can be easily modified
to collect any other data available from the router.
• perfmon.sh—Collects performance information and I/O statistics and saves
the infomation to a csv file for later analysis. This script is useful without any
modification
Table 1 Remote CLI sample scripts (continued)
DescriptionFolder name
script_csv
simple
test
track_assets
This folder contains scripts for automated migration of a large number of LUNs
based on input from a migration planning spreadsheet. A csv file can display
(for example, in a spreadsheet) the output (results) of the execution of the Remote
CLI script. The script_csv example does just the opposite, that is, the
spreadsheet is used to generate the RCLI script.
At the customer site, initial planning for a data migration includes collecting
information about which LUNs are going to be migrated and their destination
locations. This information is typically collected in a spreadsheet that is approved
before the operation can start. The spreadsheet data is saved in csv format,
which is then used as input for the RCLI script csv command. The script
csv output is a script that you can run in RCLI to automate the repetitive tasks
required in a data migration involving a large number of LUNs.
A basic example that shows the use of Remote CLI from a Windows batch file
and from a Linux shell script.
This folder contains scripts used for automated testing of Remote CLI during
production builds. These scripts provide a good example of using Remote CLI
in a moderately complex Python application that runs identically on Linux and
Windows.
A Python script that produces a list of all routers in the local network, and the
serial number and IP address of each. With minor modifications, this script can
collect other information from all routers in the local network. This script has no
input parameters.
Generating a script using a csv file from a spreadsheet
To re-create the example scripts described in Table 1 (page 8):
1. In the Remote CLI examples folder, open the Microsoft Excel
2. Open the csv file using a text file editor such as Notepad, delete the first line (column labels),
3. Create a sheet1_script.bat file for the Remote CLI script csv commands. For example:
4. Generate the script files by running the sheet1_script.bat file.
5. Use Remote CLI to run the script files. For example:
CLI usage
The Remote CLI enables you to perform a variety of router management tasks through an Ethernet
connection.
migration_planning_spreadsheet.xlsx spreadsheet, and then save it as a csv file
named migration_planning_spreadsheet.csv.
and then save the csv content to the following two text files:
• sheet1_1_to_159.txt
• sheet1_160_to_319.txt
rcli script csv
/csv_file=c:\t\make_script5\sheet1_1_to_159.txt
-file=bl1_hba0_mask_src_1_to_159.txt /cmd="add lunmask"
/ip=10.0.0.13 -fc_initiator=csv_c -lun_wwuln=csv_f
rcli execute script /file=bl1_hba0_mask_src_1_to_159.txt
rcli execute script /file=bl1_add_migration_1_to_159.txt
CLI usage 9
Command line syntax
The following Remote CLI syntax rules apply:
• Begin all commands with rcli; for example, rcli show time.
• Remote CLI input is not case sensitive. Examples in this guide are shown in lowercase; however,
you can interchangeably use uppercase.
• Run either Linux shell scripts or Windows batch files to specify command selection and input
parameters using an all-text command line syntax.
• Start the command line with an action and include an item on which to perform the action.
• To provide additional context, optionally include keywords after the command.
For example, the command show system -ip=10.0.0.1 provides summary system
◦
information (including serial number and firmware version) from the MPX router with a
management port at 10.0.0.1.
◦ Start keywords with either a hyphen (-) or a forward slash (/). For example, the preceding
command could also be entered as show system /ip=10.0.0.1.
◦ In the syntax for each command, required keywords are included. Optional keywords
are listed separately.
◦ Keyword order on the command line is not important, unless stated otherwise in the
keyword description. For example, if more than one operating system type is specified
when adding an initiator, no error occurs, but only the last type specified on the command
line is used.
◦ Every command supports the keywords listed in “General keywords” (page 12) in addition
to the keywords listed in the command description.
• Parameter data containing spaces can be used if enclosed by either single (' ') or double
quotation marks (" "). For example:
◦ -name="New name"
◦ -name='Name with "quotes" in it'
Abbreviating keywords
Any keyword can be abbreviated to the minimum number of characters needed to avoid ambiguity.
For example, the show system command can be shortened as follows:
sh sy /ip=10.0.0.1
The default item is system, therefore, the show system command can be further shortened as
follows:
sh /ip=10.0.0.1
Input persistence
Most input data items for Remote CLI commands have a default value that is used if you do not
specify a value. However, some data items are retained between runs of RCLI. Remote CLI stores
these items separately for each user in the user home directory on Linux or the My Documents
folder on Windows. In commands where you would expect the default value to be the last value
you entered, these values are set correctly even if a different user has since logged in and used
RCLI.
Most input data is not persistent. Remote CLI obtains default values for optional parameters from
the current router settings, if they are valid. For example, when you modify an existing FCIP route,
most of the parameters default to the current settings on the router, except for the required parameter
10 Getting started
identifying the FCIP route you want to modify. When you add a new FCIP route, fixed default
values are used because there is no existing route from which to get defaults. For example, if you
do not specify an MTU size, normal is the default.
The view log command is a good example of persistent data use. If you issue a command to
display the previous ten log entries, the current position in the log file is saved. The next time you
issue the view log command, it displays the next ten entries, and then saves the new position.
Controlling access
Access control includes elements of both physical security and passwords.
Physical security
In order to prevent unauthorized changes to MPX routers, HP recommends that you connect to the
router’s management ports only from within a network that has no connection outside the local
area and where access to the local area is limited to authorized personnel.
Under these circumstances, the admin password can remain at the factory default setting, and
command line usage does not require passwords.
Password-based access control
Remote CLI does not require you to use the /pw keyword if the password on the router is set to the
factory default. HP recommends that you set a new password on the router unless the router is in
a physically secure area with access only for trusted individuals. After you set a new password,
all subsequent RCLI commands must include the /pw keyword.
Passwords are visible inside script files and on the command line. All scripts that use RCLI must be
protected by file system permissions or encryption. To prevent unauthorized access, HP recommends
that remote users of RCLI always use an encrypted connection, such as a VPN.
Controlling access 11
2 General keywords
This chapter provides the description and syntax for keywords that apply to all commands. Because
these keywords are defined here, they are not repeated for every command in the command
reference chapters.
General keywords
The keywords in this section apply to all commands.
-blade
Use the -blade keyword to specify the primary or secondary router blade (MPX200 only). When
specified, the blade selection is saved for future use as the default.
Syntax
-blade=[primary | secondary | 1 | 2]
Options
Use the router with management port at the specified IP address.1
Use the peer router in the same chassis as the primary router.2
Use the router with management port at the specified IP address.primary
Use the peer router in the same chassis as the primary router.secondary
-dmpw
-echo
-help
Use the -dmpw keyword to provide the data migration password, if one has been set.
Syntax
-dmpw= password
Use the -echo keyword to display a copy of the command line and other text output to the console
or to a text file, if specified.
Syntax
-echo=filename
Use the -help keyword to display command syntax and available keywords. This is the same
information that appears if you enter incorrect command syntax. Including this keyword is optional
and blocks all other effects of the command.
Syntax
-help[=file_name]
Examples
To display the help summary for the show system command:
c:\> rcli show system -help
To save the help summary for the show system command in a Microsoft Word file:
12 General keywords
-ip
-pw
c:\> rcli show system -help=help.doc
Use the -ip keyword to specify the IPv4 or IPv6 management port address of the MPX200
Multifunction router. If not specified, the default is either the last value specified or 10.0.0.1.
NOTE: This keyword is required for most commands.
Syntax
-ip=IPv4 or IPv6 address
Examples
To specify an IPv4 address:
-ip=10.0.0.1
To specify an IPv6 address:
-ip=2001::1234
Use the -pw keyword to provide the RPC password, if one has been set.
NOTE: A password is required only if a non-default RPC password has been set.
-quiet
-result
Syntax
-pw=password
The -quiet keyword to suppress all text output from the command, including normal text display
and error messages. If this keyword is used in a script, RCLI returns the completion status only.
Syntax
-quiet
Use the -result keyword to create a binary output data file. If the binary output data file already
exists, the command replaces the original file with the new file. The default file location is the
current working directory, and the default file name is action_item.dat. This keyword is
optional for all commands, but the binary output data varies depending on the command.
All result files comprise the following items in order:
• One integer indicating the header size, in bytes.
• Four integers indicating the MPX management API version.
• Two integers indicating the command action and item.
• One integer indicating the completion status.
Additional data can be saved in the result file depending on the command, with the first integer
of each data item being an integer size of the item in bytes. (See individual command descriptions
in “Command reference” (page 15)).
Syntax
-result [= file_name]
General keywords 13
Examples
To create a show_system.dat file in the working directory:
c:\> rcli show system /result
To create a show_system_January2012.dat file in the working directory:
c:\> rcli show system /result = show_system_January2012.dat
-show_only_error
Similar to the -quiet keyword, the -show_only_error keyword suppresses all text output from
the command except for error messages.
Syntax
-show_only_error
-textfile
Use the -textfile keyword to append normal display text and error messages to a specified
file. The default file location is the working directory, and the default file name is
action_item.log.
This optional keyword can be used with the -quiet keyword.
Syntax
-textfile[=file_name]
Example
To create a show_system.log file in the working directory:
c:\> rcli show system /textfile
14 General keywords
3 Command reference
This chapter provides the description, syntax, specific keywords, and examples of the RCLI
commands. The commands are listed in alphabetic order.
NOTE: Keywords that apply to all commands are not listed in this chapter. The general keywords
described in “General keywords” (page 12) are optional for every command in this chapter.
To see a list of commands in order by category, see “Commands by category” (page 108)
?
The ? command displays a help summary, including a brief description of the available commands.
To view detailed syntax for a specific command, enter the action and item with the -help keyword.
See “-help” (page 12)
See also “help” (page 27).
Syntax
?
Example
To display summary help for all commands:
c:\> rcli ?
add fcip_route
The command adds an FCIP route for a Fibre Channel port.
Syntax
add fcip_route -fcport=FC port number -ge_port= GbE port number
-remote_ip=IPV4 or IPV6 remote IP address
Keywords
-bandwidth=
-enable=
Specifies the bandwidth in Mb/s.
Enter number from 1 to 1000, or 0 for maximum available.
If you do not use this keyword, the default value is the maximum available bandwidth.
Enables the Ethernet and Fibre Channel ports for the newly-created route. Values
are:
• yes (default)
• no
• on
• off
• true
• false
-ipv4_subnet=
-local_ip=
Specifies the IPv4 gateway address or the IPv6 default router address.-gateway_ip=
Specifies the IPv4 subnet mask to be associated with -local_ip.
NOTE: This keyword is ignored if -local_ip is an IPv6 address.
Specifies the IPv4 or IPv6 address to be used for the local end of this FCIP route.
This keyword is required, unless the -uselinklocal keyword is used instead.
? 15
Specifies the MTU size for the iSCSI port. Values are:-mtu_size=
• min (minimum)
• normal (default)
• max (maximum)
• jumbo (jumbo frames)
• An integer ranging from 582 to 9000
Specifies the port speed in Mb/s. Values are:-port_speed=
• auto (default)
• 100
• 1000
• 10000
Enables use of software compression for the newly-created route.-swcompress_enable=
• yes (default)
• no
• on
• off
• true
• false
Specifies the TCP port number ranging from 1024 to 65535.-tcp_port=
The default value is 3225.
-uselinklocal
Specifies the TCP window size for the iSCSI port. Values are:-tcpwindow=
• 8192 (default)
• 16384
• 32768
• 65536
• 131072
• 262144
• 524288
• 1048576
• 2097152
• 4194304
• 8388608
• 16777216
Specifies that the IPv6 link local address is used for the local end of this FCIP route.
This keyword is required unless the -local_ip keyword is used instead.
Enables use of a VLAN for the newly-created route. Values are:-vlan_enable=
• yes
• no (default)
• on
• off
• true
• false
NOTE: The router must be capable and licensed for FCIP. To view router capabilities, issue the
show features command. See “show features” (page 68).
16 Command reference
Example
c:\>rcli add fcip_route -fc_port=1 -enable=yes -ge_port=1
-local_ip=10.0.0.10 -gateway_ip=10.0.0.1 -remote_ip=10.0.2.10
-mtu_size=normal -tcpwindow=16777216 -port_speed=auto -bandwidth=20
-vlan_enable=y -swcompress_enable=n /ip=10.0.0.12
FCIP route successfully set
add initiator
The add initiator command adds an initiator to the list known to the router.
Syntax
add initiator
Keywords
Specifies that CHAP is enabled for this initiator. Values are:-chap_enable=
• yes
• no
• on
• off
• true
• false
This keyword is valid for an iSCSI initiator only. It cannot be used for a Fibre Channel
initiator.
Specifies the CHAP password.-chap_secret=
This keyword is optional for an iSCSI initiator only. It cannot be used for a Fibre
Channel initiator.
Sets the FCoE portal attribute on the new initiator.-fcoe
Use this keyword only in combination with the -wwpn and -wwnn keywords.
Specifies the symbolic name for a host.—host_id
Specifies the name of the iSCSI initiator you are adding.-iscsi_name=
NOTE: Do not use this keyword with either -wwpn or -wwnn.
Indicates one of the following operating systems:-ostype=
Windows Server 2003 (default)win2k3
Windows Server 2008win2k8
Linux 2.4linux24
Linux 2.6linux26
Hewlett Packard UNIX (HP-UX)hpux
IBM Advanced Interactive eXecutive (AIX)aix
Novell NetWarenetware
Sun Solaris SPARCsolaris
Apple Macintoshmac
VMwarevmware
Open Virtual Memory System (OpenVMS)openvms
OS other than what is listed hereother
This keyword is optional for both iSCSI and Fibre Channel initiators.
add initiator 17
Example
c:\> rcli add initiator -wwpn=2101-00E0-8B3A-E348
-wwnn=2001-00E0-8B3A-E348 -ostype=win2k8 /ip=10.0.0.12 FC Initiator
successfully added, (WWPN: 2101-00E0-8B3A-E348)
add lunmask
The add lunmask command adds a LUN mask to the list known to the router. A LUN mask enables
a specified initiator to use a specified LUN.
NOTE: To use this command with the -lun_serial, -lun_wwuln, -lun_eui, -lun_naa,
or -lun_any_wwuln keyword requires router firmware version 3.2.3.0 or later.
Syntax
add lunmask
NOTE: You must specify either the -fc_initiator or -is_initiator keyword, but not
both.
You can specify either the -fc_target or -is_target keyword, but not both.
Specifies the world wide node name of a Fibre Channel initiator.-wwnn=
Specifies the world wide port name of a Fibre Channel initiator.-wwpn=
Keywords
-array_with_lun_any_wwuln=
1
1
1
-fc_initiator=
-fc_target=
Specifies the WWPN of the LUN mask that you want to add.-array_wwpn=
Specifies the Fibre Channel target WWPN of the LUN mask that you want to add.-array_with_fc_target=
Specifies the iSCSI target name of the LUN mask that you want to add.-array_with_is_target=
Specifies the WWULN, T10, NAA, EUI, or Page 0x80 serial number of the LUN
mask that you want to add.
Specifies the EUI of the LUN mask that you want to add.-array_with_lun_eui=
Specifies the NAA of the LUN mask that you want to add.-array_with_lun_naa=
1
Specifies the Page 0x80 serial number of the LUN mask that you want to add.-array_with_lun_serial=
Specifies the T10 designator of the LUN mask that you want to add.-array_with_lun_tten=
1
Specifies the WWULN of the LUN mask that you want to add.-array_with_lun_wwuln=
Specifies the symbolic name of the LUN mask that you want to add.-array_with_name=
Specifies the name of the Fibre Channel initiator for which you want to add a LUN
mask.
Required, unless the -host_id or -is_initiator keyword is used instead.
Specifies the name of the Fibre Channel target for which you want to add a LUN
mask.
Required, unless the —fc_initiator or —is_initiator keyword is used instead.-host_id=
Specifies the symbolic name for a host for which you want to add LUN mask.
-lun_any_wwuln=
18 Command reference
Specifies the name of the iSCSI initiator for which you want to add a LUN mask.-is_initiator=
Required, unless the -host_id or -fc_initiator keyword is used instead.
Specifies the name of the iSCSI target for which you want to add a LUN mask.-is_target=
2
Accepts the LUN name in a variety of formats that are interpreted first as WWULN,
and then as the T10, NAA, EUI, and Page 0x80 serial number designator until at
least one LUN is found.
2, 3
2, 3
Specifies the LUN EUI.-lun_eui=
Specifies the LUN NAA designator.-lun_naa=
Specifies the LUN for which you want to add a LUN mask.-lun_number=
2, 3
3
2, 3
Specifies the LUN Page 0x80 serial number.-lun_serial=
The serial number can contain special characters. To ensure that these characters
are interpreted correctly when running in a Linux shell, enclose the input text for Page
0x80 serial numbers in single quotation marks (not double quotation marks).
Specifies the LUN T10 designator.-lun_tten=
Specifies the LUN WWULN.-lun_wwuln=
-remap_lun_number=
-use_iscsi_global_target
1
Do not combine the keywords -array_with_lun_serial, -array_with_lun_wwuln, -array_with_lun_tten,
-array_with_lun_eui, and -array_with_lun_naa. To specify any LUN, use the -array_with_lun_any_wwuln
keyword.
2
This keyword is supported with router firmware version 3.2.3.0 or later.
3
Do not combine the keywords -lun_serial, -lun_wwuln, -lun_tten, -lun_eui, and -lun_naa. To specify any
LUN, use the -lun_any_wwuln keyword instead.
Specifies a LUN for use by host initiators that can be different from the LUN used on
the target storage.
If remapping a LUN for use by a host initiator, this keyword indicates use of the
global iSCSI target (IGMAP).
Specifies the VP group index number for the LUN.-vpgindex=
Examples
c:\> rcli add lunmask -is_initiator=iqn.1991-05.com.microsoft:abcdef12
-lun_number=1 -vpgindex=1 -fc_target=5001-4380-025D-A83A /ip=10.0.0.12
Successfully added LUN Mask
-is_initiator=iqn.1991-05.com.microsoft:abcdef12
-fc_target=5001-4380-025D-A83A -lun_number=1 -vpgindex=1
c:\> rcli add lunmask
-lun_any_wwuln=6006-0160-F931-2200-01B7-E72D-6E1A-E011
-fc_initiator=5006-0161-4BA0-35DE -ip=172.35.15.121
Successfully added LUN Mask -fc_initiator=5006-0161-4BA0-35DE
-fc_target=5006-0160-4BA0-35DE -lun_number=2 -vpgindex=4
add notification
The add notification command
Syntax
add notification -name=notification profile name
You must specify at least one notification method for this profile using the -email= and -http=yes
keywords together or separately.
Keywords
-email=
Comma-delimited list containing at least one email address to be notified when the
event occurs.
add notification 19
Leave blank to disable email notifications.
-event=
-type=
Specifies the event type that triggers sending email to the list of recipients. If this
keyword is not specified, the default is either all or dm_all, depending on the
profile type. Event types include:
• Use event type all, warning, and error with profile -type=default and
-type=fcip.
• Use event types dm_all, dm_warning, and dm_error with profile -type=dm.
Specifies that the notification is to be posted to an HTTP server. Values are:-http=
• yes
• no
• on
• off
• true
• false
Specifies the text in the subject line of the generated email message.-subject=
If this keyword is not used, a default subject line containing the router IP address is
generated.
Specifies the profile type. (If this keyword is not used, the profile type is set as
default.) Profile types include:
• default specifies the default notification profile for SNMP events associated
with normal router operation
• dm specifies the data migration notification profile
• fcip specifies the FCIP notification profile
Example
c:\>rcli add notification -name="my profile" -event=all
-email=admin@abc.com,support@abc.com /ip=10.0.0.12
Notification "my profile" successfully added
clear display
The clear display command clears the console display on a Windows or Linux system.
Syntax
clear display
Example
c:\> rcli clear display
clear log
The clear log command resets the router log and deletes all previously recorded log information.
Syntax
clear log
Example
c:\> rcli clear log
Log on the router successfully cleared
20 Command reference
connect system
The connect system command verifies that the RPC connection to a router works for a specified
IP address.
Syntax
connect system -ip=IPv4 or IPv6 IP address
Example
c:\> rcli connect system -ip=10.0.0.12
create host
The create host command adds a host to the list known to the router.
Syntax
create host
Keywords
Specifies the symbolic name for the new host.-host_id
Optional. Indicates one of the following OSs:-ostype
Examples
Windows Server 2003 (default)win2k3
Windows Server 2008win2k8
Windows Server 2012win2k12
Linux 2.4.0linux24
Linux 2.6.0linux26
hpux
aix
netware
solaris
mac
vmware
For an explanation of the general keywords that apply to all commands, see “General
keywords” (page 12)
HP-UX (HP™UNIX™) (valid only for iSR6152)
IBM™ Advanced Interactive Executive (AIX™)
Novell™ NetWare
Sun™ Solaris™SPARC™
Apple™Macintosh™
VMware™
Open Virtual Memory System (OpenVMS)openvms
Other OS not listed hereother
c:\>rcli create host -host_id=myHost -ostype=win2k8
-ip=10.0.0.12[10.0.0.12]
Host myHost, OS Type "Microsoft Windows Server 2008" successfully added
destroy host
The destroy host command removes initiators and LUN masks for a specified host, and then
removes the host from the list known to the router.
connect system 21
Syntax
destroy host
Keywords
For an explanation of the general keywords that apply to all commands, see “General keywords”
(page 12)
Examples
c:\>rcli destroy host -host_id=myHost /ip=10.0.0.12[10.0.0.12]
Host successfully removed
disable beacon
The disable beacon command disables flashing the router LEDs.
Syntax
disable beacon
Example
Specifies the symbolic name for the new host.-host_id
c:\> rcli disable beacon /ip=10.0.0.12 [10.0.0.12]
Beacon successfully turned OFF
disable fc_port
The disable fc_port command disables the specified Fibre Channel port.
Syntax
disable fc_port -port=port number
Example
c:\> rcli disable fc_port -port=1 /ip=10.0.0.12
FC Port 1 successfully disabled
disable io_statistics
The disable io_statistics command stops collection of data for read/write block counts
and I/O counts for a single LUN or for all LUNs.
NOTE: This command is supported with router firmware version 3.1.0.0 or later.
Syntax
disable io_statistics
Keywords
-array_wwpn=
-array_with_fc_target=
22 Command reference
Specifies the WWPN of the storage array for which you want to stop collecting
data.
Specifies the Fibre Channel target WWPN of the storage array for which you want
to stop collecting data.
-array_with_is_target=
-array_with_lun_any_wwuln=
-array_with_lun_eui=
-array_with_lun_naa=
1
1
-array_with_lun_serial=
-array_with_lun_tten=
-array_with_lun_wwuln=
1
1
-array_with_name=
-lun_any_wwuln=
2, 3
2, 3
2
Specifies the iSCSI target name of the storage array for which you want to stop
collecting data.
Specifies the WWULN, T10, NAA, EUI, or Page 0x80 serial number of the storage
array LUN for which you want to stop collecting data.
Specifies the EUI of the storage array LUN for which you want to stop collecting
data.
Specifies the NAA of the storage array LUN for which you want to stop collecting
data.
1
Specifies the Page 0x80 serial number of the storage array LUN for which you want
to stop collecting data.
Specifies the T10 designator of the storage array LUN for which you want to stop
collecting data.
Specifies the WWULN of the storage array LUN for which you want to stop collecting
data.
Specifies the symbolic name of the storage array for which you want to stop collecting
data.
Specifies the name of the Fibre Channel target.-fc_target=
Specifies the name of the iSCSI target.-is_target=
Accepts the LUN name in a variety of formats that are interpreted first as WWULN,
and then as the T10, NAA, EUI, and Page 0x80 serial number designator until at
least one LUN is found.
Specifies the LUN EUI.-lun_eui=
Specifies the LUN NAA designator.-lun_naa=
Specifies the LUN for which you want to disable the collection of statistics.-lun_number=
2, 3
Specifies the LUN Page 0x80 serial number.-lun_serial=
The serial number may contain special characters, for example, "xxx$-xxx".
Because these characters could be interpreted incorrectly, when running in a Linux
shell always enclose the input text for Page 0x80 serial numbers within single
quotation marks ('') instead of double quotation marks ("").
3
2, 3
Specifies the LUN T10 designator.-lun_tten=
Specifies the LUN WWULN.-lun_wwuln=
Specifies the VP group index number.-vpgindex=
1
Do not combine the keywords -array_with_lun_serial, -array_with_lun_wwuln, -array_with_lun_tten,
-array_with_lun_eui, and -array_with_lun_naa. To specify any LUN, use the -array_with_lun_any_wwuln
keyword.
2
This keyword is supported with firmware version 3.2.3.0 or later.
3
Do not combine the keywords -lun_serial, -lun_wwuln, -lun_tten, -lun_eui, and -lun_naa. To disable I/O
statistics on all LUNs, use the -lun_any_wwuln keyword.
NOTE:
• You can specify either the -fc_target or the -is_target keyword, but not both.
• This command requires router firmware version 3.1.0.0 or later.
• To use this command with the -lun_serial, -lun_wwuln, -lun_eui, -lun_naa, or
-lun_any_wwuln keyword requires router firmware version 3.2.3.0 or later.
Example
c:\> rcli disable io_statistics -all /ip=10.0.0.12
I/O statistic collection successfully disabled for all LUNs
disable io_statistics 23
disable iscsi_port
The disable iscsi_port command disables the specified iSCSI port.
Syntax
disable iscsi_port
Keyword
Example
c:\>rcli disable iscsi_port -port=1 /ip=10.0.0.12
iSCSI Port 1 successfully disabled
discover iscsi_target
The discover iscsi_target command discovers iSCSI targets at a specified IP address.
NOTE: This command is supported with router firmware Version 3.2.3.0 or later.
Syntax
discover iscsi_target
Specifies the port number of the iSCSI port to disable.-port
Keywords
-tcp_port=
Example
Specifies that CHAP is enabled for this initiator. Values are:-chap_enable=
• yes
• no
• on
• off
• true
• false
If this keyword is not used, CHAP is disabled.
Specifies a CHAP password.-chap_secret=
This keyword is ignored if CHAP is not enabled.
Specifies the iSCSI target IPv4 or IPv6 address.-iscsi_ipaddr
Specifies the outbound iSCSI port number.-port
Specifies the TCP port to use on the iSCSI target. The value must be in the range of
1024 to 65534.
If this keyword is not used, the default port is 3260.
c:\> rcli discover iscsi_target -port=1 -iscsi_ipaddr=10.0.0.5
/ip=10.0.0.12
iSCSI Target discovery successful
enable beacon
The enable beacon command enables flashing the router LEDs.
24 Command reference
Syntax
enable beacon
Example
c:\> rcli enable beacon /ip=10.0.0.12
[10.0.0.12]
Beacon successfully turned ON
enable fc_port
The enable fc_port command enables the specified Fibre Channel port.
Syntax
enable fc_port -port=port number
Example
c:\> rcli enable fc_port -port=1 /ip=10.0.0.12
FC Port 0 successfully enabled
enable iscsi_port
The enable iscsi_port command enables the specified iSCSI port.
Syntax
enable iscsi_port -port=port number
Keyword
Example
c:\> rcli enable iscsi_port -port=1 /ip=10.0.0.12
iSCSI Port 0 successfully enabled
execute script
The execute script command executes a list of Remote CLI commands read in from a script
file.
Syntax
execute script —file=script file name
NOTE: If the file name does not specify a directory, the current working directory is the default.
Specifies the port number of the iSCSI port to enable.-port
Keyword
-continue_on_error
Prevents the script execution from stopping (the typical behavior) when it encounters
an error.
Example
c:\> rcli execute script -file=config_script.txt
enable fc_port 25
Script "config_script.txt" completed OK
find system
The find system command broadcasts to discover either a specified router or all routers.
Syntax
find system
Keyword
-product=
Example
c:\> rcli find system
The following iSR Routers were discovered, (Count = 5)
iSR6200, 10.0.0.87, Blade1, (Peer Blade2 at 10.0.0.93)
iSR6200, 10.0.0.93, Blade2, (Peer Blade1 at 10.0.0.87)
iSR6200, 10.0.0.78, Blade1
iSR6200, 10.0.0.85, Blade2
iSR6152, 10.0.0.84
generate script
The generate script command generates an editable text file containing a script of Remote
CLI commands. Two types of scripts can be generated:
• A mask script contains RCLI commands for adding all LUN masks for all known initiators and
LUNs.
Specifies the router type to broadcast for in the local network. Similar products may
also be found.
For example, specifying either -product=iSR6200 or -product=iSR6250
discovers all MPX200 products. When this keyword is used, it can take approximately
25 seconds to complete.
If this keyword is not used, multiple broadcasts are performed in order to locate all
product types, and can take as long as 90 seconds to complete.
• A present script contains RCLI commands for presenting virtual targets for all known physical
targets.
NOTE: This command requires router firmware Version 3.2.0.0 or later.
Syntax
generate script -type=mask | present
Keywords
-array_wwpn=
-array_with_is_target=
-array_with_lun_any_wwuln=
-array_with_lun_eui=
26 Command reference
Specifies the WWPN of the storage array to which to apply the commands in this
script. If this keyword is not used, the script is displayed on the console.
Specifies the iSCSI target name of the storage array to which to apply the commands
in this script.
Specifies the WWULN, T10, NAA, EUI, or Page 0x80 serial number of the storage
array LUN to which to apply the commands in this script.
1
Specifies the EUI of the storage array LUN to which to apply the commands in this
script.
1
-array_with_lun_naa=
-array_with_lun_serial=
-array_with_lun_tten=
-array_with_lun_wwuln=
-array_with_name=
2
2
1
Do not combine the keywords -array_with_lun_serial, -array_with_lun_wwuln, -array_with_lun_tten,
-array_with_lun_eui, and -array_with_lun_naa. To specify any LUN, use the -array_with_lun_any_wwuln
keyword.
2
You can specify either the -fc_initiator or the -is_initiator keyword, but not both.
Specifies the NAA of the storage array LUN to which to apply the commands in this
script.
1
Specifies the Page 0x80 serial number of the storage array LUN to which to apply
the commands in this script.
1
Specifies the T10 designator of the storage array LUN to which to apply the
commands in this script.
1
Specifies the WWULN of the storage array LUN to which to apply the commands
in this script.
Specifies the symbolic name of the storage array to which to apply the commands
in this script.
Limits the script to LUN masks from one specific Fibre Channel initiator.-fc_initiator=
Specifies a text file to contain a script of Remote CLI commands.-file=
If no directory is specified, the current working directory is used by default.
If this keyword is not used, the script is displayed on the console.
Limits the script to LUN masks from one specific iSCSI initiator.-is_initiator=
This keyword applies to -type=mask only.
help
Example
c:\> rcli generate script -type=mask -file=config_script.txt
/ip=10.0.0.12
Script file generated successfully.
The help command displays summary help list with a brief description of available commands.
To view detailed syntax for a specific command, enter the action and item with the -help keyword.
See “-help” (page 12).
See also “?” (page 15).
Syntax
help
Keywords
-constraint
Displays usage constraints for RCLI commands that do not work on all MPX200
router hardware and firmware versions.
Examples
To display summary help for all commands, enter:
c:\> rcli help
To display detailed help for the show system command, enter:
c:\> rcli show system -help
list array
The list array command lists the names of all storage arrays known to the router.
help 27
list host
To view detailed information for a single storage array, use the show array command. See
“show array” (page 63).
Syntax
list array
Examples
c:\> rcli list array /ip=10.0.0.12
[10.0.0.12]
Array count = 1
-array_wwpn=0000-0100-0100-0000
The list host command lists the names of all hosts known to the router. To view detailed
information for a specific host, use the show host command instead.
Syntax
list host
Keywords
This command has no specific keywords. For an explanation of the general keywords that apply
to all commands, see “General keywords” (page 12)
Examples
c:\>rcli list host /ip=10.0.0.12
[10.0.0.12]
Host count = 3
-host_id=myHost_1 —ostype=win2k8
-host_id=myHost_2 —ostype=win2k8
-host_id=myHost_3 —ostype=win2k8
list initiator
The list initiator command lists the names of all initiators known to the router.
NOTE: To view detailed information for a specific initiator, use the show initiator command.
Syntax
list initiator
Example
c:\> rcli list initiator /ip=10.0.0.12
[10.0.0.12]
Initiator count = 3
-fc_initiator=2101-00E0-8B3A-E348
(Logged Out)
-is_initiator=iqn.1986-03.com.hp:fcgw.mpx200.dm.initiator
-iscsi_name=iqn.1986-03.com.hp:fcgw.mpx200.dm.initiator -ostype=win2k3
(Data Migration)
-is_initiator=iqn.1991-05.com.microsoft:abcdef12
-iscsi_name=iqn.1991-05.com.microsoft:abcdef12 -ostype=win2k3
(Logged Out)
28 Command reference
list log
The list log command displays all log data from a file or a running system, filtered according
to severity and search text.
NOTE: To view a limited set of log data, use the view log command.
Syntax
list log
If neither -find nor -severity keywords are specified, all log entries are displayed.
Keywords
If used with -csv_file, specifies use of a delimiter other than comma (,).-csv_delimiter=
Specifies the name of a file to receive comma separated text.-csv_file=
-file=
Indicates a file containing log data. If no directory is specified, the default is the
working directory.
If -file is not specified, log data from the router is obtained and displayed.
Specifies a text string to search for within the log data list.-find=
Specifies a severity by which to filter log data. Values are:-severity=
• error
• info
• trace
• warning
list lun
Example
c:\> rcli list log -file=logdata.dat -severity=info /ip=10.0.0.12
[10.0.0.12]
INFO 04/07/2010 01:04:40 UserApp #1027: qapisetisns_1_svc:iSNS
configuration changed
The list lun command lists the names of all LUNs known to the router. The output can be copied
and pasted into other commands that use LUNs as input.
NOTE: To view details for a specific LUN, use the show lun command.
Syntax
list lun
Example
c:\> rcli list lun
Target "5001-4380-025D-A83A"
VP Group 1
-lun_number=0 -vpgindex=1 -fc_target=5001-4380-025D-A83A
-lun_number=1 -vpgindex=1 -fc_target=5001-4380-025D-A83A
-lun_number=2 -vpgindex=1 -fc_target=5001-4380-025D-A83A
-lun_number=3 -vpgindex=1 -fc_target=5001-4380-025D-A83A
-lun_number=4 -vpgindex=1 -fc_target=5001-4380-025D-A83A
VP Group 2
-lun_number=0 -vpgindex=2 -fc_target=5001-4380-025D-A83A
VP Group 3
-lun_number=0 -vpgindex=3 -fc_target=5001-4380-025D-A83A
list log 29
VP Group 4
-lun_number=0 -vpgindex=4 -fc_target=5001-4380-025D-A83A
Target "5001-4380-025D-A83E"
VP Group 1
...
list presented
The list presented command lists the names of all presented targets known to the router.
TIP: To view details for a specific presented target, use the show presented command.
Syntax
list presented
Example
c:\> rcli list presented /ip=10.0.0.12
[10.0.0.12]
Presented Target count = 6
-fc_target=2104-00C0-DD13-8FBE -fc_port=1
( physical target -fc_target=5000-1FE1-5007-0CE8 )
-fc_target=2105-00C0-DD13-8FBE -fc_port=1
( physical target -fc_target=5000-1FE1-5007-0CED )
-fc_target=2104-00C0-DD13-8FBF -fc_port=2
( physical target -fc_target=5000-1FE1-5007-0CE9 )
-fc_target=2105-00C0-DD13-8FBF -fc_port=2
( physical target -fc_target=5000-1FE1-5007-0CEC )
-is_target=iqn.2004-08.com.hp:fcgw.mpx200.0851e00030.b1.01.50001fe
150070ce8 -ge_port=1
( physical target -fc_target=5000-1FE1-5007-0CE8 )
-is_target=iqn.2004-08.com.hp:fcgw.mpx200.0851e00030.b1.01.50001fe
150070ced -ge_port=1
( physical target -fc_target=5000-1FE1-5007-0CED )
list target
The list target command lists the names of all targets known to the router.
Syntax
list target
Example
c:\> rcli list target
Target count = 4
-fc_target=5001-4380-025D-A83A
-fc_target=5001-4380-025D-A83E
-fc_target=5001-4380-025D-A83F
-fc_target=5001-4380-025D-A83B
list vlan
The list vlan command displays VLAN information for all VLAN ports.
TIP: To view VLAN information for a single port, use the show vlan command.
30 Command reference
Loading...