RCLI User Guide

Remote Command Line Interface (CLI) for
Intelligent Storage Routers

User’s Guide
SN0054665-00 B
Remote Command Line Interface (CLI) for Intelligent Storage Routers
User’s Guide
Information furnished in this manual is believed to be accurate and reliable. However, QLogic Corporation assumes no
responsibility for its use, nor for any infringements of patents or other rights of third parties which may result from its
use. QLogic Corporation reserves the right to change product specifications at any time without notice. Applications
described in this document for any of these products are for illustrative purposes only. QLogic Corporation makes no
representation nor warranty that such applications are suitable for the specified use without further testing or
modification. QLogic Corporation assumes no responsibility for any errors that may appear in this document.
Document Revision History

Revision A, July 26, 2010
Revision B, April 12, 2011
Changes Sections Affected
Updated with latest QLogic template formats, All

including new front and back cover graphics.
Updated the QLogic technical support information. “Technical Support” on page xiii
Added information on minimum firmware version “Firmware Requirements” on page 1-1

requirements.
Added the following new RCLI commands: Chapter 3 Command Reference and Table 3-1
“Remove Array” on page 3-12
“Show Notification” on page 3-95
“Set Notification” on page 3-96
“Add Notification” on page 3-99
“Modify Notification” on page 3-101
“Remove Notification” on page 3-103
“Test Notification” on page 3-104
“RetVal” on page 3-127
ii SN0054665-00 B
User’s Guide
Updated the description, syntax, keywords, notes, Chapter 3 Command Reference

or examples for the following RCLI commands:
“Show Append” on page 3-6
“List Array” on page 3-8
“Show Array” on page 3-9
“Set Array” on page 3-10
“Show Chassis” on page 3-15
“Set Chassis” on page 3-16
“Show FCIP_Route” on page 3-19
“Add FCIP_Route” on page 3-20
“Modify FCIP_Route” on page 3-22
“Remove FCIP Route” on page 3-25
“Disable FC_Port” on page 3-31
“Set FC” on page 3-33
“Help” on page 3-41
“Show IO_Statistics” on page 3-43
“Disable IO_Statistics” on page 3-46
“Add Initiator” on page 3-51
“Modify Initiator” on page 3-53
“Set iSCSI” on page 3-59
“Set iSCSI_Adv” on page 3-62
“Discover iSCSI_Target” on page 3-66
“Login iSCSI_Target” on page 3-67
“Logout iSCSI_Target” on page 3-68
“View Log” on page 3-74
“Save Capture_File” on page 3-78
“Show LUN” on page 3-80
“Show LUNmask” on page 3-83
“Add LUNmask” on page 3-86
“Remove LUNmask” on page 3-89
“Save Script” on page 3-112
“Remove Target” on page 3-132
“List VP_Group” on page 3-147
“Show VP_Group” on page 3-148
“Set VP_Group” on page 3-149
Added license and firmware requirements for using Chapter 4 Data Migration Service Commands
data migration commands.
Added the following new data migration com- Chapter 4 Data Migration Service Commands and
mands: Table 4-1
“Show DML” on page 4-3
“Add DML” on page 4-6
“Remove DML” on page 4-8
“Save DM_Report” on page 4-34
Removed the obsolete Synchronize Migration data Chapter 4 Data Migration Service Commands and
migration command. Table 4-1
SN0054665-00 B iii
User’s Guide
Updated the description, syntax, keywords, notes, Chapter 4 Data Migration Service Commands
or examples of the following data migration service
commands:
“Add Migration” on page 4-17
“Start Migration” on page 4-23
“Acknowledge Migration” on page 4-27
Added an appendix of error codes returned by the Appendix A API Error Codes
RetVal command.
iv SN0054665-00 B
Table of Contents
Preface
Intended Audience . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xi
What’s in This Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xi
Related Materials . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xii
Documentation Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xii
License Agreements. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xiii
Technical Support. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xiii
Training . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xiii
Contact Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xiv
Knowledge Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xiv
1 Getting Started
Installing Remote CLI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-1
Firmware Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-1
Obtaining Help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-1
Command Line Scripting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-2
Generating Script Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-2
Executing Script Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-3
Saving Script Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-3
Example Script Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-3
CLI Usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-4
Command Line Syntax . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-4
Abbreviating Keywords . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-5
Input Persistence. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-5
Controlling Access . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-6
Physical Security . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-6
Password-Based Access Control . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-6
2 General Keywords
-blade. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-1
-dmpw . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-1
-help. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-1
-ip. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-2
-pw. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-2
SN0054665-00 B v
User’s Guide
General Keywords (continued)

-quiet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-2
-result. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-2
-textfile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2-3
3 Command Reference
Show Append . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-6
Set Append . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-7
List Array . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-8
Show Array . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-9
Set Array . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-10
Remove Array . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-12
Disable Beacon . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-13
Enable Beacon . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-14
Show Chassis . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-15
Set Chassis . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-16
Merge CSV . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-17
Clear Display . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-18
Show FCIP_Route. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-19
Add FCIP_Route . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-20
Modify FCIP_Route . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-22
Remove FCIP Route . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-25
Show FCIP_Statistics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-26
Show Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-28
Set Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-29
Enable FC_Port . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-30
Disable FC_Port . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-31
Show FC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-32
Set FC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-33
Show FC_Adv . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-34
Set FC_Adv . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-35
Show FC_Statistics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-37
Update Firmware . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-38
Save FRU_Config . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-39
Restore FRU_Config . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-40
Help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-41
?. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-42
Show IO_Statistics. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-43
Disable IO_Statistics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-46
List Initiator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-48
vi SN0054665-00 B
User’s Guide
Command Reference (continued)

Show Initiator. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-49
Add Initiator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-51
Modify Initiator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-53
Remove Initiator . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-55
Enable iSCSI_Port. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-56
Disable iSCSI_Port . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-57
Show iSCSI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-58
Set iSCSI . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-59
Show iSCSI_Adv . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-61
Set iSCSI_Adv. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-62
Show iSCSI_Statistics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-64
Discover iSCSI_Target . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-66
Login iSCSI_Target . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-67
Logout iSCSI_Target . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-68
Show iSNS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-69
Set iSNS . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-70
Clear Log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-71
Save Log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-72
List Log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-73
View Log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-74
Report Log. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-77
Save Capture_File. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-78
List LUN. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-79
Show LUN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-80
Show LUNmask. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-83
Add LUNmask . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-86
Remove LUNmask . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-89
Show Mgmt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-92
Set Mgmt . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-93
Show Notification. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-95
Set Notification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-96
Add Notification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-99
Modify Notification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-101
Remove Notification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-103
Test Notification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-104
Show NTP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-105
Set NTP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-106
Set Password . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-107
SN0054665-00 B vii
User’s Guide
Command Reference (continued)

Show Performance . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-108
Execute Script . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-109
Generate Script . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-110
Save Script . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-112
Show SNMP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-113
Set SNMP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-114
Show Status. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-116
Show System. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-117
Set System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-118
Ping System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-120
TraceRt System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-121
Reboot System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-122
Register System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-123
Unregister System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-124
Rescan System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-125
Reset_Factory System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-126
RetVal . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-127
Connect System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-128
Find System. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-129
Version System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-130
List Target . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-131
Remove Target . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-132
Show Target. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-133
List Presented . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-134
Show Presented . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-135
Map Target. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-137
Unmap Target . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-139
Show Time. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-141
Set Time . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-142
Wait Time. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-143
List VLAN. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-144
Show VLAN . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-145
Set VLAN. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-146
List VP_Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-147
Show VP_Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-148
Set VP_Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-149
viii SN0054665-00 B
User’s Guide
4 Data Migration Service Commands

Show DML . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-3
Add DML . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-6
Remove DML. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-8
List DM_Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-10
Show DM_Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-11
Add DM_Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-12
Remove DM_Group. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-13
List Migration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-14
Show Migration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-15
Add Migration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-17
Remove Migration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-22
Start Migration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-23
Stop Migration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-24
Pause Migration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-25
Resume Migration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-26
Acknowledge Migration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-27
Clear DM_Log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-28
Save DM_Log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-29
List DM_Log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-30
View DM_Log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-31
Report DM_Log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-33
Save DM_Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-34
A API Error Codes
Glossary
Index
List of Tables
Table Page
1-1 Remote CLI Script Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1-3
3-1 Commands by Category . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3-1
4-1 Data Migration Commands by Category . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4-2
A-1 API Error Codes Returned by RetVal. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . A-1
SN0054665-00 B ix
User’s Guide
x SN0054665-00 B
Preface
This user’s guide describes how to use QLogic’s remote command line interface
(Remote CLI or simply RCLI) to configure and manage the QLogic iSR6xxx family
of Intelligent Storage Routers.
Intended Audience
This guide is intended for individuals who are responsible for installing and
servicing a QLogic iSR6xxx router and the storage area network (SAN) equipment
to which it is attached.
What’s in This Guide

This user’s guide contains the basic information you need to get started with the
remote commands used in the CLI-based iSR management tool.
This preface specifies the intended audience, explains the typographic
conventions used in this guide, lists related documents, and provides technical
support and contact information.
The remainder of this guide is organized into the following chapters:
 Chapter 1 Getting Started provides the general information to help you get
started using the Remote CLI utility, including installation, getting help,
scripting, usage, and access control.
 Chapter 2 General Keywords provides the description and syntax for each of
the general keywords that apply to all commands.
 Chapter 3 Command Reference provides the description, syntax, and
examples of each of the common RCLI commands. The commands are
listed in alphabetic order by category.
 Chapter 4 Data Migration Service Commands provides the description,
syntax, and examples of each of the RCLI commands related to data
migration, an optional licensed feature available on some router models.
 Appendix A API Error Codes lists errors that the API may return when
parsing the retval command input or producing command output.
Following these chapters and appendix are a glossary of terms used and an index
to help you quickly find the information you need.
SN0054665-00 B xi
Preface
Related Materials
Related Materials
For additional information, refer to the Software Specification, iSR6200
Management APIs, Revision B. The specification describes a software API that
can be used by client applications written in C++ to control and manage QLogic
iSR6xxx routers. The Remote CLI utility uses this API to provide the same
functionality as a scriptable utility.
Documentation 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 shown in underlined blue. For
example:
 Table 9-2 lists problems related to the user interface and remote
agent.
 See “Installation Checklist” on page 3-6.
 For more information, visit www.qlogic.com.
 Text in Courier font indicates a file name, directory path, or command line
text, and text that you enter in a command line is shown in bold. For
example:
 To return to the root directory from anywhere in the file structure:
Type cd /root and press ENTER.
 Enter the following command: sh ./install.bin
 Key names and key strokes are indicated with UPPERCASE:

 Press CTRL+P.
 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 QLogic
Software End User License Agreement.
xii SN0054665-00 B
Preface
License Agreements
 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).
License Agreements
Refer to the QLogic Software End User License Agreement for a complete listing
of all license agreements affecting this product.
Technical Support
Customers should contact their authorized maintenance provider for technical
support of their QLogic products. QLogic-direct customers may contact QLogic
Technical Support; others will be redirected to their authorized maintenance
provider. Visit the QLogic support Web site listed in Contact Information for the
latest firmware and software updates.
For details about available service plans, or for information about renewing and
extending your service, visit the Service Program Web page at
http://www.qlogic.com/services.
Training
QLogic offers training for technical professionals for all iSCSI, InfiniBand, and
Fibre Channel products. From the main QLogic Web page at www.qlogic.com,
click the Support tab at the top, and then click Training and Certification on the
left. The QLogic Global Training portal offers online courses, certification exams,
and scheduling of in-person training.
Technical Certification courses include installation, maintenance and
troubleshooting QLogic products. Upon demonstrating knowledge using live
equipment, QLogic awards a certificate identifying the student as a certified
professional. You can reach the training professionals at QLogic by e-mail at
training@qlogic.com.
SN0054665-00 B xiii
Preface
Technical Support
Contact Information
QLogic Technical Support for products under warranty is available during local
standard working hours excluding QLogic Observed Holidays. For customers with
extended service, consult your plan for available hours. For Support phone
numbers, see the Contact Support link at support.qlogic.com.
Support Headquarters QLogic Corporation
4601 Dean Lakes Blvd.
Shakopee, MN 55379 USA
QLogic Web Site www.qlogic.com
Technical Support Web Site http://support.qlogic.com
Technical Support E-mail support@qlogic.com
Technical Training E-mail training@qlogic.com
Knowledge Database
The QLogic knowledge database is an extensive collection of QLogic product
information that you can search for specific solutions. We are constantly adding to
the collection of information in our database to provide answers to your most
urgent questions. Access the database from the QLogic Support Center:
http://support.qlogic.com.
xiv SN0054665-00 B
1 Getting Started
This chapter provides the following general information to help you get started
using the Remote CLI utility:
 Installing Remote CLI
 Firmware Requirements
 Obtaining Help
 Command Line Scripting
 CLI Usage
 Controlling Access
Installing Remote CLI

For installation instructions, see the Readme file for this utility.
Firmware Requirements
Some RCLI router management commands or their keywords require that you
have installed a minimum version of the router firmware. Where 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 greater.
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:\> show system -help
SN0054665-00 B 1-1
1–Getting Started
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.
This section provides the following information for command line scripting:
 Generating Script Files
 Executing Script Files
 Saving Script Files
 Example Script Files
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 logical unit
number (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 details, see “Generate Script” on page 3-110.
1-2 SN0054665-00 B
1–Getting Started
Executing Script Files

The execute script command accepts a text file containing a series of
Remote CLI commands to be run one after the other. For details, see “Execute
Script” on page 3-109.
Saving Script Files

After you finish setting up a new router, or whenever you save a field replaceable
unit (FRU) image, you should 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 details, see “Save
Script” on page 3-112.)
Example 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 as follows:
 For Windows:
C:\Program Files\QLogic Corporation\iSR-rcli\examples
 For Linux:
/usr/share/doc/qlogic_rcli/examples
Table 1-1 provides descriptions of the installed example scripts.
Table 1-1. Remote CLI Script Examples
Script Description
simple A basic example that shows the use of Remote CLI from a Windows
batch file and from a Linux shell script.
track_assets 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 modifica-
tions, this script can collect other information from all routers in the
local network. This script has no input parameters.
check_fcip_port_speed 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 Fibre Channel over IP (FCIP) route information,
stops if the port speed is exactly100Mb, and then continues to the
next router. This script requires some modification for use.
SN0054665-00 B 1-3
1–Getting Started
CLI Usage
Table 1-1. Remote CLI Script Examples (Continued)
Script Description
iostats A Python script that finds the hard-coded IP address of a router and
periodically collects performance data. To provide a continuous dis-
play 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 comma separated value (CSV)
files suitable for import into a spreadsheet program such as Micro-
soft Excel®. It produces one file for each port and for each LUN.
After data has been collected, you can use the merge csv com-
mand (see “Merge CSV” on page 3-17) to combine all CSV files into
a summary CSV file. You can import the summary CSV file into
Excel to produce graphs of usage over time, so that maintenance
operations can be scheduled for times when the network is less
busy.
CLI Usage
The Remote CLI enables you to perform a variety of router management tasks
through an Ethernet connection. This section describes the following:
 Command Line Syntax
 Abbreviating Keywords
 Input Persistence
Command Line Syntax

The following 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 generally
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, show system -ip=10.0.0.1 provides summary
system information—including serial number, firmware version, and so
on—from the iSR router with a management port at 10.0.0.1.
1-4 SN0054665-00 B
1–Getting Started
CLI Usage
 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 keyword, optional keywords are enclosed in
brackets. Required keywords are not enclosed in brackets.
 Keyword order on the command line is not important, unless stated
otherwise in the keyword description. For example, if more than one
OS type is specified when adding an initiator, no error occurs, but only
the last type specified on the command line is used.
 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, so the preceding 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, a few items are persistent between runs of
RCLI. Remote CLI stores these items separately for each user in either the user's
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 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
the maximum transmission unit (MTU) size is not specified, “normal” is the default.
SN0054665-00 B 1-5
1–Getting Started
Controlling Access
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 shows the next
ten entries and saves the new position.
Controlling Access
Access control includes elements of both physical security and passwords.
Physical Security
The best way to prevent unauthorized changes to iSR routers is to 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. QLogic 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, remote users of RCLI should always use an encrypted
connection, such as a virtual private network (VPN).
1-6 SN0054665-00 B
2 General Keywords
This chapter provides the description and syntax for each of the general keywords
that apply to all commands. Because these keywords are defined here, they are
not repeated for every command in the command reference chapters. The general
keywords include the following:
 -blade
 -dmpw
 -help
 -ip
 -pw
 -quiet
 -result
 -textfile
-blade
Include the -blade keyword to specify the primary or secondary router blade
(iSR6200 only).
-blade = [primary | secondary | 1 | 2]
The primary option means to use the router with management port at the
specified IP address. The secondary option means to use the peer router in the
same chassis as the primary router. When specified, the blade selection is saved
for future use as the default.
-dmpw
Include the -dmpw keyword to provide the data migration password, if one has
been set.
-dmpw <password>
-help
Include the -help keyword to display command syntax and available keywords.
This is the same information that appears if you enter incorrect command syntax.
This keyword is optional and blocks all other effects of the command.
-help=<file name for help doc>
SN0054665-00 B 2-1
2–General Keywords
The following example displays the help summary:

c:\> show system -help
The following example saves the help summary to a Microsoft Word document:
c:\> show system -help=help.doc
-ip
Include the -ip keyword to specify the IPv4 or IPv6 management port address
of the iSR6xxx router. This keyword is required for most commands. If not
specified, the default is either the last value specified or 10.0.0.1.
-ip=<IPv4 or IPv6 address>
The following example specifies an IPv4 address:
c:\ > -ip=10.0.0.1
The following example specifies an IPv6 address:

c:\ > -ip=2001::1234
-pw
Include the -pw keyword to provide the remote procedure call (RPC) password,
if one has been set. A password is required only if a non-default RPC password
has been set.
-pw=<password>
-quiet
Include the -quiet keyword to suppress all text output from the command,
including both normal text display and error messages. This keyword is If used in
a script, RCLI returns the completion status.
-result
Include the -result keyword to create a file containing binary output data. 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.
2-2 SN0054665-00 B
All result files comprise the following items in order:

1. One integer indicating the header size, in bytes.
2. Four integers indicating the iSR management API version.
3. Two integers indicating the command action and item.
4. One integer indicating the completion status.
Additional data may 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 Chapter 3 Command Reference).
Additional data is generally one or more classes from the iSR Management API
saved in binary form. For details, see the Software Specification, iSR6200
Management APIs, Revision B.
-result = <file name>
The following example creates a show_system.dat file in the working
directory:
c:\> show system /result
-textfile
Include 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 keyword is optional, and
can be used in combination with the -quiet keyword.
-textfile=<file name>
The following example creates the show_system.log file in the working
directory:
c:\> show system /textfile
SN0054665-00 B 2-3
2-4 SN0054665-00 B
3 Command Reference
This chapter provides the description, syntax, and examples of the RCLI
commands. The commands are listed in alphabetic order by category, as shown
in Table 3-1.
To view all commands related to data migration service (an optional, licensed
feature), see Chapter 4 Data Migration Service Commands.
NOTE:
All examples in this chapter use a Microsoft Windows command prompt, but
the output also applies to Linux systems.
Table 3-1. Commands by Category
Category Commands
Append “Show Append” on page 3-6

“Set Append” on page 3-7
Arrays “List Array” on page 3-8

“Show Array” on page 3-9
“Set Array” on page 3-10
“Remove Array” on page 3-12
Beacon “Disable Beacon” on page 3-13

“Enable Beacon” on page 3-14
Chassis “Show Chassis” on page 3-15

“Set Chassis” on page 3-16
CSV “Merge CSV” on page 3-17
Display “Clear Display” on page 3-18
SN0054665-00 B 3-1
3–Command Reference
Table 3-1. Commands by Category (Continued)
Category Commands
FCIP Routes “Show FCIP_Route” on page 3-19

“Add FCIP_Route” on page 3-20
“Modify FCIP_Route” on page 3-22
“Remove FCIP Route” on page 3-25
“Show FCIP_Statistics” on page 3-26
Features “Show Features” on page 3-28

“Set Features” on page 3-29
Fibre Channel Ports “Enable FC_Port” on page 3-30

“Show FC” on page 3-32
“Set FC” on page 3-33
“Show FC_Adv” on page 3-34
“Set FC_Adv” on page 3-35
“Show FC_Statistics” on page 3-37
Firmware “Update Firmware” on page 3-38
FRU “Save FRU_Config” on page 3-39

“Restore FRU_Config” on page 3-40
Help “Help” on page 3-41

“?” on page 3-42
I/O Statistics “Show IO_Statistics” on page 3-43

Initiators “List Initiator” on page 3-48

“Show Initiator” on page 3-49
“Add Initiator” on page 3-51
“Modify Initiator” on page 3-53
“Remove Initiator” on page 3-55
3-2 SN0054665-00 B
Category Commands
iSCSI Ports “Enable iSCSI_Port” on page 3-56

“Disable iSCSI_Port” on page 3-57
“Show iSCSI” on page 3-58
“Set iSCSI” on page 3-59
“Show iSCSI_Adv” on page 3-61
“Set iSCSI_Adv” on page 3-62
“Show iSCSI_Statistics” on page 3-64
iSCSI Targets “Discover iSCSI_Target” on page 3-66

ISNS “Show iSNS” on page 3-69

“Set iSNS” on page 3-70
Logs “Clear Log” on page 3-71

“Save Log” on page 3-72
“List Log” on page 3-73
“View Log” on page 3-74
“Report Log” on page 3-77
“Save Capture_File” on page 3-78
LUNs and LUN Masks “List LUN” on page 3-79

“Show LUN” on page 3-80
“Show LUNmask” on page 3-83
“Add LUNmask” on page 3-86
“Remove LUNmask” on page 3-89
Management “Show Mgmt” on page 3-92

“Set Mgmt” on page 3-93
Notifications “Show Notification” on page 3-95

“Set Notification” on page 3-96
“Add Notification” on page 3-99
“Modify Notification” on page 3-101
“Remove Notification” on page 3-103
“Test Notification” on page 3-104
SN0054665-00 B 3-3
Category Commands
NTP Information “Show NTP” on page 3-105

“Set NTP” on page 3-106
Password “Set Password” on page 3-107
Performance “Show Performance” on page 3-108
Scripts “Execute Script” on page 3-109

“Generate Script” on page 3-110
“Save Script” on page 3-112
SNMP “Show SNMP” on page 3-113

“Set SNMP” on page 3-114
Statistics “Show FC_Statistics” on page 3-37

“Show FCIP_Statistics” on page 3-26
“Show IO_Statistics” on page 3-43
“Show iSCSI_Statistics” on page 3-64
Status “Show Status” on page 3-116
System “Show System” on page 3-117

“Set System” on page 3-118
“Ping System” on page 3-120
“Reboot System” on page 3-122
“Register System” on page 3-123
“Unregister System” on page 3-124
“Rescan System” on page 3-125
“Reset_Factory System” on page 3-126
“RetVal” on page 3-127
“Connect System” on page 3-128
“Find System” on page 3-129
3-4 SN0054665-00 B
Category Commands
Targets “List Target” on page 3-131

“Remove Target” on page 3-132
“Show Target” on page 3-133
“List Presented” on page 3-134
“Show Presented” on page 3-135
“Map Target” on page 3-137
“Unmap Target” on page 3-139
“Discover iSCSI_Target” on page 3-66
Time “Show Time” on page 3-141

“Set Time” on page 3-142
“Wait Time” on page 3-143
VLANs “List VLAN” on page 3-144

“Show VLAN” on page 3-145
“Set VLAN” on page 3-146
Virtual Port (VP) Groups “List VP_Group” on page 3-147

“Show VP_Group” on page 3-148
“Set VP_Group” on page 3-149
SN0054665-00 B 3-5
Show Append
Show Append
Displays a named set of keywords that can be included as a group for any RCLI
command by including the /append=<name> keyword. If the
-append=<name> keyword is not included, this command displays all sets.
Syntax show append

