Fujitsu PRIMERGY BX600 User manual

Reference Guide
PRIMERGY BX600 10GbE I/O Module (PCIe)
Microsoft Windows Server 2003
iSCSI Initiator SM-CLP Command Reference Guide Version 1.0 (V1.0.748.0)
English

Edition April 2008
PRIMERGY BX600 10GbE LAN I/O Module (PCIe)
Microsoft Windows Server 2003
iSCSI Initiator SM-CLP Command Reference Guide
(v1.0.748.0)

COPYRIGHT NOTICE AND DISCLAIMER
© Copyright 2008 Fujitsu Siemens Computers GmbH
All Rights Reserved.
This document and the software described in this document are furnished under and are subject to the terms of a license
agreement and constitute the confidential and proprietary information of Fujitsu Siemens Computers GmbH. Except as
permitted in the license agreement, no part of this document may be reproduced in any form or by any means without the
express written consent of Fujitsu Siemens Computers GmbH.
This document is the copyrighted work of Fujitsu Siemens Computers GmbH and is owned by Fujitsu Siemens Computers
GmbH.
EXCEPT AS MAY BE EXPRESSLY SET FORTH IN THE LICENSE AGREEMENT, FUJITSU SIEMENS COMPUTERS
GMBH PROVIDES THIS DOCUMENT AND THE SOFTWARE DESCRIBED IN THIS DOCUMENT “AS IS”
WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
THE IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. FUJITSU
SIEMENS COMPUTERS GMBH SHALL NOT BE LIABLE FOR ANY DAMAGE OR LOSS RESULTING FROM THE
USE OF THIS DOCUMENT.
This document may include technical inaccuracies or omissions or typographical errors and Fujitsu Siemens Computers
GmbH shall not be liable for such inaccuracies, omissions or errors contained herein. Fujitsu Siemens Computers GmbH
reserves the right to make changes to this document without prior notice.
TRADEMARKS
ServerEngines, the ServerEngines logo, BladeXchange, and BladeEngine are trademarks or registered trademarks of
ServerEngines Corporation.
Microsoft, Windows, Windows XP, and Windows 2003 are U.S. registered trademarks of Microsoft Corporation.
Adobe and Acrobat are trademarks of Adobe Systems Incorporated.
Other product names are the trademarks or registered trademarks of their respective owners.

Table of Contents
5
Table of Contents
1. REVISION HISTORY................................................................................................... 11
2. INTRODUCTION........................................................................................................... 13
2.1. GLOSSARY...................................................................................................................... 13
2.2. DOCUMENT CONVENTION............................................................................................ 13
2.3. HARDWARE AND SOFTWARE DEPENDENCIES......................................................... 13
3. USING THE COMMAND-LINE INTERFACE...................................................................... 15
3.1. CONNECTING TO THE BLADEENGINE SERVER USING CLI ..................................... 15
3.2. INVOKING CLI ................................................................................................................. 16
3.3. ACCESSING HELP .......................................................................................................... 18
4. BASIC COMMANDS........................................................................................................... 19
4.1. COMMON OPTIONS........................................................................................................ 19
4.2. OUTPUT ARGUMENTS................................................................................................... 19
4.3. CD..................................................................................................................................... 20
4.4. SHOW............................................................................................................................... 21
4.5. SET................................................................................................................................... 22
4.6. OEMSESAVECONFIG ..................................................................................................... 23
4.7. HELP ................................................................................................................................ 24
4.8. VERSION.......................................................................................................................... 25
4.9. EXIT.................................................................................................................................. 26
5. OEMSE COMMANDS ......................................................................................................... 27
5.1. GROUP MAPS .................................................................................................................27
5.2. OEMSEERASECONFIGURATION .................................................................................. 32
5.3. OEMSEUPGRADEFLASHROM....................................................................................... 33
5.4. OEMSEENABLENIC ........................................................................................................ 34
5.5. OEMSEENABLEISCSI ..................................................................................................... 35
5.6. OEMSEDISABLENIC ....................................................................................................... 36
5.7. OEMSEDISABLEISCSI .................................................................................................... 37
5.8. OEMSEADDROUTETABLEENTRY................................................................................. 38
5.9. OEMSEDELETEROUTETABLEENTRY .......................................................................... 39
5.10. OEMSEADDARPTABLEENTRY.................................................................................... 40
5.11. OEMSEDELETEARPTABLEENTRY ............................................................................. 41
5.12. OEMSECONFIGUREIPADDRESS ................................................................................ 42
5.13. OEMSECONFIGUREDHCP........................................................................................... 43
5.14. OEMSEREFRESHNICCONFIG ..................................................................................... 44
5.15. OEMSEPING.................................................................................................................. 45
5.16. OEMSEREFRESHEVENTLOG...................................................................................... 46
5.17. OEMSECLEAREVENTLOG........................................................................................... 47
5.18. OEMSETESTUNITREADY............................................................................................. 48
5.19. OEMSESTDINQUIRY .................................................................................................... 49
5.20. OEMSEREADCAPACITY............................................................................................... 50
5.21. OEMSESCSIREAD ........................................................................................................ 51
5.22. OEMSESCSIWRITE....................................................................................................... 52
5.23. OEMSESETPERSISTENT ............................................................................................. 53
5.24. OEMSELOGIN ............................................................................................................... 54
5.25. OEMSELOGOUT ........................................................................................................... 55
5.26. OEMSEDELETEPERSISTENT...................................................................................... 56
5.27. OEMSERESCANLUNS .................................................................................................. 57
5.28. OEMSEDISCOVERYISNSTHRUDHCP......................................................................... 58
5.29. OEMSEADDISNSENTRY .............................................................................................. 59
5.30. OEMSEDELETEISNSENTRY........................................................................................ 60

