advertisement
OneCommand
TM
Manager
Command Line Interface
Version 5.1
User Manual
One Network.
One Company.
Connect with Emulex.
P005235-01A Rev. A
Copyright © 2003-2010 Emulex. All rights reserved worldwide. No part of this document may be reproduced by any means or translated to any electronic medium without the prior written consent of Emulex.
Information furnished by Emulex is believed to be accurate and reliable. However, no responsibility is assumed by
Emulex for its use; or for any infringements of patents or other rights of third parties which may result from its use.
No license is granted by implication or otherwise under any patent, copyright or related rights of Emulex.
Emulex, the Emulex logo, AutoPilot Installer, AutoPilot Manager, BlockGuard, Connectivity Continuum,
Convergenomics, Emulex Connect, Emulex Secure, EZPilot, FibreSpy, HBAnyware, InSpeed, LightPulse,
MultiPulse, OneCommand, OneConnect, One Network. One Company., SBOD, SLI, and VEngine are trademarks of
Emulex. All other brand or product names referenced herein are trademarks or registered trademarks of their respective companies or organizations.
Emulex provides this manual "as is" without any warranty of any kind, either expressed or implied, including but not limited to the implied warranties of merchantability or fitness for a particular purpose. Emulex may make improvements and changes to the product described in this manual at any time and without any notice. Emulex assumes no responsibility for its use, nor for any infringements of patents or other rights of third parties that may result. Periodic changes are made to information contained herein; although these changes will be incorporated into new editions of this manual, Emulex disclaims any undertaking to give notice of such changes.
Emulex, 3333 Susan Street
Costa Mesa, CA 92626
OpenSolaris DHCHAP Notice.
Contains portions of Covered Software subject to the Common Development and Distribution License (CDDL)
Version 1.0. Such portions of Covered Software in Source Code form may be obtained from the web site www.opensolaris.org, or by contacting online support from the web site www.emulex.com.
Derived from the RSA Data Security, Inc. MD5 Message-Digest Algorithm.
Copyright (C) 1991-2, RSA Data Security, Inc. Created 1991. All rights reserved.
OneCommand Manager Command Line Interface User Manual Page ii
In VMware ESX with an Existing HBAnyware or OneCommand Manager CLI .. 2
In Linux with an Existing HBAnyware CLI Kit..................................................... 3
Uninstalling the OneCommand Manager CLI........................................................... 6
Uninstalling Older HBAnyware or OneCommand Manager Kits in ... VMware
Uninstalling Older HBAnyware Kits in Linux ................................................ 7
Upgrading the OneCommand Manager CLI to the OneCommand Manager
Using the OneCommand Manager Command-Line Interface ................................ 10
Commands Not Supported in Linux and Solaris ....................................... 16
Commands Not Supported in VMware ESX .............................................. 16
Commands Supported by CIM Client for SMI-S v1.2.1 ............................. 16
Commands Supported by Windows CIM Client for SMI-S v2.x ................. 17
Commands Supported in Target-mode Ports ........................................... 18
Parameters Not Supported in the CIM Interface........................................ 18
Adapter License Management Commands...................................................... 22
ShowAdapterLicenseFeatures .................................................................. 23
ShowLicenseAdapterID............................................................................. 23
OneCommand Manager Command Line Interface User Manual Page iii
Data Center Bridging Commands ................................................................... 31
OneCommand Manager Command Line Interface User Manual Page iv
GetLunUnMaskByHBA.............................................................................. 64
GetLunUnMaskByTarget ........................................................................... 65
OneCommand Manager Command Line Interface User Manual Page v
RemoveAllPersistentBinding ..................................................................... 73
RemovePersistentBinding ......................................................................... 73
WWN Management Commands ..................................................................... 78
OneCommand Manager Command Line Interface User Manual Page vi
Introduction
The OneCommand
™
Manager Command Line Interface (CLI) is a comprehensive management utility for Emulex host bus adapters (HBAs) and converged network adapters (CNAs).The CLI provides support for commonly used commands without requiring installation of the OneCommand Manager
Graphical User Interface (GUI). The OneCommand Manager CLI is a separate application with core driver kits that do not include the OneCommand Manager GUI. The OneCommand Manager CLI console application name is HbaCmd and can be installed on Windows, Solaris, Linux and versions of VMware
ESX that include a Console Operating System (COS). A single operation is performed by entering
’hbacmd’ followed by the command at the command line. For syntax information and details on using the
OneCommand Manager CLI, see “Using the CLI Client” on page 14.
Supported Platforms
Table 1 shows the platforms supported with the OneCommand Manager CLI.
Table 1. OneCommand Manager Application Command Line Interface Supported Platforms
Driver
Storport and NDIS Miniport
Drivers
Architecture
Intel x86, x64, and IA64
Note: Intel IA64 is supported for FC adapters only.
LPFC 8.2.x Driver
SUSE Linux Enterprise Server
(SLES) 11 SP2 and later
LPFC 8.2.8.x Open Source
Driver for SUSE Linux
Enterprise Server 11 GM
Solaris 2.60 Driver
Intel x86, EM64T and AMD64
Intel x86, EM64T, AMD64, PPC64 and IA 64
Intel x86, EM64T, AMD64, PPC64 and IA 64
Intel x86, EM64T, AMD64 and Sun
SPARC
Operating System
Windows Server 2003 Service Pack
2 or later
Windows Server 2008
Windows Server 2008 R2
VMware ESX 4.0 and 4.1
RHEL 5.4 and later, and SUSE Linux
Enterprise Server 11 SP2 and later
SUSE Linux Enterprise Server 11
GM
Solaris 10 and Solaris 11
Note: OneConnect adapters are not supported for IA64 or PPC64.
Note: vNIC is supported only on IBM virtual fabric adapters. For specific information as to whether it is supported on a specific adapter, see the release notes that are available on the IBM adapter pages on the Emulex Web site.
New Commands
The following new commands are supported in OneCommand Manager CLI:
• Adapter License Management Commands (NIC, iSCSI, FC/FCoE)
• ShowLicenseAdapterID
• InstallAdapterLicense
• ShowAdapterLicenseFeatures
• Dump Commands
• GetDumpFile
• GetDumpFileNames
OneCommand Manager Command Line Interface User Manual Page 1
• Personality Management Commands
• ShowPersonalities
• ChangePersonality
• vNIC Support Commands
• CIM Interface Commands
Installing the OneCommand Manager CLI
In Windows
To install the OneCommand Manager CLI, run the installation.exe file for a core Windows driver kit that does not include the OneCommand Manager GUI:
• elxocmcore-windows-<
arch
>-<kit version>.exe
<
arch
> is either x64 or x86.
<kit version> represents the complete version.
For example: elxocmcore-windows-x64-5.0.2.14-1.exe.
Note: For Itanium 64 systems install the x86 kit.
In VMware ESX
To install the OneCommand Manager CLI in a new VMware system, install the specific rpm file for the driver for your VMware version.
Procedures
To install the OneCommand Manager CLI:
1. Log in as ‘root’.
2. Copy the elxocmcore-esxNN-<kit version>.x86_64.rpm file to a directory on the install machine.
3. CD to the directory to which you copied the rpm file.
4. Install the rpm file. Type: rpm -i elxocmcore-esxNN-<kit version>.x86_64.rpm
Where NN is 40 for an ESX 4.0 system and 41 for an ESX 4.1 system. The rpm contents are installed in
/usr/sbin/ocmanager. The OneCommand Manager CLI is also located in this directory.
In VMware ESX with an Existing HBAnyware or OneCommand
Manager CLI
To install the OneCommand Manager CLI in a VMware system with an existing HBAnyware or
OneCommand Manager CLI installed:
1. Install the rpm file by entering the following command, all on one line:
# rpm -U elxocmcore-esxNN-<kit version>.x86_64.rpm
Where NN is 40 for an ESX 4.0 system and 41 for an ESX 4.1 system.
OneCommand Manager Command Line Interface User Manual Page 2
In Linux
Prerequisites
For new systems, the specific driver rpm file for your Linux version must be installed.
• On RHEL 5.4 and RHEL 5.5, the OneCommand Core rpm file requires Libnl.
This library is not installed by default, but can be obtained from the OS distribution media.
• For i386 RHEL 5.4 and RHEL 5.5, use the 32-bit libnl library.
• For x86_64 RHEL 5.4 and RHEL 5.5, use the 64-bit libnl library.
• For ia64 RHEL 5.4 and RHEL 5.5, use the 64-bit libnl library.
• For PPC RHEL 5.4 and RHEL 5.4, use the 32-bit libnl library.
Procedures
To install the OneCommand Manager CLI:
1. Copy the applications kit tar file to a directory on the installation machine.
2. Change (use cd command) to the directory to which you copied the tar file.
3. Untar the file: tar zxvf elxocmcore-<supported_os>-<app_ver>-<rel>.tgz
4. Change (use cd command) to the core kit directory created in step 3.
cd elxocmcore-<supported_os>-<app_ver>-<rel>
5. Run the install.sh script.
./install.sh
Note: The core kit consists of 2 .rpm files for each supported architecture and each supported version of Linux:
1. elxocmlibhbaapi-*.rpm
2. elxocmcore-*.rpm
In Linux with an Existing HBAnyware CLI Kit
Prerequisites
For existing systems the following must be installed before installing the OneCommand Manager CLI:
On LP21000 series adapters and OneConnect FCoE adapters
• Linux driver version 8.2.0.67.12 or later (For RHEL5 and SLES11 SP2 operating systems)
• Linux driver version 8.2.8.x (For SLES11 operating systems)
On OneConnect iSCSI adapters
• be2iscsi driver
On OneConnect NIC adapters
• be2net driver
The be2net driver must also be installed if the adapter personality is iSCSI-NIC or FCoE-NIC.
Use the latest or matching driver from the Emulex Web site.
OneCommand Manager Command Line Interface User Manual Page 3
Note: On RHEL 5.4 installations, the elxocmlibhbaapi-*.rpm conflicts with the Red
Hat 5.4 libhbaapi-devel rpm. Therefore, the core kit install.sh script installs the elxocmlibhbaapi only if the Red Hat libhbaapi-devel rpm is NOT installed.
Currently there is no conflict on SLES 10 and 11 platforms and the elxocmlibhbaapi and elxocmcore rpms are always installed.
Note: The OneCommand Manager core kit cannot be installed if a previous version of the HBAnyware utility is installed.
Procedures
You have two options when installing the OneCommand Manager CLI on a Linux system:
• Upgrade - preserve existing settings
• Clean install - overwrite existing settings
Upgrading
Follow these steps:
1. You must install the current core kit as detailed in installing the OneCommand Manager CLI “In
The .rpm file handles the configuration file upgrade.
The install script executes an rpm upgrade (rpm -U *.rpm) to upgrade the installed version of the core kit to the current version.
Note: There is no upgrade path from an HBAnyware 4.x or 3.x core kit to a
OneCommand Manager 5.1 core kit. You must un-install previous versions of the
HBAnyware utility before installing a OneCommand Manager core kit. For information
Performing a Clean Install
Follow these steps:
1. Uninstall the existing OneCommand Manager CLI using the uninstall script included in the tar file or in /usr/sbin/OCManager/scripts directory.
Note: If an HBAnyware CLI or enterprise kit is installed, follow the procedure for
“Uninstalling Older HBAnyware Kits in Linux” on page 7.
Note: Your configuration files are backed up by rpm with an .rpmsave extension.
2. Install the specific rpm file for your driver for Linux version. For information on installing the rpm
file, see installing the OneCommand Manager CLI “In Linux” on page 3.
OneCommand Manager Command Line Interface User Manual Page 4
In Solaris
Prerequisites
• The Solaris 2.60 driver must be installed.
• The Solaris OCE 1.20 NIC driver must be installed (required only for OneConnect CNA management).
Procedures
To install the OneCommand Manager CLI:
1. Copy the OneCommand Manager core kit to a temporary directory on the system.
2. Untar the core kit. Type: tar xvf elxocmcore-solaris-<kit version>.tar
3. Change to the newly created elxocmcore-solaris-<kit version> directory: cd ./elxocmcore-solaris-<kit version>/
4. Run the install script and follow the instructions.
./install
If any of the following are already present on the system, the install script attempts to remove them first:
• HBAnyware utility
• OneCommand Manager core kit
• OneCommand Manager enterprise kit
• Solaris driver utilities
OneCommand Manager Command Line Interface User Manual Page 5
Uninstalling the OneCommand Manager CLI
In Windows
To uninstall the OneCommand Manager CLI in Windows:
1. Click Start > Settings > Control Panel.
2. Double-click to select Add or Remove Programs.
3. Select OCM_CLI_5-1.exe.
4. Click Remove.
In VMware ESX
To uninstall the OneCommand Manager CLI in VMware:
1. Log in as ‘root.’
2. Type: rpm -e elxocmcore-esxNN-<version>
Where NN is 40 for an ESX 4.0 system and 41 for an ESX 4.1 system.
Uninstalling Older HBAnyware or OneCommand Manager Kits in
VMware ESX
To uninstall an older OneCommand Manager or HBAnyware Kit on VMware:
1. Log in as ‘root’.
2. Type: rpm -qa | grep elx and locate either of the following rpm files: elxvmwarecorekit-<kit version>
Or elxocmcore-esxNN-<kit version>
Where NN is 40 for an ESX 4.0 system and 41 for an ESX 4.1 system.
3. Type: rpm -e elxvmwarecorekit-<kit version>
Or rpm -e elxocmcore-esxNN-<kit version>
Where NN is 40 for an ESX 4.0 system and 41 for an ESX 4.1 system.
In Linux
To uninstall the OneCommand Manager CLI on Linux:
1. Run the uninstall script uninstall_ocmanager.sh located in /usr/sbin/hbanyware/scripts,
Or,
Run the uninstall script uninstall.sh located in the installation tar file.
OneCommand Manager Command Line Interface User Manual Page 6
Uninstalling Older HBAnyware Kits in Linux
Uninstalling an older HBAnyware core kit:
1. Run the following command to remove the core kit.
rpm -e elxlinuxcorekit
Uninstalling an older HBAnyware enterprise kit:
1. Run the uninstall script located in /usr/sbin/hbanyware/scripts to remove the enterprise kit.
Or
Run the uninstall script located in the .tar file to remove the enterprise kit.
If the HBAnyware Security Configurator is installed, you must uninstall it before uninstalling the
HBAnyware configuration utility. You must use the uninstall script that shipped with the version of OneCommand Security Configurator you want to remove. Proceed to step 2. If the Security
Configurator is not installed, proceed to step 3.
2. If the HBAnyware Security Configurator is installed, follow these steps: a. Log on as ‘root’.
b. Change to the directory containing the tar file. c. Extract the tar file using the tar -xvf command.
d. Change to the newly created directory.
e. Run the uninstall script with the ssc parameter specified. Type:
./uninstall ssc
3. Uninstall the HBAnyware utility and the Application Helper module: a. Log on as ‘root’. b. Change to the directory containing the tar file.
c. Extract the tar file using the tar -xvf command.
d. Change to the newly created directory.
e. Uninstall any previously installed versions. Type:
./uninstall
In Solaris
To uninstall the OneCommand Manager CLI on Solaris:
1. Run /opt/ELXocm/scripts/uninstall
Or,
Run the uninstall script located in the installation tar file
Or,
Enter the command pkgrm ELXocmcore.
OneCommand Manager Command Line Interface User Manual Page 7
Upgrading the OneCommand Manager CLI to the OneCommand Manager Enterprise Kit
Note: An upgrade can be performed only if the version of the OneCommand Manager enterprise kit is the same or later than the OneCommand Manager CLI version. You cannot upgrade a OneCommand Manager CLI with a previous version of the
OneCommand Manager enterprise kit.
Note: When the OneCommand Vision Sensor software is installed on production servers with Emulex adapters installed, the Sensor software may load and use some of the software components included in the OneCommand Manager application or
HBAnyware utility software stacks. It is essential that the OneCommand Vision
Sensor software be stopped before performing any upgrades, or updates, to the
OneCommand Manager or HBAnyware software stack components. For information on stopping the Sensor, refer the OneCommand Vision user manual.
In Windows
To upgrade from the OneCommand Manager CLI to the full-featured OneCommand Manager enterprise kit:
1. From the desktop, run the elxocm-windows-<
arch
>-<kit version>.exe file that contains the full application kit.
Running this executable file removes the OneCommand Manager CLI and installs a full-featured version of the OneCommand Manager application that includes the CLI and the GUI.
In VMware ESX
The full-featured OneCommand Manager enterprise kit is not supported for VMware ESX.
In Linux
To upgrade from the OneCommand Manager CLI to the full-featured OneCommand Manager enterprise kit:
1. Run the install.sh script of the OneCommand Manager enterprise kit.
The install script executes an rpm upgrade (rpm -U *.rpm) to upgrade the installed core kit to an enterprise kit.
In Solaris
To upgrade from the OneCommand Manager CLI to the full-featured OneCommand Manager enterprise kit:
1. Download the OneCommand Manager enterprise kit to a temporary directory on your system.
2. Untar the OneCommand Manager enterprise kit tar file.
tar xvf elxocm-solaris-<kit version>.tar
3. Change to the newly created elxocm-<kit version> directory cd ./elxocm-solaris-<kit version>/
OneCommand Manager Command Line Interface User Manual Page 8
4. Unzip the platform-specific kit gunzip elxocm-solaris-<kit version>-<platform>.tar.gz
5. Untar the platform-specific kit.
tar xvf elxocm-solaris-<kit version>-<platform>.tar
6. Install the ELXocmgui package pkgadd -d . ELXocmgui
OneCommand Manager Command Line Interface User Manual Page 9
Using the OneCommand Manager Command-Line Interface
The Command Line Interface (CLI) Client component of the OneCommand Manager application provides access to the capabilities of the Remote Management library from a console command prompt.
This component is intended for use in scripted operations from within shell scripts or batch files. The CLI
Client is a console application named HbaCmd. Each time you run this application from the command line, a single operation is performed.
The first parameter of this command is the requested operation. When the specified operation is completed, the command prompt is displayed. Most operations retrieve information about an entity on the storage area network (SAN) and show that information on the console.
Most of the CLI Client commands require one or more additional parameters that specify the nature of the command. For FC ports the world wide port name (WWPN) of the adapter must be specified.
For example, run the following command to display the port attributes for the adapter with the specified
WWPN: hbacmd PortAttributes 10:00:00:00:c9:20:20:20
For iSCSI and NIC ports the MAC address must be specified.
For example, run the following command to set the target properties for the CNA port with the specified
MAC address: hbacmd SetTargetProperties 00-11-22-33-44-55 iscsiTarget 1
The command sets the extended timeout value to 1.
The OneCommand Manager CLI can be run in TCP/IP mode by making the first argument h=<host>. For example: hbacmd h=cp-hp5670 ListHBAs hbacmd h=138.239.91.121 ListHBAs
The OneCommand Manager CLI can manage Emulex adapters in systems configured to support the
Common Information Model (CIM), such as systems with VMware ESX 4.0i installed.
The CIM is a standard management mechanism for device management in VMware’s Visor based ESX platforms. The OneCommand Manager uses the standard CIM interfaces to manage the adapters in the
ESX COS and Visor environments.
You can use the following syntax for issuing CIM-based commands:
A> hbacmd <h=IPAddress[: port]> m=cim [u=userid] [p=password] [n=root/emulex] command <WWPN>
B> hbacmd <h=IPAddress [: port]> <m=cim> <cmd>
Before issuing the syntax B, do one of the following:
• Add the host IP with CIM credentials using the AddHost command.
For example: hbacmd <m=cim> AddHost <IPAddress> [u=userid] [p=password] [n=namespace]
Or,
OneCommand Manager Command Line Interface User Manual Page 10
• Set the default CIM credentials using the SetCimCred command.
Note: This command sets only the cim credentials. Once you have set these, subsequent
HbaCmd commands do not require you specify the cim credentials on the command line.
For example: hbacmd SetCimCred <username> <password> <namespace> <portnum>
Note: If you specify the command with the discovery method "m=cim" and you do not specify the CIM credentials (userid, password, or namespace) the default value for the missing CIM credential is obtained in the following order:
(1) The information entered using the addhost command is looked up.
(2) If no values exist, the information entered using the setcimcred command is used.
(3) If no values exist, the following credentials are used:
username = root,
password = root,
namespace = root/emulex
portnum = 5988
Note: The OneCommand Manager CLI running on VMware ESX 4.0/4.1 and VMware
ESX 4.0/4.1 COS does not support management of adapters using the CIM interface.
For example, run the following command to display a list of adapters managed for a specified host using
CIM interface:
In Windows:
C:\Program Files\Emulex\Util\OCManager>hbacmd h=10.192.113.128 m=cim u=root p=root n=root/emulex listhbas
Note: In Linux, VMware and Solaris, you cannot use hbacmd as a cim client.
OneCommand Manager Command Line Interface User Manual Page 11
The output displayed is similar to the following:
Manageable HBA List
Port WWN : 10:00:00:00:c9:6b:62:2b
Node WWN : 20:00:00:00:c9:6b:62:2b
Fabric Name: 00:00:00:00:00:00:00:00
Flags : 00000000
Host Name : eng.ma.emulex.com
Mfg : Emulex Corporation
Serial No. : BG73539764
Port Number: n/a
Discovery : cim
Port WWN : 10:00:00:00:c9:6b:62:59
Node WWN : 20:00:00:00:c9:6b:62:59
Fabric Name: 00:00:00:00:00:00:00:00
Flags : 00000000
Host Name : eng.ma.emulex.com
Mfg : Emulex Corporation
Serial No. : BG73539764
Port Number: n/a
Discovery : cim
C:\Program Files\Emulex\Util\OCManager>hbacmd h=10.192.113.128 m=cim u=root p=root n=root/emulex portattributes 10:00:00:00:c9:6b:62:2b
Port Attributes for 10:00:00:00:c9:6b:62:2b
Node WWN : 20 00 00 00 c9 6b 62 2b
Port WWN : 10 00 00 00 c9 6b 62 2b
Port Symname :
Port FCID
Port Type
: 0000
: Fabric
Port State : Unknown
Port Service Type: 12 vNIC Name : vNIC Outer VLAN ID: vNIC Min. Bandwidth: vNIC Max. Bandwidth:
Port Supported FC4: 00 00 01 20 00 00 00 01
00 00 00 00 00 00 00 00
OneCommand Manager Command Line Interface User Manual Page 12
00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00
Port Active FC4: 00 00 01 00 00 00 00 01
00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00
00 00 00 00 00 00 00 00
Port Supported Speed: 1 2 4 GBit/sec.
Port Speed : 4 GBit/sec.
Max Frame Size: 2048
OS Device Name:
Num Discovered Ports: 0
Fabric Name: 00 00 00 00 00 00 00 00
• If you specify the parameter 'm=cim,' the CLI uses the CIM interface to talk to the CIM server running on ESX to get the management information.
• If you do not specify the parameter 'm=cim, the CLI uses the RM interface to talk to the RM server to get the management information.
OneCommand Manager Command Line Interface User Manual Page 13
The CLI Client Command Reference
Using the CLI Client
Syntax Rules
The syntax rules for HbaCmd are as follows:
• All commands must start with ‘hbacmd’ in lowercase in Linux, Solaris, and VMware which are case sensitive.
• The requested operation must contain at least three characters, or as many as needed to distinguish it from any other operation.
• Whenever a WWPN is specified, individual fields are separated by colons (:) or spaces ( ). When using space separators, the entire WWPN must be enclosed in quotes (").
• When a MAC address is specified the fields are separated by a dash (-).
Syntax Rules for CIM
The syntax of the existing HbaCmd commands are the same except for the additional m=cim option for getting the data from the ESXi host. Following is a list of HbaCmd commands supported through the CIM interface.
• AddHost
• AllNodeInfo
• CEEDownload
• ChangePersonality
• ChangeWWN
• ClearAllAadapterLicenses
• DeleteDumpFiles
• Download
• Dump
• EnableBootCode
• GetBeacon
• GetDCBParams
• GetDriverParams
• GetDriverParamsGlobal
• GetDumpDirectory
• GetDumpFile
• GetDumpFileNames
• GetFcfInfo
• GetFipParams
• GetLunList
• GetPGInfo
• GetQosInfo
• GetRetentionCount
OneCommand Manager Command Line Interface User Manual Page 14
• GetVPD
• GetWWNCap
• GetXcvrData
• HbaAttributes
• InstallAdapterLicense
• ListHbas
• LoadList
• LoopBackTest
• PciData
• PortAttributes
• PortStatistics
• ReadWWN
• RemoveHost
• Reset
• RestoreWWN
• ServerAttributes
• SetBeacon
• SetCnaPGBW
• SetDCBParam
• SetDCBPriority
• SetDriverParam
• SetDriverParamDefaults
• SetDumpDirectory
• SetFipParam
• SetRetentionCount
• ShowAdapterLicenseFeatures
• ShowLicenseAdapterID
• ShowPersonalities
• TargetMapping
OneCommand Manager Command Line Interface User Manual Page 15
The Command Reference
CLI Client commands are supported for Windows, Solaris, Linux and VMware ESX.
Commands Not Supported in Linux and Solaris
Note: The following commands are not supported in Linux and Solaris:
PersistentBinding
SetPersistentBinding
RemovePersistentBinding
RemoveAllPersistentBinding
BindingCapabilities
BindingSupport
SetBindingSupport
Commands Not Supported in VMware ESX
Note: The following commands are not supported in VMware ESX:
BindingCapabilities
BindingSupport
CreateVPort
DeleteVPort
GetLunMaskByHBA
GetLunMaskByTarget
PersistentBinding
RescanLuns
RemoveAllPersistentBinding
RemovePersistentBinding
SetBindingSupport
SetLunMask
SetPersistentBinding
Commands Supported by CIM Client for SMI-S v1.2.1
Note: The following commands are supported by CIM client for SMI-S v1.2.1:
HbaAttributes
PortAttributes
PortStatistics
ServerAttributes
GetDriverParams
GetDriverParamsGlobal
SetDriverParam
Download
AddHost
RemoveHost
Listhba
SetCimCred
GetCimCred
All other HbaCmd commands return an error message “This command is currently not available via the cim interface.”
OneCommand Manager Command Line Interface User Manual Page 16
Commands Supported by Windows CIM Client for SMI-S v2.x
Note: The following additional commands are supported to manage the adapters on the ESX4i platform with SMI-S v2.x.x provider:
ChangePersonality
ChangeWWN
Dump
GetDCBParams
GetDumpDierctory
GetDumpFile
GetDumpFileNames
GetFCFInfo
GetFipParams
GetRetentionCount
GetVPD
GetWWNCap
GetXcvrData
InstallAdapterLicense
LoadList
ReadWWN
Reset
RestoreWWN
SetDCBParam
SetCnaPGBW
SetDCBPriority
SetDumpDirectory
SetFipParam
SetRetentionCount
ShowAdapterLicenseFeatures
ShowLicenseAdapterID
ShowPersonalities
This supported command list includes some entries that are unavailable in the SMI-S provider v1.2.1 and v2.x.x. For those entries, HbaCmd reports “Not Available.” For
details on parameters not supported for specific commands, see Table 2 on page 18.
If you are running older adapter firmware or managing a remote host running the
HBAnyware utility, version 4.x, the PG 1 and PG 2 settings and all bandwidth settings are disabled and the Enable Host Ethernet Priority Flow Control (PFC) Linkage is disabled.
OneCommand Manager Command Line Interface User Manual Page 17
Commands Supported in Target-mode Ports
Note: The following HbaCmd commands are supported for managing target mode ports:
DeleteDumpFiles
Download
DriverConfig
ExportSanInfo
GetDCBParams
GetDriverParams
GetDriverParamsGlobal
GetDumpDirectory
GetFCFInfo
GetFIPParams
GetPGInfo
GetPortStatistics
GetRetentionCount
GetVPD
GetXcvrData
HbaAttributes
ListHBAs
PortAttributes
Reset
SaveConfig
ServerAttributes
SetDCBPGBW
SetDCBParam
SetDriverParam
SetDriverParamDefaults
SetFIPParam
SetPortEnabled
SetRetentionCount
All other HbaCmd commands return the error message:
"Not Supported for Target Mode Adapters."
Parameters Not Supported in the CIM Interface
Note: X indicates the parameter is not available on the particular OS. Blank table cells indicate that the parameter is available.
Table 2. Parameters Not Available
Command Parameter
Not Available on ESX 3i U4 via CIM
Provider v
2.0.9.x
ESX 4.0i
ListHBAs Port WWN
Node WWN
Fabric Name
Flags
Host Name
Mfg
OneCommand Manager Command Line Interface User Manual
ESX 4.1i
Page 18
Table 2. Parameters Not Available (Continued)
Command Parameter
Not Available on ESX 3i U4 via CIM
Provider v
2.0.9.x
ESX 4.0i
HbaAttributes
Serial No.
Port Number
Mode
Discovery
Host Name
Manufacturer
Serial Number
Model
Model Desc
Node WWN
Node Symname
HW Version
Opt ROM Version
FW Version
Vendor Spec ID
Number of Ports
Driver Name
Device ID
HBA Type
Operational FW
SLI1 FW
SLI2 FW
SLI3 FW
IEEE Address
Boot Code
Driver Version
Kernel Version
HBA Temperature
X
X
ESX 4.1i
OneCommand Manager Command Line Interface User Manual Page 19
Table 2. Parameters Not Available (Continued)
Command Parameter
PortAttributes
ServerAttributes
PortStatistics
Node WWN
Port WWN
Port Symname
Port FCID
Port Type
Port State
Port Service Type
Port Supported FC4
Port Active FC4
Port Supported Speed
Port Speed
Max Frame Size
OS Device Name
Num Discovered Ports
Fabric Name
Host Name
FW Resource Path
DP Resource Path
OneCommand Server Version
Host OS Version
Exchange Count
Responder Exchange Count
Tx Seq Count
Rx Seq Count
Tx Frame Count
Rx Frame Count
Tx Word Count
Rx Word Count
Tx KB Count
X
X
Not Available on ESX 3i U4 via CIM
Provider v
2.0.9.x
ESX 4.0i
OneCommand Manager Command Line Interface User Manual
ESX 4.1i
Page 20
Table 2. Parameters Not Available (Continued)
Command Parameter
Not Available on ESX 3i U4 via CIM
Provider v
2.0.9.x
ESX 4.0i
ESX 4.1i
Rx KB Count
LIP Count
NOS Count
Error Frame Count
Dumped Frame Count
Link Failure Count
Loss of Sync Count
Loss of Signal Count
Prim Seq Prot Err Count
Invalid Tx Word Count
Invalid Rx Frame CRC Cnt
Link Transition Count
Active RPI Count
Active XRI Count
Rx Port Busy Count
Rx Fabric Busy Count
Primary Sequence Timeout
Elastic Buffer Overrun
Arbitration Timeout
GetVPD
GetXcvrData
LoadList
SetDriverParam
WWN Management
Read-Only Mode
The OneCommand Manager CLI does not allow the execution of certain commands when it is configured for read-only mode. An error message is displayed if such a command is attempted:
Error: Read-only management mode is currently set on this host. The requested command is not permitted in this mode.
OneCommand Manager Command Line Interface User Manual Page 21
Help Command
These help command lists the various levels of help for the HbaCmd console application.
Help
Supported by: Windows, Solaris, Linux and VMware ESX
Syntax:
hbacmd Help [GroupName][CmdName]
Description: Help is displayed at three levels. The command hbacmd help lists (by groups) all the commands. The command hbacmd groupname, lists all the commands in the group. The command help commandname shows the help for the specific command.
Parameters:
[GroupName] - All commands in the group.
[CmdName] - Any CLI command.
Adapter License Management Commands
Note: In these commands the WWPN or MAC address argument is given (only one is used) to specify the adapter the command is acting upon. This is how hbacmd identifies the adapter. It does not imply that the command works on the specified port.
InstallAdapterLicense
Supported by: Windows, Solaris, Linux and VMware ESX
Syntax: hbacmd InstallAdapterLicense <WWPN|MAC> <LicenseFile>
Note: For managing ESX/ESXi hosts from a Windows client, add the m=cim option to
Description: This command installs the License Keys from a license file to enable specific features on the adapter.
Parameters:
License File - The path to the license key file containing the License Keys obtained from the
License Web site.
WWPN - Adapter’s FCoE port WWPN.
MAC - Adapter’s NIC or iSCSI port address.
Example:
For non-ESXi hosts hbacmd InstallAdapterLicense 00-12-34-56-78-9A K:\lf1324.txt
For ESXi hosts hbacmd h=<IP_Address> m=cim u=root p=<password> n=<namespace>
InstallAdapterLicense 00-12-34-56-78-9A K:\lf1324.txt
OneCommand Manager Command Line Interface User Manual Page 22
ShowAdapterLicenseFeatures
Supported by: Windows, Solaris, Linux and VMware ESX
Syntax:
hbacmd ShowAdapterLicenseFeatures <WWPN|MAC>
Note: For managing ESX/ESXi hosts from a Windows client, add the m=cim option to
Description:
This command displays the list of licensed and licensable features as well as features that are already licensed. The output is a list of features with an indication of whether or not the feature has been licensed.
Parameters:
WWPN - Adapter’s FCoE port WWPN.
MAC - Adapter’s NIC or iSCSI port address.
Example:
For non-ESXi hosts hbacmd ShowAdapterLicenseFeatures 00-12-34-56-78-9A
For ESXi hosts hbacmd h=<IP_Address> m=cim u=root p=<password> n=<namespace>
ShowAdapterLicenseFeatures 00-12-34-56-78-9A
ShowLicenseAdapterID
Supported by: Windows, Solaris, Linux and VMware ESX
Syntax: hbacmd ShowLicenseAdapterID <WWPN|MAC>
Note: For managing ESX/ESXi hosts from a Windows client, add the m=cim option to
Description: This command displays the Adapter ID used for enabling licensed features. The Adapter
ID is used along with the Entitlement Code to obtain License Keys used to enable various features on the adapter.
Parameters:
WWPN - Adapter’s FCoE port WWPN.
MAC - Adapter’s NIC or iSCSI port address.
Example:
For non-ESXi hosts
>hbacmd ShowLicenseAdapterID 00-12-34-56-78-9A
OneCommand Manager Command Line Interface User Manual Page 23
For ESXi hosts
>hbacmd h=<IP_Address> m=cim u=root p=<password> n=<namespace>
ShowLicenseAdapterID 00-12-34-56-78-9A
Attributes Commands
HbaAttributes
Supported by: Windows, Solaris, Linux and VMware ESX
Syntax: hbacmd [h=<IPAddress>] hbaattributes <WWPN>
Note: For managing ESX/ESXi hosts from a Windows client, add the m=cim option to
Description: This command shows a list of all adapter attributes for all ports on the adapter.
Parameters: h - Host’s IP Address.
WWPN - WWPN of the adapter.
PortAttributes
Supported by: Windows, Solaris, Linux and VMware ESX
Syntax: hbacmd <h=IPAddress of host> PortAttributes <WWPN | MAC>
Note: For managing ESX/ESXi hosts from a Windows client, add the m=cim option to
Description: This command shows a list of all port attributes for the adapter.
Parameters: h - Host’s IP Address.
WWPN - Port’s WWPN.
MAC - MAC address of the NIC or iSCSI port.
PortStatistics
Supported by: Windows, Solaris, Linux and VMware ESX
Syntax:
hbacmd PortStatistics <WWPN>
Note: For managing ESX/ESXi hosts from a Windows client, add the m=cim option to
OneCommand Manager Command Line Interface User Manual Page 24
Description: This command shows all port statistics for the adapter.
Parameters:
WWPN - Adapter’s WWPN.
ServerAttributes
Supported by: Windows, Solaris, Linux and VMware ESX
Syntax: hbacmd ServerAttributes <WWPN | MAC>
Note: For managing ESX/ESXi hosts from a Windows client, add the m=cim option to
Description: This command shows a list of server attributes for the adapter.
Parameters:
WWPN - Adapter’s WWPN.
MAC - MAC address of the NIC or iSCSI port.
SetPortEnabled
Supported by: Windows, Solaris, Linux and VMware ESX
Syntax:
hbacmd SetPortEnabled <WWPN | MAC> <PortEnable>
Description: This command enables or disables the FC or CNA port.
Parameters:
WWPN - Adapter’s WWPN.
MAC - MAC address of the NIC or iSCSI port.
PortEnable -
0 for Disable
1 for Enable
Note: Ensure all I/O on the port is stopped, before disabling the port.
Note: When the SetPortEnabled command disables an FC port, the adapter must be reset to activate the new setting. Only OneConnect adapters do not require a reset when the adapter port is enabled or disabled.
OneCommand Manager Command Line Interface User Manual Page 25
Authentication Commands
AuthConfigList
Supported by: Windows, Solaris and Linux
Syntax: hbacmd AuthConfigList <WWPN>
Description: This command returns the list of WWPNs that have an authentication connection configuration with the specified adapter.
Parameters:
WWPN - Adapter’s WWPN.
DeleteAuthConfig
Supported by: Windows, Solaris and Linux
Syntax: hbacmd DeleteAuthConfig <WWPN1> <WWPN2> <PasswordType> <Password>
Description: This command deletes the authentication configuration on the adapter.
Parameters:
WWPN1 - Adapter’s WWPN.
WWPN2 - Must be "ff:ff:ff:ff:ff:ff:ff:ff" for a switch or the actual WWPN for a target.
PasswordType -
1 = ASCII
2 = Hex (binary)
3 = Password not yet defined
Password - Current password value.
GetAuthConfig
Supported by: Windows, Solaris and Linux
Syntax: hbacmd GetAuthConfig <WWPN1> <WWPN2>
Description: This command retrieves the authentication configuration for the adapter.
Parameters:
WWPN1 - Adapter’s WWPN.
WWPN2 - Must be "ff:ff:ff:ff:ff:ff:ff:ff" for a switch or the actual WWPN for a target.
OneCommand Manager Command Line Interface User Manual Page 26
GetAuthStatus
Supported by: Windows, Solaris and Linux
Syntax: hbacmd GetAuthStatus <WWPN1> <WWPN2>
Description: This command returns the current status for the authentication connection specified by
WWPN 1 and 2 (adapter and the switch). It includes the current authentication state (connected or failed). Currently authenticated connections specify the hash algorithm and DH group used in the
DHCHAP associated with this connection. Failed status includes the failure reason.
Parameters:
WWPN1 - Adapter’s WWPN.
WWPN2 - Must be "ff:ff:ff:ff:ff:ff:ff:ff" for a switch or the the actual WWPN for a target.
InitiateAuth
Supported by: Windows, Solaris and Linux
Syntax:
hbacmd InitiateAuth <WWPN1> <WWPN2>
Description: This command initiates the authentication configuration on the adapter.
Parameters:
WWPN1 - Adapter’s WWPN.
WWPN2 - Must be "ff:ff:ff:ff:ff:ff:ff:ff" for a switch or the actual WWPN for a target.
SetAuthConfig
Supported by: Windows, Solaris and Linux
Syntax: hbacmd SetAuthConfig <WWPN1> <WWPN2> <PasswordType> <Password> <Parameter>
<Value>
Description: This command sets the authentication configuration for the adapter.
Parameters:
WWPN1 - Adapter’s WWPN.
WWPN2 - Must be "ff:ff:ff:ff:ff:ff:ff:ff" for a switch or the actual WWPN for a target.
PasswordType -
1 = ASCII
2 = Hex (binary)
3 = Password not yet defined
Password - Current password value.
Parameter -
Mode
Timeout
OneCommand Manager Command Line Interface User Manual Page 27
Bi-directional
Hash-priority
DH-priority
Re-authentication, and
Re-authentication-interval
Value - Parameter-specific value:
Mode = <disabled, enabled, passive>
Timeout = time in seconds
Bi-directional = <disabled, enabled>
Hash-priority = <md5, sha1> (md5 = first md5, then sha1; sha1 = first sha1, then md5)
DH-priority = <1,2,3,4,5>, any combination up to 5 digits
Re-authentication = <disabled, enabled>
Re-authentication-interval = < 0, 10 - 3600>
SetPassword
Supported by: Windows, Solaris and Linux
Syntax:
hbacmd SetPassword <WWPN1> <WWPN2> <Flag> <Cpt> <Cpw> <Npt> <Npw>
Description: This command sets the password for the adapter.
Parameters:
WWPN1 - Adapter’s WWPN.
WWPN2 - Must be "ff:ff:ff:ff:ff:ff:ff:ff" for switch, or the actual WWPN for target.
Flag -
1 = Local (password used by adapter when adapter authenticates to the switch.
2 = Remote (password used by adapter when switch authenticates to the adapter.
Cpt - Current password type:
1 = ASCII or
2 = Hex (binary)
3 = Password not yet defined
Cpw - Current password value.
Npt - New password type:
1 = ASCII or
2 = Hex (binary)
Npw - New password value.
OneCommand Manager Command Line Interface User Manual Page 28
Boot Commands
EnableBootCode
Note: This command is not supported for OneConnect adapters. The boot code is always enabled on OneConnect adapters.
Supported by: Windows, Solaris, Linux and VMware ESX
Syntax:
hbacmd EnableBootCode <WWPN | MAC> <Flag>
Note: For managing ESX/ESXi hosts from a Windows client, add the m=cim option to
Description: This command enables or disables the boot code on the FC adapter or the Preboot
Execution Environment (PXE) BIOS of the NIC on the CNA adapter. If the boot code is disabled on the
FC adapter, the adapter will not boot from the SAN, regardless of the value for the EnableBootFromSan boot param. If the boot code is enabled on the FC adapter, the adapter will boot from the SAN if the
EnableBootFromSan parameter is also enabled. Disabling the PXE BIOS on the CNA adapter's NIC, prevents booting from the NIC. Enabling the PXE BIOS on the CNA adapter's NIC, allows booting from the NIC.
Parameters:
WWPN - Adapter’s WWPN.
MAC - The MAC address of the NIC or iSCSI port.
Flag -
D = Disable the boot code
E = Enable the boot code
GetBootParams
Supported by: Windows, Solaris, Linux and VMware ESX
Syntax: hbacmd GetBootParams <WWPN> <Type>
Description: This command shows the boot parameters. If any arguments are missing or invalid, a suitable error is reported. If all arguments are correct, the data is displayed in tabular form.
Parameters:
WWPN - Adapter’s WWPN.
Type - X86, EFI, OB
SetBootParam
Supported by: Windows, Solaris, Linux and VMware ESX
Syntax: hbacmd SetBootParam <WWPN> <Type> <Param> <Value1> [BootDev <Value2>]
OneCommand Manager Command Line Interface User Manual Page 29
Description: This command changes the boot parameters. You can change adapter parameters and boot device parameters for OpenBoot, x86, and EFI boot.
• When changing adapter parameters, omit the BootDev keyword and value; otherwise, an error is reported.
• When changing bootdevice parameters for OpenBoot, omit the BootDev keyword and value; otherwise, an error is reported.
• For boot device parameters for X86 or EFI, you must provide the BootDev keyword and value.
Parameters:
WWPN - Adapter’s WWPN.
Type - X86, EFI, OB.
Param - Parameter name.
Value1 - Parameter value.
BootDev - The boot device.
Value2 - Boot device entry number: (0 - 7).
CEE Commands
Note: Converged Enhanced Ethernet (CEE) commands are for CEE management of
LP21000 series adapters only.
CEEDownload
Note: Supported for LP21000 series adapters only. Not supported for OneConnect adapters.
Supported by: Windows, Solaris, Linux and VMware ESX
Syntax: hbacmd CEEDownload <WWPN> <Filename>
Note: For managing ESX/ESXi hosts from a Windows client, add the m=cim option to
Description: This command updates the CEE firmware on the adapter.
Parameters:
WWPN - Adapter’s WWPN.
Filename - Name of the file to download.
GetCEEParams
Supported by: Windows, Solaris, Linux and VMware ESX
Syntax:
hbacmd GetCEEParams <WWPN>
Description: This command shows the CEE parameters.
OneCommand Manager Command Line Interface User Manual Page 30
Parameters:
WWPN - CNA’s WWPN.
SetCEEParam
Supported by: Windows, Solaris, Linux and VMware ESX
Syntax:
hbacmd SetCEEParam <WWPN> <Param> <Value>
Description: This command sets or clears the Internal Host PFC flag. SetCEEParam configures one of the CEE parameters.
Parameters:
WWPN - World Wide Port Name of the adapter.
Param - Parameter Name.
LP-21000-M and LP21002-M parameters:
Pausetype - 1 = Standard, 2 = Per Pause Priority pfcflag - 0 = Clear, 1= Set pfcpriority - (0-0xff) fcoepriority - (0-7) fcoeformat - (0 or 0x10000)
Uifporttype - 1 = Access, 2 = Trunk
Value - Parameter Value.
Where multiple values are possible, they should be specified using comma separated values.
Data Center Bridging Commands
Note: Data Center Bridging (DCB) commands are for DCB management of
OneConnect adapters only.
Note: DCB commands are not supported for NIC-only adapters.
GetDCBParams
Supported by: Windows, Solaris, Linux and VMware ESX
Syntax: hbacmd GetDCBParams <WWPN | MAC>
Note: For managing ESX/ESXi hosts from a Windows client, add the m=cim option to
Description: This command shows the Internal Host PFC flag value and DCBX mode (that is, DCB version). Priorities, Priority Groups, and the corresponding bandwidths as well as the LLDP state are shown for both iSCSI and FCoE CNAs.
OneCommand Manager Command Line Interface User Manual Page 31
Parameters:
WWPN - Adapter’s WWPN.
MAC - MAC address of the NIC or iSCSI port.
GetPGInfo
Supported by: Windows, Solaris, Linux and VMware ESX
Syntax: hbacmd GetPGInfo <WWPN | MAC>
Note: For managing ESX/ESXi hosts from a Windows client, add the m=cim option to
Description: This command shows the priority membership and bandwidth percentages for two priority groups for the port.
Parameters:
WWPN - The WWPN address of the NIC or iSCSI port.
MAC - MAC address of the NIC or iSCSI port
SetCnaPGBW
Supported by: Windows, Solaris, Linux and VMware ESX
Syntax: hbacmd SetCnaPGBW <WWPN | MAC> <BW0 … BW7>
Note: For managing ESX/ESXi hosts from a Windows client, add the m=cim option to
Description: This command sets the bandwidth percentage of a priority group according to the following rules:
1. The bandwidth percentage can be 0-100% with a granularity of 1%.
2. The sum of both bandwidths must add up to 100 or else an error message is displayed.
3. The first value is for PGID0, and the second is for PGID1.
4. Both bandwidths (PGID0 - PGID1) must be specified.
Parameters:
WWPN - Adapter’s WWPN.
MAC - MAC address of the NIC or iSCSI port.
BW - Bandwidth allocated for each priority group.
Example:
This command sets the bandwidth of PGID0 to 50 PGID1 to 50 and the rest to 0%.
hbacmd SetCnaPGBW 10:00:00:00:c9:3c:f7:88 50 50 0 0 0 0 0 0
OneCommand Manager Command Line Interface User Manual Page 32
SetDCBParam
Supported by: Windows, Solaris, Linux and VMware ESX
Syntax: hbacmd SetDCBParam <WWPN | MAC> <Param> <Value>
Note: For managing ESX/ESXi hosts from a Windows client, add the m=cim option to
Description: This command sets or clears the Internal Host PFC flag. The SetDCBParam configures one of the DCB parameters. The values must be set according to the following rules:
1. For FCoEPriority and iSCSIPriority the valid range is 0 to 7. You must specify a single priority.
2. PFCPriorities are specified by a single priority or a list of comma separated values.
The valid range for each priority is 0 to 7.
3. Valid values for the following parameters are 0 and 1:
DcbxState
DcbxMode
TxState
RxState
TxPortDesc
TxSysDesc
TxSysName
TxSysCap
PfcEnable
PfcPriority
Default - Setting the Param arguments to default sets all CNA DCB params (including priority groups) to their default values.
For example: hbacmd SetDCBParam <WWPN|MAC> defaults
Parameters:
WWPN - Adapter’s WWPN.
MAC - MAC address of the NIC or iSCSI port.
Param - Parameter Name.
Value - Parameter Value.
OneConnect adapter parameters:
DCBXState - 1= enabled 0 = disabled
DCBXMode - 1= DCB, 0 = CIN
PFCEnable - 1= enabled, 0 = disabled
PFCWilling - 1 = enabled, 0 = disabled
PFCAdvertise - 1 = enabled, 0 = disabled
PGEnable - 1 = enabled, 0 = disabled
PGWilling - 1 = enabled, 0 = disabled
PGAdvertise - 1 = enabled, 0 = disabled
OneCommand Manager Command Line Interface User Manual Page 33
FCoEPGID - (0-7)
FCoEPriority - (0-7) [only for FCoE adapters] iSCSIPriority - (0-7) [only for iSCSI adapters]
PFCPriorities - Comma separated list of up to 7 values ranging from 0-7.
Link Layer Discovery Protocol (LLDP) settings:
For the following settings:
1 = Enabled
0 = Disabled
TxState
RxState
TxPortDesc
TxSysDesc
TxSysName
TxSysCap
Where multiple values are possible, specify them with a comma-separated list.
Example:
# hbacmd h=10.192.203.151 m=cim u=root p=Swamiji001 n=root/emulex setdcbparam
00-00-c9-3c-f7-88 fcoepriority 3
SetDCBPriority
Supported by: Windows, Solaris, Linux and VMware ESX
Syntax: hbacmd SetDCBPriority <WWPN> <PFC Priorities> <Priorities of PGID0> < Priorities of PGID1>...<Priorities of PGID7>
Note: For managing ESX/ESXi hosts from a Windows client, add the m=cim option to
Description: This command sets the priorities for a priority group. The values must be set according to the following rules:
1. The priorities range from 0 to 7.
2. The Priority group IDs (PGID) range from 0 to 7.
3. Each set of priorities for a group must be separated by a space.
4. Specify multiple priorities for the same group by a comma-separated list.
5. To specify none, use "-" for the argument.
6. The same priority values cannot be specified to different groups.
7. All priorities (0 to 7) must be assigned to some PGID.
8. Not all PGIDs must be assigned a priority.
OneCommand Manager Command Line Interface User Manual Page 34
Parameters:
WWPN - Adapter’s WWPN.
PFCPriorities - Comma separated list of up to 7 values ranging from 0-7.
Priorities of PGID - (0-7).
Example:
hbacmd h=10.192.203.151 m=cim setdcbpriority 10:00:00:00:c9:3c:f7:88 3
0,1,2,4,5,6,7 3 0 0 0 0 0 0
Diagnostic Commands
EchoTest
Note: This command is not supported for OneConnect adapters.
Supported by: Windows, Solaris, Linux and VMware ESX
Syntax:
hbacmd EchoTest <WWPN Source> <WWPN Destination> <Count> <StopOnError> <Pattern>
Description: This command runs the echo test on adapters.
Note: Support for remote adapter is TCP/IP access only. The EchoTest command fails if the target WWPN does not support the ECHO ELS command.
Parameters:
WWPN Source - WWPN of the originating adapter.
WWPN Destination - WWPN of the destination (echoing) adapter.
Count - Number of times to run the test. 0 = run test indefinitely.
StopOnError - Checks if the test must be halted on error.
0 = No halt
1 = Halt on error
Pattern - Hexadecimal data pattern to transmit (up to 8 characters).
GetBeacon
Supported by: Windows, Solaris, Linux and VMware ESX
Syntax: hbacmd GetBeacon <WWPN | MAC>
Note: For managing ESX/ESXi hosts from a Windows client, add the m=cim option to
Description: This command shows the current beacon state, ON or OFF.
Parameters:
WWPN - WWPN of the FC port.
OneCommand Manager Command Line Interface User Manual Page 35
MAC - MAC address of the NIC or iSCSI port.
GetXcvrData
Supported by: Windows, Solaris, Linux and VMware ESX
Syntax: hbacmd GetXcvrData <WWPN | MAC>
Note: For managing ESX/ESXi hosts from a Windows client, add the m=cim option to
Description: This command shows transceiver data such as vendor name and serial number.
Parameters:
WWPN: Adapter’s WWPN port.
MAC - MAC address of the NIC or iSCSI port.
Example:
C:\Program Files\emulex\Util\OCManager>hbacmd h=10.192.203.154 m=cim u=root p=Swamiji001 n=root/emulex getxcvrdata 00-00-c9-93-2f-d6
LoadList
Note: Not supported for OneConnect adapters.
Supported by: Windows, Solaris, Linux and VMware ESX
Syntax:
hbacmd LoadList <WWPN>
Note: For managing ESX/ESXi hosts from a Windows client, add the m=cim option to
Description: This command shows the flash memory load list data for the adapter.
Parameters:
WWPN - Adapter’s WWPN.
LoopBackTest
Supported by: Windows, Solaris, Linux and VMware ESX
Syntax: hbacmd LoopBackTest <WWPN | MAC> <Type> <Count> <StopOnError> [Pattern]
Note: For managing ESX/ESXi hosts from a Windows client, add the m=cim option to
OneCommand Manager Command Line Interface User Manual Page 36
Description: This command runs the loop test on the adapter specified by the WWPN or MAC address.
Only PHY loopback test and MAC loopback tests are enabled for OneConnect adapters.
Note: Loopback tests can be run on FC ports being managed locally or remotely managed through TCP/IP-based management.
Parameters:
WWPN - WWPN of the FC or FCoE port.
MAC - MAC address of the NIC or iSCSI port.
Type - Type of loopback test to run.
0 = PCI LoopBack Test
1 = Internal LoopBack Test
2 = External LoopBack Test (requires loopback plug)
3 = DMA Loopback Test
4 = PHY Loopback Test
5 = MAC Loopback Test
Note: Loopback tests 0 and 1 are not supported for OneConnect adapters.
Loopback tests 3, 4 and 5 are only supported for OneConnect adapters
Count - Number of times to run the test (0 = run test infinitely, Range = 1...99,999).
StopOnError - Checks if the test must be halted on error.
0 = No halt
1 = Halt
Pattern (optional) - 1 to 8 hexadecimal bytes to use for loopback data (for example: 1a2b3c4d).
Example:
hbacmd h=10.192.193.154 m=cim u=root p=Swamiji001 n=root/emulex loopbacktest 00-
00-c9-93-2f-9f 4 120 0
LoopMap
Note: Supported for FC ports only.
Supported by: Windows, Solaris and Linux
Syntax: hbacmd LoopMap <WWPN>
Description: This command shows the arbitrated loop map data.
Parameters:
WWPN - Adapter’s WWPN.
OneCommand Manager Command Line Interface User Manual Page 37
PciData
Supported by: Windows, Solaris, Linux and VMware ESX
Syntax:
hbacmd PciData <WWPN | MAC> <Type>
Note: For managing ESX/ESXi hosts from a Windows client, add the m=cim option to
Description: This command shows PCI configuration data.
The PCI registers displayed are specific to the function referenced in the OneCommand Manager CLI.
For example, if you specify the WWPN for the FCoE function, the PCI registers for that FCoE function are displayed. If you specify the MAC address for the NIC function on that same physical port, the PCI registers for that NIC function are displayed.
Only the base PCI registers are displayed. The extended PCI registers are not available on a CNA.
Parameters:
WWPN - Adapter’s WWPN port.
MAC - MAC address of the NIC or iSCSI port.
Type:
1 = Formatted SFS data
2 = Raw SFS data
The OneCommand Manager CLI has a command that displays wakeup parameter information, much the same way that the OneCommand Manager application displays it in its own control field.
Example:
C:\Program Files\emulex\Util\HBAnyware>hbacmd h=10.192.203.154 m=cim u=root p=Swamiji001 n=root/emulex pcidata 00-00-c9-93-2f-d6
Output:
Vendor ID:
Command:
Revision ID:
Subclass:
0x19A2 Device ID:
0x0406 Status:
0x02 Prog If:
0x00 Base Class:
Cache Line Size: 0x10 Latency Timer:
Header Type: 0x80 Built In Self Test:
Base Address 0:
Base Address 2:
0x00000000 Base Address 1:
0xDF480004 Base Address 3:
Base Address 4:
CIS:
SubSystem ID:
Interrupt Line:
0xDF4A0004 Base Address 5:
0x00000000 SubVendor ID:
0xE622 ROM Base Address:
0x00 Interrupt Pin:
Minimum Grant: 0x00 Maximum Latency:
Capabilities Ptr: 0x40
0x0700
0x0010
0x00
0x02
0x00
0x00
0xDF478000
0x00000000
0x00000000
0x10DF
0x00000000
0x01
0x00
OneCommand Manager Command Line Interface User Manual Page 38
PostTest
Note: Not supported for OneConnect adapters.
Supported by: Windows, Solaris, Linux and VMware ESX
Syntax: hbacmd PostTest <WWPN>
Description: This command runs the POST on the adapter. Support for a remote adapter is via TCP/IP access only.
Parameters:
WWPN - Adapter’s WWPN.
SetBeacon
Supported by: Windows, Solaris, Linux and VMware ESX
Syntax:
hbacmd SetBeacon <WWPN | MAC> <BeaconState>
Note: For managing ESX/ESXi hosts from a Windows client, add the m=cim option to
Description: This command turns the beacon ON or OFf.
Parameters:
WWPN - WWPN of the FC port.
MAC - MAC address of the NIC or iSCSI port.
BeaconState - New state of the beacon:
0 = Off
1= On
Wakeup
Note: Not supported for OneConnect adapters.
Supported by: Windows, Solaris, Linux and VMware ESX
Syntax:
hbacmd Wakeup <WWPN>
Description: This command wakes up the adapter.
Parameters:
WWPN - Adapter’s WWPN.
OneCommand Manager Command Line Interface User Manual Page 39
Driver Parameter Commands
Note: Supported for FC and FCoE ports only.
Note: Driver Parameters that are set temporarily and globally (using the "G" and "T" flags) must be read using the "GetDriverParams" hbacmd command to view the current value of the parameter. The "GetDriverParamsGlobal" hbacmd command displays only permanently set driver parameter values. Additionally, if temporary, global values have been set for one or more driver parameters, the "SaveConfig" hbacmd command must be run with the "N" flag (using the "N" flag is analogous to the hbacmd command "GetDriverParams") to force the driver parameter values for the specified adapter to be saved. Inaccurate values may be saved if the "G" flag is used for this command.
Note: The DriverConfig and SetDriverParamDefaults commands are not supported for Solaris.
DriverConfig
Supported by: Windows, Linux and VMware ESX
Syntax: hbacmd DriverConfig <WWPN> <FileName> <Flag>
Description: This command sets all driver parameters to the values in the .dpv file type. The .dpv file’s driver type must match the driver type of the host platform adapter.
Parameters:
WWPN - Adapter’s WWPN.
FileName - Name of the .dpv file (stored in the Emulex Repository directory).
Flag -
G = Make change global (all adapters on this host).
N = Make change non-global (adapter-specific).
GetDriverParams
Supported by: Windows, Solaris, Linux and VMware ESX 4.0.
Syntax:
hbacmd GetDriverParams <WWPN>
Note: For managing ESX/ESXi hosts from a Windows client, add the m=cim option to
Description: This command shows the name and values of each parameter.
Parameters:
WWPN - Adapter’s WWPN.
OneCommand Manager Command Line Interface User Manual Page 40
GetDriverParamsGlobal
Supported by: Windows, Solaris, Linux and VMware ESX 4.0.
Syntax: hbacmd GetDriverParamsGlobal <WWPN>
Note: For managing ESX/ESXi hosts from a Windows client, add the m=cim option to
Description: This command shows the name and the global value of each driver parameter.
Parameters:
WWPN - Adapter’s WWPN.
SaveConfig
Note: Driver Parameters that are set temporarily and globally (using the "G" and "T" flags) must be read using the "GetDriverParams" hbacmd command to view the current value of the parameter. The "GetDriverParamsGlobal" hbacmd command displays only permanently set driver parameter values. Additionally, if temporary, global values have been set for one or more driver parameters, the "SaveConfig" hbacmd command must be run with the "N" flag (using the "N" flag is analogous to the hbacmd command "GetDriverParams") to force the driver parameter values for the specified adapter to be saved. Inaccurate values may be saved if the "G" flag is used for this command.
Supported by: Windows, Solaris, Linux and VMware ESX
Syntax: hbacmd SaveConfig <WWPN> <FileName> <Flag>
Description: This command saves the specified adapter’s driver parameters to a file. The resulting file contains a list of driver parameter definitions in ASCII file format with definitions delimited by a comma.
Each definition is of the form:
<parameter-name>=<parameter-value>.
The command saves either the values of the global set, or those specific to the adapter in the Emulex
Repository directory.
Parameters:
WWPN - Adapter’s WWPN.
FileName - Name of the file that contains the driver parameters list.
Flag -
G = Save the global parameter set.
N = Save the local (adapter-specific) parameter set.
OneCommand Manager Command Line Interface User Manual Page 41
SetDriverParam
Supported by: Windows, Solaris, Linux and VMware ESX
Syntax: hbacmd SetDriverParam <WWPN> <Flag1> <Flag2> <Param> <Value>
Note: For managing ESX/ESXi hosts from a Windows client, add the m=cim option to
Description: This command changes a driver parameter and designates the scope of the change.
Parameters:
WWPN - Adapter’s WWPN.
Flag1 -
L = Make change local for this adapter only.
G = Make change global (all adapters on this host).
Flag2 -
P = Make change permanent (persists across reboot).
T = Make change temporary.
Param - Name of the parameter to modify.
Value - New parameter value, decimal or hex (0xnnn).
SetDriverParamDefaults
Supported by: Windows, Linux and VMware ESX
Syntax: hbacmd SetDriverParamDefaults <WWPN> <Flag1> <Flag2>
Note: For managing ESX/ESXi hosts from a Windows client, add the m=cim option to
Description: This command changes all values to the default for the adapter(s).
Parameters:
WWPN - Adapter’s WWPN.
Flag1 -
L = Make changes local for this adapter only.
G = Make changes global (all adapters on this host).
Flag2 -
P = Make changes permanent (persists across reboot).
T = Make changes temporary.
OneCommand Manager Command Line Interface User Manual Page 42
Dump Commands
Caution: Disruption of service can occur if a diagnostic dump is run during I/O activity.
Note: The diagnostic dump feature enables you to create a “dump” file for a selected adapter. Dump files contain various information such as firmware version, driver version, and so on. This information is particularly useful when troubleshooting an adapter. (Unavailable in read-only mode.)
DeleteDumpFiles
Supported by: Windows, Solaris, Linux and VMware ESX
Syntax: hbacmd DeleteDumpFiles <WWPN>
Note: For managing ESX/ESXi hosts from a Windows client, add the m=cim option to
Description: This command deletes all diagnostic dump files for the adapter.
Parameters:
WWPN - Adapter’s WWPN.
Dump
Note: Not supported on OneConnect adapters.
Supported by: Windows, Solaris, Linux and VMware ESX
Syntax: hbacmd Dump <WWPN>
Note: For managing ESX/ESXi hosts from a Windows client, add the m=cim option to
For LP adapters, only: hbacmd h=ipaddress[:port] m=cim [u=username] [p=password] [n=root/emulex] Dump
<WWPN>
Description: This command creates a diagnostic dump file in the hbacmd dump file directory.
Parameters:
WWPN - Adapter’s WWPN h - Host’s IP Address.
m - cim u - root p - <password> n - <namespace>
OneCommand Manager Command Line Interface User Manual Page 43
GetDumpDirectory
Supported by: Windows, Solaris, Linux and VMware ESX
Syntax: hbacmd h=ipaddress[:port] m=cim [u=username] [p=password] [n=root/emulex]
GetDumpDirectory <WWPN>
Note: For managing ESX/ESXi hosts from a Windows client, add the m=cim option to
Description: This command shows the dump file directory for the adapters in the host.
Note: The dump directory applies to all adapters in the server. There is not a separate dump directory for each adapter.
Parameters:
WWPN - Adapter’s WWPN
SetDumpDirectory
Supported by: VMware ESX/ESXi
Syntax: hbacmd h=ipaddress[:port] m=cim [u=username] [p=password] [n=root/emulex] setdumpdirectory <DumpDirectoryName>
Description: This command sets the dump directory for the ESX/ESXi host. The ‘Dump’ feature works only if the Dump directory is set for the ESXi host.
You must first create a directory to where the files are to be stored. The Dump directory created is prefixed with /vmfs/volumes. You cannot create a directory in /vmfs/volumes.
The provider checks for the Dump directory and creates the dump files in that location.
Note: The dump directory applies to all adapters in the server. There is no separate dump directory for each adapter.
Parameters:
<DumpDirectoryName> - The dump directory to be created.
h - Host’s IP Address.
m - cim u - root p - <password> n - <namespace>
Example:
hbacmd h=10.192.203.173 m=cim u=root p=Swamiji001 n=root/emulex setdumpdirectory
10:00:00:00:c9:61:f2:64 ocm-datastore
OneCommand Manager Command Line Interface User Manual Page 44
GetDumpFile
Supported by: Windows, Solaris, Linux and VMware ESX
Syntax: hbacmd [h=ipAddress] GetDumpFile <WWPN> <filename>
Note: For managing ESX/ESXi hosts from a Windows client, add the m=cim option to
Description: This command gets the dump file. For dump file retrieval over FC/FCoE, the WWPN of a remote FC/FCoE port is required to access the remote host. This command gets the user specified dump file to local client's dump directory. The dump directory (local and remote) is named Dump, and is placed under the OCManager installation directory. Since, the dump files are copied from the Dump directory of the remote host to the Dump directory of the local host, specifying a local port identifier for this command returns the following error, since the source and destination directory is the same.
ERROR: HBACMD_GetDumpFile: RM_GetDumpFile call failed (2)
ERROR: <2>: Not Supported
Dump directory:
For Windows:
For Linux:
For Solaris:
For ESX:
Parameters:
C:\Program Files\Emulex\Util\Dump
/usr/sbin/ocmanager/Dump
/opt/ELXocm/Dump
The dump directory set using the SetDumpDirectory command.
WWPN - Adapter’s WWPN.
<filename> - Name of the dump file to be copied from the remote host.
Example:
hbacmd h=10.192.193.154 m=cim u=root p=Swamiji001 n=root/emulex getdumpfile BG-
HBANYWARE-15_10000000c97d1314_20100120-032820421.dmp
GetDumpFileNames
Supported by: Windows, Solaris, Linux and VMware ESX
Syntax:
hbacmd GetDumpFileNames <wwpn>
Or, hbacmd <h=ipAddress> GetDumpFileNames
Note: For managing ESX/ESXi hosts from a Windows client, add the m=cim option to
Description: This command gets the names of the files in the remote host's dump directory.
OneCommand Manager Command Line Interface User Manual Page 45
Parameters:
WWPN - Adapter’s WWPN.
h - Host’s IP Address.
Example:
hbacmd h=10.192.193.154 m=cim u=root p=Swamiji001 n=root/emulex getdumpfilenames
GetRetentionCount
Supported by: Windows, Solaris, Linux and VMware ESX
Syntax:
hbacmd GetRetentionCount <WWPN>
Note: For managing ESX/ESXi hosts from a Windows client, add the m=cim option to
Description: This command shows the maximum number of diagnostic dump files to keep.
Parameters:
WWPN - Adapter’s WWPN.
SetRetentionCount
Supported by: Windows, Solaris, Linux and VMware ESX
Syntax: hbacmd SetRetentionCount <WWPN> <Value>
Note: For managing ESX/ESXi hosts from a Windows client, add the m=cim option to
Description: This command specifies the maximum number of diagnostic dump files for the adapter.
When the count reaches the limit, the next dump operation deletes the oldest file.
Note: The retention count applies to all adapters in the server.
Parameters:
WWPN - Adapter’s WWPN.
Value - The number of dump files to retain.
Example:
hbacmd h=10.192.193.154 m=cim u=root p=Swamiji001 n=root/emulex
SetRetentionCount 00-00-c9-93-2f-9f 6
OneCommand Manager Command Line Interface User Manual Page 46
FCoE Commands
Note: These commands are supported only on OneConnect adapters running the
FCoE protocol.
GetFCFInfo
Supported by: Windows, Solaris, Linux and VMware ESX
Syntax: hbacmd GetFCFInfo <WWPN>
Note: For managing ESX/ESXi hosts from a Windows client, add the m=cim option to
Description: This command shows the FCF information of the OneConnect adapter in FCoE mode.
Parameters:
WWPN - Adapter’s WWPN.
Example
# hbacmd getfcfinfo 10:00:00:00:c9:3c:f7:88
GetFIPParams
Supported by: Windows, Solaris, Linux and VMware ESX
Syntax: hbacmd GetFIPParams <WWPN>
Note: For managing ESX/ESXi hosts from a Windows client, add the m=cim option to
Description: This command gets the FIP parameters of the OneConnect adapter in FCoE mode.
Parameters:
WWPN - Adapter’s WWPN.
Example:
#hbacmd getfipparams 10:00:00:00:c9:5b:3a:6d
SetFIPParam
Supported by: Windows, Solaris, Linux and VMware ESX
Syntax: hbacmd SetFIPParam <WWPN> <Param> <Value>
Note: For managing ESX/ESXi hosts from a Windows client, add the m=cim option to
OneCommand Manager Command Line Interface User Manual Page 47
Description: This command sets the FIP parameters of the OneConnect adapter in FCoE mode.
Parameters:
WWPN - Adapter’s WWPN.
Param -
Value pfabric - 8 byte fabric name (format XX:XX:XX:XX:XX:XX:XX:XX) pswitch - 8 byte switch name (format XX:XX:XX:XX:XX:XX:XX:XX) vlanid - 2 byte VLAN ID [0-4095]
Or
'any' for any VLANID fcmap - 3-byte FC_map, 0x0EFCxx cinvlanid - 2-byte VLAN_ID [0-4095]
Example:
#hbacmd setfipparam 10:00:00:00:c9:5b:3a:6d fcmap 0x0efc99
iSCSI Commands
Note: iSCSI commands are supported only for OneConnect adapters running the iSCSI protocol.
Note: VMware ESX 4.0 does not support iSCSI.
The following commands support the iSCSI interface in the OneCommand Manager CLI. The commands and their syntax are listed here.
<…> = Required, […] = Optional
The MAC address <MAC_Address> of the CNA port must be passed to each command as the first argument.
Some commands require values to be set in a format similar to: "option_name=value". Either type the
full option name, or the abbreviated option name (shown in Table 3. Option Names on page 48). Then,
enter the value.
The following abbreviations are available for use when setting the option name for a
“option_name=value” option. The abbreviations are not case sensitive.
Table 3. Option Names
Option Name
ImmediateData id
Abbreviation
id=1
Example
DataDigest
HeaderDigest
Auth
Initiator_name
Initiator_alias
DHCP
VLAN_ENABLED
VLAN_ID ia dh ve vi dd hd au in dd=1 hd=1 au=1 in= initiator name ia= initiator alias dh=1 ve=1 vi=1
OneCommand Manager Command Line Interface User Manual Page 48
Table 3. Option Names
Option Name
Priority pr
Abbreviation
pr=1
Example
AddARPTableEntry
Supported by: Windows, Solaris, Linux and VMware ESX
Syntax: hbacmd [h=host_IP[:port] | hostname[:port]] AddARPTableEntry <MAC_Address>
<Dest_MAC_Address> <Dest_IP_Address>
Description: This command adds an Address Resolution Protocol table entry.
Parameters:
MAC_Address - MAC address of the CNA port.
Dest_MAC_Address - Destination MAC address to add to the ARP table.
Dest_IP_Address - Destination IP address to add to the ARP table.
AddRouteTableEntry
Supported by: Windows, Solaris, Linux and VMware ESX
Syntax:
hbacmd [h=host_IP[:port] | hostname[:port]] AddRouteTableEntry <MAC_Address>
<Dest_IP_Address> <Subnet_Mask> <Gateway>
Description: This command adds a new route table entry to the route table of the specified port.
Parameters:
MAC_Address - MAC address of the CNA port.
Dest_IP_Address - Destination IP address to add to the route table.
Subnet_Mask - Subnet Mask to add to the route table.
Gateway - Gateway to add to the route table.
AddTarget
Supported by: Windows, Solaris, Linux and VMware ESX
Syntax:
hbacmd [h=host_IP[:port] | hostname[:port]] AddTarget <MAC_Address> <Target_IP>
<Port> <iscsi_target_name> [ImmediateData=<0|1>] [HeaderDigest=<0|1>]
[DataDigest=<0|1>] [Auth=<0|1|2> "TgtCHAPName" "TgtSecret" "InitCHAPName"
"InitSecret"]
Description: This command adds a target to the list of targets seen by the initiator and logs into the target once it has been successfully created. This command requires that you specify a valid target IP
<Target_IP>, port number <Port>, and iSCSI name <iscsi_target_name>. If you do not specify the remaining options, these options are set to their default values. When you set the Authentication Method
OneCommand Manager Command Line Interface User Manual Page 49
<Auth> to a value other than 0, you must set additional parameters to specify the initiator CHAP name, target CHAP name, and initiator and target secret strings. Each string should be enclosed in quotations to avoid mangling by the Windows, Linux, Solaris, or VMware shell's parser.
If you set the Authentication Method to "One-Way CHAP (value of 1)", you must also specify the "Target
CHAP Name" and "Target Secret."
Example:
hbacmd AddTarget 00-11-22-33-44-55 192.168.1.1 8000 iscsitarget Auth=1
"TgtCHAPName" "TargetSecret1"
If you set the Authentication Method to "Mutual CHAP (value of 2)" you must specify all 4 values.
Example:
hbacmd AddTarget 00-11-22-33-44-55 192.168.1.1 8000 iscsitarget Auth=1
"TgtCHAPName" "TargtSecret1" "InitCHAPName" "InitialSecret1"
Parameters:
MAC_Address - MAC address of the CNA port.
Port - Port number of the Target Portal (value: 1024-65535).
iscsi_target_name - Target’s iSCSI name enclosed in quotes (string length:11-255).
Target_IP - IP address of the target portal.
ImmediateData -
0 = No.
1 = Yes (default: 1)
HeaderDigest -
0 = None.
1= CRC32C (default: 0)
DataDigest -
0 = None.
1= CRC32C (default: 0)
Auth -
0 = None
1= One-Way CHAP
2 = Mutual CHAP (default: 0)
TgtCHAPName - Target CHAP Name enclosed in quotes (string length: 1-256).
TgtSecret - Target Secret enclosed in quotes (string length: 12-16).
InitCHAPName - Initiator CHAP Name enclosed in quotes (string length: 1-256).
InitSecret - Initiator Secret enclosed in quotes (string length: 12-16).
Note: If you set Auth to 1, you must also specify the TgtCHAPName and TgtSecret. If you set Auth to a value of 2, you must also specify the TgtCHAPName, TgtSecret,
InitCHAPName, and InitSecret must also be specified.
OneCommand Manager Command Line Interface User Manual Page 50
AddTargetPortal
Note: You must specify either the TSIH value or the ISID qualifier. If you specify ISID qualifier you must also specify the Target’s ID address.
Supported by: Windows, Solaris, Linux and VMware ESX
Syntax: hbacmd [h=host_IP[:port] | hostname[:port]] AddTargetPortal <MAC_Address>
<Target_IP> <Port> [ImmediateData=<0|1>] [HeaderDigest=<0|1>] [DataDigest=<0|1>]
[Auth=<0|1|2> "TgtCHAPName" "TgtSecret" "InitCHAPName" "InitSecret"]
Description: This command adds a new SendTarget Portal for the initiator and runs a target discovery once the SendTarget Portal is created. This command requires that you specify a valid portal IP address
<Target_IP> and a valid port number <Port>. If you do not specify the remaining options, these options are set to their default values. When you set the Authentication Method <Auth> to a value other than 0, you must set additional parameters to specify the initiator CHAP name, target CHAP name, and initiator and target secret strings. Each string should be enclosed in quotations to avoid mangling by the
Windows, Linux, Solaris, or VMware shell's parser.
If you set the Authentication Method to "One-Way CHAP (value of 1)", you must also set the "Target
CHAP Name" and "Target Secret."
Example:
hbacmd AddTargetPortal 00-11-22-33-44-55 10.0.0.1 8000 Auth=1 "TgtCHAPName"
"TargetSecret1"
If you set the Authentication Method to "Mutual CHAP (value of 2)", You must specify all 4 values.
Example:
hbacmd AddTargetPortal 00-11-22-33-44-55 10.0.0.1 8000 Auth=2 "TgtChapName"
"TargetSecret1" "InitCHAPName" "InitialSecret1"
Parameters:
MAC_Address - MAC address of the CNA port.
Target_IP - IP address of the Target Portal.
Port - Port number of the Target Portal (value: 1024-65535).
ImmediateData -
0 = No
1 = Yes (default: 1)
HeaderDigest -
0 = None
1= CRC32C (default: 0)
DataDigest -
0 = None
1= CRC32C (default: 0)
Auth -
0 = None
OneCommand Manager Command Line Interface User Manual Page 51
1= One-Way CHAP
2 = Mutual CHAP (default: 0)
TgtCHAPName - Target CHAP Name enclosed in quotes (string length: 1-256).
TgtSecret - Target Secret enclosed in quotes (string length: 12-16).
InitCHAPName - Initiator CHAP Name enclosed in quotes (string length: 1-256).
InitSecret - Initiator Secret enclosed in quotes (string length: 12-16).
Note: If Auth is set to 1, the TgtCHAPName and TgtSecret must be specified. If Auth is set to a value of 2, the TgtCHAPName, TgtSecret, InitCHAPName, and InitSecret must also be specified.
CleariSNSServer
Supported by: Windows, Solaris, Linux and VMware ESX
Syntax: hbacmd [h=host_IP[:port] | hostname[:port]] CleariSNSServer <MAC_Address>
Description: This command clears the configured iSNS server and disables iSNS target discovery. If there is no iSNS server currently configured, this command does nothing.
Parameters:
MAC_Address - MAC address of the CNA port.
DelARPTableEntry
Supported by: Windows, Solaris, Linux and VMware ESX
Syntax: hbacmd [h=host_IP[:port] | hostname[:port]] DelARPTableEntry <MAC_Address>
<Dest_MAC_Address> <Dest_IP_Address>
Description: This command removes an ARP (Address Resolution Protocol) table entry.
Parameters:
MAC_Address - MAC address of the CNA port.
Dest_MAC_Address - Destination MAC address to remove from the ARP table.
Dest_IP_Address - Destination IP address to remove from the ARP table.
DelRouteTableEntry
Supported by: Windows, Solaris, Linux and VMware ESX
Syntax: hbacmd [h=host_IP[:port] | hostname[:port]] DelRouteTableEntry <MAC_Address>
<Dest_IP_Address> <Subnet_Mask> <Gateway>
Description: This command removes a route table entry from the specified port.
Parameters:
MAC_Address - MAC address of the CNA port.
OneCommand Manager Command Line Interface User Manual Page 52
Dest_IP_Address - Destination IP address to delete from the route table.
Subnet_Mask - Subnet Mask to delete from the route table.
Gateway - Gateway to delete from the route table.
DiscoveriSNSServer
Supported by: Windows, Solaris, Linux and VMware ESX
Syntax:
hbacmd [h=host_IP[:port] | hostname[:port]] DiscoveriSNSServer <MAC_Address>
Description: This command discovers an iSNS server address through DHCP. If the DHCP server returns an iSNS server address, it replaces the configured iSNS server and can be viewed using the
ShowiSNSServer command.
Parameters:
MAC_Address - MAC address of the CNA port.
GetInitiatorProperties
Supported by: Windows, Solaris, Linux and VMware ESX
Syntax: hbacmd [h=host_IP[:port] | hostname[:port]] GetInitiatorProperties <MAC_Address>
Description: This command shows all the initiator login options for the specified port.
Parameters:
MAC_Address - MAC address of the CNA port.
GetiSCSILuns
Supported by: Windows, Solaris, Linux and VMware ESX
Syntax: hbacmd [h=host_IP[:port] | hostname[:port]] GetiSCSILuns <MAC_Address>
<iscsi_target_name>
Description: This command shows all the LUNs and their information for a specified target. The iSCSI target name <iscsi_target_name> tells the command to gather the information from the specified iSCSI target.
Parameters:
MAC_Address - MAC address of the CNA port.
iscsi_target_name - Target’s iSCSI name enclosed in quotes (string length:11-255).
OneCommand Manager Command Line Interface User Manual Page 53
GetiSCSIPortStats
Supported by: Windows, Solaris, Linux and VMware ESX
Syntax:
hbacmd [h=host_IP[:port] | hostname[:port]] GetiSCSIPortStats <MAC_Address>
Description: This command shows all the port statistics for a specified port.
Parameters:
MAC_Address - MAC address of the CNA port.
GetSessionInfo
Supported by: Windows, Solaris, Linux and VMware ESX
Syntax:
hbacmd [h=host_IP[:port] | hostname[:port]] GetSessionInfo <MAC_Address>
<iscsi_target_name> <TSIH | <ISID_Qual Target_IP>>
Description: This command lists all session information for a specified session. You must specify the iSCSI target name <iscsi_target_name> and either the TSIH <TSIH> of the session or the session's ISID Qualifier <ISID_Qual> and the target's IP address <Target_IP>. These parameters tell the command to gather the information from the specified target and session. You can find the TSIH and ISID qualifier by running the ListSessions command.
Parameters:
MAC_Address - MAC address of the CNA port.
iscsi_target_name - Target’s iSCSI name enclosed in quotes (string length:11-255).
TSIH - TSIH value of the session (value: 1-65535).
ISID_Qual - ISID qualifier of the session (value: 0-65535).
Target_IP - The Target's IP address.
Note: You must specify either the TSIH value or the ISID qualifier. If ISID qualifier is specified you must also specify the Target’s ID address.
iSCSIPing
Supported by: Windows, Solaris, Linux and VMware ESX
Syntax:
hbacmd [h=host_IP[:port] | hostname[:port]] iSCSIPing <MAC_Address> <IP_Address>
Description: This command issues ICMP echo requests to a target.
Parameters:
MAC_Address - MAC address of the CNA port.
IP_Address - IP Address of target to send ICMP echo request.
OneCommand Manager Command Line Interface User Manual Page 54
ListSessions
Supported by: Windows, Solaris, Linux and VMware ESX
Syntax: hbacmd [h=host_IP[:port] | hostname[:port]] ListSessions <MAC_Address>
<iscsi_target_name>
Description: This command lists all the sessions on a specified target. The iSCSI target name
<iscsi_target_name> instructs the command to gather the information from the listed iSCSI target name.
Parameters:
MAC_Address - MAC address of the CNA port.
iscsi_target_name - Target’s iSCSI name enclosed in quotes (string length:11-255).
RemoveTarget
Supported by: Windows, Solaris, Linux and VMware ESX
Syntax: hbacmd [h=host_IP[:port] | hostname[:port]] RemoveTarget <MAC_Address>
<iscsi_target_name>
Description: This command removes the target with the specified iSCSI target name
<iscsi_target_name>.
Parameters:
MAC_Address - MAC address of the CNA port.
iscsi_target_name - Target’s iSCSI name enclosed in quotes (string length:11-255).
RemoveTargetPortal
Supported by: Windows, Solaris, Linux and VMware ESX
Syntax:
hbacmd [h=host_IP[:port] | hostname[:port]] RemoveTargetPortal <MAC_Address>
<Target_IP> <Port>
Description: This command removes the SendTarget Portal containing the target IP <Target_IP> and the port <Port> from the list of portals for the specified initiator.
Parameters:
MAC_Address - MAC address of the CNA port.
Target_IP - IP address of the Target Portal.
Port - Port number of the Target Portal (value: 1024-65535).
OneCommand Manager Command Line Interface User Manual Page 55
SetInitiatorProperties
Supported by: Windows, Solaris, Linux and VMware ESX
Syntax:
hbacmd [h=host_IP[:port] | hostname[:port]] SetInitiatorProperties
<MAC_Address> [Initiator_Name="initiator_name"]
[Initiator_Alias="initiator_alias"] [ImmediateData=<0|1>] [HeaderDigest=<0|1>]
[DataDigest=<0|1>] [Auth=<0|1|2> "TgtCHAPName" "TgtSecret" "InitCHAPName"
"InitSecret"]
Description: This command sets the initiator properties for the specified port. It allows you to specify an initiator name <Initiator_Name> and, an initiator alias <Initiator_Alias>. If you opt not to specify these fields, a default iSCSI name is assigned. When you set Authentication Method <Auth> to a value other than 0, you must set additional parameters to specify the initiator, target CHAP name, and secret strings. Enclose these strings in quotations to avoid mangling by the Windows, Linux, Solaris, or
VMware shell's parser.
If you set the Authentication Method to "One-Way CHAP (value of 1)", you must also set the "Target
CHAP Name" and "Target Secret."
Example:
hbacmd SetInitiatorProperties 00-11-22-33-44-55 Auth=1 "TgtChapName"
"TargetSecret1"
If you specify the Authentication Method to "Mutual CHAP (value of 2)", you must specify all 4 values.
Example:
hbacmd SetInitiatorProperties 00-11-22-33-44-55 Auth=2 "TgtChapName"
"TargetSecret1" "InitCHAPName" "InitialSecret1"
Parameters:
MAC_Address - MAC address of the CNA port.
Initiator_Name - Initiator iSCSI Name enclosed in quotes (string length: 1-224).
Initiator_Alias - Initiator iSCSI Alias enclosed in quotes (string length: 0-32).
ImmediateData -
0 = No
1 = Yes (default: 1)
HeaderDigest -
0 = None
1= CRC32C (default: 0)
DataDigest -
0 = None
1= CRC32C (default: 0)
Auth -
0 = None
1= One-Way CHAP
OneCommand Manager Command Line Interface User Manual Page 56
2 = Mutual CHAP (default: 0)
TgtCHAPName - Target CHAP Name enclosed in quotes (string length: 1-256).
TgtSecret - Target Secret enclosed in quotes (string length: 12-16).
InitCHAPName - Initiator CHAP Name enclosed in quotes (string length: 1-256).
InitSecret - Initiator Secret enclosed in quotes (string length: 12-16).
Note: If you set Auth to 1, you must also specify the TgtCHAPName and TgtSecret. If you set Auth is set to a value of 2, you must also specify the TgtCHAPName,
TgtSecret, InitCHAPName, and InitSecret.
SetNetworkConfiguration
Supported by: Windows, Solaris, Linux and VMware ESX
Syntax: hbacmd [h=host_IP[:port] | hostname[:port]] SetNetworkConfiguration
<MAC_Address> <VLAN_ENABLED=<0|1> [<VLAN_ID=<0-4096>> <Priority=<0-7>>]
<DHCP=<0|1>> [<IP_Address> <Subnet_Mask> [Gateway]]
Description: This command sets the TCP/IP configuration on a specified port. The required fields for this command depend upon the values set for DHCP <DHCP> and VLAN Enabled <VLAN_ENABLED>.
Parameters:
MAC_Address - MAC address of the CNA port.
VLAN_ENABLED - 0 = Disabled, 1 = Enabled.
VLAN_ID - VLAN ID of the interface (value: 0-4095).
Priority - VLAN priority of the interface (value: 0-7).
DHCP -
0 = Disabled
1 = Enabled
IP_Address - New IP address (for example: 10.192.1.1).
Subnet_Mask - Subnet Mask (for example: 255.255.255.0).
Gateway - Gateway (for example: 10.192.1.1).
Note: VLAN_ID and Priority are required only if VLAN_ENABLED is Enabled; otherwise, these values should be omitted.
Note: IP_Address and Subnet_Mask are required only if DHCP is Disabled; otherwise these values should be omitted.
OneCommand Manager Command Line Interface User Manual Page 57
SetTargetLoginProperties
Supported by: Windows, Solaris, Linux and VMware ESX
Syntax:
hbacmd [h=host_IP[:port] | hostname[:port]] SetTargetLoginProperties
<MAC_Address> <iscsi_target_name> [ImmediateData=<0|1>] [HeaderDigest=<0|1>]
[DataDigest=<0|1>] [Auth=<0|1|2> "TgtCHAPName" "TgtSecret" "InitCHAPName"
"InitSecret"]
Description: This command sets the login and authentication properties associated with a specific target. This command requires that you specify a valid iSCSI target name <iscsi_target_name>. If you do not specify some of the remaining properties, these options are set to their default values.
However, if no properties are changed, an error is generated. You must change at least one property for this command to return successfully. When you set the Authentication Method <Auth> to a value other than 0, you must set additional parameters to specify the initiator CHAP name, target CHAP name, and initiator and target secret strings. Each string should be enclosed in quotations to avoid mangling by the
Windows, Linux, Solaris, or VMware shell's parser.
If you set the Authentication Method is set to "One-Way CHAP (value of 1)", you must also set the
"Target CHAP Name" and "Target Secret."
Example:
hbacmd SetTargetLoginProperties 00-11-22-33-44-55 iscsitarget Auth=1
"TgtCHAPName" "TargetSecret1"
If you set the Authentication Method to "Mutual CHAP (value of 2)", you must also specify all 4 values.
Example:
hbacmd SetTargetLoginProperties 00-11-22-33-44-55 iscsitarget Auth=2
"TgtChapName" "TargetSecret1" "InitCHAPName" "InitialSecret1"
Parameters:
MAC_Address - MAC address of the CNA port.
iscsi_target_name - Target’s iSCSI name enclosed in quotes (string length:11-255).
ImmediateData -
0 = No.
1 = Yes (default: 1).
HeaderDigest -
0 = None
1= CRC32C (default: 0).
DataDigest -
0 = None
1= CRC32C (default: 0).
Auth -
0 = None
1= One-Way CHAP
OneCommand Manager Command Line Interface User Manual Page 58
2 = Mutual CHAP (default: 0).
TgtCHAPName - Target CHAP Name enclosed in quotes (string length: 1-255).
TgtSecret - Target Secret enclosed in quotes (string length: 12-16).
InitCHAPName - Initiator CHAP Name enclosed in quotes (string length: 1-255).
InitSecret - Initiator Secret enclosed in quotes (string length: 12-16).
Note: If you set Auth is set to 1, you must specify the TgtCHAPName and TgtSecret.
If you set Auth to a value of 2, you must specify the TgtCHAPName, TgtSecret,
InitCHAPName, and InitSecret.
SetTargetProperties
Supported by: Windows, Solaris, Linux and VMware ESX
Syntax: hbacmd [h=host_IP[:port] | hostname[:port]] SetTargetProperties <MAC_Address>
<iscsi_target_name> <ETO>
Description: This command sets the Extended TimeOut (ETO) value of a target. This command requires you specify the iSCSI target name <iscsi_target_name> and the Extended Timeout <ETO> values.
Parameters:
MAC_Address - MAC address of the CNA port.
iscsi_target_name - Target’s iSCSI name enclosed in quotes (string length:11-255).
ETO - Extended Timeout Option for the target (value differs depending on the OS):
Windows: 0 - 3600
Solaris, Linux and ESX: 0 - 30
SetTPLoginProperties
Supported by: Windows, Solaris, Linux and VMware ESX
Syntax: hbacmd [h=host_IP[:port] | hostname[:port]] SetTPLoginProperties <MAC_Address>
<Target_IP> <Port> [ImmediateData=<0|1>] [HeaderDigest=<0|1>] [DataDigest=<0|1>]
[Auth=<0|1|2> TgtCHAPName TgtSecret InitCHAPName InitSecret]
Description: This command sets a target portal's login properties. This command requires that you specify a valid Target IP <Target_IP> and Port <Port>. However, if you specify no options other than the Target IP and Port, no changes are made. You must change at least one of the optional parameters for this command to make any changes to the target portal's login properties. When you set the
Authentication Method <Auth> to a value other than 0, you must set additional parameters to specify the initiator CHAP name, target CHAP name, and initiator and target secret strings. Each string should be enclosed in quotations to avoid mangling by the Windows, Linux, Solaris, or VMware shell's parser.
If the Authentication Method is set to "One-Way CHAP (value of 1)", you must also specify the "Target
CHAP Name" and "Target Secret".
OneCommand Manager Command Line Interface User Manual Page 59
Example:
hbacmd SetTPLoginProperties 00-11-22-33-44-55 10.192.1.1 5050 Auth=1
"TgtChapName" "TargetSecret1"
If you set the Authentication Method to "Mutual CHAP (value of 2)", you must specify all 4 values.
Example:
hbacmd SetTPLoginProperties 00-11-22-33-44-55 10.192.1.1 5050 Auth=2
"TgtChapName" "TargetSecret1" "InitCHAPName" "InitialSecret1"
Parameters:
MAC_Address - MAC address of the CNA port.
Target_IP - IP address of the Target Portal.
Port - Port number of the Target Portal (value: 1024-65535).
ImmediateData - 0 = No, 1= Yes (default: 1).
HeaderDigest - 0 = None, 1= CRC32C (default: 0).
DataDigest - 0 = None, 1= CRC32C (default: 0).
Auth - 0 = None, 1= One-Way CHAP, 2 = Mutual CHAP (default: 0).
TgtCHAPName - Target CHAP Name enclosed in quotes (string length: 1-256).
TgtSecret - Target Secret enclosed in quotes (string length: 12-16).
InitCHAPName - Initiator CHAP Name enclosed in quotes (string length: 1-256).
InitSecret - Initiator Secret enclosed in quotes (string length: 12-16).
Note: If you set Auth to 1, you must specify the TgtCHAPName and TgtSecret. If you set Auth to a value of 2, you must specify the TgtCHAPName, TgtSecret,
InitCHAPName, and InitSecret.
ShowARPTable
Supported by: Windows, Solaris, Linux and VMware ESX
Syntax: hbacmd [h=host_IP[:port] | hostname[:port]] ShowARPTable <MAC_Address>
Description: This command shows the current Address Resolution Protocol table for the specified port.
Parameters:
MAC_Address - MAC address of the CNA port.
ShowiSNSServer
Supported by: Windows, Solaris, Linux and VMware ESX
Syntax: hbacmd [h=host_IP[:port] | hostname[:port]] ShowiSNSServer <MAC_Address>
Description: This command shows the currently configured Internet Storage Name Server. This command also indicates whether or not iSNS discovery is enabled.
OneCommand Manager Command Line Interface User Manual Page 60
Parameters:
MAC_Address - MAC address of the CNA port.
ShowRouteTable
Supported by: Windows, Solaris, Linux and VMware ESX
Syntax:
hbacmd [h=host_IP[:port] | hostname[:port]] ShowRouteTable <MAC_Address>
Description: This command shows the route table for a specific port.
Parameters:
MAC_Address - MAC address of the CNA port.
Example:
hbacmd h=10.192.203.240 showroutetableentry 00-00-c9-a0-ce-77
ShowTarget
Supported by: Windows, Solaris, Linux and VMware ESX
Syntax: hbacmd [h=host_IP[:port] | hostname[:port]] ShowTarget <MAC_Address>
[<iscsi_target_name> | refreshtargets]
Description: This command shows the properties for a specified target. If you do not specify the iSCSI target name <iscsi_target_name>, all targets and their associated properties are displayed. If you specify refreshtargets in place of the iSCSI Target Name, all targets are refreshed before displaying the information. If you provide no iSCSI Target Name and do not specify refreshtargets, only the targets from the last refresh are displayed.
Parameters:
MAC_Address - MAC address of the CNA port.
iscsi_target_name - Target’s iSCSI name enclosed in quotes (string length:11-255).
refreshtargets - Refresh all targets before displaying the information.
Note: Only one command option can be specified with this command. If you provide the <iscsi_target_name>, you cannot specify refreshtargets. Likewise, if you specify refreshtargets then you cannot specify the <iscsi_target_name>.
ShowTargetPortal
Supported by: Windows, Solaris, and Linux
Syntax: hbacmd [h=host_IP[:port] | hostname[:port]] ShowTargetPortal <MAC_Address>
[<Target_IP> <Port>]
Description: This command shows the properties for a specified SendTarget Portal. If the Target_IP and Port are not specified, all SendTarget Portals and their associated properties are displayed.
OneCommand Manager Command Line Interface User Manual Page 61
Parameters:
MAC_Address - MAC address of the CNA port.
Target_IP - IP address of the target portal.
Port - Port number of the target portal.
TargetLogin
Supported by: Windows, Solaris, Linux and VMware ESX
Syntax: hbacmd [h=host_IP[:port] | hostname[:port]] TargetLogin <MAC_Address>
<iscsi_target_name> [target_portal_ip <port>] [ImmediateData=<0|1>]
[HeaderDigest=<0|1>] [DataDigest=<0|1>] [Auth=<0|1|2> "TgtCHAPName" "TgtSecret"
"InitCHAPName" "InitSecret"]
Description: This command logs in to a target. The iSCSI target name <iscsi_target_name> is the only mandatory option. The target's portal <target_portal> and port <port> information are optional and if they are not provided a default target portal is used. If you do not specify the remaining options, these options are set to their default values. When you set the Authentication Method <Auth> to a value other than 0, you must set additional parameters to specify the initiator CHAP name, target CHAP name, and initiator and target secret strings. Each string should be enclosed in quotations to avoid mangling by the
Windows, Linux, Solaris, or VMware shell's parser.
If you set the Authentication Method to "One-Way CHAP (value of 1)", you must also specify the "Target
CHAP Name" and "Target Secret."
Example:
hbacmd TargetLogin 00-11-22-33-44-55 iscsitarget Auth=1 "TgtChapName"
"TargetSecret1"
If the you set the Authentication Method to "Mutual CHAP (value of 2)", you must specify all 4 values.
Example:
hbacmd TargetLogin 00-11-22-33-44-55 iscsitarget Auth=2 "TgtChapName"
"TargetSecret1" "InitCHAPName" "InitialSecret1"
Parameters:
MAC_Address - MAC address of the CNA port.
iscsi_target_name - Target’s iSCSI name enclosed in quotes (string length:11-255).
Port - Port number of the Target Portal (value: 1024-65535).
ImmediateData -
0 = No
1= Yes (default: 1)
HeaderDigest -
0 = None
1= CRC32C (default: 0)
DataDigest -
0 = None
OneCommand Manager Command Line Interface User Manual Page 62
1= CRC32C (default: 0)
Auth -
0 = None
1= One-Way CHAP
2 = Mutual CHAP (default: 0)
TgtCHAPName - Target CHAP Name enclosed in quotes (string length: 1-255).
TgtSecret - Target Secret enclosed in quotes (string length: 12-16).
InitCHAPName - Initiator CHAP Name enclosed in quotes (string length: 1-255.
InitSecret - Initiator Secret enclosed in quotes (string length: 12-16).
Note: If you set Auth to 1, you must specify the TgtCHAPName and TgtSecret. If you set Auth to 2, you must specify the TgtCHAPName, TgtSecret, InitCHAPName, and
InitSecret.
TargetLogout
Supported by: Windows, Solaris, Linux and VMware ESX
Syntax: hbacmd [h=host_IP[:port] | hostname[:port]] TargetLogout <MAC_Address>
<iscsi_target_name> <TSIH | <ISID_Qual Target_IP>
Description: This command logs out of a target. The required fields are the iSCSI target name
<iscsi_target_name> and either the TSIH <TSIH> of the session or the session's ISID qualifier
<ISID_Qual> and the target's IP address <Target_IP>.
Parameters:
MAC_Address - The MAC address of the CNA port.
iscsi_target_name - Target’s iSCSI name enclosed in quotes (string length:11-255).
TSIH - TSIH value of the session to log out (values: 1-65535).
ISID_Qual - ISID qualifier of the session to logout (value: 0-65535).
Target_IP - The Target's IP address.
UpdateiSNSServer
Supported by: Windows, Solaris, Linux and VMware ESX
Syntax:
hbacmd [h=host_IP[:port] | hostname[:port]] UpdateiSNSServer <MAC_Address>
<Server_IP> <Port>
Description: This command updates the configured iSNS server. This command requires the server IP
<Server_IP> and port number <Port> of the iSNS server be available to respond to the iSNS requests.
Parameters:
MAC_Address - MAC address of the CNA port.
Server_IP - IP address of the iSNS server to configure.
Port - Port number of the iSNS server to configure (value: 1024-65535).
OneCommand Manager Command Line Interface User Manual Page 63
LUN Masking Commands
Note: Supported for FC/FCoE adapters only.
Note: LUN masking commands are not supported by Linux.
Note: The GetLunMaskbyHBA, GetLunMaskbyTarget, RescanLuns, SetLunMask, and GetAutoConfig commands are not supported for VMware ESX and Solaris.
GetLunList
Supported by: Windows and Solaris
Syntax: hbacmd GetLunList <HBA WWPN> <Target WWPN> <Option>
Note: For managing ESX/ESXi hosts from a Windows client, add the m=cim option to
Description: This command queries for the presence of any masked LUNs.
Parameters:
HBA WWPN - Adapter’s WWPN.
Target WWPN - World wide port name of the target.
Option -
0 = Get information from driver.
1 = Get information from configuration.
GetLunUnMaskByHBA
Supported by: Windows and Solaris
Syntax: hbacmd GetLunUnMaskByHBA <HBA WWPN> <Option>
Description: This command queries for the presence of any unmasked LUNs by adapter.
Parameters:
HBA WWPN - Adapter’s WWPN.
Option -
0 = Get information from driver.
1 = Get information from configuration.
OneCommand Manager Command Line Interface User Manual Page 64
GetLunUnMaskByTarget
Supported by: Windows and Solaris
Syntax:
hbacmd GetLunUnMaskByTarget <HBA WWPN> <Target WWPN> <Option>
Description: This command queries for any unmasked LUNs by target.
Parameters:
HBA WWPN - Adapter’s WWPN.
Target WWPN - Target’s WWPN.
Option -
0 = Get information from driver.
1 = Get information from configuration.
RescanLuns
Supported by: Windows and Solaris
Syntax:
hbacmd RescanLuns <HBA WWPN> <Target WWPN>
Description: This command rescans LUNs to find any new LUNs.
Parameters:
HBA WWPN - Adapter’s WWPN.
Target WWPN - Target’s WWPN.
SetLunMask
Supported by: Windows and Solaris
Syntax:
hbacmd SetLunMask <HBA WWPN> <Target WWPN> <Option> <Lun> <LunCount> <MaskOp>
Description: This command masks the specified LUNs.
Parameters:
HBA WWPN - Adapter’s WWPN.
Target WWPN - Target’s WWPN.
Option -
0 = Send information to the driver.
1 = Send information to configuration (make persistent).
2 = Send information to both.
Lun - Starting LUN number.
LunCount - Number of LUNs.
OneCommand Manager Command Line Interface User Manual Page 65
MaskOp -
A = Mask LUN
B = Clear unmask target level
C = Clear unmask HBA level
D = Unmask LUN
E = Unmask target level
F = Unmask HBA level
Miscellaneous Commands
<…> = Required, […] = Optional
AddHost
Supported by: Windows, Solaris, Linux and VMware ESX
Syntax: hbacmd AddHost host_address
Note: For managing ESX/ESXi hosts from a Windows client, add the m=cim option to
Description: This command adds a host to the hosts file for TCP/IP management in the OneCommand
Manager GUI. The adapters for these hosts are also presented by the listhbas command. The host_address can be an IP address or a host name.
Parameters: host_address - Host to add.
CnaClearEventLog
Note: Supported for OneConnect adapters only.
Supported by: Windows, Linux and VMware ESX
Syntax: hbacmd CnaClearEventLog <WWPN|MAC>
Description: This command clears the CNA eventlog specified by the WWPN or MAC address.
Parameters:
WWPN - WWPN of the CNA FCoE port.
MAC - MAC address of NIC or iSCSI port of the CNA.
OneCommand Manager Command Line Interface User Manual Page 66
CnaGetEventLog
Note: Supported for OneConnect adapters only.
Supported by: Windows, Linux and VMware ESX
Syntax:
hbacmd CnaGetEventLog <WWPN|MAC>
Description: This command shows the CNA event log specified by the WWPN or MAC address.
Parameters:
WWPN: Adapter’s WWPN port.
MAC - MAC address of the NIC or iSCSI port.
Download
Supported by: Windows, Solaris, Linux and VMware ESX
Syntax:
hbacmd Download <WWPN|MAC> <FileName>
Note: For managing ESX/ESXi hosts from a Windows client, add the m=cim option to
Description: Loads the firmware image to the FC or CNA port specified by the WWPN or MAC address.
Parameters:
WWPN - Port’s WWPN.
MAC - The MAC address of the NIC or iSCSI port.
FileName - The name and location of the firmware image (any file accessible to the CLI client).
Note: For OneConnect adapters, while the WWPN or MAC address is used to identify the adapter, the updated firmware applies to all ports on that adapter. It is not necessary to download the firmware on all the adapter ports of a OneConnect adapter.
ExportSANInfo
Note: Emulex recommends that you redirect this output to a file with proper extension, '.xml' for XML-formatted files and '.csv' for CSV-formatted files.
Note: Due to the amount of information that must be obtained and reported, this command can take a long time on large SAN configurations.
Supported by: Windows, Solaris Linux and VMware ESX
OneCommand Manager Command Line Interface User Manual Page 67
Syntax: hbacmd ExportSANInfo [format]
Note: [format] is optional. If the format parameter is specified as csv, adapter information is shown in csv format. If the format parameter is specified as xml, adapter information is shown in xml format. Leaving the format parameter blank shows the data in xml format.
Description: For reporting purposes, this command captures the SAN information in xml or csv format.
As large amount of information is output from this command Emulex recommends that you re-direct the output to a file.
Parameters:
Format: csv - Output information in CSV format.
xml - Output information in XML format (default).
GetCimCred
Supported by: Windows
Syntax: hbacmd GetCimCred
Description: This command shows the default credentials set for the CIM client.
Note: The password will be shown encrypted.
Parameters: None.
GetElxSecInfo
Supported by: Windows and Linux
Syntax:
hbacmd GetElxSecInfo
Description: This command shows the version of the ElxSec system.
Parameters: None.
GetQoSInfo
Supported by: Windows, Solaris, Linux and VMware ESX
Syntax: hbacmd [h=host_IP[:port] | hostname[:port]] GetQoSInfo <MAC_Address>
Note: For managing ESX/ESXi hosts from a Windows client, add the m=cim option to
Description: This command shows the QoS information for a specified NIC port.
OneCommand Manager Command Line Interface User Manual Page 68
Parameters:
h - Host’s IP Address or hostname.
WWPN - Adapter’s WWPN port.
MAC - MAC address of the NIC or iSCSI port.
Example:
C:\Program Files\emulex\Util\HBAnyware>hbacmd h=10.192.203.154 m=cim u=root p=Swamiji001 n=root/emulex getqosinfo 00-00-c9-93-2f-d6
GetVPD
Supported by: Windows, Solaris, Linux and VMware ESX
Syntax: hbacmd GetVPD <WWPN>
Note: For managing ESX/ESXi hosts from a Windows client, add the m=cim option to
Description: This command shows the port’s Vital Product Data (VPD).
Parameters:
WWPN - Adapter’s WWPN.
ListHBAs
Supported by: Windows, Solaris, Linux and VMware ESX
Description: This command shows a list of the manageable Emulex adapters found by local, remote inband (FC), and remote out-of-band (TCP/IP) discovery. For a NIC-only or iSCSI adapter instead of the
Port WWN, the MAC address is displayed. The Node WWN and Fabric WWN are not displayed.
Syntax:
hbacmd [h=<IPAddress>] listhbas [local] [m=model] [pt=type]
Note: For managing ESX/ESXi hosts from a Windows client, add the m=cim option to
Parameters: h - Host’s IP Address.
local - Only display local adapters.
m=model - Model filter (append * to end of model name for wildcard match, e.g. LP9*).
pt=type - Port type filter (valid types: NIC, iSCSI, FC, FCoE).
OneCommand Manager Command Line Interface User Manual Page 69
RemoveHost
Supported by: Windows, Solaris, Linux and VMware ESX
Syntax:
hbacmd RemoveHost host_address
Note: For managing ESX/ESXi hosts from a Windows client, add the m=cim option to
Description: This command removes a host from the hosts file use for TCP/IP management in the
OneCommand Manager GUI. The host_address can be an IP address or a host name.
Parameters: host_address - Host to remove.
Reset
Note: Supported only for FC and FCoE ports. Not supported for NIC and iSCSI ports.
Note: For OneConnect FCoE ports, this command only resets the driver to update changed driver parameters that require a driver reset. It does not cause a hardware reset of the adapter port.
Supported by: Windows, Solaris, Linux and VMware ESX
Syntax:
hbacmd Reset <WWPN>
Note: For managing ESX/ESXi hosts from a Windows client, add the m=cim option to
Description: This command resets the adapter. An adapter reset can require several seconds to complete, especially for remote devices. When the reset is completed, the system command prompt is displayed.
Parameters:
WWPN - Adapter’s WWPN.
SetCimCred
Supported by: Windows
Syntax: hbacmd SetCimCred <username> <password> <namespace> <portnum>
Note: Use this command to set only the CIM credentials. Once this is done, subsequent hbacmd commands do not require you to specify the CIM credentials in the command line
OneCommand Manager Command Line Interface User Manual Page 70
Description: This command sets the default CIM credentials. You must specify all four credentials: username, password, namespace and portnumber. Default credentials are used if any credential is not in the hbacmd command argument. Once the default credentials for a host are set, any other command can be issued by specifying m=cim.
Parameters:
h - Port’s IP Address.
m - cim username - root - Login User ID of the VMware ESX.
password - Login password of the VMware ESX.
namespace - Namespace where the Emulex provider is registered in the sfcb CIMOM of
VMware ESX, that is, root/emulex.
portnum - Port number of the sfcb CIMOM listening to that is, 5988 (HTTP) or 5989 (HTTPS).
TargetMapping
Supported by: Windows, Solaris, Linux and VMware ESX
Syntax: hbacmd TargetMapping <WWPN>
Note: For managing ESX/ESXi hosts from a Windows client, add the m=cim option to
Description: This command shows a list of mapped targets and the LUNs for the port.
Parameters:
WWPN - Adapter’s WWPN.
Version
Supported by: Windows, Solaris, Linux and VMware ESX
Syntax: hbacmd Version
Description: This command shows the current version of the OneCommand Manager CLI Client.
Parameters: None.
OneCommand Manager Command Line Interface User Manual Page 71
Persistent Binding Commands
Note: Supported for FC adapters only.
Note: Not supported on Linux, Solaris or VMware ESX;
PersistentBinding, SetPersistentBinding, RemovePersistentBinding, Remove All
Persistent Binding, BindingCapabilities, BindingSupport and SetBindingSupport.
Note: In order for a binding to take effect immediately (SetPersistentBinding parameter, Scope = I or B), the SCSIBus and SCSITarget must match the SCSI bus and SCSI target to which the FC target is already automapped. If automapping is disabled, the binding takes effect immediately if the FC target is not already persistently bound, and the specified SCSIBus and SCSITarget are available to be persistently bound. Also, the BindType must match the currently active bind type.
Otherwise, you are notified that you must reboot the system to cause the persistent binding to become active.
AllNodeInfo
Supported by: Windows, Solaris and Linux
Syntax: hbacmd AllNodeInfo <WWPN>
Note: For managing ESX/ESXi hosts from a Windows client, add the m=cim option to
Description: This command shows target node information for each target accessible by the adapter.
Parameters:
WWPN - Adapter’s WWPN.
BindingCapabilities
Supported by: Windows and Solaris
Syntax:
hbacmd BindingCapabilities <WWPN>
Description: This command shows the binding capabilities of the adapter. If a binding is configured, it is maintained across reboots.
Parameters:
WWPN - Adapter’s WWPN.
BindingSupport
Supported by: Windows and Solaris
Syntax: hbacmd BindingSupport <WWPN> <Source>
Description: This command shows the binding support for the adapter.
OneCommand Manager Command Line Interface User Manual Page 72
Parameters:
WWPN - Adapter’s WWPN.
Source -
C = Configuration support
L = Live support
PersistentBinding
Supported by: Windows and Solaris
Syntax: hbacmd PersistentBinding <WWPN> <Source>
Description: This command specifies which set of persistent binding information (configured or live state) is requested.
Parameters:
WWPN - Adapter’s WWPN.
Source -
C = Configuration
L = Live
RemoveAllPersistentBinding
Supported by: Windows and Solaris
Syntax:
hbacmd RemoveAllPersistentBinding <WWPN>
Description: Removes all persisting bindings for the adapter.
Parameters:
WWPN - Adapter’s WWPN.
RemovePersistentBinding
Supported by: Windows and Solaris
Syntax: hbacmd RemovePersistentBinding <WWPN> <BindType> <ID> <SCSIBus> <SCSITarget>
Description: This command removes persistent binding between an FC target and a SCSI Bus and target. The binding to be removed can be to a target WWPN, target WWNN, or target D_ID.
Parameters:
WWPN - Adapter’s WWPN.
BindType:
P = Remove binding by WWPN.
N = Remove binding by WWNN.
OneCommand Manager Command Line Interface User Manual Page 73
D = Remove binding by D_ID.
ID:
Target WWPN if BindType = P.
Target WWNN if BindType = N.
Target D_ID if BindType = D.
SCSIBus - Bus number of the SCSI device.
SCSITarget - Target number of the SCSI device.
SetBindingSupport
Supported by: Windows and Solaris
Syntax: hbacmd SetBindingSupport <WWPN> <BindFlag>
Description: This command enables and sets the binding support(s) for the adapter.
Parameters:
WWPN - Adapter’s WWPN.
BindFlag:
*D = Binding by D_ID
P = Binding by WWPN
*N = Binding by WWNN
*A = Binding by Automap
DA = Binding by D_ID and Automap
PA = Binding by WWPN and Automap
NA = Binding by WWNN and Automap
* Not available for the Storport Miniport driver.
SetPersistentBinding
Supported by: Windows and Solaris
Syntax: hbacmd SetPersistentBinding <WWPN> <Scope> <BindType> <TargetId> <SCSIBus>
<SCSITarget>
Description: This command sets a persistent binding between an FC target and a SCSI Bus target. The binding can be to a target WWPN, target WWNN, or target D_ID.
Parameters:
WWPN - Adapter’s WWPN.
Scope: P = Permanent binding (survives reboot)
I = Immediate binding
B = Binding is both permanent and immediate
OneCommand Manager Command Line Interface User Manual Page 74
BindType:
P = Enable binding by WWPN
N = Enable binding by WWNN
D = Enable binding by D_ID
TargetId:
Target WWPN if BindType = P
Target WWNN if BindType = N
Target D_ID if BindType = D
SCSIBus: Bus number of the SCSI device.
SCSITarget: Target number of the SCSI device.
Personality Change Commands
The OneConnect adapters that are capable of personality changes allow you to change the personality of the adapter, reboot the host and have the adapter come back up running the new personality. The personalities OneConnect adapters are currently capable of running are NIC-only, NIC + FCoE, and NIC
+ iSCSI. In some cases the adapters are pre-configured to support multiple personalities. In other cases a feature enablement license must be installed before the adapter can support multiple personalities.
Also, the three different personalities may not always be available on an adapter. For example, an NIC +
FCoE adapter can change to a NIC-only or NIC + iSCSI adapter, but an iSCSI adapter cannot change to a NIC + FCoE adapter.
Note: It is possible to install one (or more) driver kits for the current personality, then change the personality and no longer have the driver(s) necessary to run the adapter.
If you change personalities you must install the appropriate drivers. Drivers are available on the Emulex Web site.
ChangePersonality
Supported by: Windows, Solaris, Linux and VMware ESX
Syntax:
hbacmd ChangePersonality <WWPN|MAC> <personality_type>
Note: For managing ESX/ESXi hosts from a Windows client, add the m=cim option to
Description:
This command changes the personality on the adapter. Requires reboot after successful change.
Parameters:
WWPN - CNA’s WWPN
MAC - MAC address of iSCSI or NIC Port
Personality Type - The personality type to change to, either NIC, iSCSI, or FCoE. The ShowPersonalities command displays the personality types.
OneCommand Manager Command Line Interface User Manual Page 75
Example:
For non-ESXi hosts
>hbacmd ChangePersonality 00-12-34-56-78-9A fcoe
For ESXi hosts
>hbacmd h=<IP_Adress> m=cim u=root p=<password> n=<namespace> ChangePersonality
00-12-34-56-78-9A fcoe
ShowPersonalities
Supported by: Windows, Solaris, Linux and VMware ESX
Syntax:
hbacmd ShowPersonalities <WWPN|MAC>
Note: For managing ESX/ESXi hosts from a Windows client, add the m=cim option to
Description:
This command displays the list of personalities available on the adapter. The personality type is displayed as either NIC, iSCSI, or FCoE.
Parameters:
WWPN - CNA’s WWPN.
MAC - MAC address of iSCSI or NIC Port.
Example:
For non-ESXi hosts
>hbacmd ShowPersonalities 00-12-34-56-78-9A
For ESXi hosts
>hbacmd h=<IP_Address> m=cim u=root p=<password> n=<namespace> showpersonalities
00-12-34-56-78-9A
Virtual Port (VPort) Commands
Note: Supported by FC and FCoE adapter ports only.
<…> = Required, […] = Optional
CreateVPort
Supported by: Windows, Solaris and Linux
Syntax: hbacmd CreateVPort <physical WWPN> auto [vname]
Or hbacmd CreateVPort <physical WWPN> <virtual WWPN> <virtual WWNN> [vname]
OneCommand Manager Command Line Interface User Manual Page 76
Description: This command creates a virtual port with an automatically generated WWPN or a user specified virtual WWPN on the specified physical port. If you specify “auto”, the virtual WWPN is generated automatically. Otherwise, you must specify the virtual WWPN for this parameter. If creation is successful, the WWPN is displayed as part of the output from the command. The optional [vname] parameter can be specified for the virtual port's name.
Parameters:
Physical WWPN - WWPN of the object adapter.
Auto - The virtual WWPN is automatically generated for the virtual port.
Vname - The virtual port’s name (optional).
Virtual WWPN – The virtual WWPN to create.
Virtual WWNN – The virtual WWNN to create.
Vname - The virtual port’s name (optional).
DeleteVPort
Supported by: Windows, Solaris and Linux
Syntax: hbacmd DeleteVPort <physical WWPN> <virtual WWPN>
Description: This command deletes the virtual port specified by a physical and virtual WWPN.
Parameters:
Physical WWPN - Adapter’s WWPN.
Virtual WWPN - The WWPN of the virtual port.
ListVMs
Note: This command lists information for VMware ESX only.
Supported by: Windows, Solaris, Linux and VMware ESX
Syntax: hbacmd ListVMs <physical WWPN> <virtual WWPN>
Description: This command lists all virtual machines and their information for all manageable ports.
If the host is specified with the “h=<host>” option or just the physical WWPN is given, only the virtual machines for that host are displayed. If the physical port and the virtual port are specified, only the virtual machine for the specified virtual port is displayed.
The virtual machine name is only displayed if the virtual port is associated with a virtual machine on
VMware ESX 4.0. If you are running this command on any other server that has virtual ports, you will not see the virtual machine name.
Parameters:
Physical WWPN - Adapter’s WWPN on the targets are visible.
Virtual WWPN - The WWPN of the virtual port.
OneCommand Manager Command Line Interface User Manual Page 77
ListVPorts
Supported by: Windows, Solaris, Linux and VMware ESX
Syntax:
hbacmd ListVPorts <physical WWPN>
Description: This command lists virtual ports on the specified physical port. Leaving the physical
WWPN parameter blank will list all virtual ports on all manageable hosts that support virtual ports.
Parameters:
Physical WWPN - Adapter’s WWPN
VPortTargets
Supported by: Windows, Solaris, Linux and VMware ESX
Syntax: hbacmd VPortTargets <physical WWPN> <virtual WWPN>
Description: This command lists targets visible to the specified virtual port.
Parameters:
Physical WWPN - Adapter’s WWPN.
Virtual WWPN - The WWPN of the virtual port.
WWN Management Commands
Note: Supported for Fibre Channel and FCoE adapters only.
Note: WWN Management validates WWNs carefully to avoid name duplication. Therefore, you may see error and warning messages if a name duplication is detected. Emulex strongly recommends that the activation requirement be fulfilled after each WWN change or restore. When running with “pending changes”, some diagnostic and maintenance features are not allowed.
ChangeWWN
Supported by: Windows, Solaris, Linux and VMware ESX
Syntax: hbacmd ChangeWWN <WWPN> <New WWPN> <New WWNN> <Type>
Note: For managing ESX/ESXi hosts from a Windows client, add the m=cim option to
Description: This command changes the volatile or non-volatile state of WWNs. If the volatile change is requested on an adapter that does not support volatile WWNs, anit displays a not supported error.
Note: When a volatile change is supported, a reboot is required to activate the new setting. Volatile names are active until system power-down or adapter power-cycle.
OneCommand Manager Command Line Interface User Manual Page 78
Note: For VMware ESX: After changing the WWN of an adapter, be sure your zoning settings are updated before you reboot your ESX server. If the zoning is not updated before your reboot, the subsequent boot may take a long time.
Note: For VMware ESX: After changing the WWN of an adapter, you must reboot the
ESX system before trying to access the adapter on that system. For information on rebooting the ESX system, refer to VMware documentation.
Note: For ESX COS: If you are using the CIM interface to access adapters, after changing the WWN of an adapter you must restart the CIMOM (that is, SFCB) on the
ESX COS system before trying to access the adapter on that system. For information on restarting the CIMOM, refer to VMware documentation.
Parameters:
WWPN - Adapter’s WWPN.
New WWPN - New adapter’s WWPN.
New WWNN - New adapter’s WWNN.
Type:
0 = Volatile
1 = Non-Volatile
GetWWNCap
Supported by: Windows, Solaris, Linux and VMware ESX
Syntax:
hbacmd GetWWNCap <WWPN>
Note: For managing ESX/ESXi hosts from a Windows client, add the m=cim option to
Description: This command shows if volatile change is supported for the WWPN.
Parameters:
WWPN - Adapter’s WWPN.
ReadWWN
Supported by: Windows, Solaris, Linux and VMware ESX
Syntax: hbacmd ReadWWN <WWPN> <Type>
Note: For managing ESX/ESXi hosts from a Windows client, add the m=cim option to
Description: This command reads different types of WWNs.
Parameters:
WWPN - Adapter’s WWPN.
OneCommand Manager Command Line Interface User Manual Page 79
Type -
0 = Volatile
1 = Non-Volatile
2 = Factory Default
3 = Current
4 = Configured
RestoreWWN
Supported by: Windows, Solaris, Linux and VMware ESX
Syntax: hbacmd RestoreWWN <WWPN> <Type>
Note: For managing ESX/ESXi hosts from a Windows client, add the m=cim option to
Description: This command changes the WWNs to the factory default or non-volatile values. (Change is non-volatile).
Note: A reboot is required to activate the new setting.
Note: For VMware ESX: After changing the WWN of an adapter, you must reboot the
ESX system before trying to access the adapter on that system. For information on rebooting the ESX system, refer to VMware documentation.
Note: For ESX COS: If you are using the CIM interface to access adapters, after changing the WWN of an adapter you must restart the CIMOM (that is, SFCB) on the
ESX COS system before trying to access the adapter on that system. For information on restarting the CIMOM, refer to VMware documentation.
Parameters:
WWPN - Adapter’s WWPN.
Type -
0 - Restore Default WWNs
1 - Restore NVRAM WWNs
OneCommand Manager Command Line Interface User Manual Page 80
advertisement
* Your assessment is very important for improving the workof artificial intelligence, which forms the content of this project
Related manuals
advertisement