[-append=<name>]
Keywords -append
Specifies the name of a keyword set to display. (If not used, displays all sets.)
For an explanation of the general keywords that apply to all commands, see
Chapter 2 General Keywords.
Examples The following example shows the show append command:

c:\>rcli show append
-append="testset" --> "-quiet -text="c:\temp\test_show_system.txt" "
3-6 SN0054665-00 B
Set Append
Set Append
Creates, replaces, or deletes a named set of keywords that can be included as a
group for any RCLI command by using the /append=<name> keyword.
Syntax set append

-append=<name> <... rest of the command line...>. If <... rest of the command
line...> is not blank, this set of keywords is used in place of
/append=<name> for any other RCLI command. If <... rest of the
command line...> is blank, the named set of append keywords is
deleted.
Keywords -append
Specifies the name of a keyword set to create, replace, or delete.
Examples The following examples show the set append command:

c:\>rcli set append -append=modset1 /ip=10.0.0.12 /blade=1
-append=modset1 --> /ip=10.0.0.12 /blade=1
c:\>rcli set append -append=modset1

[10.0.0.12]
MAC Address = 00-C0-DD-12-F9-5B
IPv4 Link Status = LINK_UP

IPv4 Address is manually entered
IPv4 Address = 10.0.0.12
IPv4 Subnet Mask = 255.255.254.0
IPv4 Gateway Address = 10.0.0.1
...
c:\>rcli set append -append=modset1

-append=modset1 contents cleared
SN0054665-00 B 3-7
List Array
List Array
Lists the names of all storage arrays known to the router.
To view detailed information for a single storage array, use the show array
command instead (see “Show Array” on page 3-9.)
Syntax list array
Keywords This command has no specific keywords. For an explanation of the general
keywords that apply to all commands, see Chapter 2 General Keywords.
Notes This command requires router firmware version 3.2.0.0 or greater.
Examples The following example shows the list array command:

c:\>rcli list array /ip=10.0.0.12
[10.0.0.12]
Array count = 1
-array_wwpn=0000-0100-0100-0000
3-8 SN0054665-00 B
Show Array
Show Array
Displays detailed information for one or more storage arrays.
To view just the names of all storage arrays known to the router, use the list
array command instead (see “List Array” on page 3-8).
Syntax show array

-array_wwpn=<WWPN of a storage array>
Keywords -array_wwpn
Specifies the world wide port number (WWPN) of the storage array for which you
want to view detailed information. If not specified, the command displays detailed
information for all storage arrays.
Notes  This command is not supported for iSR6xxx routers.

 This command requires router firmware version 3.2.0.0 or greater.
Examples The following example shows the show array command:

c:\>rcli show array -array_wwpn=0000-0100-0100-0000 /ip=10.0.0.12
[10.0.0.12]
Storage Array "HP HSV340-0"

-array_wwpn=0000-0100-0100-0000
Array WWNN = 0000-0100-0100-0000
Vendor ID: HP
Product ID: HSV340
Online
Load Balancing: Enabled
Licensed
Bandwidth = max for Storage Array
Data Migration Target Type: Source and Destination
-fc_target=5001-4380-025D-A83A
-fc_target=5001-4380-025D-A83F
-fc_target=5001-4380-025D-A83B
SN0054665-00 B 3-9
Set Array
Set Array
Configures the name, bandwidth, and data migration target type for a storage
array.
Syntax set array

[-name=<symbolic name for storage array>]
[-load_balancing= yes | no | on | off | true | false]
[-bandwidth=<number in range 50 to 1600, or =0 to use maximum storage
array bandwidth>]
[-dm_target_type= source | destination | both_src_and_dest | none | unknown ]
[-dmpw=<migration password>]
[-license= array | scrub]
Specifies the WWPN of the storage array for which you want to view and
configure detailed information.
-name
Specifies a symbolic name to apply to this storage array. The default is the current
setting on the router.
-load_balancing
Specifies whether load balancing is enabled or disabled. The default is the current
-bandwidth
Specifies the bandwidth. Enter a number between 50 and 1600, or enter zero to
use the maximum storage array bandwidth. The default is the current setting on
the router.
-dm_target_type
Specifies the data migration target type: source, destination, both source and
destination, neither source nor destination, or unknown type. The default is the
current setting on the router.
-dmpw
Required only if a data migration password is set. Specifies the password for data
migration.
3-10 SN0054665-00 B
Set Array
-license
Specifies that a license is to be consumed for this array. The keyword
-license=array consumes an array license, and -license=scrub applies
a data scrubbing license. Before using this keyword, issue the show features
command to determine the number of licenses issued and used. If the array is
already licensed, no additional licenses are consumed. To apply more than one
license type, issue the set array command again.
Examples The following example shows the set array command:

c:\>rcli set array -array_wwpn=0000-0100-0100-0000 -name="HP
HSV340-0" /ip=10.0.0.12
Storage Array 0000-0100-0100-0000 successfully configured
SN0054665-00 B 3-11
Remove Array
Remove Array
Removes an offline storage array.
Syntax remove array

[-license=[ error | keep | discard ]]
Specifies the WWPN of the storage array that you want to remove.
-license
Specifies what to do with any licenses currently applied to the array that is to be
removed.
 -license=error (the default) specifies that if the array is licensed,
the operation fails with an error message indicating that you must
specify what to do with the license.
 -license=keep specifies that the licenses (maximum 128) are kept
in persistent data and reused if the same array later becomes
available.
 -license=discard specifies that no licenses are stored for future
use.
Examples The following example shows the remove array command:

c:\>rcli remove array -array_wwpn=0000-0100-0100-0000
/ip=10.0.0.12
Storage Array 0000-0100-0100-0000 successfully removed
3-12 SN0054665-00 B
Disable Beacon
Disable Beacon
Disables flashing the router LEDs.
Syntax disable beacon
Examples The following example shows the disable beacon command:

c:\>rcli disable beacon /ip=10.0.0.12
[10.0.0.12]
Beacon successfully turned OFF
SN0054665-00 B 3-13
Enable Beacon
Enable Beacon
Enables flashing the router LEDs.
Syntax enable beacon
Examples The following example shows the enable beacon command:

c:\>rcli enable beacon /ip=10.0.0.12
[10.0.0.12]
Beacon successfully turned ON
3-14 SN0054665-00 B
Show Chassis
Show Chassis
Displays chassis information, including the chassis name, serial number,
hardware version, and status of blades, slots, and fans.
Syntax show chassis
Notes Single-controller systems (iSR61xx) do not support this command.
Examples The following example shows the show chassis command:

c:\>rcli show chassis /ip=10.0.0.12
[10.0.0.12]
Product Name = iSR6200

Chassis Name = Multifunction Router
Serial Number = 0823E00014
Hardware Version Number = 0001
Revision Number =
Blade Slot = 1
Partner Status = PARTNER_BLADE_UP
Blade Count = 2
Slot 0, Fan 0 Status = FAN_NORMAL
Slot 0 Power Status = POWER_ON
Slot 1 Power Status = POWER_ON
SN0054665-00 B 3-15
Set Chassis
Set Chassis
Sets the chassis name and lists the current chassis configuration.
Syntax set chassis

-name=<new chassis name>
Keywords -name
Specifies a text string no longer than 64 characters as the chassis name. To
specify a chassis name containing spaces, type the name within quotation marks.
Notes Single-controller systems (iSR61xx) do not support this command.
Examples The following example shows the set chassis command.

c:\>rcli set chassis -name="My Multifunction Router" /ip=10.0.0.12
[10.0.0.12]

Symbolic Name = My Multifunction Router
Operation Mode = ISCSI_CONNECTIVITY
Use IQN = NO_NAME_OR_SERIAL
SW Version = 3.2.0.0rc5e
HW Version = 00000-01
FC port count = 2
iSCSI port count = 4
Target Presentation Mode = AUTO_TARGET_PRESENTATION
LUN Mapping = Enabled
Controller LUN Automap = Disabled
Target Access Control = Enabled
Telnet = Enabled
3-16 SN0054665-00 B
Merge CSV
Merge CSV
Creates an optional comma separated values (CSV) file using output from the
show io_statistics or show performance commands. The merge csv
command collects input from multiple files and combines them into a summary
CSV file, which you can import into a spreadsheet program such as Microsoft
Excel. Use the spreadsheet program to graph usage over time, so that
maintenance can be planned for less busy times.
The show io_statistics or show performance commands can save
output to multiple files, one per port or per LUN. See “Show IO_Statistics” on
page 3-43 and “Show Performance” on page 3-108.
Syntax merge csv

[-file=<script file name>]
[-csv_folder=<folder containing comma delimited file output>]
Keywords -file
Specifies the name of the output file for the comma separated text. If not
specified, the command displays the output text on the console.
-csv_folder
Specifies the folder containing the comma separated files from which to collect the
LUN and port performance data. If not specified, this command collects data from
CSV files in the working directory.
Examples The following example shows the merge csv command:

c:\>rcli merge csv -csv_folder=c:\temp -file=summary.csv
CSV output file summary.csv created successfully
SN0054665-00 B 3-17
Clear Display
Clear Display
Clears the console display on a Windows or Linux system.
Syntax clear display
Examples The following example shows the clear display command:

c:\>rcli clear display
3-18 SN0054665-00 B
Show FCIP_Route
Show FCIP_Route
Displays basic information for all FCIP routes or a specified FCIP route.
Syntax show fcip_route

[-fc_port=<Fibre Channel port number, (first port is 1)>]
Keywords -fc_port
Limits display output to the FCIP route for the specified Fibre Channel port. If not
specified, the command displays information for all FCIP routes.
Notes The router must be capable and licensed for FCIP. To view router capabilities,
issue the show features command (see “Show Features” on page 3-28).
Examples The following example shows the show fcip_route command:

c:\>rcli show fcip_route /ip=10.0.0.12
[10.0.0.12]
FC port number 1
FCIP interface: Enabled
GE port number 1
GE Remote IP Address 10.0.2.10
GE Local Address: 10.0.0.10
GE Subnet Mask: 0.0.0.0
GE Gateway Address: 10.0.0.1
MTU Size 1500
TCP Window Max Size TCPWINDOWSIZE_16777216
Port Speed GE_PORT_SPEED_AUTO
Bandwidth 20
VLAN Disabled
FCIP S/W Compression Disabled
Link Status LINK_DOWN
GE Link Status LINK_DOWN
SN0054665-00 B 3-19
Add FCIP_Route
Add FCIP_Route
Adds an FCIP route for this Fibre Channel port. Input for this command is the
same as for the modify fcip_route command, except that the keywords are
either required or have specific default values.
Syntax add fcip_route

-fc_port=<Fibre Channel port number, (first port is 1)>
-ge_port=<gigabit Ethernet (GbE) port number, (first port is 1)>
-remote_ip=<IPv4 or IPv6 remote IP address>
[-uselinklocal]
[-local_ip=<IPv4 or IPv6 local IP address>]
[-ipv4_subnet=<IPv4 subnet mask>]
[-gateway_ip=<IPv4 gateway or IPv6 default router IP address>]
[-enable= yes | no | on | off | true | false]
[-mtu_size=[ min | normal | jumbo | max | <number in range 582 to 9000> ]]
[-tcpwindow=[ 8192 | 16384 | 32768 | 65536 | 131072 | 262144 | 524288 |
1048576 | 2097152 | 4194304 | 8388608 | 16777216 ]]
[-tcp_port=<number in range 1024 to 65535>]
[-port_speed=[ auto | 100 | 1000 | 10000 ]]
[-bandwidth=<number in range 1 to 1000, or zero for maximum available>]
[-vlan_enable= yes | no | on | off | true | false]
[-swcompress_enable= yes | no | on | off | true | false]
Keywords -fc_port
Specifies the Fibre Channel port number.
-ge_port
Specifies the GbE port number.
-remote_ip
Specifies the IPv4 or IPv6 address of the remote end of this FCIP route.
-uselinklocal
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.
-local_ip
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.
-ipv4_subnet
Specifies the IPv4 subnet mask to be associated with -local_ip, (ignored if
-local_ip is an IPv6 address).
3-20 SN0054665-00 B
Add FCIP_Route
-gateway_ip
Specifies the IPv4 gateway address or the IPv6 default router address.
-enable
Enables the Ethernet and Fibre Channel ports for the newly-created route. The
default value is yes.
-mtu_size
Specifies the MTU size for the iSCSI port as min (minimum), normal (the
default), jumbo (Jumbo frames), max (maximum), or an integer from
582–9000.
-tcpwindow
Specifies the TCP window size for the iSCSI port. The default value is 8192.
-tcp_port
Specifies the TCP port number. The default value is 3225.
-port_speed
Specifies the port speed as auto (the default), 100, 1000, or 10000 Mbps.
-bandwidth
Specifies the bandwidth in Mbps. The default value is the maximum available
bandwidth.
-vlan_enable
Enables use of a virtual LAN (VLAN) for the newly-created route. The default
value is no.
-swcompress_enable
Enables use of software compression for the newly-created route. The default
value is yes.
Examples The following example shows the add fcip_route command:

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
SN0054665-00 B 3-21
Modify FCIP_Route
Modify FCIP_Route
Modifies an existing FCIP route for this Fibre Channel port.
Most command keywords are optional. This command fails if there is no FCIP
route currently set for this Fibre Channel port.
Syntax modify fcip_route

[-ge_port=<GbE port number, (first port is 1)>]
[-remote_ip=<IPv4 or IPv6 remote IP address>]
[-gateway_ip=<IPv4 gateway or IPv6 default router IP address>]
[-mtu_size=[ min | normal | jumbo | max | <number in range 582 to 9000> ]]
[-tcpwindow=[ 8192 | 16384 | 32768 | 65536 | 131072 | 262144 | 524288 |
1048576 | 2097152 | 4194304 | 8388608 | 16777216 ]]
[-port_speed=[ auto | 100 | 1000 | 10000 ]]
[-uselinklocal]
[-local_ip=<IPv4 or IPv6 local IP address>]
[-bandwidth=<number in range 1 to 1000, or zero to use maximum available>]
[-vlan_enable= yes | no | on | off | true | false]
[-swcompress_enable= yes | no | on | off | true | false]
Keywords -fc_port
Specifies the Fibre Channel port number.
-enable
Enables the Ethernet and Fibre Channel ports for the route. The default value is
yes.
-ge_port
Specifies the Ethernet port number. The default is as currently set on the router.
-remote_ip
Specifies the IPv4 or IPv6 address at the other end of the route. The default is as
currently set on the router.
NOTE:
You can specify either the -local_ip or -uselinklocal keyword, but
not both. The default is as currently set on the router.
3-22 SN0054665-00 B
Modify FCIP_Route
-gateway_ip
Specifies the IPv4 gateway address or the IPv6 default router address. The
default is as currently set on the router.
-enable
Enables the Ethernet and Fibre Channel ports for the newly created route. The
default is as currently set on the router.
-mtu_size
582–9000.
-tcpwindow
Specifies the TCP window size for the iSCSI port. The default is as currently set
on the router.
-tcp_port
Specifies the TCP port number. The default is as currently set on the router.
-port_speed
Specifies the port speed as auto, 100, 1000, or 10000 Mbps. The default is
as currently set on the router.
-uselinklocal
If specified, the IPv6 link local address is used as the local IP address. The default
is as currently set on the router.
-local_ip
Specifies the local the IPv4 or IPv6 address.
-ipv4_subnet
Specifies the IPv4 subnet mask to be associated with -local_ip, (ignored if
-local_ip is an IPv6 address).
-bandwidth
Specifies the bandwidth in Mbps. The default is as currently set on the router.
-vlan_enable
Enables use of VLAN for the newly-created route. The default is as currently set
on the router.
-swcompress_enable
Enables use of software compression for the newly-created route. The default is
as currently set on the router.
SN0054665-00 B 3-23
Modify FCIP_Route
Examples The following example shows the modify fcip_route command:

c:\>rcli modify fcip_route -fc_port=1 -vlan_enable=n /ip=10.0.0.12
FCIP route successfully modified
3-24 SN0054665-00 B
Remove FCIP Route
Remove FCIP Route

Removes one FCIP route.
Syntax remove fcip_route

Keywords -fc_port
Specifies the port number for the FCIP route to be removed.
Examples The following example shows the remove fcip_route command:

c:\>rcli remove fcip_route -fc_port=1 /ip=10.0.0.12
[10.0.0.12]
FCIP route successfully removed
SN0054665-00 B 3-25
Show FCIP_Statistics
Samples FCIP statistics data over a specified interval and displays the result
scaled to per-second units
Syntax show fcip_statistics

[-csv_folder=<folder to receive comma delimited file output>]
Keywords -seconds
Specifies the time, in seconds, for FCIP port statistics data collection. Regardless
of the length of this interval, results are displayed in per-second units. The default
collection interval is two seconds.
-csv_folder
If used, an individual file containing CSV is created for each port. Files are
created, or appended to if they already exist.
Examples The following example shows the show fcip_statistics command:

c:\>rcli show fcip_statistics /ip=10.0.0.12
FCIP Route 1
FC Xmit Frames 164
FC Rcvd Frames 0
IP Xmit Packets 9758
IP Xmit Byte Count 0
IP Xmit Fragments 613
IP Rcvd Packets 25143
IP Rcvd Byte Count 0
IP Rcvd Fragments 613
IP Datagram Reassembly Count 611
IP V6Pkt Rcvd 0
IP Error Packets 0
IP Reassembly Errors 0
TCP Xmit Segment Count 0
TCP Xmit Byte Count 0
TCP Xmit Acks 0
TCP Rcvd Segment Count 0
TCP Rcvd Byte Count 0
TCP Rcvd Acks 0
TCP Rcvd Window Probes 0
3-26 SN0054665-00 B
TCP Timer Expired 0

TCP ECC Error Corections 0
MAC Xmit Frames 0
MAC Xmit Bytes 0
MAC Xmit Multi Count 0
MAC Xmit Broad Count 0
MAC Xmit Pause Count 0
MAC Xmit Control Frames 0
MAC Xmit Deferrals 0
MAC Xmit Late Collisions 0
MAC Xmit Aborted 0
MAC Xmit Multiple Collisions 0
MAC Xmit Single Collisions 0
MAC Xmit Collisions 0
MAC Xmit Dropped Frames 0
MAC Xmit Jumbo Frames 0
MAC Rcvd Frames 0
MAC Rcvd Bytes 0
MAC Rcvd Multi Count 0
MAC Rcvd Broad Count 0
MAC Rcvd Pause Count 0
MAC Rcvd Control Frames 0
MAC Rcvd Dribbles 0
MAC Rcvd Frame Lenght Errors 0
MAC Rcvd Jabbers 0
MAC Rcvd Carrier Sense Errors 0
MAC Rcvd Dropped Frames 0
MAC Rcvd CRC Errors 0
MAC Rcvd Encoding Error 0
MAC Rcvd Length Errors 0
SN0054665-00 B 3-27
Show Features
Show Features
Displays extended features available for the router and specifies whether the
feature is licensed.
Syntax show features
Examples The following example shows the show features command:

c:\>rcli show features /ip=10.0.0.12
[10.0.0.12]
FCIP 1Gig Capable Licensed

FCIP SACK Capable No License Needed
DM Offline Capable No License Needed
DM Online Capable No License Needed
DM Capacity Capable 10240 GB Issued, 0 GB Used, 0 GB In-Use
DM Array Capable 9 Array Issued, 1 Used
3-28 SN0054665-00 B
Set Features
Set Features
Sets the license key to enable extended features on the router.
Syntax set features

-key=<license key>
Keywords -key
Specifies the purchased license key.
Examples The following example shows the set features command:

c:\>rcli set features -key=abcdef /ip=10.0.0.12
[10.0.0.12]
FCIP 1Gig Capable Licensed

FCIP SACK Capable No License Needed
DM Offline Capable No License Needed
DM Online Capable No License Needed
DM Capacity Capable 10240 GB Issued, 0 GB Used, 0 GB In-Use
DM Array Capable 9 Array Issued, 1 Used
SN0054665-00 B 3-29
Enable FC_Port
Enable FC_Port
Enables the specified Fibre Channel port.
Syntax enable fc_port

[-port=<port number, (first port is 1)>]
Keywords -port
Specifies the Fibre Channel port number to enable.
Examples The following example shows the enable fc_port command:

c:\>rcli enable fc_port -port=1 /ip=10.0.0.12
FC Port 0 successfully enabled
3-30 SN0054665-00 B
Disable FC_Port
Disable FC_Port
Disables the specified Fibre Channel port.
Syntax disable fc_port

Keywords -port
Specifies the Fibre Channel port number to disable.
Examples The following example shows the disable fc_port command:

c:\>rcli disable fc_port -port=1 /ip=10.0.0.12
FC Port 1 successfully disabled
SN0054665-00 B 3-31
Show FC
Show FC
Displays basic information for the selected Fibre Channel port.
Syntax show fc
Keywords -port
Specifies the Fibre Channel port number for which you want to view basic
information. If not specified, the command displays basic information for all Fibre
Channel ports.
Examples The following example shows the show fc command:

c:\>rcli show fc -port=1 /ip=10.0.0.12
[10.0.0.12]
Port = FC1
Port Status = PORT_ENABLED
Link Status = LINK_UP
Current Link Rate = 2Gb
Programmed Link Rate = Auto
Connection Mode = Unknown
FibreChannel Mode = FCP
WWNN = 2000-00C0-DD12-F95C
WWPN = 2100-00C0-DD12-F95C
Port ID = 0A-00-00
Firmware Revision = 5.01.03
Driver Revision =
3-32 SN0054665-00 B
Set FC
Set FC
Sets the link rate for a specified Fibre Channel port.
Syntax set fc
[-fc_link_rate=[Auto, 1Gb, 2Gb, 4Gb, 8Gb]]
Keywords -port
Specifies the Fibre Channel port for which you want to set the link rate.
-fc_link_rate
Specifies a new link rate in gigabits per second for the specified Fibre Channel
port. Link rate options include Auto, 1Gb, 2Gb, 4Gb, or 8Gb. The default is the
Examples The following example shows the set fc command:

c:\>rcli set fc -port=1 -fc_link_rate=auto /ip=10.0.0.12
FC Port 1 basic info successfully configured
SN0054665-00 B 3-33
Show FC_Adv
Show FC_Adv
Displays detailed information (including the frame size, execution throttle,
connection type, and port mode) for one or all Fibre Channel ports.
Syntax show fc_adv

Keywords -port
Specifies the Fibre Channel port number for which you want to view advanced
information. If no port number is specified, advanced information is displayed for
all Fibre Channel ports.
Examples The following example shows the show fc_adv command:

c:\>rcli show fc_adv -port=1 /ip=10.0.0.12
[10.0.0.12]
Frame Size = 2048

Execution Throttle = 256
Programmed Connection Option = Loop Preferred
Advanced Port Mode = FCP
3-34 SN0054665-00 B
Set FC_Adv
Set FC_Adv
Sets the frame size, execution throttle, and connection type for a specific Fibre
Channel port.
Syntax set fc_adv

-port=<port number, (first port is 1)>
[-frame_size=[512 | 1024 | 2048]]
[-exec_throttle=<number in range 16 to 65536>]
[-loop_only]
[-p2p_only]
[-loop_preferred]
[-p2p_preferred]
Keywords -port
Specifies the Fibre Channel port number for which you want to set advanced
options.
-frame_size
Specifies the frame size of 512, 1024, or 2,048 bytes. The default value is set on
the router.
-exec_throttle
Specifies the execution throttle value as an integer in the range of 16–65536. The
default value is set on the router.
-loop_only
Specifies loop-only as the programmed connection option.
-p2p_only
Specifies point-to-point only as the programmed connection option.
-loop_preferred
Specifies loop as the preferred programmed connection option.
-p2p_preferred
Specifies point-to-point as the preferred programmed connection option.
NOTE:
You can specify either the -loop_only, -loop_preferred, or
-p2p_preferred keyword, but not more than one. If none of these
keywords is used, the default is as currently set on the router.
SN0054665-00 B 3-35
Set FC_Adv
Examples The following example shows the set fc_adv command:

c:\>rcli set fc_adv -port=1 -frame_size=2048 -loop_preferred
/ip=10.0.0.12
FC1 advanced info successfully configured
3-36 SN0054665-00 B
Show FC_Statistics
Show FC_Statistics
Samples Fibre Channel Port statistics and displays the result.
Syntax show fc_statistics

Keywords -csv_folder
Examples The following example shows the show fc_statistics command:

c:\>rcli show fc_statistics fc_stat /ip=10.0.0.12
[10.0.0.12]
Fibre Channel Port FC1 FC2 FC3 FC4

Interrupt Count 284194 85771 85062 85949
Target Command Count 0 0 0 158
Initiator Command Count 199403 150 0 0
Link Failure Count 0 0 0 0
Loss of Sync Count 0 0 0 0
Loss of Signal Count 0 0 0 0
Primitive Sequence Error Count 0 0 0 1
Invalid Transmission Word Count 0 0 0 0
Invalid CRC Error Count 0 0 0 0
SN0054665-00 B 3-37
Update Firmware
Update Firmware
Uploads a firmware image to the router. You must reboot the router following a
firmware update.
Syntax update firmware

-file=<firmware file name>
Keywords -file
Specifies the binary firmware file name for upload into the router. If no directory is
specified, the default is the current working directory.
Examples The following example shows the update firmware command:

c:\>rcli update firmware -file=c:\temp\isr6200-3_2_0_0.bin /ip=10.0.0.12
Firmware update complete ++ REBOOT REQUIRED ++
3-38 SN0054665-00 B
Save FRU_Config
Save FRU_Config
Collects from the router a file that contains the FRU configuration.
Syntax save fru_config

-file=<output file name>
Keywords -file
Specifies the file name to create. If no directory is specified, the default is the
working directory.
Examples The following examples show the save fru_config command:

c:\>rcli save fru_config -file=savecap.dat
FRU config file saved successfully
c:\>rcli save fru_config -file=c:\temp\savecap.dat

c:\>rcli save fru_config -file=/home/admin/savecap.dat

SN0054665-00 B 3-39
Restore FRU_Config
Restore FRU_Config
Uploads a FRU configuration file to the router to restore previously-saved settings.
Syntax restore fru_config

-file=<FRU config file name>
[-full_reset]
Keywords -file
Specifies a FRU configuration file for upload into the router. If no directory is
specified, the default is the working directory.
-full_reset
If used, the management port IP address changes after the router is rebooted. If
not used, the management port IP address does not change, even after the router
reboots.
Examples The following example shows the restore fru_config command:

c:\>rcli restore fru_config -file=c:\temp\my_fru_config.bin /ip=10.0.0.12
FRU Configuration restore complete
3-40 SN0054665-00 B
Help
Help
Displays summary help with a very brief description of the available commands.
To view detailed syntax for a specific command, enter the action and item with the
-help keyword.
Syntax help
[-constraint]
Keywords -constraint
If used, usage constraints are displayed for RCLI commands that do not work on
all QLogic iSR6xxx router hardware and firmware versions.
Examples The following examples show the help command.

To display summary help for all commands, issue the following command:
c:\> help
To display detailed for the show system command, issue the following
command:
RCLI> show system -help
SN0054665-00 B 3-41
?
?
Displays summary help with a very 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” on page 3-41).
Syntax ?
Examples To display summary help for all commands, issue the ? command as follows:
c:\> ?
3-42 SN0054665-00 B
Show IO_Statistics
Show IO_Statistics
Displays collected I/O statistics for a single LUN or for all LUNs. Starts collection
of statistics if not already enabled. Displays output in a comma delimited format
suitable for import into a spreadsheet program such as Microsoft Excel, with the
following columns of information:
LUN#, VP Group, Target, Read Blocks, Read I/Os, Write Blocks, Write I/Os
Syntax show io_statistics

[-lun_serial=<LUN page 0x80 serial number>]
[-lun_wwuln=<WWULN>]
[-lun_tten=<LUN T10 designator>]
[-lun_eui=<LUN EUI designator>]
[-lun_naa=<LUN NAA designator>]
[-lun_any_wwuln=<LUN WWULN, T10, NAA, EUI, or page 0x80 serial number
designator>]
[-lun_number=<LUN number>]
[-vpgindex=<VP group index starting at 1>]
[-fc_target=<Fibre Channel target name>]
[-is_target=<iSCSI target name>]
[-seconds=<time interval for sample>]
Keywords -lun_serial
Specifies the LUN’s page 0x80 serial number.
-lun_wwuln
Specifies the LUN’s WWULN.
-lun_tten
Specifies the LUN’s T10 designator.
-lun_eui
Specifies the LUN’s extended unique identifier (EUI).
-lun_naa
Specifies the LUN’s name address authority (NAA) designator.
-lun_any_wwuln
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.
SN0054665-00 B 3-43
Show IO_Statistics
NOTE:
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.
-lun_number
Specifies the LUN number for which you want to view statistics.
-vpgindex
Specifies the VP group index number.
-fc_target
Specifies the Fibre Channel target name.
-is_target
Specifies the iSCSI target name.
NOTE:
You can specify either the -fc_target or -is_target keyword, but
not both. If none of the preceding keywords are used, this command
displays statistics as if -all was used. If any of the preceding keywords
are used, they must all be used so that together they specify only one LUN.
-seconds
Specifies time interval for data collection; the default is two seconds.
-csv_folder
Specifies the folder into which individual files are created for each LUN. If existing
files are already in the specified folder, this command appends the new statistics
in those files.
Notes  This command requires router firmware version 3.1.0.0 or greater.

 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 greater.
Examples The following examples show the show io_statistics command:

c:\>rcli show io_statistics -lun_number=2 -vpgindex=1
-fc_target=5001-4380-025D-A83A /ip=10.0.0.12
3-44 SN0054665-00 B
Show IO_Statistics
Lun VP Read Write Read Write

Number Group Target Blocks Blocks I/Os I/Os
---------------------------------------------------------------------
2 1 5001-4380-025D-A83A 0 0 0 0
c:\rcli show io_statistics

-lun_any_wwuln=6006-0160-F931-2200-01B7-E72D-6E1A-E011 -ip=172.35.15.121
Lun VP Read Write Read Write

Number Group Target Blocks Blocks I/Os I/Os
---------------------------------------------------------------------
2 4 5006-0160-4BA0-35DE 0 0 0 0
2 4 5006-0168-4BA0-35DE 0 0 0 0
2 4 5006-0161-4BA0-35DE 0 0 0 0
2 4 5006-0169-4BA0-35DE 0 0 0 0
SN0054665-00 B 3-45
Disable IO_Statistics
Stops collection of data for read/write block counts and I/O counts for a single
LUN or for all LUNs.
Syntax disable io_statistics

designator>]
-lun_wwuln
-lun_tten
-lun_eui
Specifies the LUN’s EUI.
-lun_naa
Specifies the LUN’s NAA designator.
-lun_any_wwuln
NOTE:
3-46 SN0054665-00 B
-lun_number
Specifies the LUN number for which you want to disable the collection of statistics.
-vpgindex
-fc_target
Specifies the name of the Fibre Channel target.
-is_target
Specifies the name of the iSCSI target.
NOTE:
not both.
Notes  This command requires router firmware version 3.1.0.0 or greater.

 To use this command with the -lun_serial, -lun_wwuln, -lun_eui,
3.2.3.0 or greater.
Examples The following example shows the disable io_statistics command:

c:\>rcli disable io_statistics -all /ip=10.0.0.12
I/O statistic collection susccessfully disabled for all Luns
SN0054665-00 B 3-47
List Initiator
List Initiator
Lists the names of all initiators known to the router. (To view detailed information
for a specific initiator, use the show initiator command instead.)
Syntax list initiator
Examples The following example shows the list initiator command:

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)
3-48 SN0054665-00 B
Show Initiator
Show Initiator
Displays detailed information for a single initiator. (To view all initiators known to
the router, use the list initiator command instead.)
Syntax show initiator

[-fc_initiator=<Fibre Channel initiator name>]
[-is_initiator=<iSCSI initiator name>]
Keywords -fc_initiator
Specifies the Fibre Channel initiator name.
-is_initiator
Specifies the iSCSI initiator name.
NOTE:
You can specify either the -fc_initiator or -is_initiator
keyword, but not both. If neither is used, detailed information is displayed for
all initiators.
Examples The following example shows the show initiator command:

c:\>rcli show initiator -is_initiator=iqn.1991-05.com.microsoft:abcdef12
/ip=10.0.0.12
[10.0.0.12]
(Logged Out)
iSCSI Target
IPv6 Address = 0:0:0:0:0:0:0:0
iSCSI Name = iqn.1991-05.com.microsoft:abcdef12
iSCSI Alias =
CHAP is Disabled
CHAP Secret =
Portal = 0
Operational State = Logged Out
Initiator Device Path = No port specified
Discovery Method = NAME_SERVER
SN0054665-00 B 3-49
Show Initiator
Operating System Type = Microsoft Windows Server 2003

Initiator is NOT Mapped
3-50 SN0054665-00 B
Add Initiator
Add Initiator
Adds an initiator to the list known to the router.
Syntax add initiator

[-iscsi_name=<new iSCSI initiator name>]
[-wwpn=<new Fibre Channel initiator WWPN>]
[-wwnn=<new Fibre Channel initiator WWNN>]
[-fcoe]
[-ostype=[win2k3 | linux24 | linux26 | hpux | aix | netware | solaris | mac |
vmware | openvms | other | win2k8]]
[-chap_enable=yes | no | on | off | true | false]
[-chap_secret=<password>]
Keywords -iscsi_name
Specifies the name of the new iSCSI initiator you are adding.
NOTE:
Do not combine the -iscsi_name keyword with either -wwpn or -wwnn.
-wwpn
Specifies the world wide port name (WWPN) of a Fibre Channel initiator.
-wwnn
Specifies the world wide node name (WWNN) of a Fibre Channel initiator.
-fcoe
Use only in combination with the -wwpn and -wwnn keywords. Sets the Fibre
Channel over Ethernet (FCoE) portal attribute on the new initiator.
-ostype
Optional for both iSCSI and Fibre Channel initiators. Indicates one of the following
operating systems:
win2k3 Windows Server 2003 (the default)

win2k8 Windows Server 2008
linux24 Linux 2.4
linux26 Linux 2.6
hpux Hewlett Packard UNIX (HP-UX) a
aix IBM Advanced Interactive eXecutive (AIX)
SN0054665-00 B 3-51
Add Initiator
netware Novell NetWare

solaris Sun Solaris SPARC
mac Apple Macintosh
vmware VMware
openvms Open Virtual Memory System (OpenVMS)
other Other OS not listed here
a
The keyword -ostype=hpux is only valid for iSR61xx routers.
-chap_enable
Optional for an iSCSI initiator; cannot be used for a Fibre Channel initiator.
Specifies that challenge handshake authorization protocol (CHAP) is enabled for
this initiator.
-chap_secret
Optional for an iSCSI initiator; cannot be used for a Fibre Channel initiator.
Specifies the CHAP password.
Examples The following example shows the add initiator command:

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)
3-52 SN0054665-00 B
Modify Initiator
Modify Initiator
Changes the OS type for an existing initiator.
Syntax modify initiator

[-ostype= [ win2k3 | linux24 | linux26 | hpux | aix | netware | solaris | mac |
vmware | openvms | other | win2k8 ]]
Required, unless the -is_initiator keyword is used. Specifies the Fibre
Channel initiator name.
-is_initiator
Required, unless the -fc_initiator keyword is used. Specifies an iSCSI
initiator name.
NOTE:
You must specify either the -fc_initiator or -is_initiator
keyword, but not both.
-ostype
Optional for both iSCSI and Fibre Channel initiators. Indicates one of the following
operating systems:
win2k3 Windows Server 2003 (the default)

win2k8 Windows Server 2008
linux24 Linux 2.4
linux26 Linux 2.6
hpux Hewlett Packard UniX (HP-UX) a
aix IBM Advanced Interactive eXecutive (AIX)
netware Novell NetWare
solaris Sun Solaris SPARC
SN0054665-00 B 3-53
Modify Initiator
mac Apple Macintosh

vmware VMware
openvms Open Virtual Memory System (OpenVMS)
other Other OS not listed here
a
The keyword -ostype=hpux is only valid for iSR61xx routers.
Examples The following example shows the modify initiator command:

c:\>rcli modify initiator
-is_initiator=iqn.1991-05.com.microsoft:abcdef12 -ostype=win2k8
/ip=10.0.0.12
[10.0.0.12]
(Logged Out)
3-54 SN0054665-00 B
Remove Initiator
Remove Initiator
Deletes an existing initiator.
Syntax remove initiator

Required, unless the -is_initiator keyword is used. Specifies the name of
the Fibre Channel initiator to be deleted.
-is_initiator
Required, unless the -fc_initiator keyword is used. Specifies the name of
the iSCSI initiator to be deleted.
NOTE:
Examples The following example shows the remove initiator command:

c:\>rcli remove initiator -fc_initiator=2101-00E0-8B3A-E348
/ip=10.0.0.12
[10.0.0.12]
Initiator successfully removed
SN0054665-00 B 3-55
Enable iSCSI_Port
Enable iSCSI_Port
Enables the specified iSCSI port.
Syntax enable iscsi_port

Keywords -port
Specifies the port number of the iSCSI port to enable.
Examples The following example shows the enable iscsi_port command:

c:\>rcli enable iscsi_port -port=1 /ip=10.0.0.12
iSCSI Port 1 successfully enabled
3-56 SN0054665-00 B
Disable iSCSI_Port
Disable iSCSI_Port
Disables the specified iSCSI port.
Syntax disable iscsi_port

Keywords -port
Specifies the port number of the iSCSI port to disable.
Examples The following example shows the disable iscsi_port command:

c:\>rcli disable iscsi_port -port=1 /ip=10.0.0.12
iSCSI Port 1 successfully disabled
SN0054665-00 B 3-57
Show iSCSI
Show iSCSI
Displays basic information for either a single iSCSI port or for all iSCSI ports.
Syntax show iscsi

Keywords -port
Specifies the port number for the iSCSI port for which you want to view basic
information. If not used, basic information is displayed for all iSCSI ports.
Examples The following example shows the show iscsi command:

c:\>rcli show iscsi /ip=10.0.0.12
[10.0.0.12]
Port = GE1
Port Status = Enabled
Link Status = Down
Flow Control = Disabled
Number of open connections = 0
iSCSI Port name = iqn.1986-03.com.hp:fcgw.mpx200.0823e00014.b1.0
Firmware Revision = 3.00.01.57
Driver Revision =
Current Port Speed = Unknown
Programmed Port Speed = Auto
MAC Address = 00-c0-dd-12-f9-5c
IPv6 is Disabled
Port = GE2
...
3-58 SN0054665-00 B
Set iSCSI
Set iSCSI
Sets iSCSI port configuration.
Syntax set iscsi

[-ipv4_disable]
[-ipv4_addr=<static IPv4 address, (DHCP not supported for iSCSI ports)>]
[-ipv4gw_addr=<IPv4 gateway address>]
[-ipv6_disable]
[-ipv6_site_addr=<static site-local IPv6 address, (auto-config not supported
for iSCSI ports)>]
[-ipv6_def_addr=<default router IPv6 address>]
[-ipv6_glob_addr=<static global IPv6 address (auto-config not supported for
iSCSI ports)>]
Keywords -port
Specifies the port number for the iSCSI port that you want to configure.
-ipv4_disable
Disables use of IPv4 for the iSCSI port. If used, all other IPv4-related keywords
are ignored. Default is the current setting on the router.
-ipv4_addr
Specifies the static IPv4 address for the iSCSI port. Default is the current setting
on the router.
-ipv4gw_addr
Specifies the IPv4 gateway address for the iSCSI port. Default is the current
-ipv4_subnet
Specifies the IPv4 subnet mask. Default is the current setting on the router.
-ipv6_disable
-ipv6_site_addr
Specifies the site-local IPv6 address for the iSCSI port. Default is the current
SN0054665-00 B 3-59
Set iSCSI
-ipv6_def_addr
Specifies the default router IPv6 address for the iSCSI port. Default is the current
-ipv6_glob_addr
Specifies the global IPv6 address for the iSCSI port. Default is the current setting
on the router.
Notes Some older router hardware does not support IPv6.
Examples The following example shows the set iscsi command:

c:\>rcli set iscsi -port=1 -ipv4_static -ipv4_addr=10.0.0.5
/ip=10.0.0.12
iSCSI Port 1 basic info successfully configured
3-60 SN0054665-00 B
Show iSCSI_Adv
Show iSCSI_Adv
Displays advanced information for a specified iSCSI port or all iSCSI ports.
Syntax show iscsi_adv

Keywords -port
Specifies the port number for the iSCSI port for which you want to view advanced
information. If not used, advanced information is displayed for all iSCSI ports.
Examples The following example shows the show iscsi_adv command:

c:\>rcli show iscsi_adv -port=1 /ip=10.0.0.12
[10.0.0.12]
Advanced Info for iSCSI Port 1

Header Digest: Disabled
Data Digest: Disabled
CHAP: Disabled
MTU Size 1500
TCP Window Max Size TCPWINDOWSIZE_32768
Connections (free/total): 256 / 256
SN0054665-00 B 3-61
Set iSCSI_Adv
Set iSCSI_Adv
Sets advanced iSCSI port configuration.
Syntax set iscsi_adv