Table of Contents
6
5.31. OEMSEDISCOVERTARGETS....................................................................................... 61
5.32. OEMSEADDSENDTARGETPORTAL............................................................................ 62
5.33. OEMSEDELETESENDTARGETPORTAL ..................................................................... 63
5.34. OEMSEREFRESHAVAILABLETARGETS..................................................................... 64
5.35. OEMSEADDTARGET .................................................................................................... 65
5.36. OEMSEDELETETARGET .............................................................................................. 66
6. APPENDIX .......................................................................................................................... 67
6.1. MILI_GROUPS ................................................................................................................. 67
6.1.1. ROOT .......................................................................................................................... 67
6.1.2. BLADEENGINE .......................................................................................................... 67
6.1.3. LOGICALHBA............................................................................................................. 68
6.1.4. NIC.............................................................................................................................. 68
6.1.5. PHYSICALHBA........................................................................................................... 68
6.1.6. PCI............................................................................................................................... 70
6.1.7. DRIVER....................................................................................................................... 70
6.1.8. QOS............................................................................................................................. 70
6.1.9. ISCSI.......................................................................................................................... 71
6.1.10. INITIATORISCSINAME.......................................................................................... 71
6.1.11. INITIATORDEFAULTLOGINOPTIONS.................................................................. 72
6.1.12. INITIATORLOGINOPTIONS.................................................................................. 72
6.1.13. AUTHENTICATION ................................................................................................. 73
6.1.14. PHYSICALHBA ........................................................................................................... 73
6.1.15. ROUTETABLE .......................................................................................................... 73
6.1.16. ROUTETABLEENTRY .............................................................................................. 74
6.1.17. ARPTABLE................................................................................................................ 74
6.1.18. ARPTABLEENTRY.................................................................................................... 74
6.1.19. PCI............................................................................................................................ 76
6.1.20. DRIVER .................................................................................................................... 76
6.1.21. NETWORK................................................................................................................ 77
6.1.22. DHCP........................................................................................................................ 77
6.1.23. TCPIPCONFIGURATION ........................................................................................ 78
6.1.24. NICCONFIGURATION............................................................................................ 78
6.1.25. QOS.......................................................................................................................... 78
6.1.26. EVENTLOG............................................................................................................... 79
6.1.27. EVENTLOGENTRY................................................................................................... 79
6.1.28. SNMP........................................................................................................................ 80
6.1.29. TARGET.................................................................................................................... 81
6.1.30. TARGETPORTAL...................................................................................................... 81
6.1.31. TARGETLOGINOPTIONS....................................................................................... 82
6.1.32. AUTHENTICATION ................................................................................................. 82
6.1.33. SESSION.................................................................................................................. 83
6.1.34. SESSIONNEGOTIATEDLOGINOPTIONS............................................................. 83
6.1.35. SNMP........................................................................................................................ 84
6.1.36. CONNECTION.......................................................................................................... 84
6.1.37. CONNECTIONNEGOTIATEDLOGINOPTIONS..................................................... 85
6.1.38. LUN........................................................................................................................... 85
6.1.39. PERSISTENTLOGIN................................................................................................ 86
6.1.40. PERSISTENTLOGINPORTAL ................................................................................. 86
6.1.41. PERSISTENTLOGINOPTIONS............................................................................... 86
6.1.42. AUTHENTICATION ................................................................................................. 87
6.1.43. DISCOVERY............................................................................................................. 87
6.1.44. SLP............................................................................................................................ 87
6.1.45. ISNS......................................................................................................................... 88
6.1.46. ISNSENTRY............................................................................................................. 88
6.1.47. SENDTARGETPORTAL ........................................................................................... 88

