OneCommandTM Manager Command Line Interface Version 5.2 User Manual P006980-01A Rev.
Copyright © 2011 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.
Introduction.............................................................................................................. 1 Supported Platforms.......................................................................................... 1 New Commands ................................................................................................ 2 Installing the OneCommand Manager CLI ............................................................... 2 In Windows.................................................
Help .......................................................................................................... 20 Adapter License Management Commands ..................................................... 20 InstallAdapterLicense ................................................................................ 20 ShowAdapterLicenseFeatures .................................................................. 21 ShowLicenseAdapterID.............................................................................
DeleteDumpFiles....................................................................................... 43 Dump ........................................................................................................ 43 GetDumpDirectory .................................................................................... 44 SetDumpDirectory..................................................................................... 44 GetDumpFile .......................................................................
GetCimCred .............................................................................................. 71 GetElxSecInfo ........................................................................................... 71 GetQoSInfo ............................................................................................... 71 GetVPD..................................................................................................... 72 ListHBAs ................................................................
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 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).
New Commands The following new commands are supported in OneCommand Manager CLI: • Diagnostic Commands • • CableNVP Micellaneous Commands • AddHost and RemoveHost commands now support IPv6 address formats in addition to IPv4 address formats Installing the OneCommand Manager CLI In Windows There are two ways to install the OneCommand Manager CLI in Windows: • Attended installation • Unattended installation Attended Installation in Windows To install the OneCommand Manager CLI, run the installation.
In a New VMware ESX Server To install the OneCommand Manager CLI in a new VMware system, install the specific rpm file for the driver for your VMware version. Prerequisites • To manage FCoE adapters, the LPFC driver version 8.2, or later, must be loaded. • To manage NIC or iSCSI adapters, driver version 2.102.440.0, or later, must be loaded. • To manage iSCSI adapters, the iSCSI driver must be loaded. Note: The iSCSI driver is not supported for VMware ESX 4.0.
In Linux Prerequisites For new systems, the specific driver rpm file for your Linux version must be installed. Note: On RHEL 5.5 and later and RHEL 6 and later, the OneCommand Core rpm file requires the "Libnl" library. This library is not installed by default, but can be obtained from the OS distribution media. • For i386 RHEL 5.5, RHEL 5.6 and RHEL 6, use the 32bit libnl library. • For x86_64 RHEL 5.5, RHEL 5.6 and RHEL 6, use the 64bit libnl library. • For ia64 RHEL 5.5, RHEL 5.
Note: The core kit consists of 2 or 3 .rpm files for each supported architecture and each supported version of Linux: 1. elxocmlibhbaapi-*.rpm (on 64bit platforms that support 32 bit apps, there will be 2 of these) 2. elxocmcore-*.rpm In Linux with an Existing OneCommand Manager 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.x (For RHEL5.
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 or later core kit. You must un-install previous versions of the HBAnyware utility before installing a OneCommand Manager core kit. For information on uninstalling older versions of HBAnyware, see “Uninstalling Older HBAnyware Kits in Linux” on page 8.
Starting and Stopping Linux and Solaris Daemon Processes On Linux and Solaris machines, you can stop and start the OneCommand Manager daemon processes using the "stop_ocmanager" and "start_ocmanager" scripts respectively. These are found in the following OneCommand Manager installation directory: Linux - /usr/sbin/ocmanager Solaris - /opt/ELXocm There are three basic daemon processes, included with OneCommand Manager installations, that are affected by these scripts.
Uninstalling Older HBAnyware or OneCommand Manager Kits in a VMware ESX Server To uninstall an older OneCommand Manager or HBAnyware Kit on a VMware server: 1. Log in as ‘root’. 2. Type: rpm -qa | grep elx and locate either of the following rpm files: elxvmwarecorekit- Or elxocmcore-esxNN- Where NN is 40 for an ESX 4.0 system and 41 for an ESX 4.1 system. 3. Type: rpm -e elxvmwarecorekit- Or rpm -e elxocmcore-esxNN- Where NN is 40 for an ESX 4.
2. If the HBAnyware Security Configurator is installed, follow these steps: a. Log on as ‘root’. b. c. d. e. Change to the directory containing the tar file. Extract the tar file using the tar -xvf command. Change to the newly created directory. 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. c. d. e. Change to the directory containing the tar file.
In Windows To upgrade from the OneCommand Manager CLI to the full-featured OneCommand Manager application enterprise kit: 1. From the desktop, run the elxocm-windows--.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.
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.
Before issuing the syntax B, do one of the following: • Add the host IP with CIM credentials using the AddHost command. For example: hbacmd AddHost [u=userid] [p=password] [n=namespace] Or • 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.
Mode : Initiator 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 Mode : Initiator Discovery : cim C:\Program Files\Emulex\Util\OCManager>hbacmd h=10.192.113.
• 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.
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 ( ).
• GetQosInfo • GetRetentionCount • GetVPD • GetWWNCap • GetXcvrData • HbaAttributes • InstallAdapterLicense • ListHbas • LoadList • • Test • PciData • PortAttributes • PortStatistics • ReadWWN • RemoveHost • Reset • RestoreWWN • ServerAttributes • SetBeacon • SetCableNVP • SetCnaPGBW • SetDCBParam • SetDCBPriority • SetDriverParam • SetDriverParamDefaults • SetDumpDirectory • SetFIPParam • SetRetentionCount • ShowAdapterLicenseFeatures • ShowLicense
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 SetPfcThrottle * *SetPfcThrottle is supported in Linux but not in Solaris.
Commands Supported in CIM Provider 3.1 Note: In addition to the commands supported by the CIM Provider 3.0, the following commands are supported by the CIM Provider 3.1: Dump GetDCBParams GetDumpDierctory GetDumpFile GetDumpFileNames GetFCFInfo GetFipParams GetRetentionCount GetPGInfo SetDCBParam SetCnaPgBw SetDCBPriority SetDumpDirectory SetFIPParam SetRetentionCount Commands Supported in CIM Provider 3.2 Note: In addition to the commands supported by the CIM Provider 3.0 and 3.
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
Help Command The HbaCmd help command lists 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.
Example: For non-ESXi hosts hbacmd InstallAdapterLicense 00-12-34-56-78-9A K:\lf1324.lic For ESXi hosts hbacmd h= m=cim u=root p= n= InstallAdapterLicense 00-12-34-56-78-9A K:\lf1324.lic ShowAdapterLicenseFeatures Supported by: Windows, Solaris, Linux and VMware ESX Syntax: hbacmd ShowAdapterLicenseFeatures Note: For managing ESX/ESXi hosts from a Windows client, add the m=cim option to the command.
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 For ESXi hosts >hbacmd h= m=cim u=root p= n= ShowLicenseAdapterID 00-12-34-56-78-9A Attributes Commands HbaAttributes Supported by: Windows, Solaris, Linux and VMware ESX Syntax: hbacmd [h=] hbaattributes Note: For managing ESX/ESXi hosts from a Windows client, add the m=cim option to the command.
PortStatistics Supported by: Windows, Solaris, Linux and VMware ESX Syntax: hbacmd PortStatistics Note: For managing ESX/ESXi hosts from a Windows client, add the m=cim option to the command. The default CIM credentials must be set using the SetCimCred command. See “SetCimCred” on page 73. Description: This command shows all port statistics for the adapter.
SetPortEnabled Supported by: Windows, Solaris, Linux and VMware ESX Syntax: hbacmd SetPortEnabled 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.
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 Description: This command retrieves the authentication configuration for the adapter.
SetAuthConfig Supported by: Windows, Solaris and Linux Syntax: hbacmd SetAuthConfig Description: This command sets the authentication configuration for the adapter.
Cpt - Current password type: 1 = ASCII 2 = Hex (binary) 3 = Password not yet defined Cpw - Current password value Npt - New password type: 1 = ASCII 2 = Hex (binary) Npw - New password value Boot Commands Note: Boot commands are supported on FC/FCoE adapter ports only. EnableBootCode Note: This command is not supported for OneConnect adapters. The boot code is always enabled on OneConnect adapters.
GetBootParams Supported by: Windows, Solaris, Linux and VMware ESX Syntax: hbacmd GetBootParams 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.
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 Note: For managing ESX/ESXi hosts from a Windows client, add the m=cim option to the command. The default CIM credentials must be set using the SetCimCred command. See “SetCimCred” on page 73.
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.
Parameters: WWPN - The WWPN address of the FCoE port MAC - MAC address of the NIC or iSCSI port Example: hbacmd h=10.192.203.154 getpginfo 00-00-c9-93-2f-d8 SetCnaPGBW Supported by: Windows, Solaris, Linux and VMware ESX Syntax: hbacmd SetCnaPGBW Note: For managing ESX/ESXi hosts from a Windows client, add the m=cim option to the command. The default CIM credentials must be set using the SetCimCred command. See “SetCimCred” on page 73.
OneConnect adapter parameters: (1= enabled 0 = disabled) Note: The OneConnect adapter parameters doe not apply to LP21xxx adapters. DCBXState - The current DCBX (Data Center discovery and Capability exchange protocol) state DCBXMode - The DCBX mode can be either DCB or CIN. Note: DCBX mode also configures FIP mode. If DCBX mode is DCB, FIP is enabled. If it is CIN, FIP is disabled. PFCEnable - Enabled means that flow control in both directions (Tx and Rx) is enabled.
SetDCBPriority Supported by: Windows, Solaris, Linux and VMware ESX Syntax: hbacmd SetDCBPriority < Priorities of PGID1>... Note: For managing ESX/ESXi hosts from a Windows client, add the m=cim option to the command. The default CIM credentials must be set using the SetCimCred command. See “SetCimCred” on page 73. Description: This command sets the priorities for a priority group.
Parameters: WWPN - Adapter’s WWPN MAC - MAC address of the NIC or iSCSI port PFCPriorities - PFC priority that is a comma separated list of up to 7 values ranging from 0-7. Priorities of PGID - Priority group membership that is a comma separated list of priorities ranging in value for 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.
Parameters: WWPN - WWPN of the FC port MAC - MAC address of the NIC or iSCSI port GetXcvrData Note: GetXcrvData is not supported for OneConnect OCe11100 series adapters. Supported by: Windows, Solaris, Linux and VMware ESX Syntax: hbacmd GetXcvrData Note: For managing ESX/ESXi hosts from a Windows client, add the m=cim option to the command. The default CIM credentials must be set using the SetCimCred command. See “SetCimCred” on page 73.
LoopBackTest Supported by: Windows, Solaris, Linux and VMware ESX Syntax: hbacmd LoopBackTest [Pattern] Note: For managing ESX/ESXi hosts from a Windows client, add the m=cim option to the command. The default CIM credentials must be set using the SetCimCred command. See “SetCimCred” on page 73. Description: This command runs the loop test on the adapter specified by the WWPN or MAC address.
LoopMap Note: Supported for FC ports only. Supported by: Windows, Solaris and Linux Syntax: hbacmd LoopMap Description: This command shows the arbitrated loop map data. Parameters: WWPN - Adapter’s WWPN PciData Supported by: Windows, Solaris, Linux and VMware ESX Syntax: hbacmd PciData Note: For managing ESX/ESXi hosts from a Windows client, add the m=cim option to the command. The default CIM credentials must be set using the SetCimCred command. See “SetCimCred” on page 73.
Output: Vendor ID: 0x19A2 Device ID: 0x0700 Command: 0x0406 Status: 0x0010 Revision ID: 0x02 Prog If: 0x00 Subclass: 0x00 Base Class: 0x02 Cache Line Size: 0x10 Latency Timer: 0x00 Header Type: 0x80 Built In Self Test: 0x00 Base Address 0: 0x00000000 Base Address 1: 0xDF478000 Base Address 2: 0xDF480004 Base Address 3: 0x00000000 Base Address 4: 0xDF4A0004 Base Address 5: 0x00000000 CIS: 0x00000000 SubVendor ID: 0x10DF SubSystem ID: 0xE622 ROM Base Address: 0x00000
BeaconState - New state of the beacon: 0 = Off 1= On SetCableNVP Note: This command supports only OneConnect OCe11100 series adapters. Supported by: Windows, Solaris, Linux and VMware ESX Syntax: hbacmd SetCableNVP Description: This command sets the nominal velocity of propagation (N-V-P), required for the TDR test, for the cable that connects to the phyical port associated with the WWPN or MAC.
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 returns only permanently set driver parameter values.
GetDriverParamsGlobal Supported by: Windows, Solaris, Linux and VMware ESX 4.0. Syntax: hbacmd GetDriverParamsGlobal Note: For managing ESX/ESXi hosts from a Windows client, add the m=cim option to the command. The default CIM credentials must be set using the SetCimCred command. See “SetCimCred” on page 73. Description: This command shows the name and the global value of each driver parameter.
SetDriverParam Supported by: Windows, Solaris, Linux and VMware ESX Syntax: hbacmd SetDriverParam Note: For managing ESX/ESXi hosts from a Windows client, add the m=cim option to the command. The default CIM credentials must be set using the SetCimCred command. See “SetCimCred” on page 73. Description: This command changes a driver parameter and designates the scope of the change.
Dump Commands The diagnostic dump feature enables you to create a “dump” file for a selected adapter. Dump files contain information such as firmware version, driver version, and so on. This information is particularly useful when troubleshooting an adapter. (Unavailable in read-only mode.) Caution: Disruption of service can occur if a diagnostic dump is run during I/O activity.
GetDumpDirectory Supported by: Windows, Solaris, Linux and VMware ESX Syntax: hbacmd h=ipaddress[:port] m=cim [u=username] [p=password] [n=root/emulex] GetDumpDirectory Note: For managing ESX/ESXi hosts from a Windows client, add the m=cim option to the command. The default CIM credentials must be set using the SetCimCred command. See “SetCimCred” on page 73. Description: This command shows the dump file directory for the adapters in the host.
Parameters: - The directory under /vmfs/volumes that you created to store the dump files. h - Host’s IP address m - cim u - root p - n - 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 This example shows the dump directory set to /vmfs/volumes/ocm-datastore.
GetDumpFileNames Supported by: Windows, Solaris, Linux and VMware ESX Syntax: hbacmd GetDumpFileNames Or hbacmd GetDumpFileNames Note: For managing ESX/ESXi hosts from a Windows client, add the m=cim option to the command. The default CIM credentials must be set using the SetCimCred command. See “SetCimCred” on page 73. Description: This command gets the names of the files in the remote host's dump directory.
SetRetentionCount Supported by: Windows, Solaris, Linux and VMware ESX Syntax: hbacmd SetRetentionCount Note: For managing ESX/ESXi hosts from a Windows client, add the m=cim option to the command. The default CIM credentials must be set using the SetCimCred command. See “SetCimCred” on page 73. 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.
FCoE Commands Note: These commands are supported only on OneConnect FCoE ports. GetFCFInfo Supported by: Windows, Solaris, Linux and VMware ESX Syntax: hbacmd GetFCFInfo Note: For managing ESX/ESXi hosts from a Windows client, add the m=cim option to the command. The default CIM credentials must be set using the SetCimCred command. See “SetCimCred” on page 73. Description: This command shows the FCF information of the OneConnect adapter in FCoE mode.
SetFIPParam Supported by: Windows, Solaris, Linux and VMware ESX Syntax: hbacmd SetFIPParam Note: For managing ESX/ESXi hosts from a Windows client, add the m=cim option to the command. The default CIM credentials must be set using the SetCimCred command. See “SetCimCred” on page 73. Description: This command sets the FIP parameters of the OneConnect adapter in FCoE mode.
iSCSI Commands Note: iSCSI commands are supported only on OneConnect iSCSI ports. 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 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".
AddRouteTableEntry Supported by: Windows, Solaris, Linux and VMware ESX Syntax: hbacmd [h=host_IP[:port] | hostname[:port]] AddRouteTableEntry Description: This command adds a new route table entry to the route table of the specified port.
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 leng
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.
CleariSNSServer Supported by: Windows, Solaris, Linux and VMware ESX Syntax: hbacmd [h=host_IP[:port] | hostname[:port]] CleariSNSServer 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.
DiscoveriSNSServer Supported by: Windows, Solaris, Linux and VMware ESX Syntax: hbacmd [h=host_IP[:port] | hostname[:port]] DiscoveriSNSServer 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.
GetiSCSIPortStats Supported by: Windows, Solaris, Linux and VMware ESX Syntax: hbacmd [h=host_IP[:port] | hostname[:port]] GetiSCSIPortStats Description: This command shows all the port statistics for a specified port.
ListSessions Supported by: Windows, Solaris, Linux and VMware ESX Syntax: hbacmd [h=host_IP[:port] | hostname[:port]] ListSessions Description: This command lists all the sessions on a specified target. The iSCSI target name instructs the command to gather the information from the listed iSCSI target name.
SetInitiatorProperties Supported by: Windows, Solaris, Linux and VMware ESX Syntax: hbacmd [h=host_IP[:port] | hostname[:port]] SetInitiatorProperties [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.
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.
SetTargetLoginProperties Supported by: Windows, Solaris, Linux and VMware ESX Syntax: hbacmd [h=host_IP[:port] | hostname[:port]] SetTargetLoginProperties [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 .
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.
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.
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 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.
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 [target_portal_ip ] [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.
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-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.
UpdateiSNSServer Supported by: Windows, Solaris, Linux and VMware ESX Syntax: hbacmd [h=host_IP[:port] | hostname[:port]] UpdateiSNSServer Description: This command updates the configured iSNS server. This command requires the server IP and port number of the iSNS server be available to respond to the iSNS requests.
LUN Masking Commands Note: Supported for FC/FCoE ports only. Note: LUN masking commands are not supported by Linux. Note: The GetLunMaskbyHBA, GetLunMaskbyTarget, RescanLuns, and SetLunMask commands are not supported for VMware ESX and Solaris. GetLunList Supported by: Windows and Solaris Syntax: hbacmd GetLunList
GetLunUnMaskByTarget Supported by: Windows and Solaris Syntax: hbacmd GetLunUnMaskByTarget
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 the command. The default CIM credentials must be set using the SetCimCred command. See “SetCimCred” on page 73.
CnaGetEventLog Note: Supported for OneConnect adapters only. Supported by: Windows, Linux and VMware ESX Syntax: hbacmd CnaGetEventLog Description: This command shows the CNA event log specified by the WWPN or MAC address.
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: 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\OCManager>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 Note: For managing ESX/ESXi hosts from a Windows client, add the m=cim option to the command.
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 the command. The default CIM credentials must be set using the SetCimCred command. See “SetCimCred” on page 73. Description: This command removes a host from the hosts file use for TCP/IP management in the OneCommand Manager application GUI. The host_address can be an IP address, using the IPv4 or IPv6 format, or a host name.
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.
Persistent Binding Commands Note: Supported for FC/FCoE ports 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.
BindingSupport Supported by: Windows and Solaris Syntax: hbacmd BindingSupport Description: This command shows the binding support for the adapter. Parameters: WWPN - Adapter’s WWPN Source C = Configuration support L = Live support PersistentBinding Supported by: Windows and Solaris Syntax: hbacmd PersistentBinding Description: This command specifies which set of persistent binding information (configured or live state) is requested.
Parameters: WWPN - Adapter’s WWPN BindType: P = Remove binding by WWPN N = Remove binding by WWNN 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 Description: This command enables and sets the binding support(s) for the adapter.
Parameters: WWPN - Adapter’s WWPN Scope: P = Permanent binding (survives reboot) I = Immediate binding B = Binding is both permanent and immediate 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 OneCommand Manager Command Line Interface User Manual Page 78
Personality Change Commands TheOneCommand Manager application enables you to change the personality or protocol running on OneConnect adapters. When you change the personality of the adapter and reboot the host, the adapter starts running the new personality or protocol. The personalities that OneConnect adapters currently run are NIC-only, NIC + FCoE, and NIC + iSCSI. In some cases the adapters are pre-configured to support multiple personalities.
ShowPersonalities Supported by: Windows, Solaris, Linux and VMware ESX Syntax: hbacmd ShowPersonalities Note: For managing ESX/ESXi hosts from a Windows client, add the m=cim option to the command. The default CIM credentials must be set using the SetCimCred command. See “SetCimCred” on page 73. Description: This command displays the list of personalities available on the adapter. The personality type is displayed as either NIC, iSCSI, or FCoE.
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 auto [vname] Or hbacmd CreateVPort [vname] Description: This command creates a virtual port with an automatically generated WWPN or a user specified virtual WWPN on the specified physical port.
ListVMs Note: This command lists information for VMware ESX only. Supported by: Windows, Solaris, Linux and VMware ESX Syntax: hbacmd ListVMs Description: This command lists all virtual machines and their information for all manageable ports. If you specify the host with the “h=” option or just give the physical WWPN, only the virtual machines for that host return.
WWN Management Commands Note: Supported for FC/FCoE adapter ports 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.
GetWWNCap Supported by: Windows, Solaris, Linux and VMware ESX Syntax: hbacmd GetWWNCap Note: For managing ESX/ESXi hosts from a Windows client, add the m=cim option to the command. The default CIM credentials must be set using the SetCimCred command. See “SetCimCred” on page 73. Description: This command shows if volatile change is supported for the WWPN.
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.