[-header_digest_enable= yes | no | on | off | true | false]
[-data_digest_enable= yes | no | on | off | true | false]
[-chap_enable= yes | no | on | off | true | false]
[-mtu_size=[ min | normal | jumbo | max | <number in range 582 to 9000> ]
[-tcpwindow=[ 8192 | 16384 | 32768 | 65536 | 131072 | 262144 | 524288 |
1048576 ]]
Keywords -port
Specifies the port number for the iSCSI port that you want to configure.
-header_digest_enable
Enables the header digest for the iSCSI port. The default value is set on the
router.
-data_digest_enable
Enables the data digest for the iSCSI port. The default value is set on the router.
-chap_enable
Enables CHAP for the iSCSI port. If CHAP is enabled, the -chap_secret
keyword defaults to an empty string unless it is included on the command line.
-chap_secret
Specifies the CHAP secret for the iSCSI port.
-mtu_size
582–9000. The default value is set on the router.
-tcpwindow
Specifies the TCP window size for the iSCSI port. The default value is set on the
router.
3-62 SN0054665-00 B
Set iSCSI_Adv
Examples The following example shows the set iscsi_adv command:

c:\>rcli set iscsi_adv -port=1 -mtu_size=jumbo -tcpwindow=65536
/ip=10.0.0.12
iSCSI Port 1 advanced info successfully configured
SN0054665-00 B 3-63
Show iSCSI_Statistics
Samples iSCSI port statistics and displays the result.
Syntax show iscsi_statistics

Keywords -csv_folder
Examples The following example shows the show iscsi_statistics command:

c:\>rcli show iscsi_statistics /ip=10.0.0.12
[10.0.0.12]
iSCSI Port GE1 GE2 10GE1 10GE2

Interrupt Count 25541 25541 0 0
Target Command Count 0 0 0 0
Initiator Command Count 0 0 0 0
MAC Xmit Frames 0 0 0 5
MAC Xmit Byte Count 0 0 0 390
MAC Xmit Multicast Frames 0 0 0 0
MAC Xmit Broadcast Frames 0 0 0 0
MAC Xmit Pause Frames 0 0 0 0
MAC Xmit Control Frames 0 0 0 0
MAC Xmit Deferrals 0 0 0 0
MAC Xmit Late Collisions 0 0 0 0
MAC Xmit Aborted 0 0 0 0
MAC Xmit Single Collisions 0 0 0 0
MAC Xmit Multiple Collisions 0 0 0 0
MAC Xmit Collisions 0 0 0 0
MAC Xmit Dropped Frames 0 0 0 0
MAC Xmit Jumbo Frames 0 0 0 0
MAC Rcvd Frames 0 0 0 11
MAC Rcvd Byte Count 0 0 0 2178
MAC Rcvd Unknown Control Frames 0 0 0 0
MAC Rcvd Pause Frames 0 0 0 0
MAC Rcvd Control Frames 0 0 0 0
MAC Rcvd Dribbles 0 0 0 0
3-64 SN0054665-00 B
MAC Rcvd Frame Length Errors 0 0 0 0

MAC Rcvd Jabbers 0 0 0 0
MAC Rcvd Carrier Sense Errors 0 0 0 0
MAC Rcvd Dropped Frames 0 0 0 0
MAC Rcvd CRC Errors 0 0 0 0
MAC Rcvd Encoding Errors 0 0 0 0
MAC Rcvd Length Errors Large 0 0 0 0
MAC Rcvd Length Errors Small 0 0 0 0
MAC Rcvd Multicast Frames 0 0 0 0
MAC Rcvd Broadcast Frames 0 0 0 0
iSCSI PDUs Xmited 0 0 0 0
iSCSI Data Bytes Xmited 0 0 0 390
iSCSI PDUs Rcvd 0 0 0 0
iSCSI Data Bytes Rcvd 0 0 0 2178
iSCSI I/O Completed 0 0 0 0
iSCSI Unexpected I/O Rcvd 0 0 0 0
iSCSI iSCSI Format Errors 0 0 0 0
iSCSI Header Digest Errors 0 0 0 0
iSCSI Data Digest Errors 0 0 0 0
iSCSI Sequence Errors 0 0 0 0
IP Xmit Packets 0 0 0 0
IP Xmit Byte Count 0 0 0 0
IP Xmit Fragments 0 0 0 0
IP Rcvd Packets 0 0 0 0
IP Rcvd Byte Count 0 0 0 0
IP Rcvd Fragments 0 0 0 0
IP Datagram Reassembly Count 0 0 0 0
IP Error Packets 0
SN0054665-00 B 3-65
Discover iSCSI_Target
Discover iSCSI_Target
Discovers iSCSI targets at a specified IP address.
Syntax discover iscsi_target

-port=<outbound iSCSI port number, (first port is 1)>
-iscsi_ipaddr=<IPv4 or IPv6 address for iSCSI target>
Keywords -port
Specifies the outbound iSCSI port number.
-iscsi_ipaddr
Specifies the iSCSI target IPv4 or IPv6 address.
-tcp_port
Specifies the TCP port to use on the iSCSI target. Must be in the range of 1024 to
65534. If not used, the default is 3260.
-chap_enable
Specifies that CHAP is enabled for this initiator. If not used, the default is disabled.
-chap_secret
Specifies the CHAP password. Ignored if CHAP is not enabled.
Examples The following example shows the discover iscsi_target command:

c:\>rcli discover iscsi_target -port=1 -iscsi_ipaddr=10.0.0.5 /ip=10.0.0.12
iSCSI Target discovery successful
3-66 SN0054665-00 B
Login iSCSI_Target
Login iSCSI_Target
Logs into a specified iSCSI target at a specified IP address.
Syntax login iscsi_target

-is_target=<iSCSI target name>
Keywords -port
Specifies the port number for the outbound iSCSI port.
-is_target
Specifies the iSCSI target to log into at the specified IP address.
-iscsi_ipaddr
Specifies the IPv4 or IPv6 address of the iSCSI target.
-tcp_port
-chap_enable
Specifies that CHAP is enabled for this initiator. If not used, the default is disabled.
-chap_secret
Specifies the CHAP password. Ignored if CHAP is not enabled.
Examples The following example shows the login iscsi_target command:

c:\>rcli login iscsi_target -port=1 -iscsi_ipaddr=10.0.0.5 /ip=10.0.0.12
SN0054665-00 B 3-67
Logout iSCSI_Target
Logout iSCSI_Target
Logs out from a specified iSCSI target at a specified IP address.
Syntax logout iscsi_target

-is_target=<iSCSI target name>
Keywords -port
Specifies the port number for the outbound iSCSI port.
-is_target
Specifies the iSCSI target to log out from at the specified IP address.
-iscsi_ipaddr
Specifies the IPv4 or IPv6 address of the iSCSI target.
-tcp_port
Examples The following example shows the logout iscsi_target command:

c:\>rcli logout iscsi_target -port=1 -iscsi_ipaddr=10.0.0.5 /ip=10.0.0.12
3-68 SN0054665-00 B
Show iSNS
Show iSNS
Displays Internet storage name service (iSNS) information, including the IP
address and port number for the server, and whether this feature is enabled.
Syntax show isns
Examples The following example shows the show isns command:

c:\>rcli show isns /ip=10.0.0.12
[10.0.0.12]
-enable=no
SN0054665-00 B 3-69
Set iSNS
Set iSNS
Enables or disables iSNS, and if enabled, allows setting the iSNS IP address and
TCP port.
Syntax set isns

[-isns_ipaddr=<IPv4 or IPv6 address>]
[-isns_port=<number in range1025 to 65534>
Keywords -enable
Enables iSNS so that you can set the IP address and TCP port. The default is the
-isns_ipaddr
Specifies the IPv4 or IPv6 port address. The default is the current setting on the
router.
-isns_port
Specifies the iSNS port number. The default is the current setting on the router.
Examples The following example shows the set isns command:

c:\>rcli set isns -enable=y -isns_ipaddr=10.0.0.10 -isns_port=1026
/ip=10.0.0.12
iSNS successfully configured
3-70 SN0054665-00 B
Clear Log
Clear Log
Resets the router log and deletes all previously recorded log information.
Syntax clear log
Examples The following example shows the clear log command:

c:\>rcli clear log
Log on the router successfully cleared
SN0054665-00 B 3-71
Save Log
Save Log
Gets log data from the router and saves it to a file.
Syntax save log

-file=<output file name for saved log>
Keywords -file
Specifies the name of a file to receive the log data. If no directory is specified, the
default is the working directory.
Examples The following example shows the save log command:

c:\>rcli save log -file=logdata.dat /ip=10.0.0.12
[10.0.0.12]
Log saved successfully to file: "logdata.dat"
3-72 SN0054665-00 B
List Log
List Log
Displays all log data from a file or a running system, filtered according to severity
and search text. (To view a limited set of log data, run the view log command
instead.)
Syntax list log

[-file=<input file name for saved log>]
[-find=<text to search for from base position>]
[-severity= [ error | warning | info | trace ]]
[-csv_delimiter=<delimiter for text separation in CSV file output]
[-csv_file=<CSV output file name>]
Keywords -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. If neither -find nor -severity is specified, all log entries are
displayed.
-find
Specifies a text string to search for within the log data list.
-severity
Specifies a severity (error, warning, info, or trace) by which to filter log data.
-csv_delimiter
If used with -csv_file, specifies use of a delimiter other than comma (,)
-csv_file
Specifies name of a file to receive comma separated text.
Examples The following example shows the list log command:

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
SN0054665-00 B 3-73
View Log
View Log
Displays only a limited portion of the log data (unlike the list log command
that shows all log data). A position context is maintained in persistent data. Use
the keywords to navigate to a specific range of the log data and display a limited
number of records before or after this point.
Syntax view log

[-file=<input file name for saved log>]
[-basepos= [ start | end] ]
[-offset=<number of log records from base position>]
[-time=<quoted time string "MM/DD/YYYY HH:MM:SS">]
[-find=<text to search for from base position>]
[-severity= [ error | warning | info | trace ]]
[-previous=<number of records to print after last offset>]
[-next=<number of records to print before last offset>]
Keywords All keywords are optional with default values saved in persistent data.
-file
Specifies a log data file name. If no directory is specified, the default is the
working directory.
-basepos
Specifies the starting point in the log from which to display log records.
-offset
Specifies the number of log records to display from the starting point (-basepos)
in the log.
NOTE:
 If -basepos and -offset are not specified, the position is updated
after each view command for use as the future default.
 If -basepos is used without -offset, the offset defaults to zero.
 If -offset is used, -basepos is also required.
-time
Specifies a date and time search function that modifies the position after
-basepos and -offset have been evaluated.
-find
Specifies a text string search function that modifies the position after -basepos
and -offset have been evaluated.
3-74 SN0054665-00 B
View Log
-severity
Specifies a severity search function that modifies the position after -basepos
and -offset have been evaluated.
NOTE:
The -time, -find, and -severity keywords are search options that
start from the position after -basepos and -offset are evaluated and
look for a match in the previous direction. If used in combination, they
are evaluated in this order: -time, then -find, and then -severity
-next
Displays a specified number log records after all positioning keywords have been
evaluated. If no number of records is supplied, the last specified value is used.
Initial default is 20 log records.
-previous
Displays a specified number log records before all positioning keywords have
been evaluated. If no number of records is supplied, the last specified value is
used. Initial default is 20 log records.
NOTE:
Setting -previous=-1 or -next=-1 displays all records before or after
the current position in the log after evaluating the -basepos, -offset,
-time, -find, and -severity keywords. These two keywords can be
used in combination, but show some duplicate output: first displaying for
-next, and then for -previous.
Examples The following examples show the view log command.

To view the last five entries in the current log on the router, issue the following
command:
c:\>rcli view log -basepos=end -previous=5 /ip=10.0.0.12
[10.0.0.12]
INFO 04/06/2010 20:03:11 UserApp qapisetsnmpparams_1_svc: snmp settings changed
INFO 04/06/2010 20:03:15 UserApp qapisetntpparams_1_svc: NTP configuration changed
INFO 04/06/2010 20:03:19 UserApp qapisetmigrfctargets_1_svc: Configuration Changed

for migration target
SN0054665-00 B 3-75
View Log
INFO 04/06/2010 20:03:19 UserApp qapisethostgroupinfo_1_svc: VPGroup with index 1

Enabled
INFO 04/06/2010 20:03:19 UserApp qapisethostgroupinfo_1_svc: VPGroup with index 2

Enabled
To repeatedly view 20 entries at a time going back through the log, issue the
following command:
c:\>rcli view log -prev=20
To view the last 20 entries in a saved log file, issue the following command:
c:\>rcli view log -file=savelog.dat -basepos=end -previous=20
To view the last log entry that has an “error” severity in a saved file, and then view
all remaining log data from that point to the most recent log entry, issue the
following command:
c:\>rcli view log -file=savelog.dat -basepos=end -severity=error
-next=-1
To find the last log record that has “restart” in the description in a saved file, and
then display the 20 previous log records, issue the following command:
c:\>rcli view log -file=savelog.dat -basepos=end -find="restart"
-prev=20
To search the saved log file for a record with a specified timestamp or older, and
then display the previous 20 log records, issue the following command:
c:\>rcli view log -file=savelog.dat -basepos=end -time="08/28/2009
12:34:50" -prev=20
To locate the 150th log record from the start of the saved file, and then display the
next 20 log records, issue the following command:
c:\>rcli view log -file=savelog.dat -basepos=start -offset=150
-next=20
3-76 SN0054665-00 B
Report Log
Report Log
Gets log data from the router and saves a formatted text report to a file.
Syntax report log

[-file=<output file name for report text>]
Keywords -file
Indicates a file name to receive the report text. If not used, the report is displayed
on the console. If no directory is specified, the file is saved in the current working
directory.
Examples The following example shows the report log command:

c:\>rcli report log -file=logreport.txt
Report saved successfully to file: "logreport.txt"
SN0054665-00 B 3-77
Save Capture_File
Save Capture_File
Collects a file that contains diagnostic information for the router.
Syntax save capture_file

Keywords -file
Specifies the name of the file to be created. If the specified file name does not end
with .tar.gz, this command appends .tar.gz to the file name. If you do not
specify a directory, the file is saved in the current working directory.
Notes  This command is not supported for iSR61xx routers.

Examples The following examples show the save capture_file command:

c:\>rcli save capture_file -file=savecap.tar.gz
Capture file saved successfully
c:\>rcli save capture_file -file=c:\temp\savecap.tar.gz

c:\>rcli save capture_file -file=/home/admin/savecap.tar.gz

3-78 SN0054665-00 B
List LUN
List LUN
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. (To view details for a specific
LUN, use the show lun command instead.)
Syntax list lun
Examples The following example shows the list lun command:

c:\>rcli list lun
Target "5001-4380-025D-A83A"
VP Group 1
-lun_number=0 -vpgindex=1 -fc_target=5001-4380-025D-A83A
VP Group 2
VP Group 3
VP Group 4
Target "5001-4380-025D-A83E"
VP Group 1
...
SN0054665-00 B 3-79
Show LUN
Show LUN
Displays detailed information either for a single LUN or for all LUNs known to the
router.
Syntax show lun

designator>]
-lun_wwuln
-lun_tten
-lun_eui
-lun_naa
-lun_any_wwuln
NOTE:
3-80 SN0054665-00 B
Show LUN
-lun_number
Specifies the LUN number for which you want to view detailed information.
-vpgindex
-fc_target
Limits the list to the LUNs from the Fibre Channel target.
-is_target
Limits the list to the LUNs from the iSCSI target.
NOTE:
not both.
If none of the optional keywords are used, detailed information is displayed
for all LUNs known to the router. If -lun_number, -vpindex, and
-is_target are all used, detailed information is displayed for a single
LUN. If only one or two keywords are used, detailed information is displayed
for all LUNs that match the input. For example, if only -vpgindex is used,
detailed information is displayed for all LUNs on any target that are in that
VP group.
Notes To use this command with the -lun_serial, -lun_wwuln, -lun_eui,

3.2.3.0 or greater.
Examples The following example shows the show lun command:

c:\>rcli show lun -lun_number=2 -vpgindex=1
-fc_target=5001-4380-025D-A83A /ip=10.0.0.12
[10.0.0.12]
SN0054665-00 B 3-81
Show LUN
Target = 5001-4380-025D-A83A
LUN number = 2
VP Group Index = 1st VP Group
Vendor ID = HP HSV340 0005
Product ID = HSV340 0005
Revision Level = 0005
LUN State = Online
Size = 102400
WWuln = 6005-08B4-000D-225C-0001-C000-0024-0000
Vendor Designator =
T10 Designator =
EUI Designator =
3-82 SN0054665-00 B
Show LUNmask
Show LUNmask
Displays detailed information either for a single LUN mask or for all LUN masks
known to the router.
Syntax show lunmask

designator>]
-lun_wwuln
-lun_tten
-lun_eui
-lun_naa
-lun_any_wwuln
SN0054665-00 B 3-83
Show LUNmask
NOTE:
-lun_number
Specifies the LUN number for which you want to view detailed LUN mask
information.
-vpgindex
Specifies the VP group index number for the LUN.
-fc_target
Specifies the Fibre Channel target name.
-is_target
Specifies the iSCSI target name.
-fc_initiator
Specifies the Fibre Channel initiator name.
-is_initiator
Specifies the iSCSI initiator name.
NOTE:
not both.
for all LUN masks known to the router. If a LUN number, VP group, and
target are all specified, LUN masks are displayed for all Initiators for a single
LUN. If only one or two keywords are used, detailed information is displayed
for all LUN masks that match the input. For example, if only -vpgindex is
used, detailed information is displayed for all LUN masks relating to any
LUNs on any targets that are in that VP group.
3-84 SN0054665-00 B
Show LUNmask

3.2.3.0 or greater.
Examples The following examples show the show lunmask command:

c:\>rcli show lunmask -lun_number=0 -vpgindex=1 -fc_target=5000-1FE1-5007-0CE8
/ip=10.0.0.12
[10.0.0.12]
-lun_number=0 -vpgindex=1 -fc_target=5000-1FE1-5007-0CE8

-fc_initiator=1000-0000-C98E-4548
-fc_initiator=1000-0000-C98E-4549
c:\>rcli show lunmask -lun_any_wwuln=6006-0160-F931-2200-01B7-E72D-6E1A-E011

-ip=172.35.15.121
[172.35.15.121]
No LUN Mask found
SN0054665-00 B 3-85
Add LUNmask
Add LUNmask
Adds a LUN mask to the list known to the router. A LUN mask enables a specified
initiator to use a specified LUN.
Syntax add lunmask

designator>]
[-lun_number=<number>]
[-vpgindex=<virtual port group index>]
Required, unless the -is_initiator keyword is used instead. Specifies the
Fibre Channel initiator name for which you want to add a LUN mask.
-is_initiator
Required, unless the -fc_initiator keyword is used instead. Specifies the
iSCSI initiator name for which you want to add a LUN mask.
NOTE:
-fc_target
Specifies the Fibre Channel target name for which you want to add a LUN mask.
-is_target
Specifies the iSCSI target name for which you want to add a LUN mask.
NOTE:
not both.
3-86 SN0054665-00 B
Add LUNmask
-lun_serial
-lun_wwuln
-lun_tten
-lun_eui
-lun_naa
-lun_any_wwuln
NOTE:
-lun_number
Specifies the LUN number for which you want to add a LUN mask.
-vpgindex

3.2.3.0 or greater.
Examples The following examples show the add lunmask command:

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
SN0054665-00 B 3-87
Add LUNmask
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
3-88 SN0054665-00 B
Remove LUNmask
Remove LUNmask
Removes a LUN mask from the list known to the router.
Syntax remove lunmask

designator>]
[-lun_number=<number>]
[-vpgindex=<virtual port group index>]
Required, unless the -is_initiator keyword is used instead. Specifies the
Fibre Channel initiator name for which you want to remove a LUN mask.
-is_initiator
Required, unless the -fc_initiator keyword is used instead. Specifies the
iSCSI initiator name for which you want to remove a LUN mask.
NOTE:
-fc_target
Required, unless the -is_target keyword is used instead. Specifies the Fibre
Channel target name for which you want to remove a LUN mask.
-is_target
Required, unless the -fc_target keyword is used instead. Specifies the iSCSI
target name for which you want to remove a LUN mask.
SN0054665-00 B 3-89
Remove LUNmask
NOTE:
You must specify either the -fc_target or -is_target keyword, but
not both.
-lun_serial
-lun_wwuln
-lun_tten
-lun_eui
-lun_naa
-lun_any_wwuln
NOTE:
-lun_number
Specifies the LUN number for which you want to remove a LUN mask.
-vpindex

3.2.3.0 or greater.
3-90 SN0054665-00 B
Remove LUNmask
Examples The following example shows the remove lunmask command:

c:\>rcli remove 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
[10.0.0.12]
Lun Mask successfully removed
SN0054665-00 B 3-91
Show Mgmt
Show Mgmt
Displays the management port’s IP addresses.
Syntax show mgmt
Examples The following example shows the show mgmt command:

c:\>rcli show mgmt /ip=10.0.0.12
[10.0.0.12]
MAC Address = 00-C0-DD-12-F9-5B
IPv4 Link Status = LINK_UP

IPv6 is Enabled
IPv6 Site-Local Address = 0:0:0:0:0:0:0:0
IPv6 Global Address = 2001:9012:0:0:0:0:0:12
IPv6 Default Router Address = 2001:9012:0:0:0:0:0:1
IPv6 Link Local Address = fe80:0:0:0:2c0:ddff:fe12:f95b
3-92 SN0054665-00 B
Set Mgmt
Set Mgmt
Sets the management port IP addresses.
Syntax set mgmt

[-ipv4_disable]
[-ipv4_static]
[-ipv4_dhcp]
[-ipv4_addr=<IPv4 address>]
[-ipv4gw_addr=<IPv4 gateway address>]
[-ipv6_disable]
[-ipv6_static]
[-ipv6_auto]
[-ipv6_site_addr=<site-local IPv6 address>]
[-ipv6_def_addr=<default router IPv6 address>]
[-ipv6_glob_addr=<global IPv6 address>]
Keywords -ipv4_disable
Disables use of IPv4 for the management port IP addresses. If used, all other
IPv4-related keywords are ignored.
-ipv4_static
Specifies the static IPv4 address for the management port. Default is the current
-ipv4_dhcp
Enables dynamic host configuration protocol (DHCP) for the IPv4 address for the
management port.
NOTE:
You can specify either the -ipv4_static or -ipv4_dhcp keyword, but
not both.
-ipv4_addr
Specifies the IPv4 address for the management port.
-ipv4_subnet
Specifies the IPv4 subnet mask for the management port. If not specified, the
default is 255.255.255.0.
-ipv4gw_addr
Specifies the IPv4 gateway address.
SN0054665-00 B 3-93
Set Mgmt
-ipv6_disable
Disables use of IPv6 for the management port address. If used, all other
IPv6-related keywords are ignored.
-ipv6_static
Specifies the static IPv6 address for the management port. Default is the current
-ipv6_auto
Enables auto-config for the management port IPv6 address. Default is the current
NOTE:
You can specify either the -ipv6_static or -ipv6_auto keyword, but
not both.
-ipv6_site_addr
Specifies the site-local IPv6 address for the management port.
-ipv6_def_addr
Specifies the default router IPv6 address for the management port.
-ipv6_glob_addr
Specifies the global IPv6 address for the management port.
Examples The following example shows the set mgmt command:

c:\>rcli set mgmt -ipv4_static -ipv4_addr=10.0.0.12
-ipv4_subnet=255.255.254.0 -ipv4gw_addr=10.0.0.1 /ip=10.0.0.12
Management Port successfully configured
3-94 SN0054665-00 B
Show Notification
Show Notification
Displays the notification feature configuration and one or more profiles. Each
profile lists e-mail addresses to which notices are sent if a specific event occurs.
Syntax show notification

[-name=<notification profile name>]
Keywords -name
Specifies a notification profile name. If not used, all profiles are displayed.
Examples The following example shows the show notification command:

c:\>rcli show notification -name="my Profile" /ip=10.0.0.12
[10.0.0.12]
-name="my Profile"
SN0054665-00 B 3-95
Set Notification
Set Notification
Configuring notifications, including IP addresses and port numbers for SMTP
servers, and contact information such as phone number, street address, and
e-mail addresses.
Syntax set notification