Table of Contents
7
6.1.48. SENDTARGETPORTALLOGINOPTIONS............................................................... 89
6.1.49. AUTHENTICATION ................................................................................................. 89
6.2. MILI_PROPERTIES ......................................................................................................... 90
6.2.1. MANUFACTURER....................................................................................................... 90
6.2.2. MODELNUMBER........................................................................................................ 90
6.2.3. DESCRIPTION........................................................................................................... 90
6.2.4. SERIALNUMBER........................................................................................................ 90
6.2.5. ACTIVEFIRMWAREVERSION .................................................................................. 91
6.2.6. FIRMWAREVERSIONONFLASH............................................................................... 92
6.2.7. BIOSVERSION........................................................................................................... 92
6.2.8. BOOTCODEVERSION............................................................................................... 92
6.2.9. FIRMWARESTATUS.................................................................................................. 92
6.2.10. ISCSIVERSIONMIN................................................................................................ 93
6.2.11. ISCSIVERSIONMAX............................................................................................... 93
6.2.12. MAXCDBLENGTH.................................................................................................... 93
6.2.13. MAXMTUSIZE.......................................................................................................... 93
6.2.14. LDTO......................................................................................................................... 95
6.2.15. DEFAULTETO........................................................................................................... 95
6.2.16. VLDCAPABLE........................................................................................................... 95
6.2.17. VLDENABLED.......................................................................................................... 96
6.2.18. VENDORID............................................................................................................... 96
6.2.19. DEVICEID................................................................................................................ 96
6.2.20. SUBSYSDEVICEID ................................................................................................. 96
6.2.21. SUBSYSVENDORID................................................................................................ 97
6.2.22. BUSNUMBER........................................................................................................... 97
6.2.23. DEVICENUMBER..................................................................................................... 97
6.2.24. FUNCTIONNUMBER ............................................................................................... 97
6.2.25. DRIVERNAME.......................................................................................................... 98
6.2.26. DRIVERVERSION ................................................................................................... 98
6.2.27. IFNAME.................................................................................................................... 98
6.2.28. MACADDRESS......................................................................................................... 98
6.2.29. MAXBITSPERSECOND........................................................................................... 99
6.2.30. MAXPACKETSPERSECONDPERNIC ..................................................................... 99
6.2.31. INITIATORISCSINAME.......................................................................................... 99
6.2.32. INITIATORALIAS.................................................................................................. 100
6.2.33. DEFAULTISCSINAME........................................................................................... 100
6.2.34. INITIALR2T ........................................................................................................... 100
6.2.35. IMMEDIATEDATA................................................................................................. 100
6.2.36. MAXCONNECTIONS............................................................................................. 101
6.2.37. MAXOUTSTANDINGR2T...................................................................................... 101
6.2.38. FIRSTBURSTLENGTH .......................................................................................... 101
6.2.39. MAXBURSTLENGTH............................................................................................. 101
6.2.40. DEFAULTTIME2WAIT........................................................................................... 103
6.2.41. DEFAULTTIME2RETAIN....................................................................................... 103
6.2.42. ERRORRECOVERYLEVEL..................................................................................... 103
6.2.43. DATAPDUINORDER.............................................................................................. 103
6.2.44. DATASEQUENCEINORDER................................................................................. 104
6.2.45. HEADERDIGEST................................................................................................... 104
6.2.46. DATADIGEST ........................................................................................................ 104
6.2.47. MAXRECVDATASEGMENTLENGTH.................................................................... 104
6.2.48. TCPWINDOWSIZE................................................................................................ 106
6.2.49. INITIALR2T ........................................................................................................... 106
6.2.50. IMMEDIATEDATA................................................................................................. 106
6.2.51. AUTHENTICATIONMETHOD ............................................................................... 106
6.2.52. INITIATORCHAPNAME ........................................................................................ 108
6.2.53. INITIATORSECRET............................................................................................... 108

Table of Contents
8
6.2.54. TARGETCHAPNAME ............................................................................................. 108
6.2.55. TARGETSECRET.................................................................................................... 109
6.2.56. HEADERDIGEST................................................................................................... 109
6.2.57. DATADIGEST ........................................................................................................ 109
6.2.58. IPADDRESS........................................................................................................... 110
6.2.59. SUBNETMASK....................................................................................................... 110
6.2.60. GATEWAY .............................................................................................................. 110
6.2.61. IPADDRESS........................................................................................................... 110
6.2.62. MACADDRESS....................................................................................................... 111
6.2.63. VENDORID............................................................................................................. 111
6.2.64. DEVICEID.............................................................................................................. 111
6.2.65. SUBSYSDEVICEID ............................................................................................... 111
6.2.66. SUBSYSVENDORID.............................................................................................. 112
6.2.67. BUSNUMBER......................................................................................................... 112
6.2.68. DEVICENUMBER................................................................................................... 112
6.2.69. FUNCTIONNUMBER ............................................................................................. 112
6.2.70. DRIVERNAME........................................................................................................ 113
6.2.71. DRIVERVERSION ................................................................................................. 113
6.2.72. DHCPSERVERAVAILABLE ................................................................................... 113
6.2.73. DHCPOBTAINNEWIPADDRESS.......................................................................... 113
6.2.74. DHCPENABLED..................................................................................................... 114
6.2.75. INITIATORIPADDRESS ....................................................................................... 114
6.2.76. INITIATORSUBNETMASK ................................................................................... 114
6.2.77. DEFAULTGATEWAY.............................................................................................. 114
6.2.78. IPVERSIONSUPPORTED...................................................................................... 116
6.2.79. VLANID .................................................................................................................. 116
6.2.80. PORTSPEED........................................................................................................... 116
6.2.81. PORTMAXSPEED................................................................................................... 116
6.2.82. MAXFRAMESIZE................................................................................................... 117
6.2.83. LINKSTATUS......................................................................................................... 117
6.2.84. ACTIVEPORT......................................................................................................... 117
6.2.85. MACADDRESS....................................................................................................... 117
6.2.86. MAXBYTESPERSECONDPERISCSI..................................................................... 118
6.2.87. MAXIOSPERSECONDPERISCSI ......................................................................... 118
6.2.88. PORTROWSTATUS............................................................................................... 118
6.2.89. PORTALROLE ........................................................................................................ 118
6.2.90. PORTALPROTOCOL.............................................................................................. 119
6.2.91. PORTALTAG........................................................................................................... 119
6.2.92. SEQUENCENUMBER............................................................................................. 119
6.2.93. TIMESTAMP........................................................................................................... 119
6.2.94. SEVERITY .............................................................................................................. 120
6.2.95. DESCRIPTION....................................................................................................... 120
6.2.96. ERRORCODE ......................................................................................................... 120
6.2.97. NODEROLES.......................................................................................................... 120
6.2.98. PORTALCOUNT..................................................................................................... 121
6.2.99. NODECOUNT......................................................................................................... 121
6.2.100. SESSIONCOUNT ................................................................................................ 121
6.2.101. SESSIONFAILURECOUNT................................................................................. 121
6.2.102. LASTSESSIONFAILURETYPE............................................................................ 123
6.2.103. LASTSESSIONRMTNODENAME....................................................................... 123
6.2.104. SESSIONDIGESTERRORS................................................................................ 123
6.2.105. SESSIONCONNECTIONTIMEOUT.................................................................... 123
6.2.106. SESSIONFORMATERRORS............................................................................... 124
6.2.107. LOGINFAILURES................................................................................................ 124
6.2.108. LASTFAILURETIME............................................................................................ 124
6.2.109. LASTFAILURETYPE ............................................................................................ 124