[-email= yes | no | on | off | true | false]
[-http= yes | no | on | off | true | false]
[-ipv4_disable]
[-ipv4_addr=<IPv4 address>]
[-ipv6_disable]
[-ipv6_site_addr=<site-local IPv6 address>
[-ipv6_glob_addr=<global IPv6 address>
[-tcp_port=<TCP port number on SMTP server>]
[-phone=<contact phone number>]
[-street=<contact street address>]
[-contact_email=<contact e-mail address>]
[-from=<sender e-mail address for generated messages>]
[-replyto_email=<“reply to” e-mail address for generated messages>]
[-url=<server URL for HTTP notifications>]
Keywords -email
Enables or disables e-mail notifications. The default value is as currently set on
the router.
-http
Enables or disables HTTP Notification. The default value is as currently set on the
router.
-ipv4_disable
-ipv4_addr
Specifies the static IPv4 address for the iSCSI port. Default is the current setting
on the router
-ipv4_subnet
Specifies the IPv4 subnet mask. Default is the current setting on the router.
3-96 SN0054665-00 B
Set Notification
-ipv6_disable
-ipv6_site_addr
Specifies the site-local IPv6 address for the iSCSI port. Default is the current
-ipv6_glob_addr
Specifies the global IPv6 address for the iSCSI port. Default is the current setting
on the router.
-tcp_port
Specifies the TCP port number on the mail server. Default is the current setting on
the router.
NOTE:
Specify only one IPv4 or IPv6 address each for the primary and secondary
SMTP servers.
-phone
Specifies the contact phone number. Default is as currently set on the router.
-street
Specifies the contact street address. Default is as currently set on the router.
-contact_email
Specifies the contact e-mail address. Default is as currently set on the router.
-from
Specifies the sender e-mail address for generated messages. Default is as
-replyto_email
Specifies the “reply to” e-mail address for generated messages. Default is as
-url
Specifies the URL for HTTP notifications.
SN0054665-00 B 3-97
Set Notification
Examples The following example shows the set notification command:

c:\>rcli set notification -smtp1_ipv4_addr=10.0.0.14 /ip=10.0.0.12
[10.0.0.12]
Notification configuration set successfully
3-98 SN0054665-00 B
Add Notification
Add Notification
Adds a new notification profile to the list known to the router.
Syntax add notification

-name=<new notification profile name>
[-email=<comma delimited list of e-mail addresses>] (Leave blank to disable
e-mail notifications.)
[-type=[ default | dm | fcip ]]
[-event = [ all | warning | error | dm_start | dm_stop | dm_pause | dm_fail |
dm_complete | dm_verify_complete | dm_all ]]
[-subject=<subject text for generated e-mail>]
Keywords -name
Specifies the name of the new notification profile.
-email
Comma-delimited list containing at least one e-mail address to be notified when
the event occurs. Or, leave blank to disable e-mail notifications.
-http
Specifies that the notification is to be posted to an HTTP server.
NOTE:
You can use the -email= and -http=yes keywords together or
separately to specify the notification methods for this profile. You must
specify at least one notification method.
-type
Specifies the profile type. (If this keyword is not used, the profile type is set as
-type=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.
SN0054665-00 B 3-99
Add Notification
-event
Specifies the event type that triggers sending e-mail to the list of recipients, (If this
keyword is not specified, the default is either -event=all or -event=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 starting with dm_ (such as -event=dm_all) only
with profile -type=dm.
-subject
Specifies the text in the subject line of the generated e-mail message. If not used,
a default subject line containing the router IP address is generated.
Examples The following example shows the add notification command:

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
3-100 SN0054665-00 B
Modify Notification
Modify Notification
Changes an existing notification profile.
Syntax modify notification

-name=<notification profile name>
[-type=[ default | dm | fcip ]]
[-event = [ all | warning | error | dm_start | dm_stop | dm_pause | dm_fail |
dm_complete | dm_verify_complete | dm_all ]]
[-email=<comma delimited list of e-mail addresses>]
[-subject=<subject text for generated e-mail>]
Keywords -name
Specifies the name of the notification profile to be modified.
-type
Specifies the profile type. (If this keyword is not specified, the current profile
settings are used.) 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.
-event
Specifies the event type that triggers sending e-mail to the list of recipients, (If this
keyword is not specified, the default is either -event=all or -event=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 starting with dm_ (such as -event=dm_all) only
with profile -type=dm.
-http
Specifies that the notification is to be posted to an HTTP server. If this keyword is
not specified, the current profile settings are used instead.
-email
Comma-delimited list of e-mail addresses to which a message is sent when the
event occurs. If this keyword is not specified, e-mail notification for this profile is
disabled; specify the -http keyword to enable HTTP notification instead. If this
keyword is not specified, the current profile settings are used.
SN0054665-00 B 3-101
Modify Notification
NOTE:
You must use either the -http or -email keyword, or both, to specify
the notification method for this profile.
-subject
Subject text for generated e-mail. If this keyword is not specified, the current
profile settings are used.
Examples The following example shows the modify notification command:

c:\>rcli modify notification -name="my profile" -event=dm_all
-http /ip=10.0.0.12
Notification "my profile" successfully modified
3-102 SN0054665-00 B
Remove Notification
Remove Notification
Deletes an existing notification profile.
Syntax remove notification

Keywords -name
Specifies the name of a notification profile to be removed.
Examples The following example shows the remove notification command:

c:\>rcli remove notification -name="my Profile" /ip=10.0.0.12
[10.0.0.12]
Notification successfully removed
SN0054665-00 B 3-103
Test Notification
Test Notification
Tests an existing notification profile by sending a trial e-mail message to the
recipients listed in the profile.
Syntax test notification

Keywords -name
Specifies the name of a notification profile to be tested.
Examples The following example shows the test notification command:

c:\>rcli test notification -name="my Profile" /ip=10.0.0.12
[10.0.0.12]
Notification profile test started OK
3-104 SN0054665-00 B
Show NTP
Show NTP
Displays network time protocol (NTP) information for the router.
Syntax show ntp

[-index=<NTP server address array index in range 0 to 2>]
Keywords -index
Specifies a single array index for an NTP server address. Default is to show all
valid NTP server addresses.
Examples The following example shows the show ntp command:

c:\>rcli show ntp /ip=10.0.0.12
[10.0.0.12]
-index=0 -ntp_ipaddr=10.0.0.100 -tz_hours=-8 -tz_mins=0

SN0054665-00 B 3-105
Set NTP
Set NTP
Sets the NTP server IP address and time zone offsets.
Syntax set ntp

[-index=<NTP server address array index in range 0 to 2>]
[-ntp_ipaddr=<IPv4 or IPv6 address>]
[-tz_hours=<time zone hours offset in range –12 to 12>]
[-tz_mins=<time zone minutes offset in range 0 to 59>]
Keywords -enable
Optional, with default value as currently set on the router. If used to enable NTP,
the -ntp_ipaddr is required so that at least one valid NTP server address is
present. If used to disable NTP, all current IP address settings are initialized and
all other keywords are ignored.
-index
Specifies the array index for the NTP server address. The default is index 0.
-ntp_ipaddr
Specifies the NTP server IPv4 or IPv6 address. The default is the current setting
on the router.
-tz_hours
Specifies the number of hours (–12 to 12) to offset for the time zone. The default
is the current setting on the router.
-tz_mins
Specifies the number of minutes (0–59) to offset the time zone. The default is the
Examples The following example shows the set ntp command:

c:\>rcli set ntp -enable=yes -ntp_ipaddr=10.0.0.100 -tz_hours=-8
-tz_mins=0 /ip=10.0.0.12
NTP -index=0 successfully configured
3-106 SN0054665-00 B
Set Password
Set Password
Changes the RPC or data migration password for the router.
After you change a password, you must include the /pw=xxxxx keyword in all
subsequent command lines. If you change the password back to the default value,
commands will no longer require the /pw=xxxxx keyword.
Syntax set password

[-rpc_password=<new password>]
[-dm_password=<new password>]
[-old_password=<old password, if any>]
Keywords -rpc_password
If specified, sets the new RPC password.
-dm_password
If specified, sets the new data migration password.
-old_password
Optional if the current password is the factory default value; required to match the
current RPC or data migration password.
Notes The -rpc_password and -dm_password cannot be combined in a single

command line.
If a non-default RPC password is currently set, you must supply the current
password in both -pw and -old_password keywords.
If a non-default RPC password is currently set and you want to modify the data
migration password, you must supply the current RPC password in the -pw
keyword, and the current migration password in the -old_password keyword.
Examples The following example shows the set password command:

c:\>rcli set password -rpc_password=mynewpw -old_password=myoldpw -pw=myoldpw
/ip=10.0.0.12
Password has been changed
SN0054665-00 B 3-107
Show Performance
Show Performance
Samples port performance data over a specified interval and displays the result
scaled to per-second units.
Syntax show performance

[-seconds=<time interval for sample>]
Keywords -seconds
Specifies the time, in seconds, for performance data collection. Regardless of the
length of this interval, results are displayed in per-second units. The default
collection interval is two seconds.
-csv_folder
Examples The following example shows the show performance command:

c:\>rcli show performance /ip=10.0.0.12
Port Bytes/s Bytes/s Bytes/s Bytes/s Bytes/s
Number (init_r) (init_w) (tgt_r) (tgt_w) (total)
------ -------- -------- -------- -------- --------
GE1 0 0 0 0 0
GE2 0 0 0 0 0
GE3 0 0 0 0 0
GE4 0 0 0 0 0
FC1 0 0 0 0 0
FC2 58MB 58MB 0 0 117.81MB
3-108 SN0054665-00 B
Execute Script
Execute Script
Executes a list of Remote CLI commands read in from a file.
Syntax execute script

-file=<script file name>
Keywords -file
Specifies a text file containing Remote CLI commands. If no directory is specified,
the default is the current working directory.
Examples The following example shows the execute script command:

c:\>rcli execute script -file=config_script.txt
Script "config_script.txt" completed OK
SN0054665-00 B 3-109
Generate Script
Generate Script
Generates an editable text file containing a script of Remote CLI commands. Two
types of scripts can be generated:
 -type=mask scripts contain RCLI commands for adding all LUN masks for
all known initiators and LUNs.
 -type=present scripts contain RCLI commands for presenting virtual
targets for all known physical targets.
Syntax generate script

[-file=<script file name>]
-type=[ present | mask ]
[-array_wwpn=<WWPN of a storage array>]
Keywords -file
Specifies a text file to contain a script of Remote CLI commands. If no directory is
specified, the default is the current working directory. If not used, the script is
displayed on the console.
-type
Specifies the script type, either present or mask. The -type=present
scripts contain Remote CLI commands for presenting virtual targets for all known
physical targets. The -type=mask scripts contain Remote CLI commands for
adding all LUN masks for all known initiators and LUNs.
-array_wwpn
Specifies the WWPN of the storage array to which to apply the commands in this
script. If not used, the script is displayed on the console.
-fc_initiator
Limits the script to LUN masks from one Fibre Channel initiator.
-is_initiator
Optional for -type=mask only. Limits the script to LUN masks from one iSCSI
initiator.
NOTE:
3-110 SN0054665-00 B
Generate Script
Examples The following example shows the generate script command:

c:\>rcli generate script -type=mask -file=config_script.txt
/ip=10.0.0.12
Script file generated successfully.
SN0054665-00 B 3-111
Save Script
Save Script
Saves an editable text file containing the current router configuration in the form of
a list of Remote CLI commands.
Syntax save script

-file=<script file name>
Keywords -file
Specifies a text file to be created to receive the command script. If -file is not
specified, the script outputs to the console. If no directory is specified, the default
is the current working directory.
Examples The following example shows the save script command:

c:\>rcli save script -file=config_script.txt
Script file generated successfully.
3-112 SN0054665-00 B
Show SNMP
Show SNMP
Displays the simple network management protocol (SNMP) information.
Syntax show snmp
Examples The following example shows the show snmp command:

c:\>rcli show snmp /ip=10.0.0.12
[10.0.0.12]
-read_community=public -trap_community=private -location="Server Room"

-contact=admin@widget.com -auth_enable=no -trap_index=0 -trap_ipaddr=10.0.0.10
-trap_port=1026 -trap_version=0
SN0054665-00 B 3-113
Set SNMP
Set SNMP
Sets the SNMP parameters.
Syntax set snmp

[-read_community=<SNMP read community>]
[-trap_community=<SNMP trap community>]
[-location=<SNMP system location>]
[-contact=<SNMP system contact>]
[-auth_enable= yes | no | on | off | true | false]
[-trap_index=<SNMP trap array index in range 0 to 7>]
[-trap_enable= yes | no | on | off | true | false ]
[-trap_ipaddr=<IPv4 or IPv6 address>]
[-trap_port=<number in range 1 to 65535>]
[-trap_version=<number in range1 to 3>]
Keywords -read_community
Specifies the SNMP read community. The default is the current setting on the
router.
-trap_community
Specifies the SNMP trap community. The default is the current setting on the
router.
-location
Specifies the SNMP system location. The default is the current setting on the
router.
-contact
Specifies the name of the SNMP system contact. The default is the current setting
on the router.
-auth_enable
Specifies if authentication is enabled or disabled for SNMP. The default is the
-trap_index
Specifies an integer (0–7) for the SNMP trap array index. Defaults to 0 if not
specified.
-trap_enable
Specifies if SNMP traps are enabled or disabled. The default is the current setting
on the router.
3-114 SN0054665-00 B
Set SNMP
-trap_ipaddr
Specifies the IPv4 or IPv6 address for the SNMP trap. The default is the current
-trap_port
Specifies the maximum number (1–65535) of SNMP trap ports to allow. The
default is the current setting on the router.
-trap_version
Specifies the SNMP trap version (1, 2, or 3). The default is the current setting on
the router.
Examples The following example shows the set snmp command:

c:\>rcli set snmp -location="Server Room"
-contact=admin@widget.com -auth_enable=n -trap_index=0
-trap_enable=yes -trap_ipaddr=10.0.0.10 -trap_port=1026
/ip=10.0.0.12
SNMP -trap_index=0 successfully configured
SN0054665-00 B 3-115
Show Status
Show Status
Displays status information for the router.
Syntax show status
Examples The following example shows the show status command:

c:\>rcli show status /ip=10.0.0.12
[10.0.0.12]
Sequence Number = 4
Alarm Status = Off
Hardware Status = 0
Temperature at Board Front = 0x35, 53 C.
Temperature at Board Rear = 0x25, 37 C.
Temperature of CPU #1 = 0x1ae, 43 C.
Temperature of CPU #2 = 0x1b8, 44 C.
Bridge Mask = 0x40008
Bridge Mask Ext = 0x0, 0x0, 0x4, 0x0
3-116 SN0054665-00 B
Show System
Show System
Displays system information, including serial number, firmware version, and more.
Syntax show system
Examples The following example shows the show system command:

c:\>rcli show system /ip=10.0.0.12
[10.0.0.12]

Symbolic Name = Blade-1
Operation Mode = ISCSI_CONNECTIVITY
Use IQN = NO_NAME_OR_SERIAL
SW Version = 3.2.0.0rc5e
HW Version = 00000-01
FC port count = 2
iSCSI port count = 4
Target Presentation Mode = AUTO_TARGET_PRESENTATION
LUN Mapping = Enabled
Controller LUN Automap = Disabled
Target Access Control = Enabled
Telnet = Enabled
SSH = Enabled
SN0054665-00 B 3-117
Set System
Set System
Sets global control and display items for the router, including symbolic name,
enable or disable controller LUN automatic mapping, LUN mapping, and target
presentation mode. You must reboot the router after issuing this command.
Syntax set system

[-name=<new symbolic name>]
[-target_presentation_mode = auto|manual]
[-target_access_control = yes | no | on | off | true | false]
[-controller_lun_automap = yes | no | on | off | true | false]
[-lun_mapping = yes | no | on | off | true | false]
[-telnet = yes | no | on | off | true | false]
[-ssh = yes | no | on | off | true | false]
[-ftp = yes | no | on | off | true | false]
Keywords -name
Specifies a symbolic name for the router. The name can be blank, or a maximum
of 63 alphanumeric characters, spaces, and special symbols.
-target_presentation_mode
Specifies the target presentation mode as either auto or manual. The default
-target_access_control
Specifies whether target access control is enabled or disabled. The default is the
-controller_lun_automap
Specifies whether automatic LUN mapping is enabled or disabled for the
controller. The default is the current setting on the router.
-lun_mapping
Specifies whether LUN mapping is enabled or disabled for the router. The default
-telnet
Specifies whether Telnet is enabled or disabled for the router. The default is the
-ssh
Specifies whether Secure Shell (SSH) is enabled or disabled for the router. The
default is the current setting on the router.
3-118 SN0054665-00 B
Set System
-ftp
Specifies whether FTP is enabled or disabled for the router. The default is the
current setting on the router. This keyword requires router version firmware
3.2.0.0 or greater.
Examples The following example shows the set system command:

c:\>rcli set system -lun_mapping=off /ip=10.0.0.12
[10.0.0.12]
setBridgeInfo completed successfully

*** REBOOT REQUIRED ***
SN0054665-00 B 3-119
Ping System
Ping System
Issues a ping through either the management port or one of the GbE ports.
Syntax ping system

[-port=<port number or "mgmt">]
-ping_ipaddr=<IPv4 or IPv6 address>
[-packet_size=<size in bytes to be sent>]
Keywords -port
Specifies the outbound port either as a number for an Ethernet port, or as mgmt
for the management port. Default is to use the management port.
-ping_ipaddr
Specifies either the IPv4 or IPv6 address to ping.
-packet_size
Specifies the ping packet size in bytes; the default is 56 bytes.
Examples The following example shows the ping system command:

c:\>rcli ping system -port=mgmt -ping_ipaddr=10.0.0.11
/ip=10.0.0.12
Reply from 10.0.0.11, time = 1 ms
3-120 SN0054665-00 B
TraceRt System
TraceRt System
Traces the route from the management port to a specified IP address.
Syntax tracert system

[-port=<mgmt>]
[-ping_ipaddr=<IPv4 or IPv6 address>]
[-count=<number of times to ping at each hop, (typically 3)>]
Keywords -port
Specifies the outbound port as mgmt for the management port. This keyword is
optional, but if used, it must specify the outbound port as mgmt.
NOTE:
This command no longer supports the use of iSCSI ports for outbound router
tracing.
-count
Specifies the number of times to ping at each hop. If not used, the default ping
count is 3.
Examples The following example shows the tracert system command:

c:\>rcli tracert system -port=mgmt -ping_ipaddr=10.0.0.11
/ip=10.0.0.12
1) 10.0.0.11 Min: <1 ms Max: 1 ms Avg(3): <1 ms
SN0054665-00 B 3-121
Reboot System
Reboot System
Restarts the firmware program in the router.
Syntax reboot system
Examples The following example shows the reboot system command:

c:\>rcli reboot system /ip=10.0.0.12
[10.0.0.12]
Router is restarting...
3-122 SN0054665-00 B
Register System
Register System
Registers RCLI as the management client for the router. If another application is
already registered as the management client for the router, this command may
fail. If successful, the router refuses commands from all other management clients
until this client is unregistered.
Each RCLI command in the session must include the -session keyword. At the
end of the session, you must issue the unregister system command (see
“Unregister System” on page 3-124).
Syntax register system

[-id=<text-only unique ID for RCLI>]
[-file=<name of the input file that contains the binary or text unique ID for
RCLI>]
Keywords -id
Specifies as a text string the unique ID for RCLI.
-file
Specifies the name of a file that contains either the binary or text unique ID for
RCLI. If no directory is specified, the default is the working directory.
NOTE:
You can specify either the -id or -file keyword, but not both. If neither
is specified, this command creates a default, unique identifier for RCLI.
Examples The following example shows the register system command:

c:\>rcli register system -file=rcli_id.dat
RCLI management client registered successfully
SN0054665-00 B 3-123
Unregister System
Unregister System
Unregisters RCLI as the management client for the router. If another application is
already registered as the management client for the router, this command may
fail. However, you can use the -force keyword to ensure that this command
succeeds.
Syntax unregister system

[-id=<text-only unique ID for this management client>]
[-file=<name of the input file that contains the binary or text unique ID for this
management client>]
[-force]
Keywords -id
Specifies as a text string the unique ID for RCLI.
-file
Specifies the name of a file that contains either the binary or text unique ID for
RCLI. If no directory is specified, the default is the working directory.
NOTE:
You can specify either the -id or -file keyword, but not both. If neither
is specified, this command creates a default, unique identifier for RCLI.
-force
Specifies that the current management client becomes unregistered, even if it is
other than RCLI.
Examples The following example shows the unregister system command:

c:\>rcli unregister system -file=rcli_id.dat
RCLI management client unregistered successfully
3-124 SN0054665-00 B
Rescan System
Rescan System
Scans LUNs again for a specified target or storage array, or for all targets known
to the router.
Syntax rescan system

[-array_wwpn=<source storage array WWPN>]
Specifies the storage array as a WWPN. If this keyword is not used, LUNs are
rescanned for all storage arrays known to the router.
Examples The following example shows the rescan system command:

c:\>rcli rescan system
[10.0.0.12]
rescan LUNs successful for Storage Array "0000-0100-0200-0000"
SN0054665-00 B 3-125
Reset_Factory System
Reset_Factory System
Restores the router's factory default configuration. After issuing this command,
you must reboot the router.
Syntax reset_factory system

[-full_reset]
Keywords -full_reset
Specifies that the management port IP address is changed after the router
reboots. If this keyword is not used, the management port IP address does not
change, even after the router reboots.
Examples The following examples show the reset_factory command:

c:\>rcli reset_factory -ip=10.0.0.12
c:\>rcli reset_factory system -full_reset /ip=10.0.0.12

[10.0.0.12]
Reset successful -- Reboot required
3-126 SN0054665-00 B
RetVal
RetVal
Displays a description of the specified return value. The return value from this
command is one of the following:
RCLI_OK
RCLI_INIT_FAIL
RCLI_PARSE_FAIL
RCLI_CMD_FAIL
RCLI_RESULT_FAIL
For all return values other than RCLI_OK, the API returns an error. See
Appendix A API Error Codes for a list of errors that the API may return when
parsing the retval command input or producing command output.
Syntax retval system

[-rv=<return value from a previously executed RCLI command>]
Keywords -rv
Specifies a return value from a previously executed RCLI command.
Examples The following example shows the retval system command:

c:\>rcli retval system -rv=140
QAPI_E_NOT_FOUND
SN0054665-00 B 3-127
Connect System
Connect System
Verifies that the RPC connection to a router works for a specified IP address.
Syntax connect system

-ip=<IPv4 or IPv6 IP address>
Keywords -ip
Specifies the IPv4 or IPv6 IP address to test to ensure that a connection can be
made.
Examples The following example shows the connect system command:

c:\>rcli connect system -ip=10.0.0.12
3-128 SN0054665-00 B
Find System
Find System
Broadcasts to discover either a specified router, or all routers (if no keywords are
included in the command).
Syntax find system

[-product=<router model name>]
Keywords -product
Specifies the router type to broadcast for in the local network. Similar products
may also be found. For example, specifying either -product=iSR6140 or
-product=iSR6142 discovers all iSR61xx products. If this keyword is used, it
may take about 25 seconds to complete. If this keyword is not used, multiple
broadcasts are performed in order to locate all product types, and may take as
long as 90 seconds to complete.
Examples The following examples show the find system command:

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
iSR61xx, 10.0.0.84
SN0054665-00 B 3-129
Version System
Version System
Displays the version information for Remote CLI and the API library it is using.
The first four segments indicate the API version, the fifth segment indicates the
Remote CLI branch release number, and the sixth segment is the Remote CLI
build number.
Syntax version system
Examples The following example shows the version system command:

c:\>rcli version
QLogic iSR Router Remote Command Line Interface (RCLI)

Version 1.73.0.0.0.0
3-130 SN0054665-00 B
List Target
List Target
Lists the names of all targets known to the router.
Syntax list target
Examples The following example shows the list target command:

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
SN0054665-00 B 3-131
Remove Target
Remove Target
Removes the specified offline target.
Syntax remove target

Keywords -fc_target
Specifies the name of the Fibre Channel target that you want to remove.
-is_target
Specifies the name of the iSCSI target that you want to remove.
NOTE:
not both. Use this command to remove only one target at a time.
Examples The following example shows the remove target command:

c:\>rcli remove target -fc_target=5001-4380-025D-A83E
/ip=10.0.0.12
[10.0.0.12]
Offline Target successfully removed
3-132 SN0054665-00 B
Show Target
Show Target
Displays detailed information for a single target. (To view all targets known to the
router, use the list target command instead.)
Syntax show target

Keywords -fc_target
Specifies the name of the Fibre Channel target for which you want to view detailed
information.
-is_target
Specifies the name of the iSCSI target for which you want to view detailed
information.
NOTE:
You may specify either the -fc_target or -is_target keyword, but
not both. If no target is specified, detailed information is displayed for all
targets.
Examples The following example shows the show target command:

c:\>rcli show target -fc_target=5001-4380-025D-A83E
Fibre Channel Target

WWNN: 5001-4380-025D-A830
WWPN: 5001-4380-025D-A83E
Port ID = 0A-07-00-00
MP Virtual target = Yes

Portal = 0
Target State = ONLINE
Target Device Mode = SMART_WRITE_DISABLED
Target Device Path = Port 1, Port 2
SN0054665-00 B 3-133
List Presented
List Presented
Lists the names of all presented targets known to the router. (To view details for a
specific presented target, use the show presented command instead.)
Syntax list presented
Examples The following example shows the list presented command:

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
-fc_target=2105-00C0-DD13-8FBF -fc_port=2
( physical target -fc_target=5000-1FE1-5007-0CEC )
-is_target=iqn.2004-08.com.qlogic:isr6200.0851e00030.b1.01.50001fe
150070ce8 -ge_port=1
-is_target=iqn.2004-08.com.qlogic:isr6200.0851e00030.b1.01.50001fe
150070ced -ge_port=1
( physical target -fc_target=5000-1FE1-5007-0CED )
3-134 SN0054665-00 B
Show Presented
Show Presented
Displays detailed information about one or more presented targets, or for all
presented targets associated with a specified physical target.
Syntax show presented

[-available_wwnames]
Keywords -fc_target
Specifies the name of the presented Fibre Channel target for which you want to
view detailed information.
-is_target
Specifies the name of the presented iSCSI target for which you want to view
detailed information.
NOTE:
You can use either -fc_target or -is_target, but not both. If the
target is a presented target, only one presented target is displayed. If the
target is a physical target, there may be multiple virtual targets that map to it.
If not used, detailed information is shown for all presented targets.
-fc_port
Specifies the port number for the Fibre Channel target. This keyword cannot be
combined with -ge_port.
-ge_port
Specifies the port number for the GbE target. This keyword cannot be combined
with -fc_port.
NOTE:
You can use either -fc_port or -ge_port, but not both. If neither is
used, detailed information is displayed for all Fibre Channel and GbE ports.
-available_wwnames
Displays the next available world wide names (WWNs), one per port, for use with
the map target command (see “Map Target” on page 3-137).
SN0054665-00 B 3-135
Show Presented
Examples The following example shows the show presented command:

c:\>rcli show presented -fc_target=5000-1FE1-5007-0CE8 /ip=10.0.0.12
Presented Fibre Channel Target
WWNN: 2004-00C0-DD13-8FBE
WWPN: 2104-00C0-DD13-8FBE
Port ID = 01-0F-01-00
Portal = 0
Maps to physical target: 5000-1FE1-5007-0CE8, 1st VP Group
Presented iSCSI Target

iSCSI Name = iqn.2004-08.com.qlogic:isr6200.0851e00030.b1.01.50001fe150070ce8
iSCSI Alias =
CHAP is Disabled
Portal = 0
Maps to physical target: 5000-1FE1-5007-0CE8, 1st VP Group
3-136 SN0054665-00 B
Map Target
Map Target
Maps an iSCSI or Fibre Channel target to an iSCSI or Fibre Channel port.
Syntax map target

[-iscsi_name=<iqn... name for presented target>]
[-wwpn=<Fibre Channel worldwide port name for presented target>]
[-wwnn=<Fibre Channel worldwide node name for presented target>]
-vpgindex=<VP group index starting at 1>
Keywords -fc_target
Required, unless -is_target is specified. Specifies the name of the Fibre
Channel target to map to the iSCSI or Fibre Channel port.
-is_target
Required, unless -fc_target is specified. Specifies the name of the iSCSI
target to map to the iSCSI or Fibre Channel port.
NOTE:
not both.
-fc_port
Required, unless -ge_port is specified. Specifies the Fibre Channel port
number, where the first port is 1.
-ge_port
Required, unless -fc_port is specified. Specifies the GbE port number, where
the first port is 1.
NOTE:
You must specify either the -fc_port or -ge_port keyword, but not
both.
-iscsi_name
Optional, but only if combined with the -ge_port keyword. If -ge_port is
used and -iscsi_name is not specified, the router uses a default name for the
presented iSCSI target.
SN0054665-00 B 3-137
Map Target
-wwpn
Optional, but only if combined with the -fc_port keyword. If -fc_port is
used and -wwpn is not specified, the router uses the default WWPN name for
the presented Fibre Channel target.
-wwnn
Optional, but only if combined with the -fc_port keyword. If -fc_port is
used and -wwnn is not specified, the router uses the default WWNN for the
presented Fibre Channel target.
-vpgindex
Specifies the virtual port group index starting at 1.
Notes Manual mapping and unmapping of targets is supported only for the iSR6152
router.
Examples The following example shows the map target command:

c:\>rcli map target -fc_target=5001-4380-025C-C7D8 -ge_port=1
-vpgindex=1
Target 5001-4380-025C-C7D8 successfully mapped to Ethernet port 1
3-138 SN0054665-00 B
Unmap Target
Unmap Target
Removes the mapping from an iSCSI or Fibre Channel target to an iSCSI or Fibre
Channel port.
Syntax unmap target

[-fc_target=<Fibre Channel physical or presented target name>]
[-is_target=<iSCSI physical or presented target name>]
[-fc_port=<Fibre Channel port number>]
[-ge_port=<GbE port number>]
Keywords -fc_target
Required, unless -is_target is specified. Specifies the Fibre Channel target
name.
-is_target
Required, unless -fc_target is specified. Specifies the iSCSI target name.
NOTE:
not both.
-fc_port
Required, unless -ge_port is specified. Specifies the Fibre Channel port
number, where the first port is 1.
-ge_port
Required, unless -fc_port is specified. Specifies the GbE port number, where
the first port is 1.
NOTE:
You must specify either the -fc_port or -ge_port keyword, but not
both.
Notes Manual mapping and unmapping of targets is supported only for the iSR6152
router.
SN0054665-00 B 3-139
Unmap Target
Examples The following example shows the unmap target command:

c:\>rcli unmap target -fc_target=5001-4380-025C-C7D8 -ge_port=1
Target 5001-4380-025C-C7D8 successfully unmapped from Ethernet

port 1
3-140 SN0054665-00 B
Show Time
Show Time
Displays the date and time currently set on the router.
Syntax show time
Examples The following example shows the show time command:

c:\>rcli show time /ip=10.0.0.12
[10.0.0.12]
-gmt="04/08/2010 17:28:29"
-local="04/08/2010 10:28:29"
SN0054665-00 B 3-141
Set Time
Set Time
Sets the date and time on the router.
Syntax set time

[-use_local_time]
[-gmt=<GMT MM/DD/YYYY HH:MM:SS>]
[-local=<local time MM/DD/YYYY HH:MM:SS>]
Keywords -use_local_time
Specifies that the router time is set to the same time as is currently on the local
system.
-gmt
Specifies that the router time is set using the input treated as Greenwich Mean
Time (GMT).
-local
Specifies that the router time is set using the input treated as a local time.
NOTE:
You must use one of the preceding keywords, but you cannot use more than
one.
Examples The following example shows the set time command:

c:\>rcli set time -local="07/29/2009 23:26:03"
3-142 SN0054665-00 B
Wait Time
Wait Time
Displays a timer countdown to introduce a time delay in scripts that need to wait.
Syntax wait time

[-seconds=<delay time in seconds>]
Keywords -seconds
Specifies the wait time in seconds. If -seconds is not specified, the default
delay time is five seconds.
Examples The following example shows the wait time command:

c:\>rcli wait time -seconds=120
SN0054665-00 B 3-143
List VLAN
List VLAN
Displays virtual logical area network (VLAN) information for all VLAN ports. (To
view VLAN information for a single port, use the show vlan command instead.)
Syntax list vlan
Examples The following example shows the list vlan command:

c:\>rcli list vlan /ip=10.0.0.12
[10.0.0.12]
-port=1 -ipv4 -enable=yes -id=32 -priority=2

-port=2 -ipv4 -enable=no
3-144 SN0054665-00 B
Show VLAN
Show VLAN
Displays VLAN information for the specified port. (To view VLAN information for
all ports, use the list vlan command instead.)
Syntax show vlan

[-port=<iSCSI port number, (first port is 1)>]
[-ipv4 | -ipv6]
Keywords -port
If not used VLAN information is displayed for all ports.
-ipv4 | -ipv6
Specifies the IP version to use. The default value is -ipv4. Only one of these
can be used on the same command line.
Examples The following example shows the show vlan command:

c:\>rcli show vlan -port=1 /ip=10.0.0.12
[10.0.0.12]
IPv4 VLAN ENABLED, VLAN ID = 32, VLAN Priority = 2
SN0054665-00 B 3-145
Set VLAN
Set VLAN
Enables or disables the use of a VLAN for a specified IPv4 or IPv6 protocol on a
specified iSCSI port. If enabled, allows setting the VLAN ID and priority.
Syntax set vlan

-port=<iSCSI port number, (first port is 1)>
[-ipv4 | -ipv6]
[-priority=<number in range 0 to 7>]
[-id=<number in range 1 to 4094>]
Keywords -port
Specifies the iSCSI port number.
-ipv4 | -ipv6
Specifies the IP version to use. The default is -ipv4. Only one IP version can be
used on the same command line.
-enable
Specifies whether VLANs are enabled or disabled for the port. The default is the
-priority
Specifies a priority number from 0–7, where 7 is the highest priority. The default is
the current setting on the router.
-id
Specifies the VLAN ID number. The default is the current setting on the router.
Examples The following example shows the set vlan command:

c:\>rcli set vlan -enable=yes -port=1 -ipv4 -priority=2 -id=32
/ip=10.0.0.12
[10.0.0.12]
IPv4 VLAN ENABLED, VLAN ID = 32, VLAN Priority = 2
3-146 SN0054665-00 B
List VP_Group
List VP_Group
Lists the names of all VP groups known to the router. (To view details for a single
VP group, use the show vp_group command instead.)
Syntax list vp_group
Notes This command is not supported for iSR61xx routers.
Examples The following example shows the list vp_group command:

c:\>rcli list vp_group /ip=10.0.0.12
[10.0.0.12]
VpGroup count = 4
-vpgindex=1 "VPGROUP_1" (enabled)
SN0054665-00 B 3-147
Show VP_Group
Show VP_Group
Displays detailed information for a single VP group. (To view a list of all VP
groups, use the list vp_group command instead.)
Syntax show vp_group

[-vpgIndex=<index number starting at 1>]
Keywords -vpgIndex
Specifies the index number for the VP group for which you want to view
information. If not used, detailed information is displayed for all VP groups.
Examples The following example shows the show vp_group command:

c:\>rcli show vp_group -vpgIndex=1
[10.0.0.12]
Index: 1 "VPGROUP_1" is Enabled
3-148 SN0054665-00 B
Set VP_Group
Set VP_Group
Sets a display name for a VP group.
Syntax set vp_group

-vpgIndex=<index number starting at 1>
[-name=<new VP group name>]
Keywords -vpgIndex
Specifies the index number for the VP group.
-enable
Specifies whether VP group names are allowed. The default is the current setting
on the router.
-name
Specifies a new name for the VP group indicated by the -vpindex keyword.
The default is the current setting on the router.
Examples The following example shows the set vp_group command:

c:\>rcli set vp_group -vpgindex=1 -enable=yes -name="MyVpGroup" /ip=10.0.0.12
Virtual Port Group 1 successfully configured
SN0054665-00 B 3-149
Set VP_Group
3-150 SN0054665-00 B
4 Data Migration Service
Commands
Data migration service is a block-level, online and offline feature introduced in the
Intelligent Storage Router data transport device. The SANsurfer iSCSI/FC Router
Manager utility provides this optional, licensed feature to simplify data migration
jobs for almost zero downtime, while providing protection against common user
errors.
To use data migration commands, first ensure that your router is capable of
performing data migration, and that the you have applied an appropriate data
migration license. To view the router capabilities and licensing status, issue the
show features command (see “Show Features” on page 3-28).
In addition, all data migration commands require that the router is running
firmware version 3.2.3.0 or greater.
This chapter provides the description, syntax, and examples of each of the data
migration commands available in the Remote CLI. The commands are listed in
alphabetic order by category, as shown in Table 4-1.
NOTE:
All examples shown in this chapter are shown from a Microsoft Windows
command prompt, but the output is also applicable to Linux systems.
SN0054665-00 B 4-1
4–Data Migration Service Commands
Table 4-1. Data Migration Commands by Category
Category Commands
Data Management LUNs “Show DML” on page 4-3

“Add DML” on page 4-6
“Remove DML” on page 4-8
Data Migration Groups “List DM_Group” on page 4-10

“Show DM_Group” on page 4-11
“Add DM_Group” on page 4-12
“Remove DM_Group” on page 4-13
Data Migration Jobs “List Migration” on page 4-14

“Show Migration” on page 4-15
“Add Migration” on page 4-17
“Remove Migration” on page 4-22
“Start Migration” on page 4-23
“Stop Migration” on page 4-24
“Pause Migration” on page 4-25
“Resume Migration” on page 4-26
“Acknowledge Migration” on page 4-27
Data Migration Logs “Clear DM_Log” on page 4-28

“Save DM_Log” on page 4-29
“List DM_Log” on page 4-30
“View DM_Log” on page 4-31
“Report DM_Log” on page 4-33
Data Migration Reports “Save DM_Report” on page 4-34
4-2 SN0054665-00 B
Show DML
Show DML
Displays detailed information either for a single data management LUN (DML) or
for all DMLs known to the router.
Syntax show dml

designator>]
-lun_wwuln
-lun_tten
-lun_eui
Specifies the LUN’s EUI designator.
-lun_naa
-lun_any_wwuln
SN0054665-00 B 4-3
Show DML
NOTE:
These identifiers are not necessarily unique to a single LUN. It is possible
that any one of these keywords alone might refer to more than one LUN,
even if not combined with other identifiers.
-lun_number
Specifies the LUN number for which you want to view detailed information.
-vpgindex
-fc_target
Limits the list to the LUNs from the Fibre Channel target.
-is_target
Limits the list to the LUNs from the iSCSI target.
NOTE:
not both.
for all LUNs known to the router.
If -lun_number, -vpindex, and -is_target are all used, detailed
information is displayed for a single LUN.
If only one or two keywords are used, detailed information is displayed for all
LUNs that match the input. For example, if only -vpgindex is used,
detailed information is displayed for all LUNs on any target that are in that
VP group.
Examples The following example shows the show dml command:

c:\>rcli show dml -lun_number=2 -vpgindex=1 -fc_target=5001-4380-025D-A83A
/ip=10.0.0.12
[10.0.0.12]
Target = 5001-4380-025D-A83A
4-4 SN0054665-00 B
Show DML
LUN number = 2
VP Group Index = 1st VP Group
Vendor ID = HP HSV340 0005
Product ID = HSV340 0005
Revision Level = 0005
LUN State = Online
Size = 102400
WWuln = 6005-08B4-000D-225C-0001-C000-0024-0000
Vendor Designator =
T10 Designator =
EUI Designator =
SN0054665-00 B 4-5
Add DML
Add DML
Adds a LUN to the list of data management LUNs on the router.
Syntax add dml

designator>]
-lun_wwuln
-lun_tten
-lun_eui
-lun_naa
-lun_any_wwuln
4-6 SN0054665-00 B
Add DML
NOTE:
These identifiers are not necessarily unique to a single LUN. If combined
with other keywords, it is possible that the LUN keywords might refer to
more than one LUN. This command requires that you select a specific LUN;
so if the keywords specified match more than one LUN, you must use
additional keywords.
-lun_number
Specifies the LUN number to add.
-vpgindex
Specifies the VP group index number for the new data management LUN.
-fc_target
Specifies the Fibre Channel target for the new data management LUN.
-is_target
Specifies the iSCSI target for the new data management LUN.
NOTE:
not both.
Examples The following example shows the add dml command:

c:\>rcli add dml -lun_number=2 -vpgindex=1
-fc_target=5001-4380-025D-A83A /ip=10.0.0.12
[10.0.0.12]
SN0054665-00 B 4-7
Remove DML
Remove DML
Removes a LUN from the list of data management LUNs on the router.
Syntax remove dml

designator>]
-lun_wwuln
-lun_tten
-lun_eui
-lun_naa
-lun_any_wwuln
4-8 SN0054665-00 B
Remove DML
NOTE:
These identifiers are not necessarily unique to a single LUN. If combined
with other keywords, it is possible that the LUN keywords might refer to
more than one LUN. This command requires that you select a specific LUN;
so if the keywords specified match more than one LUN, you must use
additional keywords.
-lun_number
Specifies the LUN number to delete.
-vpgindex
Specifies the VP group index number of the LUN to delete.
-fc_target
Specifies the Fibre Channel target of the LUN to delete.
-is_target
Specifies the iSCSI target of the LUN to delete.
NOTE:
not both.
Examples The following example shows the remove dml command:

c:\>rcli remove dml -lun_number=2 -vpgindex=1
-fc_target=5001-4380-025D-A83A /ip=10.0.0.12
[10.0.0.12]
Data Management LUN -lun_number=2 -vpgindex=1

-fc_target=5001-4380-025D-A83A successfully removed.
SN0054665-00 B 4-9
List DM_Group
List DM_Group
Lists all data migration job groups known to the router.
Syntax list dm_group
Examples The following example shows the list dm_group command:

c:\>rcli list dm_group /ip=10.0.0.12
[10.0.0.12]
Data Migration Group count = 1

-name="Group 0"
4-10 SN0054665-00 B
Show DM_Group
Show DM_Group
Displays detailed information for one or all data migration job groups.
Syntax show dm_group

[-name=<data migration group name>]
Keywords -name
Specifies the name of a data migration job group to view. If not used, detailed
information is shown for all data migration job groups.
Examples The following example shows the show dm_group command:

c:\>rcli show dm_group -name="Group 0" /ip=10.0.0.12
[10.0.0.12]
DM Job Group "Group 0"
SN0054665-00 B 4-11
Add DM_Group
Add DM_Group
Adds a data migration job group.
Syntax add dm_group

-name=<data migration job group name>
Keywords -name
Specifies the name of the data migration job group to add.
Examples The following example shows the add dm_group command:

c:\>rcli add dm_group -name="My Group" /ip=10.0.0.12
[10.0.0.12]
Data Migration Job Group "My Group" successfully added
4-12 SN0054665-00 B
Remove DM_Group
Remove DM_Group
Removes a data migration job group.
Syntax remove dm_group

-name=<data migration job group name>
Keywords -name
Specifies the name of a data migration job group to be removed.
Examples The following example shows the remove dm_group command:

c:\>rcli remove dm_group -name="My Group" /ip=10.0.0.12
[10.0.0.12]
Data Migration Job Group "My Group" successfully removed
SN0054665-00 B 4-13
List Migration
List Migration
Lists all data migration jobs known to the router.
Syntax list migration

[-state= running | paused | failed | completed | serial | all ]
Keywords -state
Specifies the status of data migration jobs to view: either running, paused, failed,
completed, serial scheduled, or all jobs. If not used the default is -state=all.
Examples The following example shows the list migration command:

c:\>rcli list migration /ip=10.0.0.12
[10.0.0.12]
-dm_jobid=0
HP HSV200-0:VPG1:002 to NETAPP LUN-1:VPG1:002
Completed
4-14 SN0054665-00 B
Show Migration
Show Migration
Displays detailed information about one or more data migration jobs.
Syntax show migration

[-dm_jobid=<data migration job ID>]
[-state= running | paused | failed | completed | serial | all]
Keywords -dm_jobid
Specifies the ID of one data migration job to view. If this keyword is used, the
-state keyword is ignored.
-state
Specifies the status of data migration jobs to view: either running, paused, failed,
completed, serial scheduled, or all jobs. If not used the default is -state=all. If
-dm_jobid is used, this keyword is ignored.
Examples The following example shows the show migration command:

c:\>rcli show migration -dm_jobid=0 /ip=10.0.0.12
[10.0.0.12]
DM Job ID number = 0
DM Job Name = HP HSV200-0:VPG1:002 to NETAPP LUN-1:VPG1:002
Completed
Transfer Speed Estimate = 75 MB/sec
Start time = 04/08/2010 15:19:55
End time = 04/08/2010 15:42:25
Delta time (End-Start) = 15 sec
Source Lun ID = LUN 1 on Storage Array 0000-0100-0100-0000
Source WWuln = 6005-08B4-0007-4838-0001-2000-017B-0000
Destination Lun ID = LUN 2 on Storage Array 0000-0200-0100-0000
Destination WWuln = NETAPP LUN HnS-aJV6WgMN
DM Job Type = Online Data Migration
DM Schedule Type = Start Now
Priority = 0
Migration Owner = 1
Source Lun Start LBA = 00
Source Lun End LBA = 0c7fffff
Destination Lun Start LBA = 00
SN0054665-00 B 4-15
Show Migration
Destination Lun End LBA = 0c8072ff

Migration I/O Size = 64
DM Job Group = Group 0
4-16 SN0054665-00 B
Add Migration
Add Migration
Adds a new data migration job.
Syntax add migration

-dm_type=[offline | verify_after_offline | online | remote_online | compare |
scrub]
[-tp_dest]
[-tp_dest_with_validation]
[-scrub_algorithm=[zero_clean | dod_5220_22_m | dod_5220_22_m_e |
dod_5220_22_m_ece]]
[-name=<data migration job group name>]
[-fc_target=<source Fibre Channel target name>]
[-is_target=<source iSCSI target name>]
[-array_wwpn=<source storage array WWPN>]
[-lun_serial=<source LUN page 0x80 serial number>]
[-lun_wwuln=<source LUN WWULN>]
[-lun_tten=<source LUN T10 designator>]
[-lun_eui=<source LUN EUI designator>]
[-lun_naa=<source LUN NAA designator>]
[-lun_any_wwuln=<source LUN WWULN, T10, NAA, EUI, or page 0x80 serial
number designator>]
[-lun_number=<source LUN number>]
[-vpgindex=<source VP group index starting at 1>]
[-dmdest_fc_target=<destination Fibre Channel target name>]
[-dmdest_is_target=<destination iSCSI target name>]
[-dmdest_array_wwpn=<destination storage array WWPN>]
[-dmdest_lun_serial=<destination LUN page 0x80 serial number>]
[-dmdest_lun_wwuln=<destination LUN WWULN>]
[-dmdest_lun_tten=<destination LUN T10 designator>]
[-dmdest_lun_eui=<destination LUN EUI designator>]
[-dmdest_lun_naa=<destination LUN NAA designator>]
[-dmdest_lun_any_wwuln=<destination LUN WWULN, T10, NAA, EUI, or
page 0x80 serial number designator>]
[-dmdest_lun_number=<destination LUN number>]
[-dmdest_vpgindex=<destination VP group index starting at 1>]
[-start_now]
[-priority=<serial schedule priority in range 1 to 256>]
[-dm_io_size=<32, 64, 128, 512, or 1024 (default is 64)>]
SN0054665-00 B 4-17
Add Migration
Keywords -dm_type
Specifies the data migration job type as either offline, verify after offline, online,
compare, or scrub. If the job type is scrub, only one LUN is affected and all
-dmdest_… keywords are ignored.
-tp_dest
Specifies that the destination LUN is thin-provisioned. Do not use this keyword for
“compare” jobs.
-tp_dest_with_validation
Specifies that the destination LUN is thin-provisioned. Adding validation to the
data migration job slows performance, but it allows you to use thin-provisioned
destination LUNs that have previously initialized contents. Do not use this
keyword for “compare” jobs.
NOTE:
You can specify either the -tp_dest or -tp_dest_with_validation
keyword, but not both. If neither is used, the destination LUN will not be
thin-provisioned.
-scrub_algorithm
If the -dm_type=scrub, this keyword specifies the method to be used for
scrubbing the LUN. If this keyword is not used with -dm_type=scrub, the
default is -scrub_algorithm=zero_clean. This keyword is ignored for all
other data migration job types
-name
Specifies the name of a data migration job group. If not used, the default value is
Group 0.
-fc_target
Specifies the source array as a Fibre Channel target.
-is_target
Specifies the source array as an iSCSI target.
-array_wwpn
Specifies the source array as a WWPN.
NOTE:
You must use either -fc_target, -is_target, or -array_wwpn to
identify the source array.
4-18 SN0054665-00 B
Add Migration
-lun_serial
Specifies the source LUN’s page 0x80 serial number.
-lun_wwuln
Specifies the source LUN’s WWULN.
-lun_tten
Specifies the source LUN’s T10 designator.
-lun_eui
Specifies the source LUN’s EUI.
-lun_naa
Specifies the LUN’s name address authority (NAA) designator.
-lun_any_wwuln
NOTE:
Do not combine the keywords -lun_wwuln, -lun_serial, -lun_tten,
-lun_number
Specifies the source LUN number.
-vpgindex
Specifies the source virtual port group.
-dmdest_fc_target
Specifies the destination array as a Fibre Channel target.
-dmdest_is_target
Specifies the destination array as an iSCSI target.
-dmdest_array_wwpn
Specifies the destination array as a WWPN.
SN0054665-00 B 4-19
Add Migration
NOTE:
You must specify either the -dmdest_fc_target,
-dmdest_is_target, or -dmdest_array_wwpn keyword to identify the
destination array.
-dmdest_lun_serial
Specifies the destination LUN’s page 0x80 serial number.
-dmdest_lun_wwuln
Specifies the destination LUN’s WWULN.
-dmdest_lun_tten
Specifies the destination LUN’s T10 designator.
-dmdest_lun_eui
Specifies the destination LUN’s EUI.
-dmdest_lun_naa
Specifies the destination LUN’s name address authority (NAA) designator.
-dmdest_lun_any_wwuln
Accepts the destination 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
NOTE:
Do not combine the -dmdest_lun_serial, -dmdest_lun_wwuln,
-dmdest_lun_tten, and -dmdest_lun_eui keywords. If any of these
keywords is used and refers to more than one LUN, the command fails and
lists all LUNs that match.
-dmdest_lun_number
Specifies the destination LUN.
-dmdest_vpgindex
Specifies the destination virtual port group.
-start_now
Specifies that the data migration job starts immediately.
-time
Specifies a future time for starting the data migration job.
4-20 SN0054665-00 B
Add Migration
-priority
Specifies that the data migration job starts as part of a serial scheduled job, and
specifies the priority.
NOTE:
You cannot combine the -start_now, -time, and -priority
keywords.
-dm_io_size
Specifies the I/O size, in kilobytes, to use for data migration. This value must be
32, 64, 128, 512, or 1024 (default is 64).
Notes This command requires router firmware version 3.3.0.0 or greater for scrubbing
LUNs and thin-provisioned destination LUNs.
Examples The following example shows the add migration command:

c:\>rcli add migration -dm_type=online -lun_number=1 -vpgindex=1
-fc_target=5001-4380-025D-A83A -dmdest_lun_number=3
-dmdest_vpgindex=1 -dmdest_fc_target=5001-4380-025D-A83A
/ip=10.0.0.12
[10.0.0.12]
Online Migration Job added successfully
SN0054665-00 B 4-21
Remove Migration
Remove Migration
Removes a data migration job from the router.
Syntax remove migration

-dm_jobid=<data migration job ID>
Keywords -dm_jobid
Specifies the data migration job to be removed.
Examples The following example shows the remove migration command:

c:\>rcli remove migration -dm_jobid=0 /ip=10.0.0.12
[10.0.0.12]
Data Migration job 0 removed successfully
4-22 SN0054665-00 B
Start Migration
Start Migration
Starts a specific data migration job, or starts jobs that have been serially
scheduled. Unless a deferred start time is specified, data migration begins
immediately.
Syntax start migration

[-dm_jobid=<data migration job ID>]
[-serial_schedule]
[-priority=<serial schedule priority in range 1 to 256>]
Keywords -dm_jobid
Required, unless the -serial_schedule keyword is used instead. Specifies
the ID of the data migration job to start either immediately or at the time specified
by the -time keyword.
-serial_schedule
Required, unless the -dm_jobid keyword is used instead. Specifies that the
highest priority serial scheduled job starts immediately. When this job finishes, the
next highest priority serial job starts. Serial jobs continue to start in sequence until
all serial jobs have been run.
NOTE:
Do not combine the -dm_jobid and -serial_schedule keywords.
You must specify at least one of these to specify whether a specific job is to
be started or that serially scheduled jobs should start running.
-time
Specifies a start time either for a serial scheduled data migration job, or for an
individual data migration job (identified by job ID).
-priority
Specifies the priority of a serial scheduled job. If used, you must combine this
keyword with the -dm_jobid keyword to ensure that the priority of the specified
job is modified before scheduling starts.
Examples The following example shows the start migration command:

c:\>rcli start migration -dm_jobid=0 /ip=10.0.0.12
Data Migration Job started OK
SN0054665-00 B 4-23
Stop Migration
Stop Migration
Stops a running data migration job.
Syntax stop migration

Keywords -dm_jobid
Specifies the ID of the data migration job to be stopped.
Examples The following example shows the stop migration command:

c:\>rcli stop migration -dm_jobid=0 /ip=10.0.0.12
Data Migration job stopped OK
4-24 SN0054665-00 B
Pause Migration
Pause Migration
Pauses a running data migration job.
Syntax pause migration

Keywords -dm_jobid
Specifies the data migration job to be paused.
Examples The following example show the pause migration command:

c:\>rcli pause migration -dm_jobid=0 /ip=10.0.0.12
Data Migration job paused OK
SN0054665-00 B 4-25
Resume Migration
Resume Migration
Resumes a paused data migration job.
Syntax resume migration

Keywords -dm_jobid
Specifies the data migration job to resume running.
Examples The following example shows the resume migration command:

c:\>rcli resume migration -dm_jobid=0 /ip=10.0.0.12
Data Migration job resumed OK
4-26 SN0054665-00 B
Acknowledge Migration
Acknowledge Migration
Removes a completed data migration job from the router. You must acknowledge
jobs to free up the destination LUN so that it can become part of another job, if
required.
For an online migration job, the dirty region logs (DRLs) are flushed to the
destination LUN before removing the job. You must ensure that host access to the
source LUN has been terminated before issuing the acknowledge migration
command.
NOTE:
To remove jobs that have not yet completed, use the remove migration
command instead (see “Remove Migration” on page 4-22).
Syntax acknowledge migration

Keywords -dm_jobid
Specifies the data migration job to be acknowledged.
Examples The following example shows the acknowledge migration command:

c:\>rcli acknowledge migration -dm_jobid=0 /ip=10.0.0.12
[10.0.0.12]
Data Migration job 0 removed successfully
SN0054665-00 B 4-27
Clear DM_Log
Clear DM_Log
Resets the data migration log on the router by deleting all previously-recorded
data migration log information.
Syntax clear dm_log
Examples The following example shows the clear dm_log command:

c:\>rcli clear dm_log
[10.0.0.12]
Log on the router successfully cleared
4-28 SN0054665-00 B
Save DM_Log
Save DM_Log
Gets data migration log data from the router and saves it to a file.
Syntax save dm_log

Keywords -file
Specifies the name of a file to receive the data migration log data. If no directory is
specified, the default is to save the log file in the working directory.
Examples The following example shows the save dm_log command:

c:\>rcli save dm_log -file=dmlogdata.dat
[10.0.0.12]
Data Migration Log saved successfully to file: "dmlogdata.dat"
SN0054665-00 B 4-29
List DM_Log
List DM_Log
Displays all data migration log data from a file or a running system, and optionally
saves output to a CSV file.
Syntax list dm_log

[-file=<data migration log file name>]
[-csv_delimiter=<delimiter for text separation in CSV file output>]
[-csv_file=<CSV output file name>]
Keywords -file
Specifies a file containing saved data migration log data. If not used, data
migration log data is obtained from the router. If no directory is specified, the
default is the current working directory.
-csv_file
Specifies the name of a file to receive comma separated text.
-csv_delimiter
If used with the -csv_file keyword, specifies the use of a delimiter other than
comma (,).
Examples The following example shows the list dm_log command:

c:\>rcli list dm_log /ip=10.0.0.12
[10.0.0.12]
2 04/09/2010 18:00:01 "Migration Job Removed" -dm_jobid=0 "HP

HSV340-0:VPG1:001 to HP HSV340-0:VPG1:003"
Source Lun ID: 1, Size = 100GB, WWuln =
6005-08B4-000D-225C-0001-C000-0020-0000
Destination Lun ID: 3, Size = 100GB, WWuln =
6005-08B4-000D-225C-0001-C000-0041-0000
Migration owner: 1 I/O Size = 64 Priority = 0
1 04/09/2010 17:56:23 "Migration Job Configured Only -- not started"

-dm_jobid=0 "HP HSV340-0:VPG1:001 to HP HSV340-0:VPG1:003"
6005-08B4-000D-225C-0001-C000-0020-0000
6005-08B4-000D-225C-0001-C000-0041-0000
4-30 SN0054665-00 B
View DM_Log
View DM_Log
Displays a limited portion of the data migration log data. A position context is
maintained in persistent data. Use the keywords to navigate to a specific range of
the data migration log data and display a limited number of entries before or after
that point.
To view the entire data migration log, use the list dm_log command instead
(see “List DM_Log” on page 4-30)
Syntax view dm_log

[-file=<data migration log file name>]
[-basepos= [ start | end] ]
[-offset=<number of data migration log entries from base position>]
[-previous=<number of entries to print after last offset>]
[-next=<number of entries to print before last offset>]
Keywords -file
Specifies the name of a previously saved log data file. The default value is saved
in persistent data. If no directory is specified, the default file location is the current
working directory.
-basepos
Optional (required if -offset is used). Specifies the base position after
processing this command.
-offset
Specifies the offset position after processing this command.
NOTE:
The values of the -basepos and -offset keywords are saved in
persistent data as the starting point for the next use of this command. For
example, you can use this command either to display ten log entries at a
time going back from the end of the log, or to repeatedly search back
through the log for the text of a specific error message. If -basepos is
used without -offset, the offset defaults to zero. If -offset is used,
-basepos is also required.
-time
This option allows searching for an entry with a timestamp older than the specified
time, starting after -basepos and -offset have been evaluated and going in
the previous direction.
SN0054665-00 B 4-31
View DM_Log
-previous
Specifies the number of data migration log entries after all positioning keywords
have been evaluated.
-next
Specifies the number of data migration log entries before all positioning keywords
have been evaluated.
NOTE:
If neither the -next nor -previous keywords are used, the last
specified value is obtained from persistent data. The initial default is 20 log
entries. Setting -previous=-1 or -next=-1 causes display of all
entries before or after the current position in the log after evaluating the
-basepos, -offset, and -time keywords. If these two keywords are
combined, the display output contains some duplicate content, first -next,
and then -previous log entries.
Examples The following example shows the view dm_log command used to display the
last two entries in the current log on the router:
c:\>rcli view dm_log -basepos=end -previous=20 /ip=10.0.0.12
[10.0.0.12]
2 04/09/2010 18:00:01 "Migration Job Removed" -dm_jobid=0 "HP

HSV340-0:VPG1:001 to HP HSV340-0:VPG1:003"
6005-08B4-000D-225C-0001-C000-0020-0000
6005-08B4-000D-225C-0001-C000-0041-0000
1 04/09/2010 17:56:23 "Migration Job Configured Only -- not started"

-dm_jobid=0 "HP HSV340-0:VPG1:001 to HP HSV340-0:VPG1:003"
6005-08B4-000D-225C-0001-C000-0020-0000
6005-08B4-000D-225C-0001-C000-0041-0000
4-32 SN0054665-00 B
Report DM_Log
Report DM_Log
Retrieves data migration log data from the router and saves a formatted text
report to a file.
Syntax report dm_log

[-file=<report file name>]
Keywords -file
Specifies the file name to receive the report text. If not used, the report is
displayed on the console.
Examples The following example shows the report dm_log command:

c:\>rcli report dm_log -file=logreport.txt
SN0054665-00 B 4-33
Save DM_Report
Save DM_Report
Creates a file that contains data migration job reports for the router.
Syntax save dm_report

Keywords -file
Specifies the name of the file to be created. If the specified file name does not end
with .tar.gz, this command appends .tar.gz to the file name. If you do not
specify a directory, the file is saved in the current working directory.
Notes  This command is not supported for iSR61xx routers.

Examples The following examples show the save dm_report command:

c:\>rcli save dm_report -file=dmjobreport.tar.gz
Data Migration Job Report file saved successfully
c:\>rcli save dm_report -file=c:\temp\dmjobreport.tar.gz

c:\>rcli save dm_report -file=/home/admin/dmjobreport.tar.gz

4-34 SN0054665-00 B
A API Error Codes
Table A-1 lists alphabetically the errors that the API may return when parsing the
retval command input or producing command output. For command
description, syntax, keywords, and examples, see “RetVal” on page 3-127.
NOTE:
 Error codes that start with QAPI_E_ indicate a problem that prevented
the command from working.
 Error codes that start with QAPI_S_ indicate that the command
succeeded, but with the specified warning.
Table A-1. API Error Codes Returned by RetVal
Error Description
QAPI_E_BROADCAST_FAILED Could not broadcast to find routers.
QAPI_E_BUFFER_TOO_SMALL User-supplied buffer cannot hold all of the data to

be returned.
QAPI_E_CANNOT_ADD_SELF_AS_LOCAL_ IP address supplied for adding as a local peer is

PEER the same as this router.
QAPI_E_CANNOT_DISABLE_VPGROUP_1 Attempt to disable the first VP Group is not allowed
QAPI_E_CMD_NOT_SUPPORTED Command not supported.
QAPI_E_CONNECTION_FAILED Could not connect to router.
QAPI_E_ERROR = 100 Generic error.
QAPI_E_FAILED_SECURITY_CHECK Failed security check.
QAPI_E_FEATURE_ALREADY_PRESENT Feature already present.
QAPI_E_FEATURE_KEY_INVALID Feature key invalid.
QAPI_E_FILE_READ_ERROR Restore operation failed because the file could not

read.
SN0054665-00 B A-1
A–API Error Codes
Table A-1. API Error Codes Returned by RetVal (Continued)
Error Description
QAPI_E_FILE_WRITE_ERROR Save operation failed because the file could not be

written.
QAPI_E_FW_UPGRADE_FILE_OPEN_ERROR Unable to open the specified image file for firm-

ware upgrade.
QAPI_E_FW_UPGRADE_FILE_READ_ERROR Unable to read image data from the specified firm-

ware image file.
QAPI_E_FW_UPGRADE_NOT_COMPLETE Firmware upgrade not complete.
QAPI_E_GET_ISNS_ERROR Get the ISNS error.
QAPI_E_INVALID_ACCESS_TYPE LUN access type must be in the valid range for

PLunInfo::LUN_ACCESS_TYPE.
QAPI_E_INVALID_APPLICATION_ID To use this API function, customers and VARs who
must obtain an application ID from QLogic.
QAPI_E_INVALID_CLIENT_HANDLE A management client has registered for exclusive

access, therefore a session handle is required.
This error indicates the session handle was not
provided or that it is not valid. If the session handle
is no longer available, unregistration can be
forced.
QAPI_E_INVALID_CONNECTION_COUNT The remote bridge already has the maximum num-

ber of connections allowed.
QAPI_E_INVALID_DM_IO_SIZE Invalid data migration I/O size.
QAPI_E_INVALID_DM_JOB_TYPE Use QRouter::addScrubLunJob() to add

a scrub LUN job.
QAPI_E_INVALID_DM_SCHED_TYPE Data migration schedule type must be either start

now or manual start.
QAPI_E_UNKNOWN_ERROR Error status received from router does not corre-

spond to a QAPI_RETURN value.
QAPI_S_ALREADY_EXISTS Attempted to add something that was already

there; okay to ignore.
QAPI_S_INVALID_QROUTER_FOUND ValidateRouterList( ) removed one or

more QLogic routers from the list because they
could not connect.
A-2 SN0054665-00 B
A–API Error Codes
Table A-1. API Error Codes Returned by RetVal (Continued)
Error Description
QAPI_S_IPV4_MANAGEMENT_PORT_ If the call that disabled the IPv4 management port

SUCCESSFULLY_DISABLED was made using the current IPv4 management
port, no reconnect is possible. Call
validateRouterList( ) to remove from
the list the QLogic routers that cannot connect.
QAPI_S_IPV6_MANAGEMENT_PORT_ If the call that disabled the IPv6 management port

SUCCESSFULLY_DISABLED was made using the current IPv6 management
port, no reconnect is possible. Call
validateRouterList( ) to remove from
the list the QLogic routers that cannot connect.
QAPI_S_IPV6_NOT_SUPPORTED IPv4 features are correct, but IPv6 is not supported

by this device.
QAPI_S_NO_OFFLINE_DM_FOR_MASKED_ Migration job added successfully, but the source

LUN and destination LUNs must be unmasked before
the job can start. (Offline data migration cannot be
done if the source or destination LUN is masked.)
QAPI_S_NO_ONLINE_DM_FOR_MASKED_ Migration job added successfully, but the destina-

DEST_LUN tion LUN must be unmasked before the job can
start. (Online data migration cannot be done if the
destination LUN is masked.)
QAPI_S_ONLINE_TARGET_WITH_NO_DM_ Online target successfully unmapped; however,

JOBS_UNMAPPED there is a risk of users losing access to data.
QAPI_S_OPERATION_INPROGRESS Acknowledging job. Job will be removed after syn-

chronization is complete.
QAPI_S_REBOOT_REQUIRED Firmware upload completed successfully. Reboot

required.
QAPI_S_RECONNECT_FAILED Could not reconnect to router after changing the

management port address.
QAPI_S_TIMEOUT_NO_ROUTERS_FOUND Attempt to find routers timed out; none found.
SN0054665-00 B A-3
A–API Error Codes
A-4 SN0054665-00 B
Glossary
bandwidth CSV file

A measure of the volume of data that can Comma separated values file. A data file
be transmitted at a given transmission used for storage of data structured in a
rate. A 1-Gbps/2-Gbps Fibre Channel port table form. Each line in the file corre-
can transmit or receive at nominal rates of sponds to a row in the table. Within a line,
1- or 2-Gbps, depending on the device to fields are separated by commas, each field
which it is connected. This corresponds to belonging to one table column.
actual bandwidth values of 106 MB and
212 MB, respectively. device
A target, typically a disk drive. Hardware
CHAP such as a disk drive, tape drive, printer, or
Challenge-handshake authentication keyboard that is installed in or connected
protocol (CHAP) is used for remote logon, to a system. In Fibre Channel, a target
usually between a client and server or a device.
Web browser and Web server. A
challenge/response is a security mecha- DHCP
nism for verifying the identity of a person Dynamic host configuration protocol.
or process without revealing a secret Enables computers on an IP network to
password that is shared by the two extract their configuration from servers
entities. Also referred to as a” three-way that have information about the computer
handshake.” only after it is requested.
CLI dynamic host configuration protocol

Command line interface. A program inter- See DHCP.
face driven by entering commands and
parameters. Ethernet
The most widely used LAN technology that
comma separated values file transmits information between computer,
See CSV file. typically at speeds of 10 and 100 million
bits per second (Mbps).
command line interface
See CLI. EUI
Extended unique identifier. Part of the
numbering spaces, managed by the IEEE,
commonly used for formulating a MAC
address.
SN0054665-00 B Glossary-1
User’s Guide
extended unique identifier gigabit Ethernet

See EUI. See GbE.
FC initiator
See Fibre Channel. System component, such as a network
interface card, that originates an I/O
FCoE operation.
Fibre Channel over Ethernet. A new
technology defined by the T11 standards Internet Protocol
body that allows traditional Fibre Channel See IP.
storage networking traffic to travel over an
Ethernet link by encapsulating Fibre Internet simple name service
Channel frames inside Layer 2 Ethernet See iSNS.
frames. For more information, visit
www.fcoe.com. Internet small computer system interface
See iSCSI.
Fibre Channel
A high-speed serial interface technology IP
that supports other higher layer protocols Internet Protocol. A method by which data
such as SCSI and IP. is sent from one computer to another over
the Internet. IP specifies the format of
Fibre Channel over Ethernet packets, also called datagrams, and the
See FCoE. addressing scheme.
field replaceable unit IPv4

See FRU. Internet protocol version 4. A data-oriented
protocol used on a packet switched inter-
frame network (Ethernet, for example). It is a
Data unit consisting of a start-of-frame best-effort delivery protocol: it does not
(SOF) delimiter, header, data payload, guarantee delivery, ensure proper
CRC, and an end-of-frame (EOF) delim- sequencing, or avoid duplicate delivery.
iter. These aspects are addressed by an upper
layer protocol (TCP, and partly by UDP).
FRU IPv4 does, however, provide data integrity
Field replaceable unit. Component that protection through the use of packet
can be replaced in the field upon failure. checksums.
GbE IPv6
Gigabit Ethernet is a term describing Internet protocol version 6. Next-genera-
various technologies for transmitting tion version of IP that, among other things,
Ethernet frames at a rate of a gigabit per lengthens the IP address from 32 bits to
second, as defined by the IEEE 128 bits.
802.3-2008 standard.
Glossary-2 SN0054665-00 B
User’s Guide
iSCSI maximum transmission unit

Internet small computer system interface. See MTU.
Protocol that encapsulates data into IP
packets to send over Ethernet connec- MTU
tions. Maximum transmission unit. Refers to the
size (in bytes) of the largest packet (IP
iSNS datagram) that a specified layer of a
Internet simple name service is used for communications protocol can transfer.
discovery and management of IP-based
SANs. network time protocol
See NTP.
jumbo frames
Large IP frames used in high-performance NTP
networks to increase performance over Network time protocol. NTP is used for
long distances. Jumbo frames generally distributing the Coordinated Universal
means 9,000 bytes for Gigabit Ethernet, Time (UTC) by means of synchronizing the
but can refer to anything over the IP MTU, clocks of computer systems over
which is 1,500 bytes on an Ethernet. packet-switched, variable-latency data
networks.
load balancing
Adjusting components to spread demands path
evenly across a system’s physical A path to a device is a combination of a
resources, and thereby optimizing perfor- adapter port instance and a target port as
mance. Load balancing can be done distinct from internal paths in the fabric
manually or programmatically. network. A fabric network appears to the
operating system as an opaque network
logical unit number between the adapter (initiator) and the
See LUN. target.
Because a path is a combination of an
LUN
adapter and a target port, it is distinct from
Logical unit number, a subdivision of a another path if it is accessed through a
SCSI target. It is the small integer handle different adapter and/or it is accessing a
that differentiates an individual disk drive different target port. Consequently, when
or partition (volume) within a common switching from one path to another, the
SCSI target device such as a disk array. driver might be selecting a different
Technically, a LUN can be a single adapter (initiator), a different target port, or
physical disk drive, multiple physical disk both.
drives, or a portion (volume) of a single This is important to the driver when
physical disk drive. However, LUNs are selecting the proper method of failover
typically not entire disk drives but rather notification. It can make a difference to the
virtual partitions (volumes) of a RAID set. target device, which might have to take
Using LUNs, the Fibre Channel host can different actions when receiving retries of
address multiple peripheral devices that the request from another initiator or on a
may share a common controller. different port.
User’s Guide
ping RPC
A computer network administration utility Remote procedure call. A protocol used by
used to test whether a specified host is a program to request a service from a
reachable across an IP network, and to program located in another computer in a
measure the round-trip time for packets network. RPC uses the client/server
sent from the local host to a destination model.
computer.
SAN
point-to-point Storage area network. Multiple storage
Also FC-P2P. Two Fibre Channel nodes units (disk drives) and servers connected
directly connected (not in a loop). by networking topology.
port SCSI
Access points in a device where a link Small computer system interface. A
attaches. There are four types of ports, as high-speed interface used to connect
follows: devices, such as hard drives, CD drives,
 N_Port—a Fibre Channel port that printers, and scanners, to a computer. The
supports point-to-point topology. SCSI can connect many devices using a
single controller. Each device is accessed
 NL_Port—a Fibre Channel port that
by an individual identification number on
supports loop topology.
the SCSI controller bus.
 FL_Port—a port in a fabric where an
N_Port can attach. Secure Shell
 FL_Port—a port in a fabric where an See SSH.
NL_Port can attach.
simple network management protocol
port instance See SNMP.
The number of the port in the system.
Each adapter may have one or multiple small computer system interface
ports, identified with regard to the adapter See SCSI.
as port 0, port 1 and so forth. To avoid
confusion when dealing with a system SNMP
containing numerous ports, each port is Simple network management protocol.
assigned a port instance number when the SNMP is a networking protocol that
system boots up. So Port 0 on an adapter enables you to monitor the router using
might have a port instance number of 8, third-party applications that use SNMP.
for example, if it is the eighth port discov-
ered by the system. SSH
Secure Shell. Protocol that secures
remote procedure call connections to the switch for the command
See RPC. line interface.
router log storage area network

Log of messages describing events that See SAN.
occur on the intelligent storage router.
User’s Guide
target VLAN
The storage-device endpoint of a SCSI Virtual logical area network (LAN). A group
session. Initiators request data from of hosts with a common set of require-
targets. Targets are typically disk-drives, ments that communicate as if they were
tape-drives, or other media devices. attached to the same wire, regardless of
Typically a SCSI peripheral device is the their physical location. Although a VLAN
target but an adapter may, in some cases, has the same attributes as a physical LAN,
be a target. A target can contain many it allows for end stations to be grouped
LUNs. together even if they are not located on the
A target is a device that responds to a same LAN segment. VLANs enable
requested by an initiator (the host system). network reconfiguration through software,
Peripherals are targets, but for some instead of physically relocating devices.
commands (for example, a SCSI COPY
VPG
command), the peripheral may act as an
initiator. Virtual port group. VPG is the Remote CLI
software component used to create
TCP additional logical Fibre Channel adapter
Transmission control protocol. A set of initiator ports on the fabric.
rules to send data in packets over the
VPN
Internet protocol.
Virtual private network. A method of using
Telnet the Internet to provide secure remote
A network protocol used on the Internet or access to a network.
local area network (LAN) connections.
world wide node name
Telnet provides access to a command line
interface (CLI) on a remote machine. See WWNN.
transmission control protocol world wide port name

See TCP. See WWPN.
virtual logical area network world wide unique LUN name

See VLAN. See WWULN.
virtual port group WWNN

See VPG. World wide node name. A unique 64-bit
address assigned to a device.
virtual private network
WWPN
See VPN.
World wide port name. A unique 64-bit
address assigned to each port on a
device. One WWNN may contain multiple
WWPN addresses.
User’s Guide
WWULN
World wide unique LUN name. WWULN
identifiers for SCSI devices are read from
page 83 and page 80 of your SCSI block
device as based on the SCSI standard.
SANsurfer looks for identifiers in the order
of: page 83 type 3, page 83 type 2, page
83 type 1, page 80, and lastly page 83
type 0.
Index
Symbols B
? command 3-42 bandwidth
definition of Glossary-1
storage array, specifying 3-10
A beacons
flashing, disabling 3-13
abbreviating keywords 1-5 flashing, enabling 3-14
acknowledge migration command 4-27 binary output data 2-2
acknowledging data migration job 4-27 -blade keyword 2-1
add dm_group command 4-12 blade, specifying primary or secondary 2-1
add dml command 4-6 broadcasting to discover routers 3-129
add fcip_route command 3-20
add initiator command 3-51
add lunmask command 3-86 C
add migration command 4-17
add notification command 3-99 capturing router diagnostics to file 3-78
adding challenge-handshake authentication protocol,
data management LUN 4-6 See CHAP
data migration job 4-17 changing
data migration job group 4-12 FCIP route 3-22
FCIP route 3-20 initiators 3-53
initiators known to router 3-51 notification profile 3-101
LUN masks known to router 3-86 router password 3-107
notification profile 3-99 CHAP
agreements, license xiii definition of Glossary-1
API enabling for iSCSI initiator 3-52
error codes list A-1 enabling for iSCSI port 3-62
version, viewing 3-130 password for iSCSI initiator 3-52
arrays, See storage arrays password for iSCSI port 3-62
audience for guide xi chassis
blade, specifying 2-1
information, displaying 3-15
name, setting 3-16
clear display command 3-18
clear dm_log command 4-28
clear log command 3-71
SN0054665-00 B Index-1
User’s Guide
clearing commands (continued)

console display 3-18 list dm_log 4-30
data migration log 4-28 list initiator 3-48
router log 3-71 list log 3-73
CLI list lun 3-79
command line syntax 1-4 list migration 4-14
command reference 3-1, 4-1 list presented 3-134
definition of Glossary-1 list target 3-131
input persistence 1-5 list vlan 3-144
keywords, abbreviating 1-5 list vp_group 3-147, 3-148
keywords, general 2-1 login iscsi_target 3-67
usage, general 1-4 logout iscsi_target 3-68
comma separated values file, See CSV file map target 3-137
command line interface, See CLI merge csv 3-17
command line scripting 1-2, 3-109, 3-110, modify fcip_route 3-22
3-112 modify initiator 3-53
command line syntax 1-4 modify notification 3-101
commands pause migration 4-25
? 3-42 ping system 3-120
acknowledge migration 4-27 reboot system 3-122
add dml 4-6 remove array 3-12
add fcip_route 3-20 remove dm_group 4-13
add initiator 3-51 remove dml 4-8
add lunmask 3-86 remove fcip_route 3-25
add migration 4-17 remove initiator 3-55
add notification 3-99 remove lunmask 3-89
clear display 3-18 remove migration 4-22
clear dm_log 4-28 remove notification 3-103
clear log 3-71 remove target 3-132
connect 3-128 report dm_log 4-33
disable beacon 3-13 report log 3-77
disable fc_port 3-31 rescan system 3-125
disable io_statistics 3-46 reset_factory system 3-126
disable iscsi_port 3-57 resume migration 4-26
discover iscsi_target 3-66 retval system 3-127
enable beacon 3-14 save capture_file 3-78
enable fc_port 3-30 save dm_log 4-29
enable iscsi_port 3-56 save dm_report 4-34
execute script 3-109 save log 3-72
find 3-129 save script 3-112
generate script 3-110 set append 3-7
help 3-41 set array 3-10
list array 3-8 set chassis 3-16
list dm_group 4-10 set fc 3-33
Index-2 SN0054665-00 B
User’s Guide
commands (continued) commands (continued)

set fc_adv 3-35 show time 3-141
set features 3-29 show vlan 3-145
set is_adv 3-62 start migration 4-23
set iscsi 3-59 stop migration 4-24
set isns 3-70 test notification 3-104
set mgmt 3-93 tracert system 3-121
set notification 3-96 unmap target 3-139
set ntp 3-106 update firmware 3-38
set password 3-107 version system 3-130
set snmp 3-114 view dm_log 4-31
set system 3-118 view log 3-74
set time 3-142 wait time 3-143
set vlan 3-146 configuration
set vp_group 3-149 FRU, restoring 3-40
show append 3-6 FRU, saving 3-39
show array 3-9 configuring
show chassis 3-15 data migration job 4-17
show dm_group 4-11 Fibre Channel link rate 3-33
show dml 4-3 Fibre Channel parameters 3-35
show fc 3-32 iSNS address and TCP port 3-70
show fc_adv 3-34 management port address 3-93
show fc_statistics 3-37 notification profile 3-99
show fcip_route 3-19 notifications 3-96
show fcip_statistics 3-26 port, iSCSI 3-59, 3-62
show features 3-28 system information 3-118
show initiator 3-49 VLAN 3-146
show io_statistics 3-43 connect command 3-128
show iscsi 3-58 connection
show iscsi_adv 3-61 RPC, verifying 3-128
show iscsi_statistics 3-64 VPN 1-6
show isns 3-69 console display, clearing 3-18
show lun 3-80 contacting QLogic xiv
show lunmask 3-83 controlling access 1-6
show mgmt 3-92 conventions used in guide xii
show migration 4-15 countdown delay for scripts 3-143
show notification 3-95 creating
show ntp 3-105 file of binary output data 2-2
show performance 3-108 keyword sets 3-7
show presented 3-135 text file 2-3
show snmp 3-113 CSV file
show status 3-116 creating for LUN and port usage 3-17
show system 3-117 definition of Glossary-1
show target 3-133 saving data migration info to 4-30
SN0054665-00 B Index-3
User’s Guide
D deleting (continued)
keyword sets 3-7
.dat files, creating 2-2 LUN masks known to router 3-89
data management LUN notification profile 3-103
adding 4-6 offline target 3-132
deleting 4-8 router log info 3-71
details, viewing 4-3 storage array, offline 3-12
data migration job groups device
adding new 4-12 definition of Glossary-1
detailed information, displaying 4-11 path, initiator 3-49
list of, displaying 4-10 DHCP
removing 4-13 definition of Glossary-1
data migration jobs enabling for IPv4 management port 3-93
acknowledging 4-27 diagnostics, capturing router info to file 3-78
adding new 4-17 disable beacon command 3-13
deleting 4-22 disable fc_port command 3-31
detailed information, displaying 4-15 disable io_statistics command 3-46
pausing 4-25 disable iscsi_port command 3-57
report, saving to file 4-34 disabling
resuming 4-26 beacons 3-13
starting 4-23 I/O statistics for LUNs 3-46
stopping 4-24 port, Fibre Channel 3-31
viewing all 4-14 port, iSCSI 3-57
data migration log discover iscsi_targets command 3-66
See Also router log discovering
clearing 4-28 iSCSI targets 3-66
displaying all data 4-30 routers, single or all 3-129
displaying portion of 4-31 displaying
retrieving from router 4-33 chassis information 3-15
saving to file 4-29, 4-30, 4-33 data migration jobs, all 4-14
data migration service data migration jobs, details 4-15
command reference 4-1 data migration log (all) 4-30
password, providing 2-1 data migration log (portion of) 4-31
prerequisites for 4-1 DML details 4-3
default blade 2-1 FCIP routes 3-19
definitions of terms Glossary-1 FCIP statistics 3-26
deleting Fibre Channel port information 3-32, 3-34
array, offline 3-12 I/O statistics for LUNs 3-43
data management LUN 4-8 initiator names 3-48
data migration job 4-22 iSCSI port information 3-58, 3-61
data migration job group 4-13 iSNS information 3-69, 3-70
data migration log entries 4-28 keyword sets 3-6
FCIP route 3-25 LUN details 3-80
initiators 3-55 LUN mask details 3-83
Index-4 SN0054665-00 B
User’s Guide
displaying (continued) example script files 1-3

LUNs known to router 3-79 execute script command 3-109
NTP information 3-105 executing
performance data 3-108 list of commands from file 3-109
presented target details for single 3-135 script files 1-3
presented targets list 3-134 execution throttle, specifying 3-35
router log data (all) 3-73 extended unique identifier, See EUI
router log data (limited) 3-74
router status information 3-116
storage array details 3-9 F
storage array names 3-8
system information 3-117 factory default configuration, restoring 3-126
target details for single 3-133 FCIP routes
target names known to router 3-131 adding 3-20
time, current on router 3-141 displaying 3-19
version of Remote CLI 3-130 modifying 3-22
dm_group command 4-12 removing 3-25
-dmpw keyword 2-1 statistics, displaying 3-26
documentation conventions xii FCoE
dynamic host configuration protocol, See definition of Glossary-2
DHCP initiator attribute, setting 3-51
features, licensed
displaying 3-28
E enabling 3-29
Fibre Channel over Ethernet, See FCoE
enable beacon command 3-14 Fibre Channel port
enable fc_port command 3-30 disabling 3-31
enable iscsi_port command 3-56 enabling 3-30
enabling information, displaying 3-32, 3-34
beacons 3-14 link rate, setting 3-33
port, Fibre Channel 3-30 parameters, configuring 3-35
port, iSCSI 3-56 Fibre Channel ports
error codes, API A-1 statistics, viewing 3-37
error messages, saving to file 2-3 field replaceable unit, See FRU
Ethernet file
connection, performing router management creating with binary data output 2-2
tasks through 1-4 saving output to 2-3
definition of Glossary-1 find command 3-129
EUI finding routers, single or all 3-129
data migration job 4-19, 4-20 firmware
definition of Glossary-1 requirements, minimum 1-1, 4-1
I/O statistics 3-43, 3-46 restarting 3-122
LUN details 3-80 updating 3-38
LUN mask 3-83, 3-87, 3-90
SN0054665-00 B Index-5
User’s Guide
flashing LEDs initiators

disabling 3-13 adding 3-51
enabling 3-14 definition of Glossary-2
frame details, viewing 3-49
definition of Glossary-2 names, displaying all 3-48
size, specifying for Fibre Channel port 3-35 OS type, changing 3-51, 3-53
FRU removing 3-55
configuration, restoring 3-40 input persistence 1-5
configuration, saving 3-39 installing Remote CLI 1-1
definition of Glossary-2 instance (port), definition of Glossary-4
image, saving 1-3 intended audience for guide xi
Internet protocol version 4, See IPv4
Internet protocol version 6, See IPv6
G Internet Protocol, definition of Glossary-2
Internet simple name service, See iSNS
GbE Internet small computer system interface, See
definition of Glossary-2 iSCSI
port, FCIP route 3-20 -ip keyword 2-2
port, pinging through 3-120 IP, definition of Glossary-2
general keywords 2-1 IPv4
generate script command 3-110 address, for NTP server 3-106
generating a script text file 1-2, 3-110 definition of Glossary-2
getting started 1-1 management port address, configuring 2-2,
gigabit Ethernet, See GbE 3-93
glossary of terms Glossary-1 VLANs, configuring 3-146
GMT, setting for router 3-142 IPv6
management port address, configuring 2-2,
H 3-93
VLANs, configuring 3-146
help iSCSI, definition of Glossary-3
getting assistance with command syntax iSCSI ports
and keywords 2-1
configuring 3-59, 3-62
obtaining 1-1
disabling 3-57
help command 3-41
enabling 3-56
-help keyword 2-1
information, displaying 3-58, 3-61
statistics, viewing 3-64
iSCSI targets
I discovering 3-66
I/O statistics logging into 3-67
disabling 3-46 logging out of 3-68
displaying 3-43
Index-6 SN0054665-00 B
User’s Guide
iSNS list dm_group command 4-10

definition of Glossary-3 list dm_log command 4-30
information, configuring 3-70 list initiator command 3-48
information, enabling 3-70 list log command 3-73
information, showing 3-69 list lun command 3-79
list migration command 4-14
list presented command 3-134
J list target command 3-131
list vlan command 3-144
job report, saving to file 4-34 list vp_group command 3-147, 3-148
jumbo frames listing, See displaying
definition of Glossary-3 load balancing
MTU size for iSCSI port 3-62 definition of Glossary-3
enabling for array 3-10
local time, setting for router 3-142
K logging into iSCSI target 3-67
keyword sets logging out of iSCSI target 3-68
creating, replacing, or deleting 3-7 logical unit number, See LUN
displaying 3-6 login iscsi_target command 3-67
keywords, abbreviating 1-5 logout iscsi_target command 3-68
keywords, general 2-1 logs, See router logs and data migration logs
-blade 2-1 loop, specifying as connection option 3-35
-dmpw 2-1 LUN masks
-help 2-1 adding names known to router 3-86
-ip 2-2 adding with script 3-110
-pw 2-2 details for single, displaying 3-83
-quiet 2-2 removing from list known to router 3-89
-result 2-2 LUNs
-textfile 2-3 adding with script 3-110
knowledge database, QLogic xiv definition of Glossary-3
details for single, displaying 3-80
I/O statistics, disabling 3-46
L I/O statistics, displaying 3-43
listing names known to router 3-79
LEDs rescanning system 3-125
flashing, disabling 3-13 usage, output to CSV file 3-17
flashing, enabling 3-14
license agreements xiii
licensed features M
data migration service 4-1
displaying available 3-28 management port address
enabling 3-29 configuring 2-2, 3-93
list array command 3-8 displaying 3-92
SN0054665-00 B Index-7
User’s Guide
map target command 3-137 P

mapping targets to ports 3-137
maximum transmission unit, See MTU password
merge csv command 3-17 access control 1-6
minimum firmware requirements 1-1, 4-1 data migration, providing 2-1
modifiers, See keywords iSCSI initiator 3-52
modify fcip_route command 3-22 protection, controlling access 1-6
modify initiator command 3-53 providing for RPC 2-2
modify notification command 3-101 router, changing 3-107
modifying, See changing path, definition of Glossary-3
MTU pause migration command 4-25
definition of Glossary-3 pausing data migration job 4-25
size for FCIP route 3-21 performance data, viewing 3-108
size for iSCSI port 3-23, 3-62 persistent data 1-5
physical security 1-6
ping
N definition of Glossary-4
issuing through management or GbE port
network time protocol, See NTP 3-120
notifications ping system command 3-120
configuring 3-96 pinging system 3-120
profile, adding 3-99 point-to-point
profiles, changing 3-101 connection option, specifying 3-35
profiles, deleting 3-103 definition of Glossary-4
profiles, listing 3-95 ports
profiles, testing 3-104 See also ports, Fibre Channel 2-2
NTP See also ports, iSCSI 2-2
definition of Glossary-3 address management 2-2
displaying information 3-105 definition of Glossary-4
server, configuring 3-106 instance, definition of Glossary-4
mapping to targets 3-137
statistics, viewing for Fibre Channel 3-37
O statistics, viewing for iSCSI 3-64
tracing to IP address 3-121
offline storage array, removing 3-12
unmapping to targets 3-139
offline target, deleting 3-132
usage, output to CSV file 3-17
OS type
virtual port groups, displaying info for all
changing for initiator 3-53 3-147, 3-149
specifying for initiator 3-51 virtual port groups, displaying info for single
3-148
VLAN, displaying info for all 3-144
VLAN, displaying info for single 3-145
Index-8 SN0054665-00 B
User’s Guide
ports, Fibre Channel remove dm_group command 4-13

configuring 3-35 remove dml command 4-8
disabling 3-31 remove fcip_route command 3-25
enabling 3-30 remove initiator command 3-55
information, displaying 3-32, 3-34 remove lunmask command 3-89
link rate, setting 3-33 remove migration command 4-22
ports, iSCSI remove notification command 3-103
configuring 3-59, 3-62 remove target command 3-132
disabling 3-57 removing, See deleting
enabling 3-56 replacing keyword sets 3-7
information, displaying 3-58, 3-61 report dm_log command 4-33
preface xi report log command 3-77
prerequisites for using data migration report text
commands 4-1 formatted log data, saving to file 3-77
presented targets router diagnostics, saving to file 3-78
details, displaying for single 3-135 requirements, firmware 1-1, 4-1
listing names of 3-134 rescan system command 3-125
primary router blade, specifying 2-1 rescanning LUNs 3-125
profiles reset_factory system command 3-126
deleting 3-103 resetting
listing 3-95 router factory default configuration 3-126
notification, changing 3-101 router logs 3-71
testing 3-104 restarting
-pw keyword 2-2 data migration job 4-26
firmware program 3-122
restoring
Q FRU configuration 3-40
router factory default configuration 3-126
QLogic
-result keyword 2-2
contacting xiv
resume migration command 4-26
knowledge database xiv
resuming data migration job 4-26
technical support xiii
retrieving data migration log data 4-33
training xiii
return value, viewing 3-127
-quiet keyword 2-2
retval system command 3-127
router
password, changing 3-107
R port address, specifying 2-2
read community, configuring 3-114 router log
reboot system command 3-122 See Also data migration log
rebooting firmware program 3-122 clearing 3-71
related materials xii definition of Glossary-4
remote procedure call, See RPC displaying data (all) 3-73
remove array command 3-12 displaying data (limited) 3-74
SN0054665-00 B Index-9
User’s Guide
router log (continued) security

saving data to file 3-72, 3-77 controlling access 1-6
saving diagnostic data to file 3-78 physical connections 1-6
routes serial number, LUN
FCIP, adding 3-20 data migration job 4-19, 4-20
FCIP, modifying 3-22 I/O statistics 3-43, 3-46
FCIP, removing 3-25 LUN details 3-80
RPC LUN mask 3-83, 3-87, 3-90
connection, verifying 3-128 set append command 3-7
definition of Glossary-4 set array command 3-10
password, changing 3-107 set chassis command 3-16
password, providing 2-2 set fc command 3-33
set fc_adv command 3-35
set features command 3-29
S set is_adv command 3-62
set iscsi command 3-59
sample script files 1-3 set isns command 3-70
SAN, definition of Glossary-4 set mgmt command 3-93
save capture_file command 3-78 set notification command 3-96
save dm_log command 4-29 set ntp command 3-106
save dm_report command 4-34 set password command 3-107
save log command 3-72 set snmp command 3-114
save script command 3-112 set system command 3-118
saving set time command 3-142
data migration job report 4-34 set vlan command 3-146
data migration log to file 4-30, 4-33 set vp_group command 3-149
data migration logs 4-29 setting, See configuring
FRU configuration 3-39 show append command 3-6
output to text file 2-3 show array command 3-9
router diagnostic information to file 3-78 show chassis command 3-15
router log data to file 3-72, 3-77 show dm_group command 4-11
script text file 1-3, 3-112 show dml command 4-3
scanning LUNs again 3-125 show fc command 3-32
script files show fc_adv command 3-34
examples included 1-3 show fc_statistics command 3-37
examples of 1-2 show fcip_route command 3-19
executing 1-3 show fcip_statistics command 3-26
generating 1-2, 3-110 show features command 3-28
saving 1-3 show initiator command 3-49
timer countdown for 3-143 show io_statistics command 3-43
scripting, command line 1-2 show iscsi command 3-58
SCSI, definition of Glossary-4 show iscsi_adv command 3-61
secondary router blade, specifying 2-1 show iscsi_statistics command 3-64
Secure Shell, See SSH show isns command 3-69
Index-10 SN0054665-00 B
User’s Guide
show lun command 3-80 system

show lunmask command 3-83 LUNs, rescanning 3-125
show mgmt command 3-92 pinging 3-120
show migration command 4-15 return value 3-127
show notification command 3-95 system information
show ntp command 3-105 configuring 3-118
show performance command 3-108 displaying 3-117
show presented command 3-135
show snmp command 3-113
show status command 3-116 T
show system command 3-117
show target command 3-133 T10 designator
show time command 3-141 data migration job 4-19, 4-20
show vlan command 3-145 I/O statistics 3-43, 3-46
small computer system interface, See SCSI LUN details 3-80
SNMP LUN mask 3-83, 3-87, 3-90
definition of Glossary-4 targets
information, displaying 3-113 definition of Glossary-5
parameters, configuring 3-114 details, displaying for single 3-133
SSH iSCSI, discovering 3-66
definition of Glossary-4 iSCSI, logging into 3-67
enabling for router 3-118 iSCSI, logging out of 3-68
start migration command 4-23 LUNs, rescanning 3-125
starting data migration job 4-23 mapping to port 3-137
statistics names known to router, displaying 3-131
Fibre Channel ports, viewing 3-37 offline, deleting 3-132
iSCSI port, viewing 3-64 presented, displaying details for single 3-135
status information for router, viewing 3-116 presented, listing 3-134
stop migration command 4-24 unmapping from port 3-139
stopping TCP
data migration job 4-24 definition of Glossary-5
storage area network, See SAN port, configuring for FCIP route 3-21
storage arrays port, configuring iSNS 3-70
attributes, setting 3-10 window size for iSCSI port 3-21, 3-62
details, displaying 3-9 technical support xiii
known to router, displaying 3-8 Telnet
LUNs, adding with script 3-110 definition of Glossary-5
offline, removing 3-12 enabling for router 3-118
summary help, displaying 3-41, 3-42 terms and definitions Glossary-1
support, technical xiii test notification command 3-104
suppressing text output 2-2 testing notification profile 3-104
symbolic name, array 3-10 text file
syntax, command line 1-4 saving router configuration to 3-112
saving text and error messages to 2-3
SN0054665-00 B Index-11
User’s Guide
text output, suppressing 2-2 VPN

-textfile keyword 2-3 definition of Glossary-5
time delay in scripts 3-143 security with 1-6
time zone offsets, for NTP server 3-106
time, configuring for router 3-142
timer countdown delay for scripts 3-143 W
tracert system command 3-121
tracing port to IP address 3-121 wait time command 3-143
training, QLogic xiii what’s in this guide xi
transmission control protocol, See TCP world wide node name, See WWNN
trap community, configuring 3-114 world wide port name, See WWPN
world wide unique LUN name, See WWULN
WWNN
U definition of Glossary-5
initiator, specifying 3-51
unmap target command 3-139 WWPN
unmapping targets from ports 3-139 definition of Glossary-5
update firmware command 3-38 initiator, specifying 3-51
updating router firmware 3-38 storage array, specifying 3-9, 3-10
WWULN
data migration job 4-19, 4-20
V definition of Glossary-6
I/O statistics 3-43, 3-46
value, returned 3-127 LUN details 3-80
verifying RPC connection 3-128 LUN mask 3-83, 3-87, 3-90
version or Remote CLI, viewing 3-130
version system command 3-130
view dm_log command 4-31
view log command 3-74
viewing, See displaying
virtual LAN, See VLAN
virtual logical area network, See VLAN
virtual port groups (VPGs)
all VPGs, displaying list of 3-147
single group, configuring display name
3-149
single VPG, displaying list of 3-148
virtual private network, See VPN
VLAN
all ports, displaying info for 3-144
enabling 3-21
single port, displaying info for 3-145
Index-12 SN0054665-00 B
Corporate Headquarters QLogic Corporation 26650 Aliso Viejo Parkway Aliso Viejo, CA 92656 949.389.6000 www.qlogic.com
International Offices UK | Ireland | Germany | France | India | Japan | China | Hong Kong | Singapore | Taiwan
© 2010–2011 QLogic Corporation. Specifications are subject to change without notice. All rights reserved worldwide. QLogic and the QLogic logo
are registered trademarks of QLogic Corporation. Linux is a registered trademark of Linus Torvalds. Microsoft and Excel are registered trademarks
of Microsoft Corporation. Python is a trademark of the Python Software Foundation. All other brand and product names are trademarks or registered
trademarks of their respective owners. Information supplied by QLogic Corporation is believed to be accurate and reliable. QLogic Corporation
assumes no responsibility for any errors in this brochure. QLogic Corporation reserves the right, without notice, to make changes in product design
or specifications.

RCLI User Guide

Uploaded by

Document Information

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

RCLI User Guide

Uploaded by

Copyright:

Available Formats

Remote Command Line Interface (CLI) for

Intelligent Storage Routers

Document Revision History

Revision B, April 12, 2011

Changes Sections Affected

Updated with latest QLogic template formats, All

Added information on minimum firmware version “Firmware Requirements” on page 1-1

Updated the description, syntax, keywords, notes, Chapter 3 Command Reference

General Keywords (continued)

Command Reference (continued)

Command Reference (continued)

4 Data Migration Service Commands

What’s in This Guide

 Key names and key strokes are indicated with UPPERCASE:

 Text in italics indicates terms, emphasis, variables, or document titles. For

 What are shortcut keys?

Installing Remote CLI

Command Line Scripting

Generating Script Files

For details, see “Generate Script” on page 3-110.

Executing Script Files

Saving Script Files

Example Script Files

Table 1-1 provides descriptions of the installed example scripts.

Table 1-1. Remote CLI Script Examples

check_fcip_port_speed A Perl script that produces a list of hard-coded router IP addresses

Table 1-1. Remote CLI Script Examples (Continued)

Command Line Syntax

 Parameter data containing spaces can be used if enclosed by either single

Password-Based Access Control

The following example displays the help summary:

The following example specifies an IPv6 address:

All result files comprise the following items in order:

Table 3-1. Commands by Category

Append “Show Append” on page 3-6

Arrays “List Array” on page 3-8

Beacon “Disable Beacon” on page 3-13

Chassis “Show Chassis” on page 3-15

CSV “Merge CSV” on page 3-17

Display “Clear Display” on page 3-18

Table 3-1. Commands by Category (Continued)

FCIP Routes “Show FCIP_Route” on page 3-19

Features “Show Features” on page 3-28

Fibre Channel Ports “Enable FC_Port” on page 3-30

Firmware “Update Firmware” on page 3-38

FRU “Save FRU_Config” on page 3-39

Help “Help” on page 3-41

I/O Statistics “Show IO_Statistics” on page 3-43

Initiators “List Initiator” on page 3-48

Table 3-1. Commands by Category (Continued)

iSCSI Ports “Enable iSCSI_Port” on page 3-56

iSCSI Targets “Discover iSCSI_Target” on page 3-66

ISNS “Show iSNS” on page 3-69

Logs “Clear Log” on page 3-71

LUNs and LUN Masks “List LUN” on page 3-79

Management “Show Mgmt” on page 3-92

Notifications “Show Notification” on page 3-95

Table 3-1. Commands by Category (Continued)

NTP Information “Show NTP” on page 3-105

Password “Set Password” on page 3-107

Performance “Show Performance” on page 3-108

Scripts “Execute Script” on page 3-109

SNMP “Show SNMP” on page 3-113

Statistics “Show FC_Statistics” on page 3-37