Table of Contents
9
6.2.110. LASTTGTFAILURENAME.................................................................................... 125
6.2.111. LASTTGTFAILUREADDR.................................................................................... 125
6.2.112. LOGINACCEPTRSPS .......................................................................................... 125
6.2.113. LOGINOTHERFAILRSPS.................................................................................... 125
6.2.114. LOGINREDIRECTRSPS...................................................................................... 127
6.2.115. LOGINAUTHFAILRSPS ...................................................................................... 127
6.2.116. LOGINAUTHFAILS.............................................................................................. 127
6.2.117. LOGINNEGOFAILS............................................................................................. 127
6.2.118. LOGOUTNORMALS............................................................................................. 129
6.2.119. LOGOUTOTHERS................................................................................................ 129
6.2.120. ETO....................................................................................................................... 129
6.2.121. TARGETIPADDRESS.......................................................................................... 129
6.2.122. TARGETPORTNUMBER...................................................................................... 131
6.2.123. PORTALGROUPTAG ........................................................................................... 131
6.2.124. INITIALR2T......................................................................................................... 131
6.2.125. IMMEDIATEDATA............................................................................................... 131
6.2.126. AUTHENTICATIONMETHOD............................................................................. 133
6.2.127. INITIATORCHAPNAME...................................................................................... 133
6.2.128. INITIATORSECRET............................................................................................ 133
6.2.129. TARGETCHAPNAME........................................................................................... 134
6.2.130. TARGETSECRET................................................................................................. 134
6.2.131. HEADERDIGEST................................................................................................. 134
6.2.132. DATADIGEST...................................................................................................... 135
6.2.133. INITIALR2T......................................................................................................... 135
6.2.134. IMMEDIATEDATA............................................................................................... 135
6.2.135. MAXCONNECTIONS........................................................................................... 135
6.2.136. MAXOUTSTANDINGR2T.................................................................................... 136
6.2.137. FIRSTBURSTLENGTH........................................................................................ 136
6.2.138. MAXBURSTLENGTH........................................................................................... 136
6.2.139. DEFAULTTIME2WAIT ........................................................................................ 136
6.2.140. DEFAULTTIME2RETAIN .................................................................................... 137
6.2.141. ERRORRECOVERYLEVEL................................................................................... 137
6.2.142. DATAPDUINORDER ........................................................................................... 137
6.2.143. DATASEQINORDER ........................................................................................... 137
6.2.144. SESSIONDIRECTION ........................................................................................ 138
6.2.145. CMDPDUS............................................................................................................ 138
6.2.146. RSPPDUS............................................................................................................. 138
6.2.147. TXDATAOCTETSHIGH....................................................................................... 138
6.2.148. RXDATAOCTETSHIGH....................................................................................... 139
6.2.149. DIGESTERRORS................................................................................................. 139
6.2.150. CXNTIMEOUTERRORS ...................................................................................... 139
6.2.151. SESSIONTARGETALIAS.................................................................................... 139
6.2.152. AUTHENTICATIONMETHOD............................................................................. 141
6.2.153. HEADERDIGEST................................................................................................. 141
6.2.154. DATADIGEST...................................................................................................... 141
6.2.155. MAXRECVDATASEGMENTLENGTH.................................................................. 141
6.2.156. TCPWINDOWSIZE ............................................................................................. 142
6.2.157. TCPMSS............................................................................................................... 142
6.2.158. ISCSICONNECTIONID ...................................................................................... 142
6.2.159. STATUS................................................................................................................ 142
6.2.160. SOURCEPORTNUMBER ..................................................................................... 144
6.2.161. DESTINATIONPORTNUMBER........................................................................... 144
6.2.162. SOURCEIPADDRESS......................................................................................... 144
6.2.163. DESTINATIONIPADDRESS............................................................................... 144
6.2.164. REDIRECTEDDESTINATIONPORT................................................................... 145
6.2.165. REDIRECTEDDESTINATIONIPADDRESS....................................................... 145

Table of Contents
10
6.2.166. SESSIONTSIH .................................................................................................... 145
6.2.167. SESSIONISID..................................................................................................... 145
6.2.168. SESSIONINITIATORNAME............................................................................... 146
6.2.169. SESSIONSTATUS............................................................................................... 146
6.2.170. ISCSIBOOT......................................................................................................... 146
6.2.171. LUNNUMBER....................................................................................................... 146
6.2.172. LUNSIZE.............................................................................................................. 147
6.2.173. DEVICEVENDORNAME...................................................................................... 147
6.2.174. DEVICEMODELNUMBER.................................................................................... 147
6.2.175. IPADDRESS......................................................................................................... 147
6.2.176. PORTNUMBER..................................................................................................... 148
6.2.177. INITIALR2T......................................................................................................... 148
6.2.178. IMMEDIATEDATA............................................................................................... 148
6.2.179. AUTHENTICATIONMETHOD............................................................................. 148
6.2.180. INITIATORCHAPNAME...................................................................................... 150
6.2.181. INITIATORSECRET............................................................................................ 150
6.2.182. TARGETCHAPNAME........................................................................................... 150
6.2.183. TARGETSECRET................................................................................................. 151
6.2.184. PORTIDENTIFIER............................................................................................... 151
6.2.185. ISCSIBOOT......................................................................................................... 151
6.2.186. TARGETNAME..................................................................................................... 151
6.2.187. TARGETISCSINAME........................................................................................... 153
6.2.188. TARGETALIAS..................................................................................................... 153
6.2.189. DEFAULTLOGINPORTAL ................................................................................... 153
6.2.190. DEFAULTINTRPORT........................................................................................... 153
6.2.191. SLPSCOPES......................................................................................................... 154
6.2.192. SLPQUERYLIST................................................................................................... 154
6.2.193. IPADDRESS......................................................................................................... 154
6.2.194. PORTNUMBER..................................................................................................... 154
6.2.195. INITIALR2T......................................................................................................... 155
6.2.196. IMMEDIATEDATA............................................................................................... 155
6.2.197. INITIATORCHAPNAME...................................................................................... 155
6.2.198. INITIATORSECRET............................................................................................ 156
6.2.199. TARGETCHAPNAME........................................................................................... 156
6.2.200. TARGETSECRET................................................................................................. 156
6.2.201. AUTHENTICATIONMETHOD............................................................................. 157
6.2.202. HEADERDIGEST................................................................................................. 157
6.2.203. DATADIGEST...................................................................................................... 157
6.2.204. IPADDRESS......................................................................................................... 157
6.2.205. PORTNUMBER..................................................................................................... 158
6.2.206. PORTIDENTIFIER............................................................................................... 158
6.2.207. PORTMACADDRESS .......................................................................................... 158
6.2.208. SLPENABLED ...................................................................................................... 158
6.2.209. ISNSENABLED.................................................................................................... 160
6.2.210. DEFAULTINITIATORPORT................................................................................ 160
6.3. DATA TYPES .................................................................................................................160
6.4. COMMON ERROR MESSAGES ................................................................................... 161

1. Revision History
11
1. Revision History
May 2008 First Release

2. Introduction 2.1. Glossary
13
2. Introduction
2.1. Glossary
This section describes the meaning of some of the product and protocol specific terms that
are used in this document.
Property : An entity in the BladeEngine software that has a value associated with it. A
property can be either read-only or read-write. A property can be one of the data type
listed in Data Types section in Appendix section.
Verb : It is a command to the CLI. All the verbs that are exported by BladeEngine
software are termed as OEMSEVerbs.
Group : A logical entity that holds all the related properties and verbs. There can be
groups within groups (termed as sub-groups). Groups are organized heiracically in a tree
format.
sm-clp target : SM-CLP document uses the term target to refer to groups. To avoid
confusion, this document uses sm-clp target or groups to refer the same.
Initiator : A term used in iSCSI protocol to represent the entity that issues SCSI
commands.
Target : A term used in iSCSI protocol to represent the entity that services SCSI
commands to an initiator.
Data Types used in this document are listed with their description in the Appendix section.
2.2. Document Convention
This document uses the following conventions to describe command syntax
Convention Meaning
< > Within syntax description, indicates values that an user specifies. For example, show <
property >
[ ] Within syntax description, indicates optional keywords that can be used with the
command. For example, show [-d < target >]
|
Within syntax descriptions, the pipe symbol represents a choice to select one keyword or
variable to the left or right of the symbol. (The keyword or variable can be either optional
or required.) For example, show [-d < targets > | -l < n | all >]
Table 1: Document Convention
2.3. Hardware and Software Dependencies
The BladeEngine Software is required to be listening on a ssh or a telnet server. It should
have a user account setup for the CLI to establish a ssh or a telnet session.

3. Using the Command-Line Interface 3.1. Connecting to the BladeEngine server using CLI
15
3. Using the Command-Line
Interface
This Chapter describes how to access BladeEngine sm-clp server using the CLI. Note that it
is possible to connect to the sm-clp server by doing a telnet or SSH and use the same
commands.
The additional features that CLI would offer over a regular telnet or SSH sessions are:
• Scriptability Allows the execution of script files.
• Usability Allows tab completions on commands and parameters
• Command Line options Accepts command line options/arguments and additional
command line parameters
3.1. Connecting to the BladeEngine server using
CLI
CLI uses SSH or telnet to connect to the server that is running BladeEngine Software. SSH
is used as the default protocol to connect. CLI can be invoked by just typing CLI at the
prompt. Username and Password will be prompted for connecting the server using ssh.
Telnet can be used by providing a command line option. Username and password will be
prompted for telnet session as well.
CLI for using SSH
CLI -t telnet for using Telnet

3. Using the Command-Line Interface 3.2. Invoking CLI
16
3.2. Invoking CLI
CLI can be invoked by typing CLI on the command line as described below
CLI Syntax:
CLI [-t < transport >] [-u < username >] [-p < password >] [-o < output file >] [-s < IP
Address > [: < Port >]] [-f < script file > | "< command >"]
Option Description
-t takes in transport as argument. Valid transports are telnet and ssh
-u
takes username as argument for transport authentication. It is mandatory to provide
username and password CLI Options for authentication. If these CLI options are not
provided on the command line, then the CLI will prompt the user to input them before
continuing to process the rest of the CLI options and CLI commands.
-p takes password as argument for transport authentication
-o takes output file name as argument. This output will be redirected to this file
-s
This option takes the IP address and an optional port number (default is 22 for ssh). If this
option is not given then the CLI assumes that the SM-CLP server is running on the local
machine and attempts to connect to it.
-f takes script file as argument. The CLI program will exit gracefully upon execution of the
script file. This option cannot be used along with a command as an argument.
command
A basic command or a OEMSE command can be given as a command line argument. The
entire command must be within double quotes. This argument cannot be used along with -f
option.
Table 2: CLI Options
CLI commands can be run in three different modes as listed below:
• Immediate
In Immediate mode the CLI command is given as a CLI option with the required
parameters. The CLI will exit the program after executing the command. If the
command did not execute for some reason or if there is a syntax error then the
CLI terminates with the appropriate error message.
Example:
CLI "OEMSESaveTCPConfig"
will execute the command OEMSESaveTCPConfig and exit.
• Script
A script file can be supplied followed by a "-f" CLI option. The CLI will execute all
the CLI commands in the script file and exit. If exit is not provided at the end of
the script file then it is automatically inserted. Script will be aborted if a command
encounters with an error.
Example:
CLI -f < scriptfile >
will execute all the CLI commands in scriptfile and exit.

3. Using the Command-Line Interface 3.2. Invoking CLI
17
• Interactive
CLI will enter into an interactive mode, if neither CLI command nor script file is
provided as an option. CLI will accept CLI commands and execute them in the
interactive shell. CLI will remain in interactive mode until an exit command is
given. CLI supports tab completions and command history in the interactive mode
only if readline module (comes optionally with Python) is installed.
Example:
CLI
will enter interactive mode.
The Command Line Interface (CLI) for BladeEngine follows the specificiations as defined in
SM-CLP Standard 1.0a.
All the CLI commands and options are case insensitive
Parameters that are decimal numbers will also accept hexadecimal values with a '0x' as
prefix. For ex: 0xa for decimal 10
Quoted strings are treated as single parameter for the commands that accept character
inputs regardless of the space in the string.
For string parameters quotes are optional, unless there is a space in the string. Space is
used as a string termination, unless it is within quotes.

3. Using the Command-Line Interface 3.3. Accessing Help
18
3.3. Accessing Help
CLI provides generic help and context help. Help can be obtained by simply typing
help
at the interactive command prompt.
To obtain a context help type the following at the command prompt:
help < group > < property >
to get help on a particular property
-or-
help < group > < verb >
to get help on a particular command.
If group name is not given it is assumed to be the current group. Refer to help command
for details.

4. Basic Commands 4.1. common options
19
4. Basic Commands
This chapter describes the basic commands that are provided by the CLI. The syntax that
is provided in this chapter is for script file and interactive mode of operation. For
Immediate mode of operation the same syntax can be provided as command line
argument within double quotes.
4.1. common options
The following are the common options that can be used with any of the commands
Parameter Description
-x | -examin Examines and reports whether the command can be executed.
-h | -help Provides help on the command
-o | -output <
output_arguments >
Takes the output file format. See "output_arguments" below for
supported arguments.
-v | -version Displays the SM CLP version number used by the CLI
4.2. output arguments
The following are the arguments for -o or -output option. If more than one arguments are
used then they should be separated by commas with no spaces.
Parameter Description
format=< value
>
Format controls the structure of the output text. The only < value > supported format
is "text"
terse Selects the level of detail included in the output to terse. This option cannot be used in
conjunction with verbose.
verbose Selects the level of detail included in the output to verbose. This option cannot be
used in conjunction with terse.
error The option to select the level of detail included in the output to error is not supported.
language=<
value >
Language selects the translation of text. < value > is a 3-character string identifier of
language are specified in ISO 639.2. The only < value > supported is "eng" (for
English).
begin When multiple items are returned in the output begin/end control where to start in the
list. "end" is not supported.
order=< value
>
When multiple items are returned in the output order controls the order of those items.
The only < value > supported is "default". "reverse" is not supported.
count=< value
>
When multiple items are returned in the output number controls the number of items
returned. Default < value > is "all" which is supported. Any other value is not
supported.
Examples
The following are some examples of usage of output arguments:
To select the level of detail included in the output to verbose:
client "OEMSESaveTCPConfig -o verbose"
will execute OEMSESaveTCPConfig verb and display detailed output message.
To do the same in the interactive shell of Command Line Interface:
OEMSESaveTCPConfig -o verbose

4. Basic Commands 4.3. cd
20
4.3. cd
Command
cd
Description
This command sets the current group to the value provided in the parameter. If no
parameter is given it displays the current working group.
Syntax
cd [common_options] [ -default] [SM-CLP target]
Options
[common_options]
Parameter Description
-default takes the current working group to default which is root
SM-CLP
target
Optional input that indicates the SM-CLP target group for the given command. This
overrides the current group. ".." indcates parent group. "/" indicates root group.
Required Parameters
None
Optional Parameters
None
Possible Error Messages
Common Error Messages

4. Basic Commands 4.4. show
21
4.4. show
Command
show
Description
This command shows the property value for the property provided in the string. If no
option is given then it displays the list of all the groups and properties available under the
current group.
Syntax
show [common_options] [ -default] [ -d] [ -l] [SM-CLP target]
Options
[common_options]
Parameter Description
-default function is not defined in SM-CLP 1.0a document
-d
This option accepts a filter that is used to display the output. Valid values for Filters are
• targets Displays all the SM-CLP targets
• properties Displays all the properties
• verbs Displays all the verbs (commands)
• properties=< property name > Displays the property by the given < property
name >.
• properties=< property name >==< value > Displays the property by name <
property name > and that has value given in < value >. For example
properties=linkState==0 will display all the ports whose link is down
(linkState=0). < value > string is case sensitive. Use double quotes around the <
value > string if there is a space in it.
-l
This option specifies the level of subgroups the show command has to traverse to display.
The default value is 1 which displays just the current group. The possible values for this
option are
• 1 to n Displays the given levels of sub-groups. "n" should be an integer.
• all Displays all the sub-groups recursively.
SM-CLP
target
Optional input that indicates the SM-CLP target group for the given command. This
overrides the current group. ".." indcates parent group. "/" indicates root group.
Required Parameters
None
Optional Parameters
None
Possible Error Messages
Common Error Messages