Home

OneCommand™Manager Command Line Interface

1. eee eee D_Port Test Status Passed Buffers Required 1 Frame Size 2112 Round Trip Latency 1898 nanoseconds Estimated Cable Length 172 meters Test Phase Result Latency Local Errors Remote Errors Electrical Loopback Passed 122 Optical Loopback Passed 1898 Reverse Optical Loopback Skipped 0 Link Traffic Passed 0 OneCommand Manager Command Line Interface Version 10 2 User Manual P010067 01A Rev A 5 CLI Client Command Descriptions 73 Diagnostic Commands gt EMULEX Test Failures gt hbacmd DPortTest 10 00 00 00 c9 d1 a2 d0 Running D Port Tests Please wait Polling for results D_Port Test Status Failed Buffers Required 0 Frame Size 0 Round Trip Latency 0 nanoseconds Estimated Cable Length 0 meters Test Phase Result Latency Local Errors Remote Errors Electrical Loopback Failed n a gt hbacmd DPortTest 10 00 00 00 c9 d1 a2 d0 Running D Port Tests Please wait Polling for results 00 ee ee eens D_Port Test Status Failed Buffers Required 0 Frame Size 0 Round Trip Latency 0 nanoseconds Estimated Cable Length 0 meters Test Phase Result Latency Local Errors Remote Errors Electrical Loopback Passed 0 Optical Loopback Failed n a gt hbacmd DPortTest 10 00 00 00 c9 d1 a2 d0 Running D Port Tests Please wait Polling for results 000 eee eens D_Port Test Status Failed Buffers Required T Frame Size 2112 Round Trip Late
2. 15 Secure Management Installation vv vvn 16 LINUX ANG SOlAMS EE 16 viele UE 16 Using OneCommand Manager with Secure Management Enabled 17 2 Installing and Uninstalling the CLI ttnnnnnnnnnnnnnnn n r LO A eee ee ee rc tT cr re rT re ree er rr rrr err rer rt 18 EE ee EE 18 Installing in Linux Without an Existing OneCommand CLI KT 18 Linux OneCommand Manager Requirements sssssssssreserrererrerrrrrrerrrrrrrrrrrrrrrr 18 Installing in Linux With an Existing OneCommand CLI Kr 20 Updating Preserving Existing Setting 20 Performing a Clean Install Removing Existing Setting 21 GEELEN 21 Uninstalling Older HBAnyware Kits in LINUX 00oooosv vv cette cents eee eee en eee en eres 21 o E zad d s s d i d zad h creer cere reer reer eee i k ih ii 22 Installing in NA aa iU 22 Uninstalling in EEN 23 EN EEN 23 Installing the CIM Provider for VMware ESXi Host 23 UO 24 Installing in WINDOWS oi ees zr va dali ra ra ao ion ani nia 24 Attended Installation vvn vvv vona sees sees eee EEEEEEEEEEEEEEEEEEEEEEEEE EEEE 24 Unattended Installatton cee eeee eee eae ttrt rttr trt EEEEEEEEEEEEEEEEE EEEE 24 Uninstalling in WINdOWS za a o dan nn rn 26 Uninstalling through the Control Panel 26 Uninstalling through the Command Une 26 Starting and Stopping Daemon Processes ttstssnrnnnnnannnnnnann nnnnano a 27 LINUX and SCANS vesanccicresdeceivinwi
3. gt G EMULEX Table 5 1 CLI Client Command Reference Continued 5 CLI Client Command Descriptions VMware CIM Interface Command Linux Solaris ESXi Windows Support Page GetOoslnfo v 120 GetRetentionCount v v 86 GetSessionlnfo k v vy v 98 GetVPD v v v v v 120 GetWWNCap v N v v v 166 GetXcvrData N v N v N 75 HbaAttributes v v v v vi 50 Help v v v v N A 45 ImportiSCSI v 99 InitiateAuth v v N 56 InstallAdapterLicense v v v v v 48 iSCSIPing v N v N 100 ListHBAs N v N v 121 ListProfiles N v N v 136 ListSessions y v y v 100 ListVFunctions v N v N v 163 List VMs v 163 ListVPorts v v v 164 VPortTargets v v v 164 LoadList v v v 75 LoopBackTest v v v 76 LoopMap v N v 77 PciData v v v v v TI PersistentBinding v N 127 PortAttributes v v v v v 50 PortStatistics v v v v v 51 PostTest v v v v v 78 ReadWWN v v N v v 166 RemoveaAllPersistent v N 127 Binding RemovePersistent N v 128 Binding RemoveHost N N v N 121 OneCommand Manager Command Line Interface Version 10 2 User Manual P010067 01A Rev A 42 DE EMULEX 5 CLI Client Command Descriptions 43 Table 5 1 CLI Client Command Reference Continued VMware CIM Interface Command Linux Solaris ESXi Windows Support Page RemoveTarget v v
4. o After changing the WWN of an adapter you must reboot the ESXi system before trying to access the adapter on that system For information on rebooting the ESXi system refer to the VMware documentation e For ESXi 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 ESXi system before trying to access the adapter on that system For information on restarting the CIMOM refer to the VMware documentation Supported By Linux Solaris VMware ESXi and Windows Syntax ChangeWWN lt WWPN gt lt New WWPN gt lt New WWNN gt lt Type gt OneCommand Manager Command Line Interface Version 10 2 User Manual P010067 01A Rev A DE EMULEX 5 CLI Client Command Descriptions 166 WWN Management Commands Parameters WWPN The WWPN of an FC or FCoE port New WWPN The WWPN of the FC or FCoE port New WWNN The WWNN of an FC or FCoE port Type 0 Volatile 1 Non Volatile GetWWNCap This command shows if volatile change is supported for the WWPN Supported By Linux Solaris VMware ESXi and Windows Syntax GetWWNCap lt WWPN gt Parameters WWPN The WWPN of an FC or FCoE port ReadWWN This command reads different types of WWNs Supported By Linux Solaris VMware ESXi and Windows Syntax ReadWWN lt WWPN gt lt Type gt Parameters WWPN The WWPN of an FC or FCoE port Type 0 Volatile 1 Non Volatile 2 Factory Default 3
5. 0 1 2 3 PO NIC i1SCSI P1 NIC FCOE P2 NIC FCOE P3 P3 NIC None 5 CLI Client Command Descriptions Profile Management Commands pN labels are the port parameter names to use in the SetAdapterPortConfig command e g pO NIC FCoE 1 NIC iSCSI Concurrent Mode 2 ports gt hbacmd SetAdapterPortConfig 00 00 c9 12 34 56 pO snic iscsi fcoe pl nic fcoe gt hbacmd GetAdapterPortConfig 00 00 c9 12 34 56 Number of Ports 2 2 Maximum FCoE Functions 4 Maximum iSCSI Functions 4 Mixed Mode I O Allowed Ves Concurrent Mode I O Allowed Yes ROCE Functions Allowed Yes RebootRequired Yes Active Configuration Profile ID 33 MCType None Port Assignments Port1 NIC iSCSI FCOE Port1 NIC iSCSI FCOE Reboot Configuration Profile ID 33 OneCommand Manager Command Line Interface Version 10 2 User Manual P010067 01A Rev A 141 5 CLI Client Command Descriptions SE EMULEX Profile Management Commands e MCType None Port Assignments Port 1 p0 NIC iSCSI FCoE Port 2 pl NIC FCoE None Note pN labels are the port parameter names to use in the SetAdapterPortConfig command e g pO NIC FCoE 1 NIC iSCSI RoCE gt hbacmd SetAdapterPortConfig 00 00 c9 12 34 56 pO0 nic roce pl nic p2 nic p3 nic roce pid 21 gt hbacmd GetAdapterPortConfig 00 00 c9 12 34 56 Number of Ports SA Maximum FCoE Functions 4 Maximum iSCSI Functions 4 Mixed Mode I O Allowed Yes Conc
6. 5 CLI Client Command Descriptions 69 DCB Commands This parameter is applicable for ports running RoCE only A single priority must be specified The range of valid values is 0 7 Note Only one priority can be specified for each invocation of this command and must be for a protocol running on the port If more than one protocol priority can be set they should be unique values A list of comma separated values where multiple PFC priorities are supported The comma separated list can contain up to seven values ranging from 0 7 Use to set the DCB parameters including priority groups to their default values For example hbacmd SetDCBParam lt WWPN MAC gt defaults LLDP Settings for lt Param gt and lt Value gt lt Param gt TxState RxState TxPortDesc TxSysDesc TxSysName TxSysCap Description and lt Value gt Transmit State DCBX uses LLDP to exchange parameters between two link peers For the DCBX protocol to operate correctly both LLDP Rx and Tx must be enabled If either Rx or Tx is disabled DCBX is disabled 0 Disabled 1 Enabled Receive State DCBX uses LLDP to exchange parameters between two link peers For the DCBX protocol to operate correctly both LLDP Rx and Tx must be enabled If either Rx or Tx is disabled DCBX is disabled 0 Disabled 1 Enabled Transmit Port Description provides a description of the port in an alpha numeric format 0 Disabled 1 Enabled Transmit S
7. Subnet Mask Subnet Mask to delete from the route table Gateway Gateway to delete from the route table DiscoveriSNSServer 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 Supported By Linux Solaris VMware ESXi and Windows Syntax DiscoveriSNSServer lt MAC Address gt Parameters MAC Address The MAC address of an iSCSI port ExportiSCSsl This command outputs iSCSI target information in XML format The output can be redirected to a specified file and the file can be used for the ImportiSCSI command Supported By Windows Only Syntax ExportiSCSI Example In this example the command exports all the iSCSI targets of all the adapters on the host The output is re directed to the file targets xml hbacmd ExportiSCSI gt targets xml GetlnitiatorProperties This command shows all the initiator login options for the specified port These properties are set as the target porta s login properties to be used when discovering the targets on the target portal The discovered targets inherit these properties OneCommand Manager Command Line Interface Version 10 2 User Manual P010067 01A Rev A e 5 CLI Client Command Descriptions 97 gt G EMULEX iSCSI Commands Supported By Linux Solaris VMware ESXi and Windows Syntax GetInitiatorProperties lt MAC Ad
8. Uninstalling in Linux To uninstall the OneCommand Manager CLI in Linux 1 Log on as root 2 Do one of the following e Run the uninstall_ocmanager sh script located in usr sbin hbanyware scripts e Run the uninstall sh script located in the installation tar file 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 Do one of the following e Run the uninstall script located in usr sbin hbanyware scripts to remove the enterprise kit e 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 and proceed to step 2 If the Security Configurator is not installed proceed to step 3 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 OneCommand Manager Command Line Interface Version 10 2 User Manual P010067 01A Rev A DE EMULEX 2 Installing and Uninstalling the CLI 22 Solaris
9. and getgri C library API calls The equivalent to the API calls can be obtained OneCommand Manager Command Line Interface Version 10 2 User Manual P010067 01A Rev A 1 Introduction 16 SE EMULEX OneCommand Manager Secure Management by typing getent group from the shell command line If the four OneCommand Manager group names are listed with their member users the machine is ready to use OneCommand Manager secure management Secure Management Installation The enabling or disabling of the Secure Management feature is specified at OneCommand Manager installation time This can be done either interactively or by using dedicated install switches on Windows Linux and Solaris On Linux and Solaris if the OneCommand Manager groups described above are not configured on the machine at the time of the OneCommand Manager installation installation will fail when the secure management feature is selected Notes e Only a user with Administrator Root privileges is allowed to either enable or disable the secure management feature on a local host machine e Management mode cannot be used if Secure Management is enabled see the management mode section step 5 on page 25 for more information Linux and Solaris Interactive Installation Enterprise OneCommand Manager installations performed in interactive mode will ask if OneCommand Manager Secure Management mode should be enabled If the answer is yes the other management mo
10. 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 Change to the directory containing the tar file Extract the tar file using the tar xvf command Change to the newly created directory Pan p Uninstall any previously installed versions Type uninstall Solaris Installing in Solaris Note Prior to installation OneCommand groups must be configured on the LDAP network or the local host machine for Secure Management operation See OneCommand Manager Secure Management Configuration Requirements on page 15 for configuration instructions Before installing the OneCommand Manager CLI install the appropriate driver e The Solaris FC FCoE inbox driver version emlxs 2 80 8 0 or later or the out of box driver version elxfc 2 85 xx xx must be installed for FC FCoE management e The NIC inbox driver version oce 4 4 173 9 3S or later or the out of box driver version elxnic 4 1 xx xx must be installed for UCNA or CFA management Note If Emulex adapters are installed on the system the NIC driver must be installed and reporting all NIC ports Otherwise the OneCommand Manager application cannot manage Emulex network adapters To install the OneCommand Manager CLI in Solaris 1 Copy the OneCommand Manager core kit to a temporary directory on the system 2 Untar the core kit by typing tar xvf elxocmcore
11. Current 4 Configured OneCommand Manager Command Line Interface Version 10 2 User Manual P010067 01A Rev A 5 CLI Client Command Descriptions SE EMULEX WWN Management Commands 157 RestoreWWN This command changes the WWNs to the factory default or non volatile values The change is non volatile Notes e A reboot is required to activate the new setting e For VMware ESXi After changing the WWN of an adapter you must reboot the ESXi system before trying to access the adapter on that system For information on rebooting the ESXi system see the VMware documentation e For ESXi 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 ESXi system before trying to access the adapter on that system For information on restarting the CIMOM see the VMware documentation Supported By Linux Solaris VMware ESXi and Windows Syntax RestoreWWN lt WWPN gt lt Type gt Parameters WWPN The WWPN of an FC or FCoE port Type 0 Restore Default WWNs 1 Restore NVRAM WWNs OneCommand Manager Command Line Interface Version 10 2 User Manual P010067 01A Rev A DE EMULEX Appendix A OneCommand Manager Error Messages 168 Appendix A OneCommand Manager Error Messages Table A 1 contains a list of some of the error messages that may be encountered during an OCM session Table A 1 OneCommand Manager Error Messages Error Message Command s
12. PciData This command shows the PCI configuration data if available Diagnostic Commands 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 return If you specify the MAC address for the NIC function on that same physical port the PCI registers for that NIC function return Supported By Linux Solaris VMware ESXi and Windows Syntax PciData lt WWPN MAC gt Parameters WWPN The WWPN of an FC or FCoE port MAC The MAC address of a NIC or iSCSI port Example C Program Files emulex Util OCManagershbacmd h 10 192 203 154 m cim u root p Swamiji001 n root emulex PciData 00 00 c9 93 2f de The example output Vendor ID 0x19A2 Command 0x0406 Revision ID 0x02 Subclass 0x00 Cache Line Size 0x10 Header Type 0x80 Device ID Status Prog If Base Class Latency Timer Built In Self Test OneCommand Manager Command Line Interface Version 10 2 User Manual 0x0700 0x0010 0x00 0x02 0x00 0x00 P010067 01A Rev A 5 CLI Client Command Descriptions 78 Diagnostic Commands DE EMULEX Base Address 0 0x00000000 Base Address 1 0xDF478000 Base Address 2 OxDF480004 Base Address 3 0x00000000 Base Address 4 OxDF4A0004 Base Address 5 0x00000000 CIS 0x00000000 SubVendor ID 0x10DF SubSystem ID OxE622 ROM Base Address 0x00000000 Interrupt Line 0x00 Interrup
13. e Only OCe14000 series adapters support ARI Supported By Linux Solaris VMware ESXi and Windows Syntax hbacmd SetAdapterPortConfig lt MAC WWPN gt defaults or hbacmd SetAdapterPortConfig lt MAC WWPN gt pO0 fcnCfg pl fenCfg p2 fcnCfg p3 fcnCfg pid ProfileID mctype Type NParEpMode State Parameters MAC MAC address of any iSCSI NIC or NIC RoCE function on the adapter WWPN WWPN of any FCoE function on the adapter defaults Sets the adapter port configuration back its factory default configuration No additional parameters should be specified with the default parameter p0 fcnCfg 1st port s function s p1 fcnCfg 2nd port s function s required for 2 and 4 port adapters p2 fcnCfg 3rd port s function s required for 4 port adapters p3 fenCfg 4th port s function s required for 4 port adapters OneCommand Manager Command Line Interface Version 10 2 User Manual P010067 01A Rev A DE EMULEX 5 CLI Client Command Descriptions 139 Profile Management Commands fcnctg f0Lf1 fM where f0 1st function protocol on port must be NIC or NIC RoCE H 2nd function protocol on port optional fm Mth function protocol on port optional The number of functions per port the value of M are model and multichannel type specific ProfileID This parameter is required when specifying a NIC only or NIC RoCE personality Otherwise this parameter must be omitted Type Optional multichannel type specif
14. 2 User Manual P010067 01A Rev A e 5 CLI Client Command Descriptions 156 SG EMULEX Profile Management Commands Concurrent Mode I O Allowed Yes ROCE Functions Allowed Yes RebootRequired Yes Active Configuration Profile ID 33 MC Type NPAR Port Assignments Port 1 NIC iSCSI FCoE NIC Port 2 NIC i1SCSI None NIC Port 3 NIC iSCSI NIC FCoE Port 4 NIC iSCSI FCoE Reboot Configuration Profile ID 16 MC Type None Port Assignments Port 1 p0 NIC Port 2 pl NIC Port 3 p2 NIC Port 4 p3 NIC Note pN labels are the port parameter names to use in the SetAdapterPortConfig command e g pO NIC FCoE pl NIC iSCSI 2 Ports Switching from all NIC to NIC RoCE on First Port Run Profile 21 RoCE 2 gt hbacmd setadapterportconfig 00 00 c9 12 34 56 pO snic roce pl nic pid 21 mctype none Successfully changed port configuration A reboot is required to complete changes gt hbacmd getadapterportconfig 00 00 c9 12 34 56 Number of Ports 52 Maximum FCoE Functions 2 Maximum iSCSI Functions 22 Mixed Mode I O Allowed Yes Concurrent Mode I O Allowed Yes ROCE Functions Allowed Yes RebootRequired Yes Active Configuration OneCommand Manager Command Line Interface Version 10 2 User Manual P010067 01A Rev A DE EMULEX Profile ID 16 MC Type None Port Assignments Port 1 NIC Port 2 NIC Reboot Configuration Profile ID 21 MC Type None Port Assignments Port 1 p0 NIC ROCE Po
15. Automatic Assignment No Link Local Address fe80 ald3 f062 f44a 7577 IP Address 1 fd01 16 IP Address 2 d02 16 Gateway f400 1 GetSessionlnfo This command lists all session information for a specified session You must specify the lt iscsi target name gt and either the lt TSIH gt of the session or the session s ISID Qualifier lt ISID_Qual gt and the targe s IPv4 or IPv6 IP address lt Target IP gt These parameters tell the command to gather the information from the specified target and session You can find the TSIH and ISID gualifier by running the ListSessions command OneCommand Manager Command Line Interface Version 10 2 User Manual P010067 01A Rev A e 5 CLI Client Command Descriptions 99 gt G EMULEX iSCSI Commands Supported By Linux Solaris VMware ESXi and Windows Syntax GetSessionInfo lt MAC Address gt lt iscsi target name gt lt TSIH lt ISID Qual Target_IP gt gt Parameters MAC Address The MAC address of an iSCSI 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 1P The Target s IP address You can specify an IPv4 or IPv6 IP address ImportiSCSI This command imports iSCSI targets from an XML file to the iSCSI ports on the host The XML file is created by the ExportiSCSI command Supported By Windows Only Syntax Impor
16. Concurrent Mode I O Allowed No ROCE Functions Allowed Yes RebootRequired Yes Active Configuration Profile ID 37 MC Type UMC Port Assignments Port 0 NIC NIC NIC NIC Port 1 NIC NIC NIC NIC Port 2 NIC NIC NIC NIC Port 3 NIC NIC NIC NIC Reboot Configuration OneCommand Manager Command Line Interface Version 10 2 User Manual P010067 01A Rev A DE EMULEX Profile ID 37 MC Type UMC Port Assignments Port 0 p0 NIC i1SCSI NIC NIC Port 1 p1 NIC FCOE NIC NIC Port 2 p2 NIC FCOE NIC NIC Port 3 p3 NIC 1SCSI NIC NIC 5 CLI Client Command Descriptions 145 Profile Management Commands Note PN labels are the port parameter names to use in the SetAdapterPortConfig command e g pO NIC FCoE p1 NIC iSCSI Enable UMC on 2 Port 8 Channels Port gt hbacmd SetAdapterPortConfig 00 00 c9 12 34 56 p0O nic iscsi fcoe nic nic nic nic nic p 1 nic fcoe iscsi nic nic nic nic nic mctype UMC Successfully changed port configuration A reboot is reguired to complete changes gt hbacmd getadapterportconfig 00 00 c9 12 34 56 Number of Ports se rd Maximum FCoE Functions 4 Maximum iSCSI Functions 4 Mixed Mode I O Allowed Yes Concurrent Mode I O Allowed Yes ROCE Functions Allowed Yes RebootRequired Yes Active Configuration Profile ID 37 MC Type None Profile ID 37 Port Assignments Port 0 NIC iSCSI FCOE Port 1 NIC FCoE iSCSI Reboot Configuration Profile ID 37 MC Typ
17. Description Error Read only management mode Active management commands _ This message is returned when is currently set on this host The that change a property on an certain commands are attempted requested command is not permitted adapter or host when the CLI is configured for in this mode read only mode See CLI in Read Only Mode May Cause Error Message on page 30 Error Read only management mode various The CLI does not allow the is currently set on this host The execution of certain commands requested command is not permitted when it is configured for read only in this mode mode See CLI in Read Only Mode May Cause Error Message on page 30 Not supported ChangeWWN If a volatile change is requested on an adapter that does not support volatile WWNs it returns a not supported error See ChangeWWN on page 165 There are no license features for ShowLicenseAdapterlD Adapter License Management this adapter Install AdapterLicense commands are not available on 0Ce11101 EM EX or 0Ce11102 EM EX adapters See Adapter License Management Commands on page 48 ShowAdapterLicenseFeatures ERROR HBACMD GetDumpFile GetDumpFile Dump files are copied from the RM GetDumpFile call failed 2 Dump directory of the remote ERROR lt 2 gt Not Supported host to the Dump directory of the local host Specifying a local port identifier for this command returns an error since the source
18. If the management host option is selected you must either select the default port number or enter a valid TCP IP port number on the command line A value of 0 will not be accepted If one of the non management host options is selected you can enter the TCP IP port number on the command line Uninstalling in Windows There are two ways to uninstall the OneCommand Manager CLI in Windows e Through the control panel e Through the command line Uninstalling through the Control Panel To uninstall the OneCommand Manager CLI in Windows through the control panel 1 3 In Windows 2008 and Windows 2008 R2 select Start gt Control Panel gt Programs gt Uninstall a Program If present select Emulex Common SAN Management version and click Remove or Uninstall Click Yes The Emulex Common SAN Management components are removed from the system Select Emulex OCManager CLI version and click Remove or Uninstall Uninstalling through the Command Line To uninstall the OneCommand Manager CLI in Windows through the command line 1 Change to the appropriate uninstall directory cd lt Install Location gt Emulex Util Uninstall Type uninstall_OCManager_Core bat OneCommand Manager Command Line Interface Version 10 2 User Manual P010067 01A Rev A DE EMULEX 2 Installing and Uninstalling the CLI 27 Starting and Stopping Daemon Processes Starting and Stopping Daemon Processes Linux and Solaris On Linux and Solaris
19. MAC MAC address of any NIC or iSCSI function on the physical adapter port LPVIDO LPVID for channel 0 LPVID1 LPVID for channel 1 LPVIDn LPVID for channel n Considerations for Using UmvSetLPVID e LPVID values are in the range of 2 4094 e Every NIC channel on a physical port must have a unique LPVID e For FCoE and iSCSI channels 0 must be entered because LPVIDs can only be specified for NIC channels e LPVIDs specified for channels with protocols set to None are ignored e This command is not supported on 1 Gb ports e If channel management is disabled when this command is executed an error message is displayed Examples All NIC Channels gt hbacmd UmcSetLPVID 00 00 c9 12 34 56 1001 1002 1003 1004 Storage on 2nd channel gt hbacmd UmcSetLPVID 00 00 c9 12 34 56 1001 0 1002 1003 OneCommand Manager Command Line Interface Version 10 2 User Manual P010067 01A Rev A 5 CLI Client Command Descriptions gt lt EMULEX VPort Commands 162 VPort Commands Note Supported by FC and FCoE adapter ports only 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 vname optional parameter can be specified for the
20. N 95 DeleteDumpFiles v v N vi 84 DeleteiSNSServer N v v 95 DeleteVPort v N v 162 DiscoveriSNSServer y v v 96 Download N v N v 118 OneCommand Manager Command Line Interface Version 10 2 User Manual P010067 01A Rev A gt G EMULEX Table 5 1 CLI Client Command Reference Continued 5 CLI Client Command Descriptions VMware CIM Interface Command Linux Solaris ESXi Windows Support Page DriverConfig 81 Dump v v v 84 EchoTest v v v vi 74 EnableBootCode v k v v 58 ExportSANInfo v N v 118 ExportiSCSl v 96 FecEnable v v v 119 GetBeacon v v v 74 GetAdapterPortConfig v N v 133 GetAuthConfig N v N 55 GetAuthStatus k v v 55 GetBootParams N v v v 59 GetCimCred v 119 GetDCBParams v v v v y 66 GetDriverParams v N v v v 81 GetDriverParamsGlobal v N v N v 81 GetDumpDirectory N v v v v 85 GetDumpFile v v v v v 85 GetDumpFileNames N v v v v 86 GetExpressLaneLUNList N v N v 114 GetElxSeclnfo v v 119 GetFCFInfo v N v v 88 GetFIPParams v v v v 88 GetlnitiatorProperties v N v N 96 GetiSCSlLuns v v v fe 97 GetiSCSIPortStats v v v v 97 GetLunList v v N v v 112 GetLunUnMaskByHBA v v 113 GetLunUnMaskByTarget v v 113 GetNetwork v N v v 98 Configuration GetPGInfo v v v v v 67 OneCommand Manager Command Line Interface Version 10 2 User Manual P010067 01A Rev A 41
21. SetCnaPGBW This command sets the ETS priority group bandwidth percentages on a port of a OneConnect adapter according to the following rules e Bandwidths BW0 BW7 for priority groups 0 7 PG0 PG7 must total 100 for 100 e Bandwidth can be assigned to a priority group that has priorities Supported By Linux Solaris VMware ESXi and Windows Syntax SetCnaPGBW lt WWPN MAC gt lt BW0 BW7 gt Parameters WWPN The WWPN of an FC or FCoE port MAC The MAC address of a NIC or iSCSI port BW0 BW7 The bandwidths allocated for the priority groups 0 7 Example This command sets the bandwidth of PGO to 50 PG1 to 50 and PG2 PG7 to 0 hbacmd SetCnaPGBW 10 00 00 00 c9 3c f7 88 50 50000000 OneCommand Manager Command Line Interface Version 10 2 User Manual P010067 01A Rev A e 5 CLI Client Command Descriptions 68 gt G EMULEX DCB Commands SetDCBParam This command configures the DCB and LLDP settings on a OneConnect adapter port Use the GetDCBParams command to obtain valid parameter names for use in this command Notes e You cannot set DCBX mode If you attempt to specify a dcbxmode parameter an error message is displayed e RoCE is only available on the OCe140000 series of adapters e RoCE is only available on Windows operating systems Supported By Linux Solaris VMware ESXi and Windows Syntax SetDCBParam lt WWPN MAC gt lt Param gt lt Value gt Parameters WWPN The WWPN of an FCoE port
22. Syntax 5 CLI Client Command Descriptions 94 iSCSI Commands AddTargetPortal lt MAC Address gt lt Target_IP gt lt Port gt ImmediateData lt 0 1 gt HeaderDigest lt 0 1 gt DataDigest lt 0 1 gt Auth lt 0 1 2 gt TgtCHAPName TgtSecret InitCHAPName InitSecret Parameters MAC Address Target_IP Port ImmediateData HeaderDigest DataDigest Auth TgtCHAPNam TgtSecret InitCHAPName InitSecret The MAC address of an iSCSI port IP address of the target portal You can specify an IPv4 or IPv6 IP address Port number of the target portal value 1024 65535 0 No 1 Yes default 0 None default 1 CRC32C 0 None default 1 CRC32C 0 None default 1 One Way CHAP 2 Mutual CHAP Target CHAP name enclosed in quotes string length 1 256 Target Secret enclosed in quotes string length 12 16 Initiator CHAP name enclosed in quotes string length 1 256 Initiator Secret enclosed in quotes string length 12 16 CleariSNSServer This command clears the configured iSNS server and disables iSNS target discovery If no iSNS server is currently configured or if two or more iSNS servers are defined any attempt to use this command returns an error Note This command works only if one iSNS server is defined Supported By Linux Solaris VMware ESXi and Windows Syntax CleariSNSServer lt MAC Address gt Parameters MAC Address The MAC address of an
23. Syntax FecEnable WWPN lt 0 1 gt Parameters WWPN The WWPN of the FC port 0 Disables FEC on the port 1 Enables FEC on the port GetCimCred This command shows the default credentials set for the CIM client Note The password is encrypted Supported By Windows Syntax GetCimCred Parameters None GetElxSecinfo This command shows the version of the ElxSec system Supported By Windows and Linux OneCommand Manager Command Line Interface Version 10 2 User Manual P010067 01A Rev A e 5 CLI Client Command Descriptions 120 2 EMULEX Miscellaneous Commands Syntax GetElxSecInfo Parameters None GetQoSinfo This command shows the QoS information for a specified NIC port if multichannel support is enabled Supported By Linux Solaris VMware ESXi and Windows Syntax GetQoSInfo lt MAC Address gt Parameters MAC The MAC address of a NIC port Example hbacmd GetQoSInfo 00 00 c9 93 20f d6 GetVPD This command shows the port s VPD Supported By Linux Solaris VMware ESXi and Windows Syntax GetVPD lt WWPN MAC gt Parameters WWPN The WWPN of an FC or FCoE port MAC The MAC address of a NIC or iSCSI port OneCommand Manager Command Line Interface Version 10 2 User Manual P010067 01A Rev A DE EMULEX 5 CLI Client Command Descriptions 121 Miscellaneous Commands ListHBAs This command shows a list of the manageable Emulex adapters found by local and remote out of band TCP
24. When NPar is enabled the protocols for additional functions on each port can be specified depending upon the board model the number of ports available on the adapter and the NParEP Mode setting otherwise they will be set to None meaning there is no protocol running on the function The SetAdapterPortConfig command configures the protocols running on each function After enabling NPar mode with the SetAdapterPortConfig command default bandwidths will be automatically assigned to each partition with an assigned protocol See Default NPar Bandwidths on page 153 for more information The following rules apply when using the SetAdapterPortConfig command with multichannel enabled to configure NPar e First function on a port is always NIC NIC RoCE is not available when NPar is enabled e Storage can be configured on the 2nd 3rd or 4th partitions only A total of 2 different storage protocols can be configured on a port e Any partition other than the first partition can be configured as None that is for no protocol e A reboot is required after executing this command to run the new protocols assigned to the functions Examples 4 Ports NParEP Mode Disabled 2 Functions Port gt hbacmd setadapterportconfig 00 00 c9 12 34 56 pO nic iscsi pl nic fcoe p2 nic fcoe p3 nic iscsi mctype npar nparepmode 0 Successfully changed port configuration A reboot is required to complete changes gt hbacmd getadapterportconfig
25. e For Linux and VMware operating systems only ExpressLane enabled LUNs are shown by this command LUNS without ExpressLane enabled support are not shown e ExpressLane LUNs are supported on 16 GB FC ports only Syntax GetExpressLaneLunList lt WWPN gt vport lt vPort WWPN gt lt Target WWPN gt lt Option gt Parameters WWPN The WWPN of the FC function connected to the target or physical WWPN if virtual ports are selected vPort WWPN The WWPN of an optional vPort allowing you to get the ExpressLane LUNs of a vPort Target WWPN The WWPN of the target LUNs Option 0 Get information from driver 1 Get information from configuration Example gt hbacmd h 10 192 87 198 GetExpressLaneLunList 10 00 00 00 00 87 01 98 20 22 d4 ae 52 6e 6f 08 0 Number of LUNs 4 SetExpressLaneLunState This command enables or disables ExpressLane on a particular LUN Note ExpressLane cannot be enabled for Masked LUNs Supported By Linux VMware ESXi and Windows Syntax SetExpressLaneLunState lt WWPN gt vport lt vPort WWPN gt lt Target WWPN gt lt Lun gt lt State gt lt Option gt OneCommand Manager Command Line Interface Version 10 2 User Manual P010067 01A Rev A DE EMULEX 5 CLI Client Command Descriptions 116 Miscellaneous Commands Parameters WWPN The WWPN of the FC FCoE function connected to the target or physical WWPN if virtual ports are selected VPORT WWPN The WWPN of an optional vPort allowing you to set
26. virtual port s name Note In Linux VPorts do not persist across system reboots CreateVPort Supported By Linux Solaris and Windows Syntax CreateVPort lt physical WWPN gt auto vname 01 CreateVPort lt physical WWPN gt lt virtual WWPN gt lt virtual WWNN gt vname Parameters physical WWPN The WWPN of an FC or FCoE port auto The virtual WWPN is automatically generated for the virtual port vname The virtual por s name optional virtual WWPN The virtual WWPN to create virtual WWNN The virtual WWNN to create DeleteVPort This command deletes the virtual port specified by a physical and virtual WWPN Supported By Linux Solaris and Windows Syntax DeleteVPort lt physical WWPN gt lt virtual WWPN gt Parameters physical WWPN The WWPN of an FC or FCoE port virtual WWPN The WWPN of the virtual port OneCommand Manager Command Line Interface Version 10 2 User Manual P010067 01A Rev A 5 CLI Client Command Descriptions 163 VPort Commands SE EMULEX ListVFunctions This command lists the virtual functions on a specified NIC port that is physical function Supported By Linux Solaris VMware ESX and Windows Syntax ListVFunctions lt MAC gt Parameters MAC The MAC address of a NIC port Example hbacmd ListVFunctions 00 00 c9 12 34 56 The example output Virtual Functions for 00 00 c9 12 34 56 MAC Address 00 00 c9 12 34 ab VLADID 10 Transmit Rate 100 Mbit s
27. 00 00 c9 12 34 56 Number of Ports 4 Maximum FCoE Functions 4 Maximum iSCSI Functions 34 Mixed Mode I O Allowed Yes Concurrent Mode I O Allowed Yes ROCE Functions Allowed Yes RebootRequired Yes Active Configuration Profile ID 16 MC Type NPAR Port Assignments Port 1 NIC NIC Port 2 NIC NIC OneCommand Manager Command Line Interface Version 10 2 User Manual P010067 01A Rev A DE EMULEX Port 3 Port 4 NIC NIC NIC NIC Reboot Configuration Profile ID 37 MC Type NParEP Mode NPAR Disabled Port Assignments Port Port Port Port Note 1 2 3 4 po NIC iSCSI p1 NIC FCOE p2 NIC FCOE p3 NIC iSCSI PN 5 CLI Client Command Descriptions Profile Management Commands labels are the port parameter names to use in the SetAdapterPortConfig command e g poO NIC FCOoE p1 NIC iSCSI 2 Ports NParEP Mode Disabled 4 Functions Port gt hbacmd setadapterportconfig 00 00 c9 12 34 56 pO snic iscsi nic fcoe pl nic fcoe iscsi nic mctype npar nparepmode 0 Successfully changed port configuration A reboot is required to complete changes gt hbacmd getadapterportconfig 00 00 c9 12 34 56 Number of Ports Maximum FCoE Functions Maximum iSCSI Functions Mixed Mode I O Allowed Concurrent Mode I O Allowed ROCE Functions Allowed RebootRequired Active Configuration Profile ID 16 MC Type None Port Assignments Port 1 Port 2 NIC NIC Reboot Co
28. 129 Persistent Binding Commands BindFlag The type of binding support for the adapter D Binding by D_ID not available for Windows driver P Binding by WWPN N Binding by WWNN not available for Windows driver A Binding by automap not available for Windows driver DA Binding by D_ID and automap PA Binding by WWPN and automap NA Binding by WWNN and automap SetPersistentBinding 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 Supported By Solaris and Windows Syntax SetPersistentBinding lt WWPN gt lt Scope gt lt BindType gt lt TargetId gt lt SCSIBus gt lt SCSITarget gt Parameters WWPN The WWPN of an FC or FCoE port 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 If BindType P Target WWPN If BindType N Target WWNN If BindType D Target D ID SCSIBus The bus number of the SCSI device SCSITarget The target number of the SCSI device OneCommand Manager Command Line Interface Version 10 2 User Manual P010067 01A Rev A 5 CLI Client Command Descriptions SE EMULEX Personality Change Commands 130 Personality Change Commands The OneCommand Manager application enables you to change the personality or protocol running on O
29. 34 58 10 50 6 FCoE 00 00 c9 12 34 59 30 100 8 NIC 00 00 c9 12 34 5A 10 50 10 NIC 00 00 c9 12 34 5B 10 50 12 NIC 00 00 c9 12 34 5C 10 50 14 NIC 00 00 c9 12 34 5C 0 50 NParEP Mode When using NPar adapters you can change the total number of partitions displaved and configured on the adapter to 8 when the NParEP Mode property is disabled or to 16 when the NParEP Mode property is enabled Use the nparepmode parameter in the SetAdapterPortConfig command to enable or disable this property Notes e When NPar is disabled NParEP Mode is automatically disabled too It is not necessary to specify the nparepmode parameter on the command line when disabling NPar by setting the mctype parameter to None e After enabling or disabling NParEP Mode with the SetAdapterPortConfig command default bandwidths will be automatically assigned to each partition with an assigned protocol See Default NPar Bandwidths on page 153 for more information Parameters MAC MAC address of any iSCSI NIC or NIC RoCE partition on the adapter WWPN WWPN of any FCoE partition on the adapter nparepmode 1 enable the NParEP Mode to display and configure 16 functions 0 disable the NParEP Mode to display and configure 8 functions only OneCommand Manager Command Line Interface Version 10 2 User Manual P010067 01A Rev A e 5 CLI Client Command Descriptions 150 5 EMULEX Profile Management Commands Setting NPar Function Protocols
30. 5 1 CLI Client Command Heterence cece ener eee nn 40 Table 5 2 Option NAMESis lt itiivevecev tur sit dv vo rol ni aa 90 Table A 1 OneCommand Manager Error Messages 168 OneCommand Manager Command Line Interface Version 10 2 User Manual P010067 01A Rev A DE EMULEX 1 Introduction 11 Overview 1 Introduction Overview The OneCommand Manager Command Line Interface CLI utility is a comprehensive management utility for Emulex host bus adapters HBAs universal converged network adapters UCNAs also called OneConnect adapters and converged fabric adapters CFAs 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 A single operation is performed by entering hbacmd followed by a CLI client command and its possible parameters at the command line Compatibility The OneCommand Manager application can be installed on multiple operating systems Windows Linux Solaris and VMware ESXi For VMware ESXi hosts you can manage adapters using the OneCommand Manager application on Windows but you must install and use the appropriate Emulex CIM Provider on those VMware hosts Note For VMware ESXi hosts when advanced adapter management capabilities are required for example isCSI Management and port disable use the OneCommand Manager for VMware vCenter software plug in Fo
31. COMMaAN S sz l ussxkin sn ri va von n oni n k ao n o Dl o an ko aina 112 E Brei EE 112 EI e Belt EE 113 GetLunUnMaskByTarget 00o0sn nnnn c na s ENEE 113 e Ti EE 113 SetlunMaSk E 114 RTR EN Te DEE 114 GietExpressLanieLunliSt E 114 SetExpressLaneLunState e E EE EE di rn Age 115 Miscellaneous CommandSs 000nntonnnnnnnnnnnnnn ERRER RER sn rn 116 AGA NOSU det EENEG ni vn 116 CnaClearEventLog sssssssssrrrrrerrtt tirrr rtrt t tntan rnrn rrur tannar EEEEEEEEEEE RESE E EEn 117 CnaGetEventLog EE 117 lien E 118 beige e EE 118 PECE e 119 GetCiIMC EA EE 119 ET A SO FI Ot s b rn 119 EE O Terre 120 Get VPD s viuska kotva rh sa k it en nn 120 ele 21 OneCommand Manager Command Line Interface Version 10 2 User Manual P010067 01A Rev A DE EMULEX Table of Contents 8 ne e E 121 POSS i e V 122 EE d aoon Ee EE o O obo tini 122 SELFIE DEE zi i K 123 SN dee EE 123 TargetMapping EE 124 VIE 124 Versio sal O v 125 Persistent Binding CommandS 1 111126s1424 s sn nssn iasn s ah n KEE EKERREEKREE i dada in 125 AllNodelnfo r 126 ae Minier 126 BindingSupport EE 127 PersistentBinding EEN 127 RemoveAllPersistentBinding vvn 127 REMOVEP Er SISCENEBINGING EE 128 SEENEN GE EE 128 SetPersistentBinding s S NO 129 Personality Change Commandgs siisd s sn na zadu n k k ansk dn id hrn ia vn 130 ee n o 130 SEET ee AER REES o vo a 132 Profile Management omman S
32. Denied Allowed Table 1 3 Active Com mands machines on different domain Remote Server Remote Server Secure Not Secure Client Secure Denied Denied Client Not Secure Denied Allowed Table 1 4 Passive Commands machines on any domain Remote Server Remote Server Secure Not Secure Client Secure Allowed Allowed Client Not Secure Allowed Allowed To inform you of an unsecured server that you may want to secure Allowed if the username and password are the same on both domains OneCommand Manager Secure Management Configuration Requirements For systems to run in the OneCommand Manager secure management environment they need to be configured to provide the following two capabilities and must be configured as follows o Authentication On Linux and Solaris this is done through the PAM interface On Solaris place the correct setting in the auth section of the etc pam d other file or its earlier equivalent etc pam conf Note For Solaris systems you must use useradd G groupname for authentication to work You cannot use a lowercase g o eguivalent On Linux it is the etc pam d passwd file auth section or the User Group Membership From the host machine OneCommand Manager Secure Management must be able to access the OneCommand Manager group to which the user belongs For Linux and Solaris systems it uses the getgrnam
33. FCoE n a n a 40 100 2 NIC 00 00 c9 12 34 58 4 25 50 3 NIC 00 00 c9 12 34 59 5 10 20 Multichannel Disabled IBM gt hbacmd CMGetParams 00 00 c9 12 34 56 Active Mode None OneCommand Manager Command Line Interface Version 10 2 User Manual P010067 01A Rev A 5 CLI Client Command Descriptions Ld 62 gt G EMULEX Channel Management Commands Configured mode None Available modes vNIC1 SIMode UFP Multichannel Enabled IBM UFP gt hbacmd CMGetParams 00 00 c9 12 34 56 Active Mode UFP Configured mode UFP Available modes vNIC1 SIMode UFP Outer Func Type MAC Address VLAN Min BW Max BW 0 NIC 00 00 c9 12 34 56 2 25 50 1 NIC 00 00 c9 12 34 57 3 25 50 2 NIC 00 00 c9 12 34 58 4 25 50 3 NIC 00 00 c9 12 34 59 5 25 75 Dell NPar Disabled gt hbacmd CMGetParams 00 00 c9 12 34 56 Active Mode None Configured mode None Available modes NPAR Dell NPar Enabled 4 Functions Port Note Even though function 1 has a minimum bandwidth of 0 some traffic flows through gt hbacmd CMGetParams 00 00 c9 12 34 56 Active Mode NPAR Configured mode NPAR Available modes NPAR Func Type MAC Address Min BW Max BW 0 NIC 00 00 c9 12 34 56 25 50 1 NIC 00 00 c9 12 34 57 0 50 2 NIC 00 00 c9 12 34 58 25 50 3 NIC 00 00 c9 12 34 59 50 75 OneCommand Manager Command Line Interface Version 10 2 User Manual P010067 01A Rev A 5 CLI Client Command Descriptions gt lt e 63 gt G EMULEX Channel Management Commands CMMode Thi
34. IP discovery For a NIC only or iSCSI adapter the MAC address is displayed rather than the port WWN The node WWN and fabric WWN are not displayed The type of information listed may vary according to the adapter model Supported By Linux Solaris VMware ESXi and Windows Syntax ListHBAs local m model pt type down Parameters local Only displays local adapters m model Model filter Append to the end of the model name for a wildcard match For example LP9 pt type The port type filter Valid types are NIC iSCSI FC and FCoE down Displays only the NIC functions of inoperative OneConnect and LPe16202 adapters on the local system RemoveHost This command removes a host from the hosts file use for TCP IP management in the OneCommand Manager application GUI The lt host_address gt can be an IP address using the IPv4 or IPv6 format or a host name Supported By Linux Solaris and Windows Syntax For the RM interface hbacmd RemoveHost host_address For VMware ESXi using the CIM interface hbacmd m cim RemoveHost lt IP Address gt Note The h option for specifying an optional IP address or host name after hbacmd is not available for the RemoveHost command OneCommand Manager Command Line Interface Version 10 2 User Manual P010067 01A Rev A DE EMULEX 5 CLI Client Command Descriptions 122 Miscellaneous Commands Parameters host address The host to remove IP Address The IP ad
35. Length The length of the direct attach copper DAC cable in meters Valid values are 0 10 A length value of 0 indicates an optical cable A Length value is required when using a 10Gb SFP and QSFP transceiver interface type When the Mode parameter is 0 Speed and Length parameters are ignored and when the Mode parameter is 1 the Length parameter is ignored Note For an embedded mezzanine adapter linked to an embedded switch on the internal port the Length value is ignored Examples The following example configures the PHY port to a forced speed of 1 Gb sec with a cable length of ten meters hbacmd setphyportspeed 00 00 c9 ad ad ac 2 1Gb 10 The following example tries to configure the PHY port to a forced speed of 100 Mb sec hbacmd setphyportspeed 00 00 c9 a9 41 88 2 100Mb If the command is successful the following is displayed Successfully changed speed settings on port This command results in an error because you must include a value for the Length parameter when the Mode parameter is 2 ERROR lt 431 gt Cable length required for force mode and interface type SetPortEnabled This command enables or disables a port Notes e Ensure that all I Os on the port are stopped before disabling the port e Only OneConnect adapters do not require a reset when the adapter port is enabled or disabled For FC adapters when the SetPortEnabled command disables an FC port the adapter must be reset to activate the new setting Su
36. NIC NIC Port 3 NIC iSCSI NIC NIC Reboot Configuration Profile ID 37 MC Type UMC Port Assignments Port 0 p0 NIC iSCSI FCoE NIC Port 1 p1 NIC 1SCSI FCoE NIC Port 2 p2 NIC FCOE NIC NIC Port 3 p3 NIC i1SCSI NIC NIC Note PN labels are the port parameter names to use in the SetAdapterPortConfig command e g pO NIC FCoE p1 NIC iSCSI OneCommand Manager Command Line Interface Version 10 2 User Manual P010067 01A Rev A 5 CLI Client Command Descriptions SE EMULEX Profile Management Commands 135 NIC RoCE gt hbacmd getadapterportconfig 00 00 c9 12 34 56 Number of Ports 4 Maximum FCoE Functions 4 Maximum iSCSI Functions i4 Mixed Mode I O Allowed Yes Concurrent Mode I O Allowed Yes ROCE Functions Allowed Yes RebootRequired No Active Configuration Profile ID 21 MC Type None Port Assignments Port 0 NIC ROCE None None Port 1 NIC None None Port 2 NIC ROCE None None Port 3 NIC None None Reboot Configuration Profile ID 21 MC Type None Port Assignments Port 0 p0 NIC RoCE None None Port 1 pl NIC None None Port 2 p2 NIC ROCE None None Port 3 p3 NIC None None Note PN labels are the port parameter names to use in the SetAdapterPortConfig command e g pO NIC FCoE p1 NIC iSCSI ListProfiles This command shows a list of the available profile IDs and their descriptions for an adapter including the currently active and configured profile IDs This informa
37. OneConnect adapters only They are not available on LPe16202 OCe11101 EM EX OCe11102 EM EX or OCe14000 adapters The following error message will be returned There are no license features for this adapter In these commands the WWPN or MAC address argument specifies the adapter the command is acting upon The HbaCmd application uses the WWPN or MAC address to identify the adapter but this does not mean that the command works successfully on the specified port InstallAdapterLicense This command installs the license keys from a license file to enable specific features on the adapter Supported By Linux Solaris VMware ESXi and Windows Syntax InstallAdapterLicense lt WWPN MAC gt lt LicenseFile gt Parameters WWPN The WWPN of an FCoE port MAC The MAC address of a NIC or iSCSI port License File The path to the license key file containing the license keys obtained from the Emulex License website OneCommand Manager Command Line Interface Version 10 2 User Manual P010067 01A Rev A Adapter License Management Commands DE EMULEX 5 CLI Client Command Descriptions 49 Examples For non VMware ESXi hosts hbacmd InstallAdapterLicense 00 12 34 56 78 9A K N1f1324 lic For VMware ESXi hosts hbacmd h lt IP Address gt m cim u root p lt password gt n lt namespace gt InstallAdapterLicense 00 12 34 56 78 9A K 1f 1324 lic ShowAdapterLicenseFeatures This command displays the list of licensed and licensable feature
38. Repository directory Supported By Linux Solaris VMware ESXi and Windows Syntax SaveConfig lt WWPN gt lt FileName gt lt Flag gt Parameters WWPN The WWPN of an FC or FCoE port 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 SetDriverParam This command changes a driver parameter and designates the scope of the change Supported By Linux Solaris VMware ESXi and Windows Syntax SetDriverParam lt WWPN gt lt Flagl gt lt Flag2 gt lt Param gt lt Value gt lt enable dtm gt Parameters WWPN The WWPN of an FC or FCoE port Flagl L Make change local for this adapter only G gt 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 hexadecimal OxNNN enable dtm P Make change permanent persist across reboot Note Dynamic target mode is only supported on Light Pulse FC HBA COMSTAR ports OneCommand Manager Command Line Interface Version 10 2 User Manual P010067 01A Rev A DE EMULEX 5 CLI Client Command Descriptions 83 Dump Commands Example To enable dynamic target mode hbacmd SetDriverParam 10 00 00 00 c9 ff ff ff L P enable dtm 1 To disable dynamic target mode set the flag to 0 SetDriverParamDefaults This command change
39. SetlnitiatorProperties This command sets the initiator properties for the specified port It allows you to specify an initiator name lt Initiator_Name gt and an initiator alias lt Initiator Alias gt If you opt not to specify these fields a default isCSI name is assigned Except for the lt Initiator_Name gt and lt Initiator_Alias gt properties these properties are set as the target portal s login properties to be used when discovering the targets on the target portal The targets inherit the target portal s properties when they are discovered The discovered target s login properties can be changed using the SetTargetProperties command When you set the authentication method lt Auth gt to a value other than 0 you must set additional parameters Each string should be enclosed in quotations to avoid mishandling by the Windows Linux Solaris or VMware shell s parser Additionally these properties are used for iSNS target discovery to set the discovered target s login properties e If you set the authentication method to One Way CHAP lt Auth gt 1 you must also specify the Target CHAP Name and Target Secret For example hbacmd SetInitiatorProperties 00 11 22 33 44 55 Auth 1 TgtChapName TargetSecretl e If you set the authentication method to Mutual CHAP lt Auth gt 2 you must specify all four values For example hbacmd SetInitiatorProperties 00 11 22 33 44 55 Auth 2 TgtChapName TargetS
40. The Mode number 0 Default 1 Auto negotiate requires the Speed parameter 2 Force requires the Speed and Length parameters Note When the adapter s port speed setting and the switch s port speed setting conflict the link will not be brought up Speed The speed string of the PHY port Some valid string values include 100Mb 1Gb and 10Gb The PortAttributes command lists all the valid speeds in Auto negotiate and Force modes Auto negotiated Speeds A comma separated list of available auto negotiated speeds is displayed by the PortAttributes command for OneConnect OCe11100 series and OCe14000 series adapters For combinations of speeds each speed is separated by a slash for example 10Gb 1Gb 100Mb If the port does not support auto negotiated speeds this property will be displayed as Not Supported Forced Speeds A comma separated list of available forced speeds is displayed by the PortAttributes command for OneConnect OCe11100 series and OCe14000 series adapters There are no combinations of speeds for forced speeds If the port does not support forced speeds this property will be displayed as Not Supported Note When the Mode parameter is 1 or 2 the Speed parameter is required When the Mode parameter is 0 the Speed parameter is ignored OneCommand Manager Command Line Interface Version 10 2 User Manual P010067 01A Rev A 5 CLI Client Command Descriptions gt lt EMULEX Attributes Commands 53
41. This number can be obtained from the ListProfiles command on page 136 by looking at the Active Profile ID field Notes e Profile ID is required when specifying a NIC or NIC ROCE personality For all other personalities Profile ID should not be specified Selecting a profile that cannot be used with the specified personality results in an error Example For non ESXi hosts changing to FCoE personality hbacmd ChangePersonality 00 12 34 56 78 9A fcoe For ESXi hosts changing to FCoE personality hbacmd changepersonality 00 00 c9 12 34 56 fcoe Changing to NIC RoCE personality with Profile ID 21 hbacmd ChangePersonality 00 00 c9 12 34 56 nic roce 21 hbacmd ShowPersonalities 00 00 c9 12 34 56 Adapter Personalities NIC NIC ROCE configured iSCSI FCoE active OneCommand Manager Command Line Interface Version 10 2 User Manual P010067 01A Rev A 5 CLI Client Command Descriptions 132 Personality Change Commands gt G EMULEX ShowPersonalities This command displays the list of single personalities available on an adapter The personality type is displayed as either NIC NIC RoCE iSCSI or FCoE Notes e Ifthe active configurations are not single personality the active personality indicators are not displayed e The available personalities are adapter dependent e RoCE is only available on Windows operating systems Supported By Linux Solaris VMware ESXi and Windows Syntax ShowPersonalities lt
42. WWPN MAC gt Parameters WWPN The WWPN of an FCoE port MAC The MAC address of a NIC NIC RoCE or iSCSI port Example For non ESXi hosts hbacmd ShowPersonalities 00 12 34 56 78 9A For ESXi hosts hbacmd h lt IP Address gt m cim u root p lt password gt n lt namespace gt ShowPersonalities 00 12 34 56 78 9A For adapters that include RoCE gt hbacmd showpersonalities 00 00 c9 12 34 56 Adapter Personalities NIC NIC ROCE iSCSI FCoE active configured OneCommand Manager Command Line Interface Version 10 2 User Manual P010067 01A Rev A 5 CLI Client Command Descriptions SE EMULEX Profile Management Commands a Profile Management Commands GetAdapterPortConfig This command displays the active and reboot adapter port configurations of an OCe14000 series adapter This includes the total number of ports the maximum number of FCoE and iSCSI functions that can be defined and whether mixed mode and concurrent mode storage are supported by the adapter Additionally it shows if RoCE is supported on the adapter and if a reboot is currently required to activate the new configuration The number of functions displayed per port depends upon the current configuration of the adapter such as mixed or concurrent storage mode multichannel or NPar Notes e Inthe information displayed for the reboot configuration each of the ports displays the pN parameter name in parenthesis The pN parameter is used in the SetA
43. You cannot update a OneCommand Manager CLI with a previous version of the OneCommand Manager application enterprise kit Linux To update from the OneCommand Manager CLI to the full featured OneCommand Manager application enterprise kit in Linux run the install sh script of the OneCommand Manager application enterprise kit The install script executes an rpm update rpm U rpm to update the installed core kit to an enterprise kit Solaris To update from the OneCommand Manager CLI to the full featured OneCommand Manager application enterprise kit in Solaris 1 Download the OneCommand Manager application enterprise kit to a temporary directory on your system 2 Untar the OneCommand Manager application enterprise kit tar file tar xvf elxocm solaris lt kit version gt tar 3 Change to the newly created elxocm lt kit version gt directory cd elxocm solaris lt kit version gt 4 Run the install script and follow the instructions install Note The install script can also be run in non interactive guiet mode Enter the following command to view the syntax install help OneCommand Manager Command Line Interface Version 10 2 User Manual P010067 01A Rev A 3 Updating to the OneCommand Manager Application Enterprise Kit 29 SE EMULEX Windows Windows To update from the OneCommand Manager CLI to the full featured OneCommand Manager application enterprise kit in Windows 1 From the desktop run the elx
44. all adapter attributes for all ports on the adapter The type of information listed may vary according to the adapter model Supported By Linux Solaris VMware ESXi and Windows Syntax HbaAttributes lt WWPN gt Parameters h The IP address of the host WWPN The WWPN of an FC or FCoE port PortAttributes This command shows a list of port attributes for the adapter The type of information listed may vary according to the adapter model and may include IPv4 and IPv6 addresses Note If VEPA is supported on your adapter the VEPA state is displayed as enabled or disabled Supported By Linux Solaris VMware ESXi and Windows Syntax PortAttributes lt WWPN MAC gt OneCommand Manager Command Line Interface Version 10 2 User Manual P010067 01A Rev A DE EMULEX 5 CLI Client Command Descriptions 51 Attributes Commands Parameters h The IP address of the host WWPN The WWPN of an FC or FCoE port MAC The MAC address of a NIC or iSCSI port PortStatistics This command shows all port statistics for the adapter The type of information listed may vary according to the adapter model Supported By Linux Solaris VMware ESXi and Windows Syntax PortStatistics lt WWPN gt Parameters WWPN The WWPN of an FC or FCoE port ServerAttributes This command shows a list of server attributes for the adapter The type of information listed may vary according to the adapter model Supported By Linux Solaris VMwar
45. and destination directory are the same See GetDumpFile on page 85 ERROR lt 180 gt Authentication All The specified username is not User unknown valid or could not be authenticated by the system See OneCommand Manager Secure Management on page 14 for more information OneCommand Manager Command Line Interface Version 10 2 User Manual P010067 01A Rev A SG EMULEX Table A 1 OneCommand Manager Error Messages Continued Appendix A OneCommand Manager Error Messages Error Message Command s Description ERROR lt 181 gt Authentication All The specified username and Insufficient credentials password are valid and the user is a member of an OneCommand Manager group however the OneCommand Manager group does not have sufficient privileges to execute the specified command See OneCommand Manager Secure Management on page 14 for more information ERROR lt 183 gt Secure Mgmt user All The specified username and not a member of OCM group password could be authenticated but the user is not a member of an OneCommand Manager group See OneCommand Manager Secure Management on page 14 for more information ERROR lt 206 gt Authentication All This indicates either a valid Failed username but invalid password or a general user authentication error See OneCommand Manager Secure Management on page 14 for more information ERROR lt 222 gt DCB not available GetDCBPa
46. client application when the Secure Management feature is enabled each invocation must include a user name and password The user name and password options are added to the existing HbaCmd command in a similar fashion as is currently done for CIM commands except the lt m CIM gt option is replaced by the lt m sec gt option to distinguish it from a CIM command For example Without Secure Management or if running as root or Administrator hbacmd lt cmd gt With Secure Management as non Root or non Administrator User hbacmd lt m sec gt lt u userid gt lt p password gt lt cmd gt Syntax Rules for the Secure Management Interface For the secure management interface all of the syntax rules in HbaCmd Syntax Usage on page 31 apply Usage Example In Windows to download firmware on an adapter managed on a remote host at IP address 192 168 1 122 using the secure management interface run the following command hbacmd h 192 168 1 122 m sec u jsmith p password download 00 12 34 56 78 9A 0c11 4 6 96 2 ufi OneCommand Manager Command Line Interface Version 10 2 User Manual P010067 01A Rev A i 4 CLI Client Command Usage 33 Sens EMULEX CIM Interface CIM Interface Note In Linux and Solaris you cannot use HbaCmd as a CIM client Device Management Using the CIM Interface VMware on the hypervisor based ESXi platforms use the CIM as the only standard management mechanism for device management For VMwar
47. command sets the target properties for the NIC port with the specified MAC address with an extended timeout value of 1 hbacmd SetTargetProperties 00 11 22 33 44 55 iscsiTarget 1 e For NIC ports only the permanent MAC address is supported for the port address parameter on an HbaCmd command line Normally for a NIC port the port s permanent MAC address and current MAC address parameters are equal However it is possible to set a user specified current MAC Address that is different from the permanent MAC address OneCommand Manager Command Line Interface Version 10 2 User Manual P010067 01A Rev A i 4 CLI Client Command Usage 32 gt G EMULEX Secure Management CLI Interface Also for some implementations it is possible to have multiple NIC ports with the same current MAC addresses but with unique permanent MAC addresses Therefore to ensure that the OneCommand Manager can access the correct port only the permanent MAC address is supported Note that both the permanent MAC address and the current MAC address are displayed by using the ListHBAs command See ListHBAs on page 121 Secure Management CLI Interface Supported By Linux Solaris and Windows Note Users with root or Administrator privileges on the local machine will retain full OCM CLI configuration capability without the use of credentials local machine only Device Management Using the Secure Management Interface To run the HbaCmd CLI
48. copper cables such as the 10GBaseT adapter OCe11102 xT The TDR test attempts to determine if any cable faults are compromising the integrity of the link The test requires that the cable be free of disturbances down and quiet It is best if the cable is not terminated however if it is terminated then the link partner must not be active during the test For each twisted pair cable labeled A B C or D e Ifa fault cannot be detected the test output displays OK and an estimated cable length in meters if possible If the length cannot be determined the estimated length is displayed as invalid e If one of two faults a short or an open connection is detected the test output displays the fault type Shorted or Open and the distance to the fault in meters Supported By Linux Solaris VMware ESXi and Windows Syntax TDRTest lt MAC Address gt Parameters MAC_Address The MAC address of the NIC or iSCSI port OneCommand Manager Command Line Interface Version 10 2 User Manual P010067 01A Rev A 5 CLI Client Command Descriptions f 80 gt lt EMULEX Driver Parameter Commands Example hbacmd TDRTest lt MAC gt The example output Pair A OK Cable Length Estimation 50m Pair B OK Cable Length Estimation invalid Pair C Open Distance to Fault 38m Pair D Shorted Distance to Fault 36m Wakeup Note Not supported for OneConnect and LPe16200 series adapters This comm
49. disabled each of the ports can be configured to run with a single NIC or NIC ROCE function Use SetAdapterPortConfig command to configure these ports See SetAdapterPortConfig on page 137 for more information The syntax when disabling NPar is the following SetAdapterPortConfig lt MAC gt lt p0O NIC NIC ROCE gt lt p1 NIC NIC ROCE gt p2 NIC NIC RoCE p3 NIC NIC RoCE pid 20 21 where MAC MAC address of one of the NIC functions on the adapter PO NIC NIC ROCE Protocol to run on 1st port NIC or NIC ROCE pl NIC NIC RoCE Protocol to run on 2nd port NIC or NIC ROCE p2 NIC NIC RoCE Protocol to run on 3rd port if available NIC or NIC ROCE P3 NIC NIC ROCE Protocol to run on 2nd port if available NIC or NIC ROCE pid 20 21 Required when setting any port to NIC ROCE NIC ROCE 1 20 NIC ROCE 2 21 Note When specifying any of the ports to run NIC RoCE for example p1 RoCE the RoCE Profile ID must be specified It can be either 20 or 21 depending upon the preferred protocol Examples Disable NPar 4 Ports All NIC gt hbacmd setadapterportconfig 00 00 c9 12 34 56 pO nic pl nic p2 nic p3 nic mctype none Successfully changed port configuration A reboot is required to complete changes gt hbacmd getadapterportconfig 00 00 c9 12 34 56 Number of Ports 4 Maximum FCoE Functions 4 Maximum iSCSI Functions 4 Mixed Mode I O Allowed Ves OneCommand Manager Command Line Interface Version 10
50. gt lt EMULEX OneCommand Manager Command Line Interface Version 10 2 User Manual P010067 01A Rev A Emulex Connects Servers Storage and People SE EMULEX Copyright 2007 2014 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
51. iSCSI port OneCommand Manager Command Line Interface Version 10 2 User Manual P010067 01A Rev A e 5 CLI Client Command Descriptions 95 gt G EMULEX iSCSI Commands DelARPTableEntry This command removes an ARP table entry Supported By Linux Solaris VMware ESXi and Windows Syntax DelARPTableEntry MAC Address gt lt Dest MAC Address gt lt Dest_IP_Address gt Parameters MAC Address The MAC address of an iSCSI port Dest MAC Address The destination MAC address to remove from the ARP table Dest IP Address The destination IP address to remove from the ARP table DeleteiSNSServer This command is used to delete an iSNS server from the current iSNS server list Supported By Linux Solaris VMware ESXi and Windows Syntax DeleteiSNSServer MAC Address gt lt IP Address gt Parameters MAC Address The MAC address of an iSCSI port IP Address The IPv4 or IPv6 IP address of the iSNS server DelRouteTableEntry This command removes a route table entry from the specified port Supported By Linux Solaris VMware ESXi and Windows Syntax DelRouteTableEntry lt MAC Address gt lt Dest_IP Address gt lt Subnet Mask gt lt Gateway gt OneCommand Manager Command Line Interface Version 10 2 User Manual P010067 01A Rev A e 5 CLI Client Command Descriptions 96 gt G EMULEX iSCSI Commands Parameters MAC Address MAC address of an iSCSI port Dest IP Address Destination IP address to delete from the route table
52. 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 directories e Linux usr sbin ocmanager e Solaris opt ELXocm There are two basic daemon processes included with OneCommand Manager CLI that are affected by these scripts They are e elxhbamgrd Remote management daemon which services requests from OneCommand Manager clients running on remote host machines e mili2d MILI daemon that routes major portions of the local OneCommand Manager client network adapter management requests The daemon processes start at system boot time OneCommand Manager Command Line Interface Version 10 2 User Manual P010067 01A Rev A ae 3 Updating to the OneCommand Manager Application Enterprise Kit 2 SE EMULEX Gas 3 Updating to the OneCommand Manager Application Enterprise Kit Note The full featured OneCommand Manager application enterprise kit is not supported on Citrix XenServer 5 6 SP2 Citrix XenServer 6 0 or VMware ESXi server This chapter details procedures for updating the OneCommand Manager CLI to the OneCommand Manager application enterprise kit in Linux Solaris and Windows operating systems An update can be performed only if the version of the OneCommand Manager application enterprise kit is the same or later than the OneCommand Manager CLI version Note
53. number of ports and function protocol assignments specified in this command depends upon the available ports storage mode mixed or concurrent and multichannel and NPar state To support up to sixteen functions on an adapter ARI must be available on the system with the following conditions the system hardware such as the motherboard and BIOS must support ARI ARI must be enabled in the system BIOS the operating system must support ARI such as the Windows Server 2012 and later and any management tools that you use must support ARI such as OneCommand Manager OneCommand Manager Command Line Interface Version 10 2 User Manual P010067 01A Rev A 5 CLI Client Command Descriptions SE EMULEX Profile Management Commands 139 10 2 and later If these conditions are not met although you may configure all sixteen functions only eight functions will be present and discovered by the OneCommand Manager application after a reboot Notes e RoCE is only available on Windows operating systems e SR IOV is not supported with RoCE configurations e SR IOV must be disabled on the adapter BIOS when NPar is used See the SRIOVEnable command for information on disabling SR IOV on the adapter BIOS e Fora Linux or VMware operating system SR IOV must be enabled on the system BIOS when NParEP is used See the documentation that accompanied your Dell server for more information e NParEP support is available only on Dell 13G or newer systems
54. of an iSCSI port iscsi target name Target s iSCSI name enclosed in quotes string length 11 255 ImmediateData 0 No 1 Yes default HeaderDigest 0 None default 1 CRC32C OneCommand Manager Command Line Interface Version 10 2 User Manual P010067 01A Rev A e 5 CLI Client Command Descriptions 106 gt G EMULEX iSCSI Commands DataDigest 0 None default 1 CRC32C Auth 0 None default 1 One Way CHAP 2 Mutual CHAP TIE CHAPNam Target CHAP name enclosed in quotes string length 1 256 TgtSecret Target Secret enclosed in quotes string length 12 16 Init CHAPName Initiator CHAP name enclosed in quotes string length 1 256 InitSecret Initiator Secret enclosed in quotes string length 12 16 SetTargetProperties This command sets the ETO value of a target Supported By Linux Solaris VMware ESXi and Windows Syntax SetTargetProperties lt MAC Address gt lt iscsi target name gt lt ETO gt Parameters MAC Address The MAC address of an iSCSI port iscsi target name Target s iSCSI name enclosed in quotes string length 11 255 ETO The extended timeout option for the target e For Windows valid values are 0 3600 e For Linux Solaris and VMware ESXi valid values are 0 30 SetT PLoginProperties This command sets a target porta s login properties This command reguires that you specify a valid IPv4 or IPv6 Target IP lt Target_IP gt and Port lt Port gt However if you specify no options other
55. s sa sa n ns n enge ueesk gea vr z NEEN rh k ta D n 133 GetAdapterPortConfig EEN 133 S cers vevevnctcvescextanivec coves cibetereiacinescaneasib guerre lanieendeiea eoredeawliace EN 136 SetAdapterPortConfig EE 137 Multichannel Configurations ccccccce ese eeee eee vvn ovo ina 143 Dell NPar Confiourations cece eee vvn rain 146 UMC COMIMAN S eebe db k KK ONO KK O A ZN O K k k 157 el o ce tected tone Ee EE EE 158 a OV 158 lune EE 160 UmcSetLPVID see sak a on ska dp ere Sree ttre er gerne err a 161 VPort E EN 162 RE OT 162 S eV GE 162 List r Ta r r 163 EE 163 HEEN ee Ee ee 164 EE o Ee U 164 WWN Management Commande zeuesasgegeeeessgr guer REN axka n k r EECH v kk ak rk ir d iii 165 OneCommand Manager Command Line Interface Version 10 2 User Manual P010067 01A Rev A DE EMULEX Table of Contents 9 Change WN siiscvctare tavebecivmartviasiheembivivbeaoi aah EEE EE E E 165 RCL WWINGA EE 166 Read VIN WE 166 RESLOCEW E 167 Appendix A OneCommand Manager Error MessagesS ttttnttnn nnnn nnnn mu 168 OneCommand Manager Command Line Interface Version 10 2 User Manual P010067 01A Rev A SE EMULEX List of Tables 10 List of Tables Table 1 1 Secure Management User Privileges nn nn nn 14 Table 1 2 Active Commands machines on same domaine 15 Table 1 3 Active Commands machines on different domain eee eee eae ees 15 Table 1 4 Passive Commands machines on any domaine 15 Table
56. sets the LPVID values for the UMC and SIMode NIC channels Use the CMGetParams command to determine the number of LPVIDs required See CMGetParams on page 60 for more information A reboot is not required for these changes take effect when UMC is enabled Note When the current multichannel mode is not UMC or SIMode the CMSetLPVID command fails Supported By Linux Solaris VMware ESXi and Windows Syntax CMSetLPVID lt WWPN MAC gt lt LPVIDO gt lt LPVID1 gt LPVIDn Parameters WWPN WWPN of an FCoE function on the physical adapter port MAC MAC address of any NIC or iSCSI function on the physical adapter port LPVIDO LPVID for channel 0 LPVID1 LPVID for channel 1 LPVIDn LPVID for channel n Considerations for Using CMSetLPVID e LPVID values are in the range of 2 4094 e Every NIC channel on a physical port must have a unique LPVID e For FCoE and iSCSI channels 0 must be entered because LPVIDs can only be specified for NIC channels e LPVIDs specified for channels with protocols set to None are ignored e This command is not supported on 1 Gb ports OneCommand Manager Command Line Interface Version 10 2 User Manual P010067 01A Rev A e 5 CLI Client Command Descriptions 66 gt G EMULEX DCB Commands e If channel management is disabled when this command is executed an error message is displayed Examples 4 NIC Channels gt gt hbacmd CMSetLPVID 00 00 c9 12 34 56 1001 1002 1003 1004 8 Chan
57. solaris lt kit version gt tar 3 Change to the newly created elxocmcore solaris lt kit version gt directory cd elxocmcore solaris lt kit version gt 4 Run the install script and follow the instructions install Note The install script can also be run in non interactive guiet mode Enter the following command to view the syntax install help OneCommand Manager Command Line Interface Version 10 2 User Manual P010067 01A Rev A 2 Installing and Uninstalling the CLI 23 gt G EMULEX VMware ESXi If any of the following are already present on the system the install script attempts to remove them first e HBAnyware utility e OneCommand Manager core kit e OneCommand Manager application enterprise kit e Solaris driver utilities 5 When prompted choose whether or not to enable Secure Management for OneCommand Do you want to enable Secure Management feature for OneCommand s u Enter s to select secure management LDAP NIS OCM group configuration required Enter u to run without secure management default Enter the letter s or u Uninstalling in Solaris To uninstall the OneCommand Manager CLI in Solaris 1 Log on as root 2 Do one of the following e Run opt ELXocm scripts uninstall e Run the uninstall script located in the installation tar file e Enter the command pkgrm ELXocmcore Note The uninstall script can also be run in non interactive quiet mode Enter t
58. 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 These properties are used when discovering the targets on the target portal The targets inherit the target portal s properties when they are discovered Targets already discovered do not inherit the updated properties only newly discovered targets inherit the properties When you set the authentication method lt Auth gt to a value other than 0 you must set additional parameters Each string should be enclosed in quotations to avoid mishandling by the Windows Linux Solaris or VMware shell s parser OneCommand Manager Command Line Interface Version 10 2 User Manual P010067 01A Rev A DE EMULEX 5 CLI Client Command Descriptions 107 iSCSI Commands e If you set the authentication method to One Way CHAP lt Auth gt 1 you must also specify the Target CHAP Name and Target Secret For example hbacmd SetTPLoginProperties 00 11 22 33 44 55 10 192 1 1 5050 Auth 1 TgtChapName TargetSecretl1 e If you set the authentication method to Mutual CHAP lt Auth gt 2 you must specify all four values For example hbacmd SetTPLoginProperties 00 11 22 33 44 55 10 192 1 1 5050 Auth 2 TgtChapName TargetSecret1 InitCHAPName InitialSecret1 Supported By Linux Solaris VMware ESXi and Windows Syntax SetTPLoginPropert
59. 0 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 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 OneCommand Manager Command Line Interface Version 10 2 User Manual P010067 01A Rev A 4 CLI Client Command Usage gt G EMULEX CIM Interface Mfg Emulex Corporation Serial No BG73539764 Port Number n a Mode Initiator Discovery cim C Program Files Emulex Util OCManager gt 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 0000 Port Type 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 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 Max Frame Size 2048 OS Device Name Num Discovered Ports 0 Fabric Name 00 00 00 00 00 00 00 00 For a list of HbaCmd commands supported through the CIM interface see CLI Client Commands Supported in CIM Interface on page 3
60. 1 and later versions operating systems use Linux driver version 8 3 5 Also the RHEL 6 Enterprise kit requires the installation of the libstdc 5 so library This library is available through the compat libstdc 33 3 2 3 68 lt arch gt rpm or later The PPC64 and x86_64 builds require the 64 bit version installed which is installed in usr lib64 The i386 build requires the 32 bit version installed which is installed in usr lib e On OneConnect NIC adapters including iSCSI NIC and FCoE NIC adapters use the NIC driver To install the OneCommand Manager CLI in Linux without an existing OneCommand CLI 1 Copy the applications kit tar file to a directory on the installation machine 2 Change to the directory where you copied the tar file 3 Untar the file tar zxvf elxocmcore lt supported os gt lt app ver gt lt rel gt tgz 4 Change to the core kit directory created in step 3 cd elxocmcore lt supported os gt lt app ver gt lt rel gt 5 Run the install sh script install sh Note install sh can also be run in non interactive quiet mode Enter the following command to view the syntax install sh help The core kit consists of three or four rpm files for each supported architecture and each supported version of Linux For example e elxocmlibhbaapi rpm on 64 bit platforms that support 32 bit applications there are two of these files e elxocmcore rpm e elxocmcorelibs rpm OneCommand Manager Command Lin
61. 6 OneCommand Manager Command Line Interface Version 10 2 User Manual P010067 01A Rev A 35 SE EMULEX 4 CLI Client Command Usage 36 Commands Supported in Target Mode Ports CLI Client Commands Supported in CIM Interface For a list of HbaCmd commands supported through the CIM interface see Table 5 1 CLI Client Command Reference on page 40 Commands Supported in Target Mode Ports The following HbaCmd commands are supported for managing target mode ports CreateVPort DeleteDumpFiles DeleteVPort Download DriverConfig ExportSanInfo GetDriverParams GetDriverParamsGlobal GetDumpDirectory GetDumpFile GetRetentionCount GetVPD GetXcvrData HbaAttributes ListHbas ListVPorts PortAttributes PortStatistics Reset SaveConfig ServerAttributes SetDriverParam SetDriverParamDefaults SetPortEnabled SetRetentionCount OneCommand Manager Command Line Interface Version 10 2 User Manual P010067 01A Rev A i 4 CLI Client Command Usage 37 gt G EMULEX Unsupported Commands per Operating System Unsupported Commands per Operating System For a list of all the supported commands see Table 5 1 CLI Client Command Reference on page 40 Linux RHEL SLES and Oracle RHEL SLES and Oracle do not support the following CLI commands e BindingCapabilities e BindingSupport e GetCimCred e GetLunUnMaskByHBA e GetLunUnMaskByTarget e ListVMs e PersistentBinding e RemoveAllPersistentBinding e RemovePersistentBinding e SetBindin
62. Active Configuration Profile ID 16 MC Type None Port Assignments Port 1 NIC Port 2 NIC Reboot Configuration Profile ID 16 MC Type Port Assignments Port 1 p0 NIC Port 2 p1 NIC None 4 4 4 Yes Yes Yes No 5 CLI Client Command Descriptions Profile Management Commands Note PN labels are the port parameter names to use in the SetAdapterPortConfig command NPar enabled 2 Ports NParEP Mode Enabled on Reboot gt hbacmd getadapterportconfig 00 00 c9 12 34 56 Number of Ports Maximum FCoE Functions Maximum iSCSI Functions Mixed Mode I O Allowed Concurrent Mode I O Allowed ROCE Functions Allowed RebootRequired Active Configuration Profile ID 37 MC Type NPAR 4 4 4 Yes Yes Yes Yes OneCommand Manager Command Line Interface Version 10 2 User Manual e g pO NIC FCoE pl NIC iSCSI P010067 01A Rev A 147 5 CLI Client Command Descriptions SE EMULEX Profile Management Commands 149 Port Assignments Port 1 NIC iSCSI FCoE NIC Port 2 NIC 1SCSI FCOE NIC Reboot Configuration Profile ID 37 MC Type NPAR NParEP Mode Enabled Port Assignments Port 1 po NIC i1SCSI NIC NIC NIC NIC NIC NIC Port 2 pl NIC iSCSI FCoE NIC NIC NONE NONE NONE Note PN labels are the port parameter names to use in the SetAdapterPortConfig command e g pO NIC FCoE p1 NIC iSCSI Showing NPar Configuration Using CMGetParams The CMGetParams command shows the current NPar conf
63. Address gt lt iscsi_target_name gt refreshtargets Note Only one command option can be specified with this command That is you can only specify either lt iscsi_target_name gt or lt refreshtargets gt Parameters MAC Address The MAC address of an iSCSI port iscsi target name The targe siSCSI name enclosed in quotes string length 11 255 refreshtargets Refresh all targets before displaying the information ShowTargetPortal This command shows the properties for a specified SendTarget Portal If the lt Target_IP gt and lt Port gt are not specified all SendTarget Portals and their associated properties return Supported By Linux Solaris and Windows Syntax ShowTargetPortal MAC Address gt lt Target_IP gt lt Port gt Parameters MAC Address The MAC address of an iSCSI port Target Ip IP address of the target portal You can specify an IPv4 or IPv6 Target IP address Port Port number of the target portal OneCommand Manager Command Line Interface Version 10 2 User Manual P010067 01A Rev A e 5 CLI Client Command Descriptions 110 SE EMULEX iSCSI Commands TargetLogin This command logs in to a target The iSCSI target name lt iscsi target name gt is the only mandatory option The lt target_portal gt and lt port gt 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 Wh
64. C or iSCSI port 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 FCoE Commands Note These commands are supported only on OneConnect and LPe16202 FCoE ports GetFCFinfo This command shows the FCF information of the adapter in FCoE mode Supported By Linux Solaris VMware ESXi and Windows Syntax Get FCFInfo lt WWPN gt Parameters WWPN The WWPN of an FCoE port Example hbacmd GetFCFInfo 10 00 00 00 c9 3c 7 88 GetFIPParams This command gets the FIP parameters of the adapter in FCoE mode Supported By Linux Solaris VMware ESXi and Windows Syntax GetFIPParams lt WWPN gt OneCommand Manager Command Line Interface Version 10 2 User Manual P010067 01A Rev A 5 CLI Client Command Descriptions gt lt EMULEX FCoE Commands 89 Parameters WWPN The WWPN of an FCoE port Example hbacmd GetFIPParams 10 00 00 00 c9 5b 3a 6d SetFIPParam This command sets the FIP parameters of the adapter in FCoE mode Supported By Linux Solaris VMware ESXi and Windows Syntax SetFIPParam lt WWPN gt lt Param gt lt Value gt Parameters WWPN The WWPN of an FCoE port Param The FIP parameter name e pfabric e pswitch e vlanid e fcmap e cinvlanid Value The value based on the FIP parameter name e pfabric 8 byte fabric name format XX XX XX XX XX XX XX XX e pswitch 8 byte switch name format XX XX XX XX XX
65. CoE is running on the port one of the PFC priorities must match the FCoE priority e If iSCSI is running on the port one of the PFC priorities must match the iSCSI priority The following rules are specific to NIC only adapters e Only one PFC priority can be assigned The following rules are specific to RoCE adapters e The RoCE priority should be assigned to the PFC priority and as the only priority to one of the following Priority Groups PGO PG7 or PG15 e All non RoCE priorities should be assigned together to only one priority group other than the RoCE priority group Supported By Linux Solaris VMware ESXi and Windows Note RoCE is only available on Windows operating systems Syntax SetDcbPriority lt WWPN MAC gt lt PFC gt lt PGO gt lt PG1 gt lt PG2 gt lt PG3 gt lt PG4 gt lt PG5 gt lt PG6 gt lt PG7 gt PG15 OneCommand Manager Command Line Interface Version 10 2 User Manual P010067 01A Rev A 5 CLI Client Command Descriptions SE EMULEX Diagnostic Commands g Parameters WWPN The WWPN of an FCoE function on a port MAC The MAC address of a function on a port PFC The PFC priority that is a comma separated list of up to eight values ranging from 0 7 PGO PG7 Priority group membership that is a comma separated list of priorities ranging from 0 7 Each set of priorities for a group must be separated by a space All priorities 0 7 must be assigned to some PGID PG15 PG15 group membership req
66. GetParams 00 00 c9 12 34 56 Active mode NPAR Configured mode NPAR Available modes NPAR Func Type MAC Address Min BW Max BW 0 NIC 00 00 c9 12 34 56 15 50 1 iSCSI 00 00 c9 12 34 57 30 100 2 FCoE 00 00 c9 12 34 58 40 100 3 NIC 00 00 c9 12 34 59 15 50 4 Partitions Port 3rd 4th Partition Protocol None gt hbacmd CMSetBW 00 00 c9 12 34 56 50 100 60 100 0 0 0 0 gt hbacmd CMGetParams 00 00 c9 12 34 56 Active mode NPAR Configured mode NPAR Available modes NPAR Func Type MAC Address Min BW Max BW 0 NIC 00 00 c9 12 34 56 40 100 1 iSCSI 00 00 c9 12 34 57 60 100 2 None 00 00 c9 12 34 58 0 0 3 None 00 00 c9 12 34 59 0 0 8 Partitions Port 2 Port Card NParEP Mode Enabled Last Channel MinBandwith 0 gt hbacmd cmsetbw 00 00 c9 12 34 56 10 100 30 100 10 100 10 100 10 100 10 100 10 100 10 100 gt hbacmd cmgetparams 00 00 c9 12 34 56 Active mode NPAR Configured mode NPAR Available modes NPAR Func Type MAC Address Min BW Max BW OneCommand Manager Command Line Interface Version 10 2 User Manual P010067 01A Rev A 5 CLI Client Command Descriptions SE EMULEX Profile Management Commands 155 0 NIC 00 00 c9 12 34 56 10 100 1 iSCSI 00 00 c9 12 34 57 40 100 2 NIC 00 00 c9 12 34 58 10 100 3 NIC 00 00 c9 12 34 59 10 100 4 NIC 00 00 c9 12 34 5a 10 100 5 NIC 00 00 c9 12 34 5b 10 100 6 NIC 00 00 c9 12 34 5c 10 100 7 NIC 00 00 c9 12 34 5d 0 100 Configuring Ports When Disabling NPar When NPar is being
67. IC iSCSI Port 1 p1 NIC iSCSI Port 2 p2 NIC FCOE Port 3 P3 NIC FCoE Note PN labels are the port parameter names to use in the SetAdapterPortConfig command e g pO NIC FCoE p1 NIC iSCSI Concurrent Mode 2 port adapter port number starting at 1 gt hbacmd getadapterportconfig 00 00 c9 12 34 56 Number of Ports s 2 Maximum FCoE Functions 4 Maximum iSCSI Functions 4 Mixed Mode I O Allowed Ves Concurrent Mode I O Allowed Yes ROCE Functions Allowed Yes RebootRequired Yes Active Configuration Profile ID 37 MCType None Port Assignments Port 1 NIC iSCSI FCoE Port 2 NIC iSCSI FCoE OneCommand Manager Command Line Interface Version 10 2 User Manual P010067 01A Rev A e 5 CLI Client Command Descriptions 135 5 EMULEX Profile Management Commands Reboot Configuration Profile ID 23 MCType None Port Assignments Port 1 p0 NIC FCoE None Port 2 pl NIC FCoE None Note pN labels are the port parameter names to use in the SetAdapterPortConfig command e g pO NIC FCoE pl NIC iSCS1I Concurrent Mode UMC gt hbacmd getadapterportconfig 00 00 c9 12 34 56 Number of Ports 4 Maximum FCoE Functions 4 Maximum iSCSI Functions 4 Mixed Mode I O Allowed Ves Concurrent Mode I O Allowed Yes ROCE Functions Allowed Yes RebootRequired No Active Configuration Profile ID 37 MC Type UMC Port Assignments Port 0 NIC iSCSI FCoE NIC Port 1 NIC iSCSI FCoE NIC Port 2 NIC FCoE
68. MAC The MAC address of a NIC or iSCSI port Param The parameter name See the following DCB Settings for lt Param gt and lt Value gt and LLDP Settings for lt Param gt and lt Value gt sections Value The parameter value See the following DCB Settings for lt Param gt and lt Value gt and LLDP Settings for lt Param gt and lt Value gt sections DCB Settings for lt Param gt and lt Value gt lt Param gt Description and lt Value gt DCBXState The DCBX protocol state 0 Disabled 1 Enabled PFCEnable Flow control in both directions transmit and receive 0 Disabled 1 Enabled FCoEPriority This parameter is applicable for ports running FCoE only A single priority must be specified The range of valid values is 0 7 Note Only one priority can be specified for each invocation of this command and must be for a protocol running on the port If more than one protocol priority can be set they should be unique values iscsIPriority This parameter is applicable for ports running iSCSI only A single priority must be specified The range of valid values is 0 7 Note Only one priority can be specified for each invocation of this command and must be for a protocol running on the port If more than one protocol priority can be set they should be unique values OneCommand Manager Command Line Interface Version 10 2 User Manual P010067 01A Rev A gt EMULEX RoCEPriority PFCPriority defaults
69. OCE only e Storage functions cannot be specified on adapters running NIC ROCE OneCommand Manager Command Line Interface Version 10 2 User Manual P010067 01A Rev A 5 CLI Client Command Descriptions SE EMULEX Profile Management Commands an e RoCE cannot be specified for any multichannel configurations e This command fails under the following conditions o Two storage protocols are specified for f1 and f2 and concurrent storage mode is not available o Three storage protocols are specified on a port o The f2 and f3 storage protocols are the same e For mixed mode f2 through fm must be NIC or None e For concurrent mode f3 must be NIC or None e The optional mctype parameter can specify the multichannel type or be set to None to disable multichannel If the mctype parameter is not specified the currently configured multichannel type is not changed Note You must reboot your system after executing this command to run the new protocols assigned to the channels Examples Mixed Mode UMC 4 Port 4 Channels Port gt hbacmd SetAdapterPortConfig 00 00 c9 12 34 56 pO snic iscsi nic nic pl nic fcoe nic nic p2 nic fcoe nic nic p3 nic iscsi nic nic mctype umc Successfully changed port configuration A reboot is required to complete changes gt hbacmd GetAdapterPortConfig 00 00 c9 12 34 56 Number of Ports 4 Maximum FCoE Functions 4 Maximum iSCSI Functions 4 Mixed Mode I O Allowed Ves
70. ULEX 5 CLI Client Command Descriptions 117 Miscellaneous Commands Parameters host address The IP address using the IPv4 or IPv6 format or the host name IP Address The IP address of the host CnaClearEventLog Note Supported for OneConnect and LPe16202 adapters only This command clears the event log specified by the WWPN or MAC address Supported By Linux VMware ESXi and Windows Syntax CnaClearEventLog lt WWPN MAC gt Parameters WWPN The WWPN of an FCoE port MAC The MAC address of a NIC or iSCSI port CnaGetEventLog Note Supported for OneConnect adapters only This command shows the adapter event log specified by the WWPN or MAC address Supported By Linux VMware ESXi and Windows Syntax CnaGetEventLog lt WWPN MAC gt Parameters WWPN The WWPN of an FCoE port MAC The MAC address of a NIC or iSCSI port OneCommand Manager Command Line Interface Version 10 2 User Manual P010067 01A Rev A 5 CLI Client Command Descriptions gt lt EMULEX Miscellaneous Commands 118 Download Loads the firmware image to the port specified by the WWPN or MAC address Notes e For 16 Gb HBA firmware downloads the OneCommand Manager application only accepts grp files e For OneConnect and 16 Gb HBAs 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 OneConn
71. Windows Syntax GetDumpDirectory lt WWPN MAC gt Parameters WWPN The WWPN of an FC or FCoE port MAC The MAC address of the NIC or iSCSI port GetDumpFile 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 the local client s dump directory The dump directory local and remote is named Dump The dump files are copied from the Dump directory of the remote host to the Dump directory of the local host Therefore 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 lt 2 gt Not Supported Dump directory e For Windows C Program Files Emulex Util Dump e For Linux var opt emulex ocmanager Dump e For Solaris opt ELXocm Dump e For VMware ESXi The dump directory set using the SetDumpDirectory command Supported By Linux Solaris VMware ESXi and Windows Syntax GetDumpFile lt WWPN MAC gt lt filename gt OneCommand Manager Command Line Interface Version 10 2 User Manual P010067 01A Rev A 5 CLI Client Command Descriptions SE EMULEX Dump Commands ER Parameters WWPN The WWPN of an FC or FCoE port MAC The MAC address of a NIC oriSCSI port filename The name of the dump file to be copied from the remote host Exam
72. XX XX XX e vlanid 2 byte VLAN ID 0 4095 or any for any VLANID e fcmap 3 byte FC map 0xOEFCxx e cinvlanid 2 byte VLAN ID 0 4095 Example hbacmd SetFIPParam 10 00 00 00 c9 5b 3a 6d fcmap Ox0efc99 OneCommand Manager Command Line Interface Version 10 2 User Manual P010067 01A Rev A e 5 CLI Client Command Descriptions QQ gt G EMULEX iSCSI Commands iSCSI Commands The commands in this section support the iSCSI interface in the OCM CLI Note iSCSI commands are supported only on OneConnect iSCSI ports Note Only OCe14000 series adapters support IPv6 addresses The MAC address lt MAC_Address gt of the iSCSI 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 Type the full option name or the abbreviated option name shown in Table 5 2 Option Names and enter the value The abbreviations are not case sensitive Table 5 2 Option Names Option Name Abbreviation Example Auth au au 1 DataDigest dd dd 1 DHCP dh dh 1 HeaderDigest hd hd 1 ImmediateData id id 1 Initiator Alias ia ia initiator alias Initiator Name in in initiator name Priority pr pr 1 VLAN ENABLED ve ve 1 VLAN_ID vi vi 1 AddARPTableEntry This command adds an ARP table entry Supported By Linux Solaris VMware ESXi and Windows Syntax AddARPTableEntry lt MAC_Address gt lt Dest MAC Address gt lt Des
73. a 65 DCB CommandgS ss41ia113n005i ansasa d sa n s ia o d on s i ona nii k ia obi si s iii ia ia 66 n He EE 66 MEE MIM EE 67 Set REI E EE 67 SELLIE BPAPAN EE 68 Sel OC EPG balenia do te sas boso ston tbt EE EE 70 Dradnostie COMMANA S sssiens rne s ra ht n nen in zi hvinn t i ia ni b ii Ni ik ik nn 71 DPOMET OSE wis 630 lak r nn a r ra 71 Ge HE EE 74 EE eege r 74 GELACVI Re ET 75 ECLISSE uzasna si te bi ss b lo z br E 75 LoopBack EE 76 LOO ME EE T1 Ga E 77 o gt Te 78 Set BEACON e ke a O r EE 78 SetCableNVP EE 79 WRU CSE EE 79 VE zaznamu 80 OneCommand Manager Command Line Interface Version 10 2 User Manual P010067 01A Rev A DE EMULEX Table of Contents 6 Driver Parameter Commande ssssssssrssssnnnssnnnnsnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnnn 80 lege e 81 EE lee Ee 81 GetDriverParamsGlobal sseslost gt ko oiaoni u voorbo brian Paaaestia ro Bod nr k dn 81 AVS CONG ateren Aaa rh nr r en on 82 EES eege EE EES AR eege ER Sel DriverParamDer adults tege ed Eeer SES ER Dump Be un TE 83 Delete DUMP gege ege KEE KE de EE EE EE zrod ni 84 Ir UO 84 GeLDUIMD DIN CCEON DEE a bi fl ia 85 Cie IE e 85 GetDumpFileNaMeS eg eege i oni i k r EE REENEN E RE EE ESA Age 86 teta ICE EE 86 SetDumpDirectory EE 87 KRUTEN 87 FCoE CommandgS ss1110s1110sa3n t ian a ava r di ran dn s sd io n i t sa n k sn ba ki in ia EERSTEN 88 Cer ae ts e EE Ee 88 GetFIPParamS c
74. ace Version 10 2 User Manual P010067 01A Rev A 1 Introduction 14 SE EMULEX OneCommand Manager Secure Management OneCommand Manager Secure Management Overview OneCommand Manager Secure Management gives system administrators the ability to further enhance the active management security of their networks Using Secure Management administrators can define each user s privileges for managing both local and remote adapters When running in Secure Management mode users must log in with their user name and password to run the OneCommand Manager application When users are authenticated they can only perform the functions allowed by the OneCommand Manager user group to which they belong If your systems are running in an LDAP or Active Directory domain the OneCommand Manager application will authenticate the user with those defined in that domain For Linux and Solaris systems this is done using PAM Note OneCommand Manager Secure Management is supported on Linux Solaris and Windows but is not supported on VMware hosts Administrators set up user accounts such that a user belongs to one of the OneCommand Manager application user groups The user groups define the management capabilities for the user The following table defines the OneCommand Manager application user groups and each group s management capabilities Table 1 1 Secure Management User Privileges Group Name OneCommand Manager Capability ocmadmin Allows ful
75. active booted multichannel state the configured state the configured channel management mode N A if configured state is disabled and the available channel management modes This is followed by a table showing the specified port s channel properties The Type column shows the protocol that is running on the channel The output is different depending upon the multichannel type Supported By Linux Solaris VMware and Windows Syntax hbacmd CMGetParams lt MAC WWPN gt OneCommand Manager Command Line Interface Version 10 2 User Manual P010067 01A Rev A DE EMULEX 5 CLI Client Command Descriptions 61 Channel Management Commands Parameters MAC MAC address of any NIC or iSCSI function on an adapter port WWPN WWPN of an FCoE function on an adapter port Example Multichannel Disabled gt hbacmd CMGetParams 00 00 c9 12 34 56 Active Mode None Configured mode None Available modes UMC Multichannel Enabled UMC NIC Only gt hbacmd CMGetParams 00 00 c9 12 34 56 Active Mode UMC Configured mode UMC Available modes UMC Func Type MAC Address LPVID Min BW Max BW 0 NIC 00 00 c9 12 34 56 2 25 50 1 NIC 00 00 c9 12 34 57 3 25 50 2 NIC 00 00 c9 12 34 58 4 25 50 3 NIC 00 00 c9 12 34 59 5 50 75 Multichannel Enabled UMC with Storage gt hbacmd CMGetParams 00 00 c9 12 34 56 Active Mode UMC Configured mode UMC Available modes UMC Func Type MAC Address LPVID Min BW Max BW 0 NIC 00 00 c9 12 34 56 2 25 50 1
76. and shows the firmware s wakeup parameters for the adapter Supported By Linux Solaris VMware ESXi and Windows Syntax Wakeup lt WWPN gt Parameters WWPN The WWPN of an FC port Driver Parameter Commands Notes e Supported for FC and FCoE ports only e Driver parameters that are set to temporary or global values using the T and G flags respectively must be read using the GetDriverParams command to view the current value of the parameter The GetDriverParamsGlobal command returns only permanently set driver parameter values Additionally if temporary and global values have been set for one or more driver parameters the SaveConfig command must be run with the N flag using the N flag is analogous to the GetDriverParams command 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 e The DriverConfig and SetDriverParamDefaults commands are not supported for Solaris e The list of available driver parameters that can be configured are different depending upon the operating system and protocol FC or FCoE OneCommand Manager Command Line Interface Version 10 2 User Manual P010067 01A Rev A DE EMULEX 5 CLI Client Command Descriptions 81 Driver Parameter Commands DriverConfig This command sets all driver parameters to the values in the dpv file type The dpv fil s driver type must ma
77. 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 website www opensolaris org or by contacting online support from the website 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 Note References to OCe11100 series products also apply to OCe11100R series products OneCommand Manager Command Line Interface Version 10 2 User Manual P010067 01A Rev A Table of Contents SE EMULEX Table of Contents List OF Tables i i LO 1 Introduction ss iso kia na LL DINEEWIENE zeguer VE aE seg a REENERT da ENER EE ca n v di io dna di ri n 11 COMPACIOINILY E 11 Ab br viati ns ee EEN 11 OneCommand Manager Secure Management tttstannntnnnnnnnn nnnn n E NEN 14 VEL WOW zo K NR o 14 OneCommand Manager Secure Management Configuration Requirements
78. cc cece cece cece e ee eee eee ee eee rt rrr rrt rrtt rrr rr SEES ES eee ded SEES SEES EEE ES 88 S tFI PPA AM r aha oh aw beets ala a 89 Le Re tU FE 90 E EE e EE 90 AOGTSNSSCIVEl Eege o rov hl v r ni o o r ns Pa ini 91 AddRouteTableEntry ee 91 o o An EE 92 e EE H EE 93 EA SOS S eege 94 EE dE 95 Belet6 5NSSOTVO zad d zvonka eN ro aka r aes 95 DelRouteTableEntry EE 95 DiSCOVAJI SNSSE TEE 96 EXPOP SUS zis li o o r bo le aro 96 CNC SE Ore PO el EE 96 BO Se JE ih onacsepautenatvercitancaiaeaiienscvyanistnaieendseacarspatsegatsesndsonansaateannte 97 GetiSCSIPOrt EA Reg r i EE r no 97 GetNetworkConfiguration zool lano iol pon ik i don slab n 98 et EE 98 IMPOR SCSI kerrie eavibias aa i bers on rn 99 Be MO BEE 100 OneCommand Manager Command Line Interface Version 10 2 User Manual P010067 01A Rev A DE EMULEX Table of Contents 7 LiSt SESSIONS ia tanie ovi eiaa DE pako a oo e 100 KEMOVETA EE 100 pis N Tale ee ttrt rrr r rnnt rtt trr n EEEE A stasis 101 Kal Ee Le e 101 SetlInitiatorPropertieS xs cre V i eg 102 KK EE 103 SetNetworkConfiguration zoruvbskiznsotoon kivi bebo ivol RER EE SE ges 103 Ser ar get leet Properties aves sons r k 105 es s Es gel a ge Eege EE REES E 106 Klee al e TEE 106 Selice EE 107 Show SN EE 108 ee ET 108 SHOW Wal Gel zoro ee DEE EE 109 ShowT argetPortal sihcsccacepsdecess ceiotsstesetnesetnashegolaeaceaacscveestascliareseiaciiaies 109 Es ee TEE 110 Els ge Lee ULT 111 le Ee e KEE 112 LUN Masking
79. cifying an optional IP address or host name after hbacmd is not available for the Version command For VMware ESXi using the CIM interface hbacmd h lt IP address gt m cim Version Parameters None Persistent Binding Commands Notes e These commands are supported for FC FCoE ports only e The following persistent binding commands are not supported on Linux or VMware ESXi o BindingCapabilities o BindingSupport o PersistentBinding o RemoveAllPersistentBinding o RemovePersistentBinding o SetPersistentBinding o SetBindingSupport OneCommand Manager Command Line Interface Version 10 2 User Manual P010067 01A Rev A e 5 CLI Client Command Descriptions 126 gt G EMULEX Persistent Binding Commands In a remote environment you can perform persistent bindings operations from a host running any operating system including Linux or VMware ESXi but only to a remote host that is running Windows or Solaris For a binding to take effect immediately that is SetPersistentBinding parameter Scope I or B the lt SCSIBus gt and lt SCSITarget gt parameters 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 lt SCSIBus gt and lt SCSITarget gt parameters are available to be persistently bound Also the lt BindType gt parameter must match the current
80. cmd UmcGetParams 00 00 c9 bb cc aa Active UMC State Enabled Configured UMC State Enabled Func Type MAC Address LPVID Min BW Max BW 0 NIC 00 00 c9 bb cc aa 1001 20 50 1 FCOE 00 00 c9 bb cc ab n a 50 100 2 NIC 00 00 c9 bb cc ac 1002 20 50 3 NIC 00 00 c9 bb cc ad 1003 10 5 OneCommand Manager Command Line Interface Version 10 2 User Manual P010067 01A Rev A e 5 CLI Client Command Descriptions 160 gt G EMULEX UMC Commands UmcSetBW Note This command has been replaced by the CMSetBW command and is provided for backward compatibility for OCe11100 series adapters only This command sets the minimum and maximum bandwidths for each channel up to four on the physical port This command can also be used to disable the link on a channel by setting the minimum and maximum bandwidths of that channel to 0 The total of the minimum bandwidths must add up to 100 An exception to this rule is for UMC SIMODE configurations when both the minimum and maximum bandwidth for all channels are 0 effectively bringing the logical link down on all channels The maximum bandwidth must have a value greater than or equal to the minimum bandwidth and have a maximum value of 100 Supported By Linux Solaris VMware ESXi and Windows Syntax UmcSetBW lt WWPN MAC Address gt lt MinO Max0 gt lt Minl Maxl gt lt Min2 Max2 gt Min3 Max3 Parameters MAC Address MAC address of any NIC function on the adapter port WWPN WWPN of the FCoE function
81. commands e Solaris and VMware ESXi do not support the GetLunUnMaskbyHBA GetLunUnMaskbyTarget RescanLuns and SetLunMask commands GetLunList This command queries for the presence of any masked LUNs Supported By Linux Solaris VMware ESXi and Windows Syntax GetLunList lt HBA WWPN gt lt Target WWPN gt lt Option gt OneCommand Manager Command Line Interface Version 10 2 User Manual P010067 01A Rev A e 5 CLI Client Command Descriptions 113 gt G EMULEX LUN Masking Commands Parameters HBA WWPN The WWPN of an FC or FCoE port on the adapter Target WWPN The WWPN of the target Option 0 Get information from the driver 1 Get information from the configuration GetLunUnMaskByHBA This command queries for the presence of any unmasked LUNs by adapter Supported By Solaris and Windows Syntax GetLunUnMaskByHBA lt HBA WWPN gt lt Option gt Parameters HBA WWPN The WWPN of an FC or FCoE port Option 0 Get information from the driver 1 Get information from the configuration GetLunUnMaskByTarget This command queries for any unmasked LUNs by target Supported By Solaris and Windows Syntax GetLunUnMaskByTarget lt HBA WWPN gt lt Target WWPN gt lt Option gt Parameters HBA WWPN The WWPN of an FC or FCoE port on the adapter Target WWPN The WWPN of the target Option 0 Get information from the driver 1 Get information from the configuration RescanLuns This command rescans LUNs to fi
82. ctions Linux OneCommand Manager Requirements For new systems install the specific Linux driver rpm files before installing the OneCommand Manager CLI Libni Library On RHEL 5 5 and later and RHEL 6 and later the OneCommand Core rpm file reguires the Libnl library This library is not installed by default but can be obtained from the operating system distribution media e For i386 RHEL 5 5 RHEL 5 6 and RHEL 6 use the 32bit libnl library e For x86_64 RHEL 5 5 RHEL 5 6 and RHEL 6 use the 64bit libnl library e For PPC RHEL 5 5 RHEL 5 6 and RHEL 6 use the 64bit libnl library OneCommand Manager Command Line Interface Version 10 2 User Manual P010067 01A Rev A DE EMULEX 2 Installing and Uninstalling the CLI 19 Linux libhbaapi Library The inbox libhbaapi library is reguired on RHEL 5 RHEL 6 and SLES 11 e For i386 RHEL 5 and RHEL 6 use the 32bit libhbaapi RPM e For x86_64 RHEL 5 and RHEL 6 use the 64bit libhbaapi RPM e For PPC RHEL 5 use the 32bit libhbaapi RPM e For PPC RHEL 6 use the 64bit libhbaapi RPM For existing systems before installing the OneCommand Manager CLI download the appropriate Linux driver from the Emulex website and install it If specified also download and install the appropriate library file For example e On OneConnect FCoE adapters o For RHEL 5 and SLES 10 operating systems use Linux driver version 8 2 0 33 3p or later o For RHEL 6 and later versions and SLES 11 SP
83. dapterPortConfig command to change the port s protocol assignments This is helpful when the physical port numbering on the adapter does not start at 0 e Depending upon the presence of ARI on a host this command may show more partitions per port than are actually running on the host e For multichannel and Dell NPar configurations this command only displays the port protocol assignments For the entire multichannel configuration use the CMGetParams command on page 60 e RoCE is only available on Windows operating systems Supported By Linux Solaris VMware ESXi and Windows Syntax GetAdapterPortConfig lt MAC WWPN gt Parameters MAC MAC address of any iSCSI or NIC NIC RoCE function on the adapter WWPN WWPN of any FCoE function on the adapter Examples Mixed Mode 4PortAdapter gt hbacmd getadapterportconfig 00 00 c9 12 34 56 Number of Ports s A Maximum FCoE Functions 4 Maximum iSCSI Functions 4 Mixed Mode I O Allowed Yes OneCommand Manager Command Line Interface Version 10 2 User Manual P010067 01A Rev A e 5 CLI Client Command Descriptions 134 SG EMULEX Profile Management Commands Concurrent Mode I O Allowed No ROCE Functions Allowed Yes RebootRequired No Active Configuration Profile ID 37 MCType None Port Assignments Port 0 NIC i1SCSI Port 1 NIC iSCSI Port 2 NIC FCoH Port 3 NIC FCOE Reboot Configuration Profile ID 37 MCType None Port Assignments Port 0 p0 N
84. dd to the route table OneCommand Manager Command Line Interface Version 10 2 User Manual P010067 01A Rev A e 5 CLI Client Command Descriptions 92 gt G EMULEX iSCSI Commands AddTarget 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 IPv4 or IPv6 target IP lt Target_IP gt port number lt Port gt and iSCSI name lt iscsi_target_name gt If you do not specify the remaining options these options are set to their default values When you set the authentication method lt Auth gt to a value other than 0 you must set additional parameters Each string should be enclosed in quotations to avoid mishandling by the Windows Linux Solaris or VMware shell s parser e If you set the authentication method to One Way CHAP lt Auth gt 1 you must also specify the Target CHAP Name and Target Secret For example hbacmd AddTarget 00 11 22 33 44 55 192 168 1 1 8000 iscsitarget Auth 1 TgtCHAPName TargetSecret1 e If you set the authentication method to Mutual CHAP lt Auth gt 2 you must specify all four values For example hbacmd AddTarget 00 11 22 33 44 55 192 168 1 1 8000 iscsitarget Auth 1 TgtCHAPName TargtSecret1 InitCHAPName InitialSecret1 Supported By Linux Solaris VMware ESXi and Windows Syntax AddTarget MAC Address gt lt Target_IP gt lt Port gt
85. de questions will be skipped If the answer is no to the OneCommand Manager Secure Management mode question then the management mode installation questions will follow Unattended Installation with Install Script Switch Option Support Enterprise OneCommand Manager installations performed in unattended mode provide a switch option to enable OneCommand Manager Secure Management If the OneCommand Manager Secure Management switch is not used with the installation Secure Management will be disabled Windows During OneCommand Manager installations performed in interactive mode you will be presented with a management mode window where you can select Secure Management as the management mode OneCommand Manager Command Line Interface Version 10 2 User Manual P010067 01A Rev A 1 Introduction 17 gt EMULEX OneCommand Manager Secure Management Using OneCommand Manager with Secure Management Enabled To run the OneCommand Manager CLI application when Secure Management is enabled you must include your user name and password each time you type a command For example Secure Management disabled hbacmd lt command gt Secure Management enabled hbacmd lt m sec gt lt userid gt lt password gt lt command gt User names and passwords are used to authenticate the commands Once the credentials are authenticated the OneCommand Manager will determine which one of the four user groups you belong to and will allow command usage as appropr
86. dress Parameters MAC Address The MAC address of an iSCSI port GetiSCSiLuns This command shows all the LUNs and their information for a specified target The command gathers the information from the iSCSI target indicated by the lt iscsi_target_name gt parameter Supported By Linux Solaris VMware ESXi and Windows Syntax GetiSCSILuns lt MAC Address gt lt iscsi target name gt Parameters MAC Address The MAC address of an iSCSI port iscsi target name Target s iSCSI name enclosed in quotes string length 11 255 GetiSCSIPortStats This command shows all the port statistics for a specified port Supported By Linux Solaris VMware ESXi and Windows Syntax GetiSCSIPortStats MAC Address gt Parameters MAC Address The MAC address of an iSCSI port OneCommand Manager Command Line Interface Version 10 2 User Manual P010067 01A Rev A e 5 CLI Client Command Descriptions 98 gt G EMULEX iSCSI Commands GetNetworkConfiguration This command lists a por s TCP IP information for IPv4 and IPv6 protocols Supported By Linux Solaris VMware ESXi and Windows Syntax GetNetworkConfiguration lt MAC Address gt Parameters MAC Address The MAC address of an iSCSI port Example TCP IP Configuration for 00 00 c9 ad ad b1 VLAN Enabled No VLAN ID 0 Priority 0 IPv4 Configuration DHCP Enabled Yes IP Address 10 192 81 204 Subnet Mask 255 255 248 0 Gateway 10 192 87 254 IPv Configuration
87. dress of the host to remove Reset This command resets the adapter An adapter reset can reguire several seconds to complete especially for remote devices When the reset is completed the system command prompt is displayed Notes e Supported for FC and FCoE ports only e For OneConnect and LPe16202 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 Linux Solaris VMware ESXi and Windows Syntax Reset lt WWPN gt Parameters WWPN The WWPN of an FC or FCoE port SetCimCred This command sets the default CIM credentials You must specify all four credentials username password namespace and port number 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 Supported By Windows Syntax SetCimCred lt username gt lt password gt lt namespace gt lt portnum gt 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 Version 10 2 User Manual P010067 01A Rev A DE EMULEX 5 CLI Client Command Descriptions 123 Miscellaneous Commands Parameters username Login User ID of the VMware ESXi
88. dump files in that location Notes e The dump directory applies to all adapters in the server There is no separate dump directory for each adapter e Ina remote environment you can use the SetDumpDirectory command from a host running any operating system including Linux Solaris and Windows but only to a remote host that is running VMware ESXi Syntax hbacmd h lt IP Address gt m cim u lt username gt p lt password gt n lt namespace gt SetDumpDirectory lt DumpDirectoryName gt Parameters DumpDirectoryName The directory under vmfs volumes that you created to store the dump files h The IP address of the host Example This example shows the dump directory set to vmfs volumes ocm datastore hbacmd h 10 192 203 173 m cim u root p Swamiji001 n root emulex SetDumpDirectory 10 00 00 00 c9 61 2 64 ocm datastore SetRetentionCount 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 Supported By Linux Solaris VMware ESXi and Windows OneCommand Manager Command Line Interface Version 10 2 User Manual P010067 01A Rev A 5 CLI Client Command Descriptions gt lt EMULEX FCoE Commands 88 Syntax SetRetentionCount lt WWPN MAC gt lt Value gt Parameters WWPN The WWPN of an FC or FCoE port MAC The MAC address of a NI
89. e UMC Port Assignments Port 0 p0 NIC iSCSI FCoE NIC NIC NIC NIC NIC Port 1 pl NIC FCoE iSCSI NIC NIC NIC NIC NIC OneCommand Manager Command Line Interface Version 10 2 User Manual P010067 01A Rev A e 5 CLI Client Command Descriptions 146 gt G EMULEX Profile Management Commands Note pN labels are the port parameter names to use in the SetAdapterPortConfig command e g pO NIC FCoE p1 NIC iSCSI Setting Multichannel Bandwidths See CMSetBW on page 63 for more information Dell NPar Configurations Note ARI must be available to support sixteen functions on an adapter OCe14000 series adapters automatically support ARI However the system s motherboard must support ARI it must be enabled in the system BIOS and the operating system must support ARI If these conditions are not met although you will be required to configure all sixteen functions only eight functions will be present and discovered by the OneCommand Manager application after a reboot Enabling and Disabling NPar To enable NPar set the mctype parameter in the SetAdapterPortConfig command to NPar When enabling NPar the additional function protocols must be specified for the extra channels or they will be set to None meaning that there is no protocol running on the function Disable NPar by setting mctype to None Notes e The existing CMMode command used to enable or disable multichannel for OCe11100 series adapt
90. e Emulex website e These commands are not available on LPe16202 adapters ChangePersonality This command changes the personality on the adapter It is the only way to change the personality of an OCe10000 series and an OCe11000 series adapter For an OCe14000 series adapter ChangePersonality is an efficient way to set all ports on the adapter to run the same protocols However the OCe14000 series adapter is capable of running different protocols on different ports If you wish to set different protocols on different ports use the SetAdapterPortConfig command See SetAdapterPortConfig on page 137 for more information After a successful personality change a reboot is required Note RoCE is only available on OCe14000 series adapters running on a Windows operating system OneCommand Manager Command Line Interface Version 10 2 User Manual P010067 01A Rev A Personality Change Commands DE EMULEX 5 CLI Client Command Descriptions 131 Supported By Linux Solaris VMware ESXi and Windows Syntax ChangePersonality lt WWPN MAC gt lt type gt Profile ID Parameters WWPN The WWPN of an FCoE port MAC The MAC address of a NIC NIC RoCE or iSCSI port type The personality type to which the adapter is being changed The available values are shown when using the ShowPersonalities command See ShowPersonalities on page 132 Profile ID Optionally specifies the profile ID number to used to identify the personality
91. e ESXi and Windows Syntax ServerAttributes lt WWPN MAC gt Parameters WWPN The WWPN of an FC or FCoE port MAC The MAC address of a NIC or iSCSI port SetPhyPortSpeed This command sets the port speed on OneConnect OCe11100 series OCe14000 series and LPe16202 adapters only OneConnect 0Ce11100 Series and OCe14000 Series Adapters OneConnect OCe11100 series OCe14000 series have the capability to configure their physical port speeds Depending on the port module or transceiver installed in the physical port the speed settings can be forced to a specific value for instance 1 Gb or OneCommand Manager Command Line Interface Version 10 2 User Manual P010067 01A Rev A DE EMULEX 5 CLI Client Command Descriptions 52 Attributes Commands to a range of values for auto negotiation with the switch for example 10Gb 1Gb 100Mb There are three values that can be configured port speed mode speed value s and the DAC cable length The configurable port speeds are based upon the port module type and the mode defined by port speed Mode parameter For the Default port speed Mode the speed setting is not reguired Note 10GB CX4 10GB XFP and SGMII port module types do not support port speed settings Supported By Linux Solaris VMware ESXi and Windows Syntax SetPhyPortSpeed lt WWPN MAC gt lt Mode gt Speed Length Parameters WWPN The WWPN of an FCoE port MAC The MAC address of a NIC or iSCSI port Mode
92. e ESXi hosts you can manage adapters using the OneCommand Manager application on Windows but you must install and use the appropriate Emulex CIM Provider For installation see Installing the CIM Provider for VMware ESXi Hosts on page 23 Note For VMware ESXi hosts when advanced adapter management capabilities are required such as iSCSI management use the OneCommand Manager for VMware vCenter software plug in For more details see the OneCommand Manager for VMware vCenter User Manual Syntax Rules for the CIM Interface For the CIM interface all the syntax rules in section HbaCmd Syntax Usage on page 31 apply except that the h option is required Additionally the m cim parameter is required in the command line for getting the data from the ESXi host For example hbacmd 192 168 1 110 m cim u root p password n root emulex listhbas Syntax Options and Setting CIM Credentials For issuing CIM based commands two main syntax options are available Option A hbacmd lt h IP Address port gt m cim u userid p password n root emulex lt command gt lt WWPN gt Option B hbacmd lt h IP Address port gt lt m cim gt lt command gt Before using the option B syntax you must set the CIM credentials by doing one of the following e Set the default CIM credentials using the SetCimCred command see page 122 This command sets only the CIM credentials Once you have set them subsequent HbaCmd commands do n
93. e Interface Version 10 2 User Manual P010067 01A Rev A 2 Installing and Uninstalling the CLI 20 DE EMULEX Se 6 When prompted choose whether or not to enable Secure Management for OneCommand Do you want to enable Secure Management feature for OneCommand s u Enter s to select secure management LDAP NIS OCM group configuration required Enter u to run without secure management default Enter the letter s or u Installing in Linux With an Existing OneCommand CLI Kit Before installing the OneCommand Manager CLI download the appropriate driver from the Emulex website and install the driver For example e OnOneConnect FCoE adapters o For RHEL 5 5and later and SLES10 SP3 and later operating systems use Linux driver version 8 2 0 x o For RHEL6 and later and SL11 SP1 and later operating systems use Linux driver version 8 3 5 x e On OneConnect iSCSI adapters use the iSCSI driver e On OneConnect NIC adapters including iSCSI NIC and FCoE NIC adapters use the Ethernet driver Note The OneCommand Manager core kit cannot be installed if a previous version of the HBAnyware utility is installed You have two options when installing the OneCommand Manager CLI on a Linux system with an existing OneCommand CLI kit e Updating an existing installation preserve existing settings e Performing a clean install overwrite existing settings Updating Preserving Existing Settings To update the OneCommand Mana
94. e achange values 0 Do not allow Management Mode to change 1 Allow Management Mode to change You can also set the following optional parameters e MHost This optional switch allows a non management host user to select a Management Host with which to register If this switch is not specified the default value of 0 will be used and the capability will be disabled If the switch is specified the value can be a host name or an IP address which will be validated by the installer An error message appears if mmode is set as Local Only or Management Host OneCommand Manager Command Line Interface Version 10 2 User Manual P010067 01A Rev A 2 Installing and Uninstalling the CLI 26 gt G EMULEX Windows e excl This optional switch allows the non management host user to select whether the OneCommand Manager application will process requests exclusively from the Management Host specified by the MHost switch This option is only accepted if accompanied by a valid MHost value otherwise an error message appears If this switch is not specified the default value of 0 will be used If the switch is specified the valid values are 0 Remotely managed by other hosts 1 Remotely managed by Management Host ONLY e Mtcp This optional switch allows you to enable or disable remote management and to specify the TCP IP port number over which management will occur If this switch is not specified the default TCP IP port number 23333 will be used
95. e following command all on one line esxcli software vib install d vmware esx provider emulex cim provider 50 3 6 11 1 01 zip maintenance mode 3 Reboot the system Windows Installing in Windows There are two ways to install the OneCommand Manager CLI in Windows e Attended installation you are present during the installation You will be prompted for more information for the installation to continue e Unattended installation you do not need to be present during the installation Installation will complete on its own Installation progress may be displayed as an option Attended Installation 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 and follow the installer directions Use the following syntax for the installation executable file elxocmcore windows lt arch gt lt kit version gt exe e lt arch gt is either x64 or x86 e lt kit version gt represents the complete kit version For example at the command prompt type elxocmcore windows x64 5 0 2 14 1 exe Unattended Installation To install the OneCommand Manager CLI in Windows unattended use the following procedure 1 From the Emulex website download the x64 or x86 OneCommand Manager Core Kit installation file to your system OneCommand Manager Command Line Interface Version 10 2 User Manual P010067 01A Rev A DE EMULEX 2 Installing a
96. ec MAC Address 00 00 c9 12 34 cd VLADID s 10 Transmit Rate 100 Mbit sec MAC Address 00 00 c9 12 34 ef VLADID 10 Transmit Rate 1 bbit sec MAC Address 00 00 c9 13 34 01 VLADID 20 Transmit Rate 1 Gbit sec ListVMs This command lists all virtual machines and their information for all manageable ports If you specify the host with the h lt host gt option or provide the physical WWPN only the virtual machines for that host are returned If you specify the physical port and the virtual port only the virtual machine for the specified virtual port are returned Note If you are running this command on any server that has virtual ports you will not see the virtual machine name OneCommand Manager Command Line Interface Version 10 2 User Manual P010067 01A Rev A 5 CLI Client Command Descriptions Se EMULEX VPort Commands EE Supported By Linux Syntax ListVMs lt physical WWPN gt lt virtual WWPN gt Parameters physical WWPN The WWPN of an FC or FCoE port virtual WWPN The WWPN of the virtual port ListVPorts This command lists virtual ports on the specified physical port Leaving the physical WWPN parameter blank lists all virtual ports on all manageable hosts that support virtual ports Supported By Linux Solaris and Windows Syntax ListVPorts lt physical WWPN gt Parameters physical WWPN The WWPN of an FC or FCoE port VPortTargets This command lists targets visible
97. ecret1 InitCHAPName InitialSecret1 Supported By Linux Solaris VMware ESXi and Windows Syntax SetlnitiatorProperties MAC Address gt Initiator Name initiator name Initiator Alias initiator alias ImmediateData lt 0 1 gt HeaderDigest lt 0 1 gt DataDigest lt 0 1 gt Auth lt 0 1 2 gt TgtCHAPName TgtSecret InitCHAPName InitSecret OneCommand Manager Command Line Interface Version 10 2 User Manual P010067 01A Rev A 5 CLI Client Command Descriptions Se EMULEX iSCSI Commands 103 Parameters MAC Address The MAC address of an iSCSI 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 HeaderDigest 0 None default 1 CRC32C DataDigest 0 None default 1 CRC32C Auth 0 None default 1 One Way CHAP 2 Mutual CHAP TgtCHAPNam 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 SetiSCSIBoot This command defines whether a specific iSCSI function s Boot ROM is active Supported By Linux Solaris VMware ESXi and Windows Syntax SetiSCSIBoot lt MAC Address gt lt 0 1 gt Parameters MAC Address The MAC address
98. ect adapter or a 16 Gb HBA Supported By Linux Solaris VMware ESXi and Windows Syntax Download lt WWPN MAC gt lt FileName gt Parameters WWPN The WWPN of an FC or FCoE port MAC The MAC address of a NIC or iSCSI port FileName The name and location of the firmware image any file accessible to the CLI client ExportSANInfo For reporting purposes this command captures the SAN information in xml for XML formatted files and csv for CSV formatted files Since this command can output a large amount of information it is recommended that you re direct the output to a file 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 Linux Solaris and Windows Syntax ExportSANInfo format Note The h option for specifying an optional IP address or host name after hbacmd is not available for the ExportSANInfo command OneCommand Manager Command Line Interface Version 10 2 User Manual P010067 01A Rev A DE EMULEX 5 CLI Client Command Descriptions 119 Miscellaneous Commands Parameters format An optional parameter that specifies the format of the adapter information e csv e xml Note Leaving the format blank shows the data in xml format default FecEnable This command enables or disables FEC on LPe16000 series FC adapters Supported By Linux Solaris VMware ESXi and Windows
99. eeeredinwrdeiebeeuaniai r Bo ino E EEA E 27 OneCommand Manager Command Line Interface Version 10 2 User Manual P010067 01A Rev A 3 DE EMULEX Table of Contents 4 3 Updating to the OneCommand Manager Application Enterprise Kit 28 BIV td 28 SOJATIS eege EEN 28 UO 29 A CLI Client Command USAGE u ia sin r hi nn oa 30 OVE VIEW eeben EREAEEEREEEEREEEEREEEREREEEREAEERS REEFF EE sia ii io ka i d si si k i 30 HbaCmd Syntax TT TT 31 Secure Management CLI Interface tttantn nnnnnnnnnnonanna r tt tt 32 Device Management Using the Secure Management Interface 32 Syntax Rules for the Secure Management Interface 32 DT EE ee 33 Device Management Using the CIM Interface 33 Syntax Rules for the CIM Interfaces iasswisncvdsiew ees EE ENEE Va a ered 33 Syntax Options and Setting CIM Credenttals cece eee eee teeta ene 33 Example of Using the CIM Interface to Display Adapters cccccecseeeeeeeeeeeeeauees 34 CLI Client Commands Supported in CIM Interface ceccee cece eeeeeeeeeeeesaeeeenees 36 Commands Supported in Target Mode POrtS ssssssssssnnnsuunnnnnunnnnnnnnnnnnnnnnnnnnnn 36 Unsupported Commands per Operating System sssssssssnnnnsnnnnnnnnnnnnnnnnnnnnnnnn 37 LINUX sada r r 37 RHEL SLEG anid Oracle wiv Sax sat ek RENE dan cad e A r 37 8 dE EE 37 Seege r EEN ah 38 VMWare ESX eect ace ivn kn r o nl i ln 38 A ea a 39 5 CLI Client Command Descriptions ssssssss
100. emand mode with the host initiating the tests with the switch OneCommand Manager Command Line Interface Version 10 2 User Manual P010067 01A Rev A e 5 CLI Client Command Descriptions 72 gt G EMULEX Diagnostic Commands e When using D_Port in a boot from SAN configuration the configuration must have redundant paths to the boot LUN and only one of the redundant adapter ports should be set to D_Port Supported By Linux VMware ESXi and Windows Syntax DPortTest lt WWPN gt Parameters WWPN The WWPN of the FC function on the adapter Considerations When Using D_Port e Because itis not possible to detect if a Brocade switch can support D_Port functionality a test failure occurs if the DPortTest command is run with a switch that does not support D_Port testing e Typing lt CTL C gt while the D_Port tests are running terminates the tests and the completed results are displayed e If the Overall Test Result is FAILED you must either re run the tests successfully or reset the adapter port to bring up the link e lfatest phase fails the D Port diagnostics are automatically stopped As a result test phases that would have occurred after the failure are not displayed e When there is more than one error in a single test phase multiple lines are displayed showing each error Examples Successful Test gt hbacmd DPortTest 10 00 00 00 c9 d1 a2 d0 Running D Port Tests Please wait Polling for results 00
101. en you set the authentication method lt Auth gt to a value other than 0 you must set additional parameters Each string should be enclosed in quotations to avoid mishandling by the Windows Linux Solaris or VMware shell s parser e Ifyou set the authentication method to One Way CHAP lt Auth gt 1 you must also specify the Target CHAP Name and Target Secret For example hbacmd TargetLogin 00 11 22 33 44 55 iscsitarget Auth 1 TgtChapName TargetSecretl e If you set the authentication method to Mutual CHAP lt Auth gt 2 you must specify all four values For example hbacmd TargetLogin 00 11 22 33 44 55 iscsitarget Auth 2 TgtChapName TargetSecret1 InitCHAPName InitialSecret1 Supported By Linux Solaris VMware ESXi and Windows Syntax TargetLogin lt MAC address gt lt Target Name gt lt Target IP gt lt Port gt HeaderDigest lt 0 1 gt ImmediateData lt 0 1 gt DataDigest lt 0 1 gt Auth lt 0 1 2 gt TgtCHAPName TgtSecret InitCHAPName InitSecret Parameters MAC Address The MAC address of an iSCSI port target_name The target s iSCSI name enclosed in quotes string length 11 255 characters Target IP Target IP Address You can specify an IPv4 or IPv6 Target IP address Port The port number of the target portal The possible values are 1024 65535 HeaderDigest 0 None default 1 Uses CRC32C checksum ImmediateData 0 No 1 Yes default for appendi
102. equest You can specify an IPv4 or IPv6 IP address ListSessions This command lists all the sessions on a specified target The command gathers the information from the iSCSI target indicated by the lt iscsi_target_name gt parameter Supported By Linux Solaris VMware ESXi and Windows Syntax ListSessions lt MAC Address gt lt iscsi target name gt Parameters MAC Address The MAC address of the an iSCSI port iscsi target name Targe siSCSI name enclosed in quotes The string length is 11 255 Remove arget This command removes the target with the specified iSCSI target name lt iscsi_target_name gt Supported By Linux Solaris VMware ESXi and Windows Syntax RemoveTarget lt MAC Address gt lt iscsi target name gt OneCommand Manager Command Line Interface Version 10 2 User Manual P010067 01A Rev A 5 CLI Client Command Descriptions Se EMULEX iSCSI Commands 101 Parameters MAC Address The MAC address of an iSCSI port iscsi target name Targe siSCSI name enclosed in quotes The string length is 11 255 RemoveTargetPortal This command removes the SendTarget Portal containing the IPv4 or IPv6 target IP lt Target_IP gt and the port lt Port gt from the list of portals for the specified initiator Supported By Linux Solaris VMware ESXi and Windows Syntax RemoveTargetPortal lt MAC Address gt lt Target_IP gt lt Port gt Parameters MAC Address The MAC address of an iSCSI port Target Ip The targ
103. ers cannot be used to enable or disable NPar Using the CMMMode command to enable or disable NPar displays an error message indicating that the command is not supported by the firmware or hardware e When NPar is disabled NParEP Mode is automatically disabled as well It is not necessary to specify the nparepmode parameter on the command line when disabling NPar mctype none and an error is generated if you attempt to do so e After enabling NPar with the SetAdapterPortConfig command default bandwidths will be automatically assigned to each partition with an assigned protocol See Default NPar Bandwidths on page 153 for more information Showing NPar Configuration Both the GetAdatperPortConfig command and the CMGetParams command show different aspects of the NPar configuration Showing NPar Configuration Using GetAdapterPortConfig The GetAdatperPortConfig command displays all of the adapter s ports and the functions running on each port It also shows the state of NParEP Mode See GetAdapterPortConfig on page 133 for more information OneCommand Manager Command Line Interface Version 10 2 User Manual P010067 01A Rev A DE EMULEX Examples Using GetAdatperPortConfig NPar disabled 2 Ports NParEP Mode Disabled gt hbacmd getadapterportconfig 00 00 c9 12 34 56 Number of Ports Maximum FCoE Functions Maximum iSCSI Functions Mixed Mode I O Allowed Concurrent Mode I O Allowed ROCE Functions Allowed RebootRequired
104. et s IP address You can specify an IPv4 or IPv6 target IP address Port The port number of the target portal The possible values are 1024 65535 SetBootTargetSession This command enables and disables a iSCSI targe s session as a boot session If a session is enabled as a boot session and the system reboots it attempts to boot from that target Depending on whether the target is logged in there are two different ways to specify the session If the target is logged in use the lt TSIH gt parameter If the target is not logged in use the lt ISID Oual Target IP gt parameter You can specify an IPv4 or IPv6 target IP address Supported By Linux Solaris VMware ESXi and Windows Syntax SetBootTargetSession lt MAC Address gt lt Target gt lt TSIH lt ISID Qual Target_IP gt gt lt 0 1 gt Parameters MAC Address The MAC address of an iSCSI port Target Specifies the isCSI name of the desired iSCSI target OneCommand Manager Command Line Interface Version 10 2 User Manual P010067 01A Rev A xs e 5 CLI Client Command Descriptions 102 Se EMULEX iSCSI Commands TSIH TSIH value of the session The possible values are 1 65535 ISID_ Qual ISID qualifier of the session The possible values are 0 65535 You Target_IP can specify an IPv4 or IPv6 Target IP address that the target is using depending on the adapter type See the note above ol Specifies the state of the BootProperty for the target 0 Disabled 1 Enabled
105. eters For example IPv4 Address Subnet and IPv4 Gateway IPv4 address of initiator port For example 10 192 1 1 Note IPv4 Address is required when DHCP is disabled Subnet mask of initiator port For example 255 255 255 0 Note Subnet is required when DHCP is disabled IPv4 gateway of initiator port For example 10 192 1 1 Note IPv4 Gateway is optional when DHCP is disabled Automatic IPv6 address assignment 0 Disabled 1 Enabled Note If the AA automatic assignment parameter is disabled you must specify its parameters For example LL RA1 RA2 and GW6 Link local IPv6 address Note LL is required when AA is disabled and ignored when AA is enabled Routable IPv6 address 1 Note RA is ignored if AA is enabled Routable IPv6 address 2 Note RAZ is ignored if AA is enabled IPv6 gateway address Note GW6 is ignored if AA is enabled P010067 01A Rev A e 5 CLI Client Command Descriptions 105 gt G EMULEX iSCSI Commands Notes e VLAN ID and Priority are required only if VLAN ENABLED is enabled otherwise these values should be omitted e IPv4 Address and Subnet are required only if DHCP is disabled otherwise these values should be omitted e Ataminimum the DHCP or AA parameter must be specified and if required their associated parameters as well If either the DHCP or AA parameter is not specified an error results SetTargetLoginProperties This command sets the login and authentication propertie
106. example output Usage hbacmd version or hbacmd h IPv4 Address port Hostname port lt Command gt or hbacmd h IPv6 Address port lt Command gt Note When specifying IPv6 address with port option it must be enclosed in Example fe80 6445 80e9 9878 4527 9876 Use the following syntax for issuing CIM based commands IPv4 only A gt hbacmd lt h IPv4 port gt lt m CIM gt u userid p password n namespace lt cmd gt B gt hbacmd lt h IPv4 port gt lt m CIM gt lt cmd gt Before specifying syntax B the user should do one of the following 1 Add the host IP with CIM credentials using the AddHost command e g hbacmd lt m CIM gt u userid p password n namespace AddHost lt ip gt 2 Set the default CIM credentials using the SetCimCred command e g hbacmd SetCimCred lt u userid gt lt p password gt lt n namespace gt lt o port gt Use the following syntax to specify Secure Management credentials hbacmd h IP Address port lt m sec gt lt u username gt lt p password gt lt Command gt Command Summary Help Commands Help lt Group gt Group AdapterLicense Attributes Authentication Boot CM DCB OneCommand Manager Command Line Interface Version 10 2 User Manual P010067 01A Rev A e 5 CLI Client Command Descriptions 46 DE EMULEX Help Diagnostics DriverParams Dump FCoE iSCSI LUNMasking Miscellaneous PersistentBinding Personality Profile VPort UMC WWN Adap
107. figured for None must be 0 Notes e A reboot is not required for bandwidth changes take effect when channel management is enabled or when currently running NPar on the adapter e Unlike UMC or SIMode setting the minimum and maximum bandwidths to zero will not bring the logical link down on the NPar function nor prevent receiving or transmitting packets on that function as a small amount of network traffic trickles through Default NPar Bandwidths After enabling or disabling NParEP Mode or NPar the default bandwidths that are automatically assigned to each partition with an assigned protocol have minimum and maximum bandwidths The default minimum bandwidths are set by dividing 100 by the number of partitions with assigned protocols to run on them This may cause an uneven distribution when 100 divides evenly by the number of partitions meaning some partitions minimum bandwidths may be one greater than others The maximum bandwidth defaults to 100 for all partitions with assigned protocols Note If default bandwidths are not desirable use the CMSetBW command to configure the minimum and maximum bandwidths See CMSetBW on page 63 for more information OneCommand Manager Command Line Interface Version 10 2 User Manual P010067 01A Rev A 5 CLI Client Command Descriptions SE EMULEX Profile Management Commands 154 Examples 4 Partitions Port gt hbacmd CMSetBW 00 00 c9 12 34 56 15 50 30 100 40 100 15 50 gt hbacmd CM
108. gSupport e SetCimCred e SetDumpDirectory e SetLunMask e SetPersistentBinding Citrix Citrix acting as a hypervisor style server for OneCommand Manager CLI does not support the following CLI commands e AuthConfigList e BindingCapabilities e BindingSupport e CreateVPort e DeleteVPort e GetAuthConfig e GetAuthStatus e GetCimCred e GetElxSecInfo e GetLunList e GetLunUnMaskByHBA e GetLunUnMaskByTarget e InitiateAuth OneCommand Manager Command Line Interface Version 10 2 User Manual P010067 01A Rev A gt G EMULEX Solaris PersistentBinding RemoveAllPersistentBinding RemovePersistentBinding RescanLuns SetAuthConfig SetBindingSupport SetCimCred SetPersistentBinding SetLunMask SetPassword 4 CLI Client Command Usage 38 Unsupported Commands per Operating System Solaris does not support the following CLI commands CnaClearEventLog CnaGetEventLog DriverConfig GetCimCred GetElxSecInfo ListVMs SetCimCred SetDumpDirectory VMWare ESXi VMWare ESXi does not support the following CLI commands AuthConfigList BindingCapabilities BindingSupport Create VPort DeleteAuthConfig Delete VPort GetAuthConfig GetAuthStatus GetCimCred GetElxSecInfo GetLunlist GetLunUnMaskByHBA GetLunUnMaskByTarget ImportSCSI InitiateAuth OneCommand Manager Command Line Interface Version 10 2 User Manual P010067 01A Rev A DE EMULEX e ListVFunctions e ListVMs e List Porte e PersistentBinding e RemoveAl
109. ger CLI and preserve settings you must install the current core kit as detailed in Installing in Linux Without an Existing OneCommand CLI Kit on page 18 The rpm file handles the configuration file update The install script executes an rpm update rpm U rpm to update the installed version of the core kit to the current version Note There is no update path from an HBAnyware 4 x or 3 x core kit toa 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 21 OneCommand Manager Command Line Interface Version 10 2 User Manual P010067 01A Rev A DE EMULEX 2 Installing and Uninstalling the CLI 21 Linux Performing a Clean Install Removing Existing Settings 1 Uninstall the existing OneCommand Manager CLI using the uninstall script included in the tar file or in usr sbin ocmanager scripts directory Your configuration files are backed up by rpm with an rpmsave extension Note If an HBAnyware CLI or enterprise kit is installed follow the procedure for Uninstalling Older HBAnyware Kits in Linux on page 21 Install the specific rpm file for your driver for Linux version For information on installing the rpm file see Installing in Linux Without an Existing OneCommand CLI Kit on page 18
110. he EnableBootFromSan parameter is also enabled Note To enable or disable boot on an iSCSI target see the SetiSCSIBoot command Supported By Linux Solaris VMware ESXi and Windows Syntax EnableBootCode lt WWPN NIC MAC gt lt Flag gt lt NetworkBootMethod gt Parameters WWPN The WWPN of an FC port NIC MAC The MAC address of a NIC port Flag D Disable the boot code E Enable the boot code NetworkBootMethod Network boot method to be used by the NIC PXE or iBFT The network boot types supported on the specific NIC may be found in the Available Network Boot Methods string displayed by the HbaAttributes command This parameter is not required for FC or FCoE ports and is only specified when enabling network boot Examples The following example enables iBFT for a NIC C Program Files Emulex Util OCManager gt HBACMD EnableNetworkBoot 00 00 c9 11 22 33 e iBFT The following example disables network boot C Program Files Emulex Util OCManager gt HBACMD EnableNetworkBoot 00 00 c9 11 22 33 d OneCommand Manager Command Line Interface Version 10 2 User Manual P010067 01A Rev A DE EMULEX 5 CLI Client Command Descriptions 59 Boot Commands GetBootParams This command shows the FC 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 Supported By Linux Solaris VMware ESXi and Windows Sy
111. he following command to view the syntax uninstall help VMware ESXi For installing and uninstalling the Emulex CIM Provider in VMware systems only VMware ESXi hosts are supported and you must install and use the appropriate Emulex CIM Provider See the following section Installing the CIM Provider for VMware ESXi Hosts Installing the CIM Provider for VMware ESXi Hosts For VMware ESXi hosts you can manage adapters using the OneCommand Manager application on Windows but you must install and use the appropriate Emulex CIM Provider VMware ESXi is packaged with an inbox Emulex CIM Provider The inbox Emulex CIM Provider enables you to manage Emulex FC adapters but not Emulex network adapters To manage Emulex network adapters you must install the out of box Emulex CIM Provider OneCommand Manager Command Line Interface Version 10 2 User Manual P010067 01A Rev A 2 Installing and Uninstalling the CLI 24 SE EMULEX Windows The Emulex CIM Provider is available as an offline bundle in ESXi platforms VMware recommends using the offline bundle to update software on VMware platforms For more information about the ESXi Patch Management activities see the VMware website To install the Emulex CIM Provider in a VMware ESXi hypervisor environment use the esxli command line utility and perform the following steps 1 Copy the CIM provider zip file to var log vmware 2 Log on to the VMware hypervisor host and execute th
112. help setdcbparam The example output SetDCBParam lt WWPN MAC gt lt Param gt lt Value gt WWPN World Wide Port Name of FCoE function on port MAC MAC Address of function on port Param Parameter Name Value Parameter Value Note 1 To see the valid parameter names run the GetDCBParams command 5 CLI Client Command Descriptions 47 Help OneCommand Manager Command Line Interface Version 10 2 User Manual P010067 01A Rev A 5 CLI Client Command Descriptions mm 48 gt G EMULEX Adapter License Management Commands 2 For protocol priorites fcoepriority iscsipriority rocepriority the valid range is 0 to 7 Only one priority can be specified for each invocation of this this command and must be for a protocol running on the port If more than one protocol priority can be set they should be unique values 3 For the following parameters valid values are 0 for disable and 1 for enable DcbxState DcbxMode TxState RxState TxPortDesc TxSysDesc TxSysName TxSysCap PfcEnable 4 For PfcPriority separate each priority by a comma e g 3 4 6 5 Specifying defaults for the Param argument sets all DCB parameters including Priority Groups to their default values Ex SetDCBParams lt WWPN MAC gt defaults Adapter License Management Commands Notes e These commands are only supported on ESXi systems if the CIM provider is used on a remote system e Adapter License Management commands are supported on
113. iate OneCommand Manager Command Line Interface Version 10 2 User Manual P010067 01A Rev A EW 2 Installing and Uninstalling the CLI 18 DE EMULEX fine 2 Installing and Uninstalling the CLI This chapter details prerequisites and procedures for installing and uninstalling the OneCommand Manager CLI in the following operating systems Linux Solaris VMware ESXi and Windows It also describes the Secure Management capability and the procedure for starting and stopping daemon processes Linux Citrix Citrix is based on CentOS Linux however for the OneCommand Manager CLI Citrix is more comparable to VMware a hypervisor style server for managing virtual machines The Citrix XenServer 6 2 operating system contains the OneCommand Manager CLI application and no additional installation is required Citrix XenServer 5 6 SP2 and Citrix XenServer 6 0 and 6 1 operating systems will require OCM CLI installation Note Updated versions of OneCommand Manager CLI for Citrix XenServer are available as part of the Device Update Driver kit for Citrix XenServer 5 6 SP2 and Citrix XenServer 6 0 For the latest kit see the Emulex website Installing in Linux Without an Existing OneCommand CLI Kit Note Prior to installation OneCommand groups must be configured on the LDAP network or the local host machine for Secure Management operation See OneCommand Manager Secure Management Configuration Requirements on page 15 for configuration instru
114. ication This parameter is reguired to enable multichannel Specify None to disable multichannel If you do not specify an mctype no change to the configured multichannel type is made For a list of supported mctypes use the CMGetParams command on page 60 and review the Available Modes field NParEpMode NParEP Mode state DELL Only This parameter can only be specified when mctype NPar 0 Disabled 1 Enabled Note The protocols specified by the f0 fm parameters are the names displayed by the ShowProperties command The following rules apply when using this command with non NPar multichannel enabled e There must be no spaces before or after the and commas in the port specification For instance p0 nic iscsi would cause an error e The only choice for f0 is NIC or NIC ROCE Choices for f1 through fm are None iSCSI FCoE or NIC NIC for f1 through fm can only be specified for multichannel configurations Except for NPar iSCSI and FCoE are limited to f1 and f2 e This command will fail under the following conditions un o Two storage protocols on a port are specified and concurrent storage mode is not available o Three storage protocols on a port are specified o Two of the same storage protocols on a port are specified e NIC RoCE can only be specified as the f0 parameter with no other f parameters specified and cannot be specified with multichannel configurations If NIC ROCE is spec
115. ied using the h option with the following syntax hbacmd h IP Address port Hostname port lt command gt parameters o If the h option is omitted the command is run on the local host o Ifthe h option is specified the command is sent to the specified remote host assuming it is specified correctly the remote host is up and the remote host is running the OneCommand Manager remote management agent o The port option is optional If omitted the OneCommand Manager remote management protocol uses the default TCP port If specified it uses the user specified TCP port o Examples Using the IP address hbacmd h 138 239 91 121 ListHBAs Using the host name hbacmd h cp hp5670 ListHBAs o The h option is available for all commands except for the AddHost page 116 RemoveHost page 121 and the Version page 125 commands e For FC ports the WWPN of the adapter must be specified Where the WWPN is specified each pair of numbers within the WWPN is separated by colons or spaces When using space separators the entire WWPN must be enclosed in quotes For example the following command displays the port attributes for the adapter with the specified WWPN hbacmd PortAttributes 10 00 00 00 c9 20 20 20 e For iSCSI and NIC ports the MAC address must be specified Where a MAC address is specified each pair of numbers within the MAC address is separated by a dash For example the following
116. ies lt MAC Address gt lt Target 1P gt lt Port gt ImmediateData lt 0 1 gt HeaderDigest lt 0 1 gt DataDigest lt 0 1 gt Auth lt 0 1 2 gt TgtCHAPName TgtSecret InitCHAPName InitSecret Parameters MAC Address Target_IP Port ImmediateData HeaderDigest DataDigest Auth TgtCHAPNam TgtSecret InitCHAPName InitSecret ShowARPTable The MAC address of an iSCSI port The IP address of the target portal You can specify an IPv4 or IPv6 Target IP address The port number of the target portal value 1024 65535 0 No 1 Yes default 0 None default 1 CRC32C 0 None default 1 CRC32C 0 None default 1 One Way CHAP 2 Mutual CHAP The Target CHAP name enclosed in quotes string length 1 256 The Target Secret enclosed in quotes string length 12 16 The Initiator CHAP name enclosed in quotes string length 1 256 The Initiator Secret enclosed in quotes string length 12 16 This command shows the current ARP table for the specified port Supported By Linux Solaris VMware ESXi and Windows OneCommand Manager Command Line Interface Version 10 2 User Manual P010067 01A Rev A e 5 CLI Client Command Descriptions 108 gt G EMULEX iSCSI Commands Syntax ShowARPTable lt MAC_Address gt Parameters MAC Address The MAC address of an iSCSI port ShowiSNSServer This command shows the currently configured Internet Storage Name Server It shows u
117. ified for any of the port functions all other port function specifications must be NIC or NIC ROCE only For example a single NIC or NIC ROCE function per port is all that is allowed Also NIC RoCE can only be specified when mctype none OneCommand Manager Command Line Interface Version 10 2 User Manual P010067 01A Rev A e 5 CLI Client Command Descriptions 140 gt G EMULEX Profile Management Commands e The number of functions f specified depends upon the adapter model and configuration type for example non multichannel multichannel RoCE and NPar If an incorrect number of functions are specified an error is generated e The pid ProfileID option is required for NIC RoCE configurations If it specified and the profile does not work with the specified port functions an error is generated e f0 must always be specified However if the rest of the functions on a port can be set to None they do not need to be specified For example pO NIC iSCSI pl NIC None could be specified as pO NIC iSCSI p1 NIC e Storage protocols can be configured on f1 and or f2 however you must be aware of whether you are configuring in concurrent mode or mixed mode o If youare configuring storage protocols in concurrent mode f1 and f2 cannot be assigned the same storage protocol o If youare configuring storage protocols in mixed mode only f1 or f2 can be assigned a storage protocol but not both e If mctype is specified i
118. iguration for an adapter s physical port When NPar is enabled CMGetParams shows the function information such as the protocol and bandwidths See CMGetParams on page 60 for more information When you are using NPar this command displays the adapter s active booted mode as NPar or None the configured mode as NPar or None and the available management modes which is NPar only This is followed by a table showing the specified port s functions and function properties When NPar is active the Type column shows the protocol that is running on each function Examples Using CMGetParams NPar Disabled gt hbacmd cmgetparams 00 00 c9 12 34 56 Active Mode None Configured mode None Available modes NPAR NPar Enabled 4 Partition Port gt hbacmd cmgetparams 00 00 c9 12 34 56 Active Mode NPAR Configured mode NPAR Available modes NPAR Func Type MAC Address Min BW Max BW NIC 00 00 c9 12 34 56 20 ES 4 iSCSI 00 00 c9 12 34 57 60 100 FCoE 00 00 c9 12 34 58 40 100 12 NONE 00 00 c9 12 34 59 0 0 OneCommand Manager Command Line Interface Version 10 2 User Manual P010067 01A Rev A 5 CLI Client Command Descriptions SE EMULEX Profile Management Commands 1a NPar Enabled 8 Partitions Port gt hbacmd cmgetparams 00 00 c9 12 34 56 Active Mode NPAR Configured mode NPAR Available modes NPAR Func Type MAC Address Min BW Max BW 0 NIC 00 00 c9 12 34 56 10 50 2 iSCSI 00 00 c9 12 34 57 20 100 4 NIC 00 00 c9 12
119. iscellaneous Commands Supported By Linux Solaris VMware ESXi and Windows Syntax SRIOVEnable lt MAC gt lt 0 1 gt Parameters MAC The MAC address of a NIC port oj1 0 Disables SR IOV 1 Enables SR IOV Example The following command enables SR IOV on NIC physical function with MAC address 00 00 c9 12 34 56 hbacmd SRIOVEnable 00 00 c9 12 34 56 1 TargetMapping This command shows a list of mapped targets and the LUNs for the port Supported By Linux Solaris VMware ESXi and Windows Syntax TargetMapping lt WWPN gt Parameters WWPN The WWPN of an FC or FoE adapter VEPAEnable This command enables or disables VEPA Management VEPA Management is only supported for OCe1400x NIC ports For all other board types and port types this feature is undefined and this command returns a Hardware Does Not Support error Supported By Linux Solaris VMware ESXi and Windows Syntax VEPAEnable lt MAC gt lt 0 1 gt OneCommand Manager Command Line Interface Version 10 2 User Manual P010067 01A Rev A DE EMULEX 5 CLI Client Command Descriptions 125 Persistent Binding Commands Parameters MAC The MAC Address of any NIC on the physical port ol The VEPA state 0 Disabled 1 Enabled Version This command shows the current version of the OneCommand Manager CLI Client Supported By Linux Solaris VMware ESXi and Windows Syntax For the RM interface hbacmd Version Note The h option for spe
120. l active management of local and remote adapters ocmlocaladmin Permits full active management of local adapters only ocmuser Permits read only access of local and remote adapters ocmlocaluser Permits read only access of local adapters On Linux or Solaris systems the unix getent group utility can be run on the target host system s command shell to verify the correct configuration of the groups The groups and users within the groups will appear in the output of this command Note Although a user may belong to the administrator group or be the root user they will not have full privileges to run the OneCommand Manager application unless they are also a member of the ocmadmin group Otherwise when secure management is enabled a root user or administrator can only manage local adapters similar to the ocmlocaladmin user OneCommand Manager Command Line Interface Version 10 2 User Manual P010067 01A Rev A gt G EMULEX 1 Introduction OneCommand Manager Secure Management 15 Remote management operations between two machines is allowed or denied depending on the OneCommand Manager secure management status of the machines and the domains to which the machines belong The following tables list the behavior assuming appropriate user credentials are used Table 1 2 Active Commands machines on same domain Remote Server Remote Server Secure Not Secure Client Secure Allowed Denied Client Not Secure
121. lPersistentBinding e RemovePersistentBinding e RescanLuns e SetAuthConfig e SetBindingSupport e SetCimCred e SetLunMask e SetPersistentBinding e SetPassword e VportTargets Windows 4 CLI Client Command Usage 39 Unsupported Commands per Operating System Windows does not support the following CLI commands e SetDumpDirectory e ListVMs OneCommand Manager Command Line Interface Version 10 2 User Manual P010067 01A Rev A DE EMULEX 5 CLI Client Command Descriptions 40 5 CLI Client Command Descriptions A check mark Geh designates a supported command for a particular operating system and CIM interface N A indicates not applicable Table 5 1 CLI Client Command Reference VMware CIM Interface Command Linux Solaris ESXi Windows Support Page AddARPTableEntry N 90 AddHost v y v 116 AddiSNSServer v vy v v 91 AddRouteTableEntry v N v v 91 AddTarget v v v y 92 AddTargetPortal v v v v 93 AllNodelnfo N v N v v 126 AuthConfigList v v v 54 BindingCapabilities v v 126 BindingSupport v N 127 ChangePersonality v N v v 130 ChangeWWN N v N v 165 CleariSNSServer v v v v 94 CMGetParams v N y v 60 CMMode v v v v 63 CMSetBW v v v v 63 CnaClearEventLog N N v 117 CnaGetEventLog N v N 117 CreateVPort v v N 162 DPort Test v v N 71 DelARPTableEntry N v N 95 DeleteAuthConfig v v v 54 DelRouteTableEntry v N
122. lt iscsi target name gt ImmediateData lt 0 1 gt HeaderDigest lt 0 1 gt DataDigest lt 0 1 gt Boot lt 0 1 gt Login lt 0 1 gt Auth lt 0 1 2 gt TgtCHAPName TgtSecret InitCHAPName InitSecret Parameters MAC Address The MAC address of an iSCSI port Target Ip IP address of the target portal You can specify an IPv4 or IPv6 IP address Port Port number of the target portal value 102 65535 iscsi target name Target s iSCSI name enclosed in quotes string length 11 255 ImmediateData 0 No 1 Yes default HeaderDigest 0 None default 1 CRC32C DataDigest 0 None default 1 CRC32C OneCommand Manager Command Line Interface Version 10 2 User Manual P010067 01A Rev A e 5 CLI Client Command Descriptions 93 gt G EMULEX iSCSI Commands Boot This optional parameter specifies whether the added target is a boot device 0 Added target is not a boot device 1 Added target is a boot device Login This optional parameter specifies whether to log in to the target after it has been added 0 Do not log in to the target 1 Specify log in to the target If the Login parameter is omitted the default is 1 Auth 0 None default 1 One Way CHAP 2 Mutual CHAP TIE CHAPNam 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 encl
123. ly active bind type Otherwise you are notified that you must reboot the system to cause the persistent binding to become active AllNodelnfo This command shows target node information for each target accessible by the adapter Supported By Linux Solaris VMware ESXi and Windows Syntax AllNodeInfo lt WWPN gt Parameters WWPN The WWPN of an FC or FCoE port BindingCapabilities This command shows the binding capabilities of the adapter If a binding is configured it is maintained across reboots Supported By Solaris and Windows Syntax BindingCapabilities lt WWPN gt Parameters WWPN The WWPN of an FC or FCoE port OneCommand Manager Command Line Interface Version 10 2 User Manual P010067 01A Rev A DE EMULEX 5 CLI Client Command Descriptions 127 Persistent Binding Commands BindingSupport This command shows the binding support for the adapter Supported By Solaris and Windows Syntax BindingSupport lt WWPN gt lt Source gt Parameters WWPN The WWPN of an FC or FCoE port Source C Configuration support L Live support PersistentBinding This command specifies which set of persistent binding information configuration or live state is requested Supported By Solaris and Windows Syntax PersistentBinding lt WWPN gt lt Source gt Parameters WWPN The WWPN of an FC or FCoE port Source C Configuration support L Live support RemoveAllPersistentBinding This command re
124. message if the configured multichannel mode is VNIC1 UFP or None e For UMC the UMCSetBW command can still be used instead of CMSetBW e A reboot is not required to change the channel bandwidths when channel management is enabled or when currently running NPar on the adapter e Ifachannel s protocol is configured to None the minium and maximum bandwidth must be 0 Supported By Linux Solaris VMware ESXi and Windows Syntax hbacmd CMSetBW MAC WWPN gt lt MinO Max0 gt Minl Max1 MinN MaxN Parameters WWPN WWPN of an FCoE function on the physical adapter port MAC MAC address of any NIC or iSCSI function on the physical adapter port Minn Max0 Minimum and maximum bandwidths for channel 0 Mini Masi Minimum and maximum bandwidths for channel 1 MinN MaxN Minimum and maximum bandwidths for channel N Examples Multichannel Down Logical Link on 3rd Channel of a 4 Channel Port Adapter gt hbacmd CMSetBW 00 00 c9 12 34 56 25 50 50 100 0 0 25 50 gt hbacmd CMGetParams 00 00 c9 12 34 56 Active mode UMC OneCommand Manager Command Line Interface Version 10 2 User Manual P010067 01A Rev A DE EMULEX 5 CLI Client Command Descriptions 65 Channel Management Commands Configured mode UMC Available modes UMC Func Type MAC Address LPVID Min BW Max BW 0 NIC 00 00 c9 12 34 56 2 25 50 2 iSCSI 00 00 c9 12 34 57 n a 50 100 4 NIC 00 00 c9 12 34 58 3 0 0 6 NIC 00 00 c9 12 34 59 4 25 50 CMSetLPVID This command
125. moves all persisting bindings for the adapter Supported By Solaris and Windows Syntax RemoveAllPersistentBinding lt WWPN gt Parameters WWPN The WWPN of an FC or FCoE port OneCommand Manager Command Line Interface Version 10 2 User Manual P010067 01A Rev A DE EMULEX 5 CLI Client Command Descriptions 128 Persistent Binding Commands RemovePersistentBinding 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 Supported By Solaris and Windows Syntax RemovePersistentBinding lt WWPN gt lt BindType gt lt ID gt lt SCSIBus gt lt SCSITarget gt Parameters WWPN The WWPN of an FC or FCoE port BindType P Remove binding by WWPN N Remove binding by WWNN D Remove binding by D_ID ID The type of ID based on lt BindType gt e Target WWPN if lt BindType gt P e Target WWNN if lt BindType gt N e Target D_ID if lt BindType gt D SCSIBus The bus number of the SCSI device SCSITarget The target number of the SCSI device SetBindingSupport This command enables and sets the binding support s for the adapter Supported By Solaris and Windows Syntax SetBindingSupport lt WWPN gt lt BindFlag gt Parameters WWPN The WWPN of an FC or FCoE port OneCommand Manager Command Line Interface Version 10 2 User Manual P010067 01A Rev A DE EMULEX 5 CLI Client Command Descriptions
126. n FC port WWPN2 Use ff ff ff ff ff ff ff ff for a switch or use the WWPN for a target SetAuthConfig This command sets the authentication configuration for the adapter Supported By Linux Solaris and Windows Syntax SetAuthConfig lt WWPN1 gt lt WWPN2 gt lt PasswordType gt lt Password gt lt Param gt lt Value gt Note Where multiple parameters and values are used separate them using commas Parameters WWPN1 The WWPN of an FC port WWPN2 Use ff ff ff ff ff ff ff ff for a switch or use the WWPN for a target PasswordType 1 ASCII 2 Hex binary 3 Password not yet defined Password The current password value Param The parameter names e Mode e Timeout e Bi directional e Hash priority e DH priority e Re authentication e Re authentication interval OneCommand Manager Command Line Interface Version 10 2 User Manual P010067 01A Rev A DE EMULEX 5 CLI Client Command Descriptions 57 Authentication Commands Value The value is based on the type of lt Param gt e Mode disabled enabled or passive e Timeout time in seconds e Bi directional disabled or enabled e Hash priority md5 or shal md5 first md5 then sha1 shal first shal then md5 e DH priority 1 2 3 4 5 any combination up to 5 digits e Re authentication disabled or enabled e Re authentication interval 0 10 3600 SetPassword This command sets the password on the adapter for an authenticated connection
127. ncy 1898 nanoseconds Estimated Cable Length 172 meters Test Phase Result Latency Local Errors Remote Errors Electrical Loopback Passed 127 Optical Loopback Passed 1898 Reverse Optical Loopback Skipped 0 Link Traffic Failed n a OneCommand Manager Command Line Interface Version 10 2 User Manual P010067 01A Rev A 5 CLI Client Command Descriptions SE EMULEX Diagnostic Commands a EchoTest This command runs the echo test on FC adapters Notes e This command is only supported on FC and FCoE ports e The EchoTest command fails if the target WWPN does not support the ECHO ELS command Supported By Linux Solaris VMware ESXi and Windows Syntax EchoTest lt WWPN Source gt lt WWPN Destination gt lt Count gt lt StopOnError gt lt Pattern gt Parameters WWPN Source The WWPN of the originating adapter WWPN Destination The WWPN of the destination echoing adapter Count The number of times to run the test Use 0 to run the 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 This command shows the current beacon state either on or off Supported By Linux Solaris VMware ESXi and Windows Syntax GetBeacon lt WWPN MAC gt Parameters WWPN The WWPN of the adapter MAC The MAC address of the NIC or iSCSI port OneCommand Manager Command Line Interface Ve
128. nd Uninstalling the CLI 25 Windows 2 Use the following syntax for the installation executable file elxocmcore windows lt arch gt lt kit version gt exe lt option gt 3 Activate the kit with switch g or q2 e The q switch displays progress reports e The q2 switch does not display progress reports 4 Youcan enable Secure Management Mode by adding the sec 1 argument or disable it by sec 0 If the sec argument is not entered Secure Management is disabled by default See OneCommand Manager Secure Management on page 14 for more information To enable Secure Management at the command prompt type elxocm windows x64 5 01 00 10 4 exe sec 1 q2 To disable Secure Management at the command prompt type elxocm windows x64 5 01 00 10 4 exe sec 0 q2 5 You can select a Management Mode by adding the mmode argument and the ability to change that Management Mode by adding the change argument with selected values as in the example below Note If you enabled Secure Management in Step 4 you cannot enter an mmode value Doing so will result in a conflicting parameters error For example at the command prompt type elxocm windows x64 5 01 00 10 4 exe mmode 3 achange 1 q2 The following are the possible mmode values 1 Local Only Management Mode 2 Local Plus Management Mode 3 Full Management Mode 4 Local Plus Management Mode and Read Only 5 Full Management Mode and Read Only 6 Management host The following are the possibl
129. nd any new LUNs Supported By Linux Solaris and Windows OneCommand Manager Command Line Interface Version 10 2 User Manual P010067 01A Rev A 5 CLI Client Command Descriptions 114 SE EMULEX LUN ExpressLane Commands Syntax RescanLuns lt HBA WWPN gt lt Target WWPN gt Parameters HBA WWPN The WWPN of an FC or FCoE port on the adapter Target WWPN The WWPN of the target SetLunMask This command masks the specified LUNs Supported By Solaris and Windows Syntax SetLunMask lt HBA WWPN gt lt Target WWPN gt lt Option gt lt Lun gt lt LunCount gt lt MaskOp gt Parameters HBA WWPN The WWPN of an FC or FCoE port on the adapter Target WWPN The WWPN of the target Option 0 Get information from the driver 1 Get information from the configuration make persistent 2 Send information to both Lun The starting LUN number LunCount The number of LUNs 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 LUN ExpressLane Commands Note ExpressLane is only supported on LPe16000 series FC adapters GetExpressLaneLunList This command displays LUNs on a target and their respective ExpressLane status Supported By Linux VMware ESXi and Windows OneCommand Manager Command Line Interface Version 10 2 User Manual P010067 01A Rev A LUN ExpressLane Commands DE EMULEX 5 CLI Client Command Descriptions 115 Notes
130. neConnect adapters When you change the personality of the adapter and reboot the host the adapter starts running the new personality The personalities that the OneConnect adapters currently run are NIC only NIC FCoE NIC iSCSI and NIC RoCE for OCe14000 series adapters In some cases the adapters are pre configured to support multiple personalities In other cases you must install a license key before the adapter can support multiple personalities See Adapter License Management Commands on page 48 for more information Notes e The four different personality profiles may not always be available on an adapter For example a NIC FCoE adapter can change to a NIC only or a NIC iSCSI adapter but an iSCSI adapter may not be able to change to a NIC FCoE adapter e Choose the RoCE 2 profile for SMB Direct on Windows Server 2012 and Windows Server 2012 R2 Note Check the Implementer s Lab on the Emulex website for any updated information on additional use cases for the RoCE 2 profile e For the RoCE 1 profile check the Implementer s Lab on the Emulex website for any updated information on use cases for the RoCE 1 profile e Itis possible to install one or more driver kits for the current personality profile then change the personality profile and no longer have the drivers necessary to run the adapter If you change personality profiles you must install the appropriate drivers The appropriate drivers are available on th
131. nels Storage on 2nd channel gt hbacmd CMSetLPVID 00 00 c9 55 43 21 1001 0 1002 1003 1004 1005 1006 1007 DCB Commands This command shows the DCB and LLDP parameters for iSCSI FCoE and NIC adapter ports Notes e DCB commands are for DCB management of OneConnect adapters only e These commands are not available on OCe11101 EM EX or OCe11102 EM EX adapters The following error message will be returned ERROR lt 222 gt DCB not available GetDCBParams This command shows the active and configured DCB and LLDP settings on a port of a OneConnect adapter Supported By Linux Solaris VMware ESXi and Windows Syntax GetDCBParams lt WWPN MAC gt Parameters WWPN The WWPN of an FC or FCoE port MAC The MAC address of a NIC or iSCSI port Example hbacmd h 10 192 203 154 GetDCBParams 00 00 c9 93 2f d8 OneCommand Manager Command Line Interface Version 10 2 User Manual P010067 01A Rev A e 5 CLI Client Command Descriptions 67 gt G EMULEX DCB Commands GetPGinfo This command shows the ETS priority group bandwidth percentages for the port of a OneConnect adapter Additionally this command displays the number of priority groups supported by an adapter Supported By Linux Solaris VMware ESXi and Windows Syntax GetPGInfo lt WWPN MAC gt Parameters WWPN The WWPN address of an FC or FCoE port MAC The MAC address of a NIC or iSCSI port Example hbacmd h 10 192 203 154 getpginfo 00 00 c9 93 2f d8
132. network and storage traffic Each channel has its own unigue MAC address Depending on the type of channel management in effect each channel provides various traffic management and provisioning capabilities such as enabling and disabling minimum and maximum bandwidth and VLAN ID in UMC for untagged packets also called the LPVID OCM allows the enabling and disabling of channel management and in the case of UMC SIMode the setting of each channe s properties For the VNICI and UFP channel management types OCM will display the channel properties but not allow modification except for vVNIC1 where the LPVID inner VLAN ID can be modified Additionally the OCe14000 series adapters support NPar Use the GetAdapterPortConfig and SetAdapterPortConfig command to manage NPar for these adapters See GetAdapterPortConfig on page 133 and SetAdapterPortConfig on page 137 Notes e For IBM adapters UMC mode is referred to as SIMode e SR IOV is not supported with channel management e There are OCM CLI commands for UMC management that are still available for backward compatibility with existing UMC scripts They cannot be used to manage other channel management types See UMC Commands on page 157 for information on UMC management CMGetParams This command shows the current channel management configuration for an adapter s physical port Multichannel When using multichannel this command displays the adapter s
133. nfiguration Profile ID 33 MC Type NPAR 2 2 2 Yes No Yes Yes OneCommand Manager Command Line Interface Version 10 2 User Manual P010067 01A Rev A 151 5 CLI Client Command Descriptions SE EMULEX Profile Management Commands 152 NParEP Mode Disabled Port Assignments Port 1 po NIC iSCSI NIC FCoE Port 2 p1 NIC FCoE iSCSI NIC Note pN labels are the port parameter names to use in the SetAdapterPortConfig command e g p0 NIC FCOoE p1 NIC iSCSI 4 Ports NParEPMode Enabled 4 Functions Port gt hbacmd setadapterportconfig 00 00 c9 12 34 56 p0 nic iscsi fcoe nic pl nic iscsi none nic p2 nic iscsi nic fcoe p3 nic nic iscsi none mctype npar nparepmode 1 Successfully changed port configuration A reboot is required to complete changes gt hbacmd getadapterportconfig 00 00 c9 12 34 56 Number of Ports s4 Maximum FCoE Functions 4 Maximum iSCSI Functions 4 Mixed Mode I O Allowed Yes Concurrent Mode I O Allowed Yes ROCE Functions Allowed Yes RebootRequired Yes Active Configuration Profile ID 33 MC Type NPAR Port Assignments Port 1 NIC NIC NIC NIC Port 2 NIC NIC NIC NIC Port 3 NIC iSCSI NIC FCoE Port 4 NIC iSCSI FCoE None Reboot Configuration Profile ID 33 MC Type NPAR NParEP Mode Enabled Port Assignments Port 1 p0 NIC iSCSI FCoE NIC Port 2 pl NIC iSCSI None NIC Port 3 p2 NIC iSCSI NIC FCoE Port 4 p3 NIC NIC iSCSI None OneCommand Manager C
134. ng solicited data to a command DataDigest 0 None default 1 CRC32C checksum Auth 0 None default 1 One Way CHAP 2 Mutual CHAP OneCommand Manager Command Line Interface Version 10 2 User Manual P010067 01A Rev A e 5 CLI Client Command Descriptions 111 SE EMULEX iSCSI Commands TIE CHAPName The Target CHAP name enclosed in quotes string length 1 255 characters Note The Target CHAP name is required it you set Auth to 1 or 2 TgtSecret The Target Secret enclosed in quotes string length 12 16 characters Note The Target CHAP name is required it you set Auth to 1 or 2 InitCHAPName The Initiator CHAP name enclosed in quotes string length 1 255 characters Note The Target CHAP name is required it you set Auth to 2 InitSecret The Initiator Secret enclosed in quotes string length 12 16 characters Note The Target CHAP name is required it you set Auth to 2 TargetLogout This command logs out of a target You must specify the iSCSI target name lt iscsi_target_name gt and either the TSIH lt TSIH gt of the session or the session s ISID Qualifier lt ISID_Qual gt and the target s IP address lt Target_IP gt Supported By Linux Solaris VMware ESXi and Windows Syntax Targetlogout lt MAC Address gt lt iscsi target name gt lt TSIH lt ISID Qual Target_IP gt gt Parameters MAC Address The MAC address of an iSCSI port iscsi target name The targe siSCSI name enclosed in quote
135. nnnnssnnnnnnsunnnnnnnnnnnnnnnnnnnnnnnnnn 40 Help eee rererreerrreerrreereeeerreeerreeeritreert reer treet rer tree reer reer eer ere eee 45 Adapter License Management Commandes NENNEN 48 InstallAdapterLicense s ccsr osie s kiu l sia a ders cess r KEE o K Ta 48 Zhow dapterticenseteatures nn nn nn nn 49 pel gloat AGA DES ET EA Pls o v 49 Attributes Command gg Ces agegg ES adoc knsilab lakod E Sg dg n l ba b da k ER NEES EAR 50 hl A CLA EO dee EE EE 50 Delega 50 ae Te ici ewairiadediamiGees E 51 Server ACN lte 51 SetPhyPOrtSpEEd zasiast kovooi l sko knot bono bono no nt 51 OneConnect OCe11100 Series and OCe14000 Series Adapters nn 51 OneCommand Manager Command Line Interface Version 10 2 User Manual P010067 01A Rev A DE EMULEX Table of Contents 5 Er zuoi artkesvoske trave biol ii ovo rov nb Kovo EARNE EEEE RA 53 Authentication COMMANGS si1s4is1 sz nanakknt K n ua sk k na s k hk kika s inak 54 PUL ar CL i caste esconoos zh cezo since eso tOd oto e gt bonite st O cn nn 6 hor ts lon 54 DeleteAuthConfig EE 54 S SVALE OMG EE 55 Edel 55 a re EE 56 SSL ALE CAMO ee ee Seege ege ege eege 56 EE 57 BOOT COMMANG D 58 Enable Botoi Essien k rr EE 58 E zle le ale un 59 SetBootParam EE 59 Channel Management Commands otsnnn nnnnnnnnn o str trn 60 CMGetPara EE 60 Multichannelsisis ass oskiia no o r vk AE AE 60 CMMOdE rirni cerpen enai v rob prianie sro ri no PESENE na 63 EEN ee 63 MA aa n
136. ntax GetBootParams lt WWPN gt lt Type gt Parameters WWPN The WWPN of an FC port Type X86 OpenBoot or UEFI SetBootParam This command changes the FC boot parameters You can change adapter parameters and boot device parameters for x86 OpenBoot and UEFI boot e When changing adapter parameters omit the BootDev keyword and value otherwise an error is reported e When changing boot device parameters for OpenBoot omit the BootDev keyword and value otherwise an error is reported e For boot device parameters for x86 or UEFI you must provide the BootDev keyword and value Supported By Linux Solaris VMware ESXi and Windows Syntax SetBootParam lt WWPN gt lt Type gt lt Param gt lt Valuel gt BootDev lt Value2 gt Parameters WWPN The WWPN of an FC port Type Possible values are x86 OpenBoot or UEFI Param The parameter name Valuel The parameter value BootDev The boot device Value2 The boot device entry number 0 7 OneCommand Manager Command Line Interface Version 10 2 User Manual P010067 01A Rev A DE EMULEX 5 CLI Client Command Descriptions 60 Channel Management Commands Channel Management Commands These commands enable and disable channel management and set channel properties for UCNAs Channel management is not supported on LPe16202 adapters Each port on each adapter s physical port can be partitioned into a maximum of four isolated channels providing a converged conduit for
137. ocm windows lt kit version gt 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 OneCommand Manager Command Line Interface Version 10 2 User Manual P010067 01A Rev A 4 CLI Client Command Usage 30 Overview SE EMULEX 4 CLI Client Command Usage Overview The CLI Client component of the OneCommand Manager application provides access to the capabilities of the Remote Management library or the CIM interface from a console command prompt to get the management information The CLI Client is intended for use in scripted operations from within shell scripts or batch files The CLI Client is a console application named HbaCmd A single operation is performed by entering hbacmd followed by a CLI client command and its possible parameters at the command line For example hbacmd lt command gt parameters Note To run the HbaCmd application when Secure Management is enabled you must include your user name and password each time you type a command For example e Secure Management disabled hbacmd lt command gt e Secure Management enabled hbacmd lt m sec gt lt userid gt lt password gt lt command gt User names and passwords are used to authenticate the commands Once the credentials are authenticated the OCM will determine which one of the fo
138. of an iSCSI port oli Specifies the iSCSI boot ROM state 0 Disabled 1 Enabled SetNetworkConfiguration This command sets the TCP IP configuration on a specified port The required fields for this command depend upon the values set for lt DHCP gt and lt VLAN_ENABLED gt Supported By Linux Solaris VMware ESXi and Windows OneCommand Manager Command Line Interface Version 10 2 User Manual P010067 01A Rev A gt EMULEX Syntax 5 CLI Client Command Descriptions 104 iSCSI Commands SetNetworkConfiguration lt MAC address gt VLAN Enabled lt 0 1 gt VLAN_ID lt 0 4094 gt Priority lt 0 7 gt DHCP lt 0 1 gt lt IPv4 Address gt lt Subnet gt IPv4 Gateway AA lt 0 1 gt lt LL IPv6 Address gt Parameters MAC Address VLAN ENABLED VLAN ID Priority DHCP 1IPv4 Address Subnet IPv4 Gateway LL GW6 OneCommand Manager Command Line Interface Version 10 2 User Manual RA1 IPv6 Address RA2 IPv6 Address GW6 IPv6 Address The MAC address of an iSCSI port 0 Disabled 1 Enabled VLAN ID of the interface The possible values are 0 4095 Note This value is specified only when VLAN is enabled VLAN priority of the interface The possible values are 0 7 Note This value is specified only when VLAN is enabled Dynamic Host Configuration Protocol for automatic IPv4 address assignment 0 Disabled 1 Enabled Note If the DHCP parameter is disabled you must specify its param
139. ommand Line Interface Version 10 2 User Manual P010067 01A Rev A e 5 CLI Client Command Descriptions 153 gt G EMULEX Profile Management Commands Note pN labels are the port parameter names to use in the SetAdapterPortConfig command e g poO NIC FCoE p1 NIC iSCSI Setting NPar Bandwidths After enabling NPar with the SetAdapterPortConfig command default bandwidths are set for each partition that is enabled Use the CMSetBW command to configure new bandwidths if the default bandwidths are not acceptable See CMSetBW on page 63 for more information Note A partition is referred to as a channel in the CMSetBW help The number of bandwidth combinations that need to be specified depend upon the adapter model See CMGetParams on page 60 to determine how many bandwidths need to be specified for a port by looking at the number of functions indicated in the Func column Note If too many or too few minimum and maximum bandwidth combinations are provided an error is generated The total of the minimum bandwidths for the enabled functions such as partitions assigned protocols must add up to 100 While you are allowed to set the minimum bandwidths on some enabled functions to 0 you are not allowed to set them all to 0 The maximum bandwidth of a partition must be greater than or equal to the minimum bandwidth for that partition up to a maximum of 100 The minimum and maximum bandwidths on disabled functions those con
140. on the physical port Mino Max0 Minimum and maximum bandwidths for channel 0 Min1 Max1 Minimum and maximum bandwidths for channel 1 Min2 Max2 Minimum and maximum bandwidths for channel 2 Min3 Max3 Minimum and maximum bandwidths for channel 3 Example gt hbacmd UmcSetBW 00 00 c9 bb cc aa 25 50 0 50 50 75 25 100 Considerations e This command is not supported on 1 Gb ports e If UMC is disabled when this command is executed a warning message will be displayed indicating that UMC is currently disabled and must be enabled for these changes to take effect OneCommand Manager Command Line Interface Version 10 2 User Manual P010067 01A Rev A e 5 CLI Client Command Descriptions 161 SE EMULEX UMC Commands UmcSetLPVID Note This command has been replaced by the CMSetLPVID command and is provided for backward compatibility for OCe11100 series adapters only This command sets the LPVID values for the UMC and SIMode NIC channels Use the UmcGetParams command to determine the number of LPVIDs required See UmceGetParams on page 158 for more information A reboot is not required for these changes take effect when UMC is enabled Note When the current multichannel mode is not UMC or SIMode the UmcSetLPVID command fails Supported By Linux Solaris VMware ESXi and Windows Syntax UmcSetLPVID lt WWPN MAC gt lt LPVIDO gt lt LPVID1 gt LPVIDn Parameters WWPN WWPN of an FCoE function on the physical adapter port
141. osed in quotes string length 12 16 AddTargetPortal 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 IPv4 or IPv6 portal IP address lt Target_IP gt and a valid port number lt Port gt If you do not specify the remaining options these options are set to their default values When you set the authentication method lt Auth gt to a value other than 0 you must set additional parameters Each string should be enclosed in quotations to avoid mishandling by the Windows Linux Solaris or VMware shell s parser e If you set the authentication method to One Way CHAP lt Auth gt 1 you must also specify the Target CHAP Name and Target Secret For example hbacmd AddTargetPortal 00 11 22 33 44 55 10 0 0 1 8000 Auth 1 TgtCHAPName TargetSecret1 e If you set the authentication method to Mutual CHAP lt Auth gt 2 you must specify all four values For example hbacmd AddTargetPortal 00 11 22 33 44 55 10 0 0 1 8000 Auth 2 TgtChapName TargetSecret1 InitCHAPName InitialSecret1 You must specify either the TSIH value or the ISID qualifier If you specify the ISID qualifier you must also specify the Target s ID address Supported By Linux Solaris VMware ESXi and Windows OneCommand Manager Command Line Interface Version 10 2 User Manual P010067 01A Rev A gt EMULEX
142. ot require you specify the CIM credentials on the command line For example hbacmd SetCimCred lt username gt lt password gt lt namespace gt lt portnum gt OneCommand Manager Command Line Interface Version 10 2 User Manual P010067 01A Rev A i 4 CLI Client Command Usage 34 gt G EMULEX CIM Interface e Add the host IP address with CIM credentials using the AddHost command For example hbacmd lt m cim gt u userid p password n namespace AddHost lt IP_Address gt Default CIM Credentials If you specify the command with the CIM method m cim without specifying 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 defaults are used username root password root namespace root emulex portnum 5988 Example of Using the CIM Interface to Display Adapters In Windows to display a list of adapters managed for a specified host using the CIM interface run the following command C Program Files Emulex Util OCManagershbacmd h 10 192 113 128 m cim u root p root n root emulex listhbas The output displayed is similar to the following example 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 0
143. p to four iSNS servers if you are using the OCe14000 family of adapters and includes IPv6 addresses as well as IPv4 addresses This command also indicates whether or not iSNS discovery is enabled Note The iSNS server discovery mechanism using DHCP discovers only IPv4 addresses Supported By Linux Solaris VMware ESXi and Windows Syntax ShowiSNSServer MAC Address gt Parameters MAC Address The MAC address of an iSCSI port ShowRouteTable This command shows the route table for a specific port Supported By Linux Solaris VMware ESXi and Windows Syntax ShowRouteTable lt MAC Address gt Parameters MAC Address The MAC address of an iSCSI port Example hbacmd h 10 192 203 240 ShowRouteTable 00 00 c9 a0 ce 77 OneCommand Manager Command Line Interface Version 10 2 User Manual P010067 01A Rev A e 5 CLI Client Command Descriptions 109 gt G EMULEX iSCSI Commands ShowTarget This command shows the properties for a specified target If you do not specify the iSCSI target name lt iscsi_target_name gt all targets and their associated properties return If you specify lt refreshtargets gt in place of the lt iscsi_target_name gt all targets are refreshed before returning the information If you do not provide a lt iscsi_target_name gt or lt refreshtargets gt value only the targets from the last refresh are displayed Supported By Linux Solaris VMware ESXi and Windows Syntax ShowTarget lt MAC
144. password The login password of the VMware ESXi namespace The namespace where the Emulex provider is registered in the SFCB CIMOM of VMware ESXi specifically root emulex portnum The port number of the SFCB CIMOM listening to that is 5988 HTTP or 5989 HTTPS SetPfcThrottle This command returns the PFC throttle state as enabled or disabled Note The PFC throttle state is returned when using the PortAttributes command for OneConnect OCe10102 adapters However for OneConnect adapters with older firmware that does not support PfcThrottle and for non OneConnect adapters the PFC throttle state is not returned when using the PortAttributes command Supported By Linux Solaris VMware ESXi and Windows Syntax SetPfcThrottle lt WWPN gt lt 0 1 gt Parameters WWPN The WWPN of an FC or FCoE port o 1 The PFC throttle state 0 Disabled 1 Enabled SRIOVEnable This command enables or disables SR IOV on a specified NIC port that is physical function Notes e This command is not available on OCe11101 EM EX or OCe11102 EM EX adapters The following error will be returned ERROR lt 251 gt Hardware or firmware does not support command e SR IOV is not supported with RoCE configurations e SR IOV is not supported with UMC commands or channel management commands OneCommand Manager Command Line Interface Version 10 2 User Manual P010067 01A Rev A DE EMULEX 5 CLI Client Command Descriptions 124 M
145. ple hbacmd h 10 192 193 154 m cim u root p Swamiji001 n root emulex GetDumpFile BG HBANYWARE 15 10000000c97d1314 20100120 032820421 dmp GetDumpFileNames This command gets the names of the files in the remote host s dump directory Supported By Linux Solaris VMware ESXi and Windows Syntax GetDumpFileNames lt WWPN MAC gt Parameters WWPN The WWPN of an FC or FCoE port MAC The MAC address of a NIC or iSCSI port Example hbacmd h 10 192 193 154 m cim u root p Swamiji001 n root emulex GetDumpFileNames GetRetentionCount This command shows the maximum number of diagnostic dump files to keep Supported By Linux Solaris VMware ESXi and Windows Syntax GetRetentionCount lt WWPN MAC gt Parameters WWPN The WWPN of an FC or FCoE port MAC The MAC address of a NIC or iSCSI port OneCommand Manager Command Line Interface Version 10 2 User Manual P010067 01A Rev A 5 CLI Client Command Descriptions SE EMULEX Dump Commands g SetDumpDirectory This command sets the dump directory for the VMware ESXi hosts only Supported By VMware ESXi To use the SetDumpDirectory command you must have a directory which must be a Storage partition mapped under vmfs volumes where the files will be dumped This directory points to the internal hard disk or an external storage area and can also be mapped using the vSphere Client utility from VMware The application checks for the dump directory and creates the
146. port 0 Disables UMC 1 Enables UMC Example gt hbacmd UmcEnable 00 00 c9 bb cc aa 1 UmcGetParams Note This command has been replaced by the CMGetParams command and is provided for backward compatibility for OCe11100 series adapters only This command shows the current UMC configuration for an adapter s physical port The comman s output is the current UMC state for the adapter followed by a table showing the por s channels and their UMC properties The Type property also shows the protocol that is running on the channel This is controlled by the ChangePersonality and SetAdapterPortConfig commands not the UMC commands See ChangePersonality on page 130 and SetAdapterPortConfig on page 137 for more information OneCommand Manager Command Line Interface Version 10 2 User Manual P010067 01A Rev A 5 CLI Client Command Descriptions 159 gt lt EMULEX UMC Commands Supported By Linux Solaris VMware ESXi and Windows Syntax UmcGetParams lt WWPN MAC Address gt Parameters WWPN WWPN of an FCoE function on the physical port MAC Address MAC address of any NIC function on the adapter port Example All NIC gt hbacmd UmcGetParams 00 00 c9 bb cc aa Active UMC State Enabled Configured UMC State Enabled Func Type MAC Address LPVID Min BW Max BW 0 NIC 00 00 c9 bb cc aa 2 25 50 1 NIC 00 00 c9 bb cc ab 3 0 0 2 NIC 00 00 c9 bb cc ac 4 25 50 3 NIC 00 00 c9 bb cc ad 5 50 75 NIC Plus Storage gt hba
147. pported By Linux Solaris VMware ESXi and Windows Syntax SetPortEnabled lt WWPN MAC gt lt PortEnable gt OneCommand Manager Command Line Interface Version 10 2 User Manual P010067 01A Rev A e 5 CLI Client Command Descriptions 54 2 EMULEX Authentication Commands Parameters WWPN The WWPN of an FC or FCoE port MAC The MAC address of a NIC or iSCSI port PortEnabled The port enabled state 0 Disabled 1 Enabled Authentication Commands These commands are used to configure a DHCHAP connection between an FC port and a switch port Note Authentication commands are supported on FC adapter ports only These commands are not available on OneConnect or LPe16000 family adapters AuthConfigList This command returns the list of WWPNs that have an authentication connection configuration with the specified adapter Supported By Linux Solaris and Windows Syntax AuthConfigList lt WWPN gt Parameters WWPN The WWPN of an FC port DeleteAuthConfig This command deletes the authentication configuration on the adapter Supported By Linux Solaris and Windows Syntax DeleteAuthConfig lt WWPN1 gt lt WWPN2 gt lt PasswordType gt lt Password gt OneCommand Manager Command Line Interface Version 10 2 User Manual P010067 01A Rev A DE EMULEX 5 CLI Client Command Descriptions 55 Authentication Commands Parameters WWPN1 The WWPN of an FC port WWPN2 Use ff ff ff ff ff ff ff ff for a switch o
148. r more details see the OneCommand Manager for VMware vCenter User Manual For supported versions of operating systems platforms and adapters see the Emulex website Abbreviations ARI Alternative Routing ID Interpretation ARP address resolution protocol ASIC application specific integrated circuit BIOS basic input output system CEE Converged Enhanced Ethernet CFA converged fabric adapter CHAP Challenge Handshake Authentication Protocol CIM Common Interface Model CIMOM Common Information Model Object Manager CIN Cisco Intel Nuova data center bridging exchange CLI command line interface DAC direct attach copper OneCommand Manager Command Line Interface Version 10 2 User Manual P010067 01A Rev A gt EMULEX D ID DCB DCBX DH DHCHAP ETO FAT FC FCoE FEC FIP GUI HBA hex iBFT ICMP IP iSCSI iSNS LACP LLDP LPFC LPVID LUN MAC MILI MSI MTU NFS NIC NPAR NPVID NVP PFC PGID PGBW PHY OneCommand Manager Command Line Interface Version 10 2 User Manual 1 Introduction 12 Abbreviations destination ID data center bridging data center bridging exchange Diffie Hellman Diffie Hellman Challenge Handshake Authentication Protocol Extended TimeOut file allocation table Fibre Channel Fibre Channel over Ethernet forward error correction FCoE Initialization Protocol graphical user interface host bus adapter hexadecimal iSCSI boot firmware table Internet Control Message Protocol Internet Pro
149. r the adapter Supported By Linux Solaris VMware ESXi and Windows Syntax DeleteDumpFiles lt WWPN MAC gt Parameters WWPN The WWPN of an FC or FCoE port MAC The MAC address of a NIC or iSCSI port Dump This command creates a diagnostic dump file in the HbaCmd dump file directory Note In some cases a core dump can be performed on an inoperative OneConnect adapter To view inoperable adapters on the local host use the ListHBAs down command See ListHBAs on page 121 Note For OneConnect adapters if the core optional parameter is not specified an Enhanced FAT Dump is performed by default Supported By Linux Solaris VMware ESXi and Windows Syntax Dump lt WWPN MAC gt core Options Parameters WWPN The WWPN of an FC or FCoE port MAC The MAC address of a NIC or iSCSI port core Perform a core dump on a OneConnect adapter local host only Options For available core dump options contact Emulex technical support OneCommand Manager Command Line Interface Version 10 2 User Manual P010067 01A Rev A 5 CLI Client Command Descriptions SE EMULEX Dump Commands ga GetDumpDirectory This command shows the dump file directory for the adapters in the host Notes e The dump directory can be set on VMware ESXi hosts only e The dump directory applies to all adapters in the server There is not a separate dump directory for each adapter Supported By Linux Solaris VMware ESXi and
150. r use the WWPN for a target PasswordType 1 ASCII 2 Hex binary 3 Password not yet defined Password The current password value GetAuthConfig This command retrieves the authentication configuration for the adapter Supported By Linux Solaris and Windows Syntax hbacmd GetAuthConfig lt WWPN1 gt lt WWPN2 gt Parameters WWPN1 The WWPN of an FC port WWPN2 Use ff ff ff ff ff ff ff ff for a switch or use the WWPN for a target GetAuthStatus This command returns the current status for the authentication connection specified by WWPN 1 and WWPN2 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 Supported By Linux Solaris and Windows Syntax GetAuthStatus lt WWPN1 gt lt WWPN2 gt Parameters WWPN1 The WWPN of an FC port WWPN2 Use ff ff ff ff ff ff ff ff for a switch or use the WWPN for a target OneCommand Manager Command Line Interface Version 10 2 User Manual P010067 01A Rev A 5 CLI Client Command Descriptions gt lt EMULEX Authentication Commands 56 InitiateAuth This command initiates the authentication configuration on the adapter Supported By Linux Solaris and Windows Syntax InitiateAuth lt WWPN1 gt lt WWPN2 gt Parameters WWPN1 The WWPN of a
151. rams These commands are not available SetDCBParam on OCe11101 EM EX or 0Ce11102 EM EX adapters See GetPGInfo DCB Commands on page 66 SetDCBPriority SetCnaP GBW ERROR lt 251 gt Hardware or firmware SRIOVEnable These commands are not available does not support command UmcEnable on OCe11101 EM EX or UmcGetP 0Ce11102 EM EX adapters See meserrarams SRIOVEnable on page 123 and UmcSetBW UMC Commands on page 157 UmcSetLPVID SetPhyPortSpeed Error lt 431 gt Cable length required SetPhyPortSpeed This error is displayed when a for force mode and interface type OneCommand Manager Command Line Interface Version 10 2 User Manual length value is not included when the mode is set to 2 Example hbacmd setphyportspeed 00 00 c9 a9 41 88 2 100Mb See Examples on page 53 P010067 01A Rev A 169
152. rkConfiguration SetTargetLoginProperties SetTargetProperties SetTPLoginProperties ShowARPTable ShowiSNSServer ShowRouteTable ShowTarget ShowTargetPortal OneCommand Manager Command Line Interface Version 10 2 User Manual P010067 01A Rev A gt G EMULEX Targetlogin TargetLogout UpdateiSNSServer LUN Masking Commands GetLunList GetLunUnmaskByHba GetLunUnmaskByTarget RescanLuns SetLunMask ExpressLane Commands GetExpressLaneLunList SetExpressLaneLunState Miscellaneous Commands AddHost CnaGetEventLog CnaClearEventLog Download ExportSANInfo FecEnable GetCimCred GetElxSecInfo GetQoSInfo GetVPD ListHBAs ListVFuncs RemoveHost Reset SetCimCred SetPfcThrottle SRIOVEnable TargetMapping VEPAEnable Persistent Binding Commands AllNodeInfo BindingCapabilities BindingSupport PersistentBinding RemoveAllPersistentBinding RemovePersistentBinding SetBindingSupport SetPersistentBinding Profile Management Commands ListProfiles GetAdapterPortConfig SetAdapterPortConfig Personality Management Commands ShowPersonalities ChangePersonality UMC Universal MultiChannel Commands see Channel Management Commands UmcGetParams UmcEnable UmcSetLPVID UmcSetBW VPort Commands CreateVPort DeleteVPort ListVPorts VPortTargets ListVMs WWN Management Commands ChangeWWN GetWWNCap ReadWWN RestoreWWN Example 2 This help command example shows the details for the SetDCBParam command hbacmd
153. rlD v N v v 49 ShowPersonalities N v N v 132 ShowRouteTable v v v v 108 ShowTarget v v v v 109 ShowTargetPortal v N v N 109 SRIOVEnable v v v v v 123 TargetLogin v N v v 110 TargetLogout v v v v 111 TargetMapping v v vi v vi 124 TDRTest N v N N 79 UmcEnable N v N N v 158 UmcGetParams v v N v v 158 UmcSetBw N v N y v 160 UmcSetLPVID v v v v v 161 UpdateiSNSServer v v v v 112 VEPAEnable N v N v 124 Version N v N v 125 VPortTargets v v v 164 Wakeup v v v v 80 a iSCSI management is not supported using the CIM interface OneCommand Manager Command Line Interface Version 10 2 User Manual P010067 01A Rev A 44 e 5 CLI Client Command Descriptions 45 DE EMULEX Help Help The Help command displays command information for the HbaCmd application Without using its optional parameters the Help command lists all the commands in their respective groups Using the optional parameter GroupName it lists the commands in a group Using the optional parameter CmdName it shows the details for a specific command Supported By Linux Solaris VMware ESXi and Windows Syntax Help GroupName CmdName Parameters GroupName This optional parameter lists the commands in a particular group CmdName This optional parameter shows the details for a particular CLI command Example 1 This help command example lists all the commands in their respective groups hbacmd help The
154. rsion 10 2 User Manual P010067 01A Rev A DE EMULEX 5 CLI Client Command Descriptions 75 Diagnostic Commands GetXcvrData This command shows transceiver data for a port on an adapter Supported By Linux Solaris VMware ESXi and Windows Syntax GetXcvrData lt WWPN MAC gt Type Parameters WWPN The WWPN of an FC or FCoE port MAC The MAC address of a NIC or iSCSI port Type The type of SFP data to display e 1 Formatted data e 2 Raw data Example C Program Files emulex Util OCManagershbacmd h 10 192 203 154 m cim u root p Swamiji001 n root emulex GetXcvrData 00 00 c9 93 2f d6 LoadList Note This command is not supported for OneConnect and LPe16202 series adapters This command shows the flash memory load list data for the adapter Supported By Linux Solaris VMware ESXi and Windows Syntax LoadList lt WWPN gt Parameters WWPN The WWPN of the adapter OneCommand Manager Command Line Interface Version 10 2 User Manual P010067 01A Rev A 5 CLI Client Command Descriptions SE EMULEX Diagnostic Commands ne LoopBackTest This command runs one of the loopback tests available on the adapter port specified by the WWPN or MAC address Notes e PHY diagnostics are not supported on mezzanine cards and blade network daughter cards because they do not contain PHYs e The external loopback test is not supported for OCe11102 xT adapters Supported By Linux Solaris VMware ESXi and Windows S
155. rt 2 p1 NIC 5 CLI Client Command Descriptions UMC Commands Note pN labels are the port parameter names to use in the SetAdapterPortConfig command e g pO NIC FCoE p1 NIC iSCSI UMC Commands The adapter s physical ports provide a converged conduit for network and storage traffic Each channel has its own unigue MAC address Each channel provides traffic management capabilities such as enabling and disabling minium and maximum bandwidth and VLAN ID for untagged packets For additional information on UMC refer to the Emulex Universal Multichannel Reference Guide The CLI s UMC commands allow viewing of the UMC configuration enabling and disabling of the UMC at the adapter level and the modification of some of the channel properties The UMC commands cannot be used to manage other channel management types see Channel Management Commands on page 60 for more information UMC commands are available only on OneConnect adapters Notes e SR IOV is not supported with UMC e The UMC command UmcSetChanLink is no longer available Its functionality can be performed by the UmcSetBw command by setting the min and max bandwidths to 0 e Properties for all channels on a port can be viewed and modified with the UMC commands even when UMC is disabled This allows enabling and configuration of UMC on all channels and rebooting and running UMC without further configuration e For IBM adapters UMC mode ma
156. s command on page 60 and review the Available Modes field Disable multichannel on an adapter by setting the mctype to None When enabling multichannel the additional function protocols must be specified for the extra channels that are not available when multichannel is disabled Note The CMMode command used to enable or disable multichannel for OCe10100 and OCe11100 series adapters cannot be used on OCe14000 series adapters Using this command on OCe14000 series adapters generates an error message Examples Enable Multichannel for UMC gt hbacmd SetAdapterPortConfig 00 00 c9 12 34 56 pO nic iscsi nic nic pl nic fcoe nic nic p2 nic fcoe nic nic p3 nic iscsi nic nic mctype umc Disable Multichannel gt hbacmd SetAdapterPortConfig 00 00 c9 12 34 56 pO snic iscsi pl nic fcoe p2 nic fcoe p3 nic iscsi mctype none Showing Multichannel Configuration The CMGetParams command shows the current multichannel configuration for an adapter s physical port See CMGetParams on page 60 for more information Setting Channel Protocols using SetAdapterPortConfig Use the SetAdapterPortConfig command to configure the protocols running on the channels or functions The following rules apply when using SetAdapterPortConfig with non NPar multichannel enabled e The first function must always be NIC other functions can be None e If NIC RoCE is specified on any port all other ports must be either NIC or NIC R
157. s 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 Supported By Linux Solaris VMware ESXi and Windows Syntax ShowAdapterLicenseFeatures lt WWPN MAC gt Parameters WWPN The WWPN of an FCoE port MAC The MAC address of a NIC or iSCSI port Examples For non VMware ESXi hosts hbacmd ShowAdapterLicenseFeatures 00 12 34 56 78 9A For VMware ESXi hosts hbacmd h lt IP Address gt m cim u root p lt password gt n lt namespace gt ShowAdapterLicenseFeatures 00 12 34 56 78 9A ShowAdapterLicenselD This command returns the adapter ID used for enabling licensed features The adapter ID and the entitlement code are used to obtain license keys which enable various features on the adapter Supported By Linux Solaris VMware ESXi and Windows Syntax ShowLicenseAdapterID lt WWPN MAC gt OneCommand Manager Command Line Interface Version 10 2 User Manual P010067 01A Rev A DE EMULEX 5 CLI Client Command Descriptions 50 Attributes Commands Parameters WWPN The WWPN of an FCoE port MAC The MAC address of a NIC or iSCSI port Examples For non VMware ESXi hosts hbacmd ShowLicenseAdapterID 00 12 34 56 78 9A For VMware ESXi hosts hbacmd h lt IP Address gt m cim u root p lt password gt n lt namespace gt ShowLicenseAdapterID 00 12 34 56 78 9A Attributes Commands HbaAttributes This command shows a list of
158. s string length 11 255 TSIH The TSIH value of the session The possible values are 1 65535 ISID Qual The ISID gualifier of the session The possible values are 0 65535 Target IP The target s IP address OneCommand Manager Command Line Interface Version 10 2 User Manual P010067 01A Rev A re e 5 CLI Client Command Descriptions 112 gt G EMULEX LUN Masking Commands UpdateiSNSServer This command updates a configured iSNS server and accepts IPv4 or IPv6 iSNS server addresses This command requires the server IP lt Server_IP gt and port number lt Port gt of the iSNS server to be available to respond to the iSNS requests If a single iSNS server is configured this command replaces the single iSNS server IP address with a new IP address If no iSNS server is configured this command adds a new iSNS server Note If two or more iSNS servers are already configured any attempt to use this command results in an error Supported By Linux Solaris VMware ESXi and Windows Syntax UpdateiSNSServer MAC Address gt lt Server_IP gt lt Port gt Parameters MAC Address The MAC address of an iSCSI port Server 1P IP address of the iSNS server to configure You can specify an IPv4 or IPv6 server IP address Port Port number of the iSNS server to configure value 1024 65535 LUN Masking Commands Notes e Supported for FC FCoE ports only e Linux does not support the GetLunUnMaskByHBA GetLunUnMaskByTarget and SetLunMask
159. s all values to the default for the adapter s Supported By Linux VMware ESXi and Windows Syntax SetDriverParamDefaults lt WWPN gt lt Flagl gt lt Flag2 gt Parameters WWPN The WWPN of an FC or FCoE port Flagl L Make change local for this adapter only G Make change global applies to all adapters on this host Flag2 P Make change permanent the change persists across reboot T Make change temporary 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 operating system information This information is useful when troubleshooting an adapter but is unavailable in read only mode Caution Disruption of service can occur if a diagnostic dump is run during I O activity The dump files created are text files tx extension and binary files The extension for binary files depends on the adapter type e OneConnect and LPe16202 adapters Enhanced FAT Dump edf extension e OneConnect adapters Core Dump core extension e LPe16000 series adapters except LPe160202 bin extension e LPe12000 and LPe11000 series adapters dmp extension OneCommand Manager Command Line Interface Version 10 2 User Manual P010067 01A Rev A 5 CLI Client Command Descriptions SE EMULEX Dump Commands sa DeleteDumpFiles This command deletes all diagnostic dump files fo
160. s associated with a specific target This command requires that you specify a valid iSCSI target name lt iscsi_target_name gt 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 lt Auth gt to a value other than 0 you must set additional parameters Each string should be enclosed in quotations to avoid mishandling by the Windows Linux Solaris or VMware shell s parser e If you set the authentication method to One Way CHAP lt Auth gt 1 you must also specify the Target CHAP Name and Target Secret For example hbacmd SetTargetLoginProperties 00 11 22 33 44 55 iscsitarget Auth 1 TgtCHAPName TargetSecretl1 e If you set the authentication method to Mutual CHAP lt Auth gt 2 you must specify all four values For example hbacmd SetTargetLoginProperties 00 11 22 33 44 55 iscsitarget Auth 2 TgtChapName TargetSecret1 InitCHAPName InitialSecret1 Supported By Linux Solaris VMware ESXi and Windows Syntax SetTargetLoginProperties lt MAC Address gt lt iscsi target name gt ImmediateData lt 0 1 gt HeaderDigest lt 0 1 gt DataDigest lt 0 1 gt Auth lt 0 1 2 gt TgtCHAPName TgtSecret InitCHAPName InitSecret Parameters MAC Address The MAC address
161. s command enables or disables channel management mode on OCe10100 and OCe11100 series adapters For UMC configurations the UMCEnable command can still be used to enable UMC only This command also sets the channel management type at the adapter level A system reboot is required for the change take effect Note For OCe14000 series adapters you must set the mctype parameter in the SetAdapterPortConfig command to enable multichannel including NPar See the SetAdapterPortConfig command for more information If you use the CMMode command on an OCe14000 series adapter an error message is displayed indicating the command is not supported by the firmware or hardware Supported By Linux Solaris VMware ESXi and Windows Syntax hbacmd CMMode lt WWPN MAC Address gt lt None Type gt Parameters WWPN WWPN of an FCoE function on the physical port MAC MAC address of any NIC function on the physical adapter port None Specify None to disable channel management or a channel Type Management type see CMGetParams to enable channel management Example gt hbacmd CMMode 00 00 c9 bb cc aa None This example disables channel management on an adapter containing a NIC function with a MAC address of 00 00 c9 bb cc aa CMSetBW This command sets the minimum and maximum bandwidths for each channel on the physical port For UMC SIMode configurations this command can also be used to disable a channel s logical link by setting both
162. t Pin 0x01 Minimum Grant 0x00 Maximum Latency 0x00 Capabilities Ptr 0x40 PostTest Note Not supported for OneConnect and LPe15000 or LPe16000 series adapters This command runs the POST on the adapter Supported By Linux Solaris VMware ESXi and Windows Syntax PostTest lt WWPN gt Parameters WWPN The WWPN of the FC port SetBeacon This command turns the beacon on or off Supported By Linux Solaris VMware ESXi and Windows Syntax SetBeacon lt WWPN gt lt BeaconState gt Parameters WWPN The WWPN of an FC port MAC The MAC address of a NIC or iSCSI port BeaconState Indicates the state of the beacon to be set to 0 Off 1 On OneCommand Manager Command Line Interface Version 10 2 User Manual P010067 01A Rev A DE EMULEX 5 CLI Client Command Descriptions 79 Diagnostic Commands SetCableNVP Note This command supports only OCe11100 series adapters and LPe16202 adapters This command sets the NVP required for the TDRTest command for the cable that connects to the physical port associated with the WWPN or MAC Supported By Linux Solaris VMware ESXi and Windows Syntax SetCableNVP lt WWPN MAC gt lt NVP gt Parameters WWPN The WWPN of an FC or FCoE port MAC The MAC address of a NIC or iSCSI port NVP A percentage value between 1 and 100 Consult your cable documentation to obtain the proper NVP value TDRTest Note This command only supports OneConnect adapters that use coax
163. t must be an available multichannel type or set to None to disable multichannel If not specified the currently configured multichannel type including None remains unchanged See CMGetParams command on page 60 for available multichannel types e Ifthe functions being set to None are the last function s on a port they do not need to be specified For example pO nic iscsi none can be shortened to p0 nic iscsi e NParEP Mode can only be specified when the mctype parameter is set to NPar or when the currently configured multichannel type is NPar e When disabling NPar that is mctype none NParEP Mode is automatically disabled e A reboot is required to activate the new port configuration Examples Mixed Mode gt hbacmd SetAdapterPortConfig 00 00 c9 12 34 56 p0 nic iscsi pl nic fcoe p2 nic fcoe p3 nic gt hbacmd GetAdapterPortConfig 00 00 c9 12 34 56 Number of Ports 4 Maximum FCoE Functions 4 Maximum iSCSI Functions sA Mixed Mode I O Allowed Yes Concurrent Mode I O Allowed No ROCE Functions Allowed Yes RebootRequired Yes Active Configuration OneCommand Manager Command Line Interface Version 10 2 User Manual P010067 01A Rev A gt EMULEX Profile ID MCType 37 None Port Assignments Dr Port Port Port Port 1 2 3 NIC iSCSI NIC FCoE NIC iSCSI NIC FCOE Reboot Configuration Profile ID 37 MCType None Port Assignments Port Port Port Port Note
164. t_IP_Address gt OneCommand Manager Command Line Interface Version 10 2 User Manual P010067 01A Rev A 5 CLI Client Command Descriptions gt lt EMULEX iSCSI Commands 91 Parameters MAC Address The MAC address of the iSCSI port Dest MAC Address The destination MAC address to add to the ARP table Dest Ip Address The destination IP address to add to the ARP table AddiSNSServer This command adds a new iSNS server to the existing set of iSNS servers It accepts either an IPv4 or IPv6 server addresses Note For OCe11000 series and OCe11100 series adapters only one iSNS server can be configured For OCe14000 series adapters up to four iSNS servers can be configured Supported By Linux Solaris VMware ESXi and Windows Syntax AddiSNSServer lt MAC Address gt lt Server 1P gt lt Port gt Parameters MAC Address The MAC address of an iSCSI port Server 1P IP address of the iSNS server to configure Port Port number of the iSNS server to configure value 1024 65535 AddRouteTableEntry This command adds a new route table entry to the route table of the specified port Supported By Linux Solaris VMware ESXi and Windows Syntax AddRouteTableEntry MAC Address gt Dest IP Address gt lt Subnet Mask gt lt Gateway gt Parameters MAC Address MAC address of an iSCSI 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 a
165. tch the driver type of the host platform adapter Supported By Linux VMware ESXi and Windows Syntax DriverConfig lt WWPN gt lt FileName gt lt Flag gt Parameters WWPN The WWPN of an FC or FCoE port FileName The name of the dpv file which is stored in the Emulex Repository directory Flag G gt Make change global all adapters on this host N Make change non global adapter specific GetDriverParams This command shows the name and values of each parameter Supported By Linux Solaris VMware ESXi and Windows Syntax GetDriverParams lt WWPN gt Parameters WWPN The WWPN of an FC or FCoE port GetDriverParamsGlobal This command shows the name and the global value of each driver parameter Supported By Linux Solaris VMware ESXi and Windows Syntax GetDriverParamsGlobal lt WWPN gt Parameters WWPN The WWPN of an FC or FCoE port OneCommand Manager Command Line Interface Version 10 2 User Manual P010067 01A Rev A DE EMULEX 5 CLI Client Command Descriptions 82 Driver Parameter Commands SaveConfig 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 has the following syntax lt parameter name gt lt parameter value gt The command saves either the values of the global set or those specific to the adapter in the Emulex
166. ter License Management Commands ShowLicenseAdapterID InstallAdapterLicense ShowAdapterLicenseFeatures Attributes Commands HbaAttributes PortAttributes PortStatistics ServerAttributes SetPhyPortSpeed SetPortEnabled Authentication Commands AuthConfigList DeleteAuthConfig GetAuthConfig GetAuthStatus InitiateAuth SetAuthConfig SetPassword Boot Commands EnableBootCode GetBootParams SetBootParam CM Channel Management Commands CMGetParams CMMode CMSetLPVID CMSetBW DCB Commands GetDCBParams SetDCBParam GetPGInfo SetDCBPriority SetCnaPGBW Diagnostic Commands DPortTest EchoTest GetBeacon GetXcvrData LoadList LoopBackTest LoopMap PciData PostTest SetBeacon SetCableNVP TDRTest Wakeup Driver Parameter Commands DriverConfig GetDriverParams GetDriverParamsGlobal SaveConfig SetDriverParam SetDriverParamDefaults Dump Commands DeleteDumpFiles Dump GetDumpDirectory SetDumpDirectory GetRetentionCount SetRetentionCount GetDumpFileNames GetDumpFile FCoE Commands GetFIPParams SetFIPParam GetFCFInfo iSCSI Commands AddARPTableEntry AddRouteTableEntry AddTarget AddTargetPortal CleariSNSServer DelARPTableEntry DelRouteTableEntry DiscoveriSNSServer ExportiSCSI GetInitiatorProperties GetiSCSILuns GetiSCSIPortStats GetNetworkConfiguration GetSessionInfo ImportiSCSI iSCSIPing ListSessions RemoveTarget RemoveTargetPortal SetBootTargetSession SetInitiatorProperties SetiSCSIBoot SetNetwo
167. the min and max bandwidths to 0 To bring the logical link back up enable specify a non zero value for the minimum and maximum bandwidth If you are using NPar setting the minimum bandwidth to zero does not bring the logical link down on the NPar function or prevent the NPar function from receiving or transmitting a small amount of network traffic OneCommand Manager Command Line Interface Version 10 2 User Manual P010067 01A Rev A 5 CLI Client Command Descriptions 64 SE EMULEX Channel Management Commands The number of channels the number of channels that need to be specified and the number of bandwidth combinations that need to be specified depend upon the adapter model See CMGetParams on page 60 to determine how many bandwidths need to be specified for a port by looking at the number of functions indicated in the Func column of the output The total of the minimum bandwidths for the enabled channels or partitions NPar must add up to 100 An exception to this rule is for UMC and SIMODE configurations when both the minimum and maximum bandwidth for all channels are 0 effectively bringing down the logical link on all channels The maximum bandwidth must be greater than or equal to the minimum bandwidth for that channel or partition NPar up to a maximum value of 100 Notes e If too many or too few minimum and maximum bandwidth combinations are provided an error is generated e This command fails with an error
168. the state of a vPort LUN Target WWPN The WWPN of the target LUNs LUN The LUN number on which to set the ExpressLane status Note Obtain the LUN number from the output of the GetExpressLaneLunList command under the OS LUN column State 0 Disable ExpressLane 1 Enable ExpressLane Option 0 Set ExpressLane LUN state in driver temporary until reboot 1 Set ExpressLane LUN state in the configuration to persist across reboots 2 Set ExpressLane LUN state in both driver and in the configuration to persist across reboots Example gt hbacmd h 10 192 87 198 SetExpressLaneLUNState 10 00 00 00 00 87 01 98 20 22 d4 ae 52 6e 6f 08 2 1 2 Miscellaneous Commands AddHost 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 Supported By Linux Solaris and Windows Syntax To add non VMware ESXi hosts hbacmd AddHost lt host_address gt Note The h option for specifying an optional IP address or host name after hbacmd is not available for the AddHost command To add VMware ESXi hosts to Windows OCM hbacmd m cim u lt username gt p lt password gt n lt namespace gt AddHost lt IP_Address gt If the username password and namespace are not specified see Default CIM Credentials on page 34 OneCommand Manager Command Line Interface Version 10 2 User Manual P010067 01A Rev A DE EM
169. tiSCSI lt Import File gt clean Parameters Import File The name of XML file containing import information that was generated by the ExportiSCSI command see ExportiSCSI on page 96 clean Erases entire iSCSI configuration on all iSCSI ports before importing targets Note This command fails if the system is booted from an iSCSI target Example In this example the command imports the iSCSI targets found in the targets xml file to the iSCSI ports found on the host and erases the iSCSI configuration including targets of all iSCSI ports on these host before importing the targets hbacmd ImportiSCSI targets xml clean The example output All existing targets have been removed Added target ign 2006 01 com openfiler target121 000 on port 00 00 c9 be la 24 Added target ign 2006 01 com openfiler target121 001 0n port 00 00 c9 be la 24 OneCommand Manager Command Line Interface Version 10 2 User Manual P010067 01A Rev A e 5 CLI Client Command Descriptions 100 gt G EMULEX iSCSI Commands Added target iqn 2006 01 com openfiler target122 000 on port 00 00 c9 2f 45 1b Added target ign 2006 01 com openfiler target122 001 0n port 00 00 c9 2f 45 1b iSCSIPing This command issues ICMP echo requests to a target Supported By Linux Solaris VMware ESXi and Windows Syntax iSCSIPing lt MAC Address gt lt IP Address gt Parameters MAC Address The MAC address of an iSCSI port Ip Address IP address of target to send ICMP echo r
170. tion helps to determine the appropriate profile ID to specify to the ChangePersonality and SetAdapterPortConfig commands required for RoCE and NIC only configurations The specific profiles listed may vary according to the adapter model Note RoCE is only available on Windows operating systems Supported By Linux Solaris VMware ESXi and Windows OneCommand Manager Command Line Interface Version 10 2 User Manual P010067 01A Rev A 5 CLI Client Command Descriptions 137 SE EMULEX Profile Management Commands Syntax ListProfiles lt MAC WWPN gt Parameters MAC MAC address of any NIC NIC ROCE or iSCSI function on the adapter WWPN WWPN of any FC FCoE function on the adapter Example Note Different adapter models will have a different set of profiles gt hbacmd ListProfiles 00 00 c9 12 34 56 Active Profile ID 23 Configured Profile ID 23 Available Profiles ID Description 16 NIC 17 ISCSI initiator no DIF 19 FCOE initiator Target with DIF 20 ROCE 1 21 ROCE 2 23 FCOE initiator Target no DIF 24 NIC ETS Disabled 36 Mixed Storage 25 ISCSI initiator only 75 FCOE no DIF 37 Mixed Storage 50 ISCSI initiator only 50 FCOE no DIE 38 Mixed Storage 75 ISCSI initiator only 25 FCOE no DIF SetAdapterPortConfig This command configures the function protocol assignments for all ports on an OCe14000 series adapter It can also be used to restore the adapter to its factory default profile and settings The
171. to the switch Supported By Linux Solaris and Windows Syntax SetPassword lt WWPN1 gt lt WWPN2 gt lt Flag gt lt Cpt gt lt Cpw gt lt Npt gt lt Npw gt Parameters WWPN1 The WWPN of an FC port WWPN2 Must be ff ff ff ff ff ff ff ff for a switch or the actual WWPN for a target Flag 1 Local password used by the adapter when the adapter authenticates to the switch 2 Remote password used by the adapter when the switch authenticates to 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 OneCommand Manager Command Line Interface Version 10 2 User Manual P010067 01A Rev A DE EMULEX 5 CLI Client Command Descriptions 58 Boot Commands Boot Commands EnableBootCode This command is used to perform either of the following e Enable or disable network boot for NIC ports If network boot is being enabled it is necessary to select the specific network boot type The supported network boot types are PXE and iBFT Note that iBFT is not supported on all NIC adapter types e Enable disable the boot code for an FC adapter port If the boot code is disabled on the FC adapter the adapter does not boot from the SAN regardless of the value for the EnableBootFromSan boot parameter If the boot code is enabled on the FC adapter the adapter boots from the SAN if t
172. to the specified virtual port Supported By Linux Solaris and Windows Syntax VPortTargets lt physical WWPN gt lt virtual WWPN gt Parameters physical WWPN The WWPN of an FC or FCoE port virtual WWPN The WWPN of the virtual port OneCommand Manager Command Line Interface Version 10 2 User Manual P010067 01A Rev A 5 CLI Client Command Descriptions SE EMULEX WWN Management Commands 169 WWN Management Commands Notes e Supported for FC FCoE adapter ports only e WWN management validates WWNs carefully to avoid WWPN duplication WWNN duplication is acceptable however Therefore you may see error and warning messages if a name duplication is detected It is strongly recommended 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 This command changes the volatile state of WWNs If the volatile change is requested on an adapter that does not support volatile WWNs it returns a not supported error Notes e 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 e For VMware ESXi o After changing the WWN of an adapter update your zoning settings before you reboot your ESXi server If the zoning is not updated before your reboot the subsequent boot may take a long time
173. tocol internet Small Computer System Interface internet Storage Name Server Link Aggregation Control Protocol link layer discovery protocol LightPulse Fibre Channel logical port VLAN ID logical unit number media access control Management Interface Library message signaled interrupts maximum transmission unit network file system network interface card or controller NIC partition N_Port_ID virtualization normal velocity of propagation priority based flow control priority group ID priority group bandwidth physical layer P010067 01A Rev A gt EMULEX POST PXE RHEL RM RPM SAN SCSI SFCB SFP SLES SR IOV SSH TCP TDR UCNA UEFI UFP UMC VEPA VPD VPort WWN WWNN WWPN VM XML 1 Introduction 13 Abbreviations power on self test Pre boot Execution Environment Red Hat Enterprise Linux remote management resource package manager storage area network Small Computer System Interface Small Footprint CIM Broker small form factor pluggable SUSE Linux Enterprise Server single root I O virtualization Secure Shell Transmission Control Protocol time domain reflectometer universal converged network adapter Unified Extensible Firmware Interface Universal Fabric Port Universal Multichannel Virtual Ethernet Port Aggregator vital product data virtual port world wide name world wide node name world wide port name virtual machine extensible markup language OneCommand Manager Command Line Interf
174. uired on RoCE ports only 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 000000 Diagnostic Commands DPortTest Notes e This command is only supported for LPe16000 Fibre Channel adapters connected to D_Port enabled Brocade switches e D_Port should not be enabled on the switch port D_Port also called ClearLink is a set of diagnostic tests that allows you to detect physical cabling issues that result in increased error rates and intermittent behavior The DPortTest command runs a series of tests including local electrical loopback loopback to the remote optics loopback from the remote port to the local optics and a full device loopback test with data integrity checks It also provides an estimate of cable length from the switch to the adapter to validate that a proper buffering scheme is in place The various tests allow some fault isolation so you can distinguish faults that are the result of marginal cables optics modules as well as connectors or optics seating If the adapter firmware SFP or switch do not support D_Port testing an error is generated Notes e D Port tests run with the physical connection in an offline diagnostic state so normal I O cannot be sent through the physical port while the test is in progress While the port is in D_Port mode the link will appear down on that port similar to an unplugged cable e The DPortTest command only runs in on d
175. ur user groups you belong to and will allow command usage as appropriate See OneCommand Manager Secure Management on page 14 for more information When the specified operation is completed the command prompt is displayed For a majority of commands the first parameter following the command is the WWPN or MAC address of the port that the command is to act upon CLI in Read Only Mode May Cause Error Message Note The CLI does not allow the execution of certain commands when it is configured for read only mode The following error message is returned 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 Version 10 2 User Manual P010067 01A Rev A i 4 CLI Client Command Usage 31 gt G EMULEX HbaCmd Syntax Usage HbaCmd Syntax Usage The following syntax rules and usage apply to the HbaCmd application e Parameters denoted within angle brackets lt gt are required e Parameters denoted within square brackets are optional e For Linux and Solaris which are case sensitive program names must be in lowercase letters therefore the command line must begin with hbacmd rather than HbaCmd Windows is not case sensitive so the program name is not reguired to be in all lowercase letters e Inorder to run the command on a remote host an IP address or host name must be specif
176. urrent I O Mode Allowed Yes ROCE Functions Allowed Yes RebootRequired Yes Active Configuration Profile ID 37 MCT ype None Port Assignments Port 0 NIC iSCSI FCoE Port 1 NIC FCoE None Port 2 NIC iSCSI None Port 3 NIC None None Reboot Configuration Profile ID 21 MCType None Port Assignments Port 0 p0 NIC RoCE None None Port 1 p1 NIC None None Port 2 p2 NIC None None Port 3 p3 NIC ROCE None None Note pN labels are the port parameter names to use in the SetAdapterPortConfig command e g pO NIC FCoE 1 NIC iSCSI OneCommand Manager Command Line Interface Version 10 2 User Manual P010067 01A Rev A 5 CLI Client Command Descriptions SE EMULEX Profile Management Commands da Multichannel Configurations Note ARI must be available to support sixteen functions on an adapter OCe14000 series adapters automatically support ARI However the system s motherboard must support ARI it must be enabled in the system BIOS and the operating system must support ARI If these conditions are not met although you may configure all sixteen functions only eight functions will be present and discovered by the OneCommand Manager application after a reboot Enabling and Disabling Multichannel Use the mctype parameter in the SetAdapterPortConfig command to enable or disable multichannel on an adapter This parameter is required to enable multichannel For a list of supported mctypes use the CMGetParam
177. v v 100 RemoveTargetPortal v N v N 101 RescanLuns k v v 113 Reset v N v N 122 RestoreWWN v N v v 167 SaveConfig v v v N 82 ServerAttributes v N v v 51 SetAdapterPortConfig v v N v 137 SetAuthConfig N v v 56 SetBeacon v y v v v 78 SetBindingSupport v v 128 SetBootParam v v k v 59 SetBootTargetSession v N v N 101 SetCableNVP v v y v 79 SetCnaPGBW v v v v v 67 SetCimCred v 122 SetDCBParam v v v v 68 SetDCBPriority v v v fe 70 SetDriverParam v y v v 82 SetDriverParamDefaults v N v N 83 SetDumpDirectory v 87 SetExpressLaneLUNState v v y 115 SetFIPParam v v v v 89 SetlnitiatorProperties v N v N 102 SetiSCSIBoot v v v v 103 SetLunMask v v 114 SetNetwork v v N v 103 Configuration SetPassword k v v 57 SetPersistentBinding v v 129 SetPfcThrottle v N v 123 SetPhyPortSpeed N v N 51 OneCommand Manager Command Line Interface Version 10 2 User Manual P010067 01A Rev A gt G EMULEX Table 5 1 CLI Client Command Reference Continued 5 CLI Client Command Descriptions VMware CIM Interface Command Linux Solaris ESXi Windows Support Page SetPortEnabled v v v v y 53 SetRetentionCount v v N v v 87 SetTargetLogin v v v v 105 Properties SetTargetProperties 106 SetTPLoginProperties 106 ShowAdapterLicense v v v v v 49 Features ShowARPTable v N v v 107 ShowiSNSServer N y v v 108 ShowLicenseAdapte
178. y be referred to as SIMODE e The UMC commands are not available on OCe11101 EM EX or OCe11102 EM EX adapters When attempting to use UMC commands with these adapters the following error is returned ERROR lt 251 gt Hardware or firmware does not support command OneCommand Manager Command Line Interface Version 10 2 User Manual P010067 01A Rev A 157 e 5 CLI Client Command Descriptions 158 gt G EMULEX UMC Commands UmcEnable This command enables or disables UMC on OCe10100 and OCe11100 series adapters at the adapter level A system reboot is required to make the change take effect Notes e The UmcEnable command will enable UMC channel management only but it will disable any channel management type in effect when it is used e The CMMode command can also be used to enable UMC or other channel management modes e Ifyou are using an OCe14000 series adapter you must set the mctype parameter in the SetAdapterPortConfig command to enable UMC See the SetAdapterPortConfig command for more information If you try using the UmcEnable command on an OCe14000 series adapter an error message is displayed indicating the command is not supported by the firmware or hardware Supported By Linux Solaris VMware ESXi and Windows Syntax hbacmd UmcEnable lt WWPN MAC Address gt lt 0 1 gt Parameters WWPN WWPN of the FCoE function on the physical port MAC Address MAC address of any NIC function on the adapter
179. yntax LoopBackTest lt WWPN MAC gt lt Type gt lt Count gt lt StopOnError gt Pattern Parameters WWPN The WWPN of an FC or FCoE port MAC The MAC address of a NIC or iSCSI port Type The type of loopback test to run e 0 PCI loopback test not supported for OneConnect or LPe16202 adapters e 1 Internal loopback test not supported for OneConnect or LPe16202 adapters e 2 External loopback test requires loopback plug e 3 DMA loopback test only supported for OneConnect and LPe16202 adapters this test is not supported via the CIM interface e 4 PHY loopback test only supported for OneConnect adapters e 5 MAC loopback test only supported for OneConnect adapters Count Number of times to run the test Possible values are 1 99 9999 To run the test infinitely use 0 StopOnError Checks if the test must be halted on error 0 No halt 1 Halt Pattern An optional parameter that specifies 1 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 OneCommand Manager Command Line Interface Version 10 2 User Manual P010067 01A Rev A SE EMULEX LoopMap Note Supported for FC ports only 5 CLI Client Command Descriptions 77 This command shows the arbitrated loop map data Supported By Linux Solaris and Windows Syntax LoopMap lt WWPN gt Parameters WWPN The WWPN of the FC port
180. ystem Description provides a description of the network entity in an alpha numeric format 0 Disabled 1 Enabled Transmit System Name provides the system s assigned name in an alpha numeric format 0 Disabled 1 Enabled Transmit System Capabilities 0 Disabled 1 Enabled OneCommand Manager Command Line Interface Version 10 2 User Manual P010067 01A Rev A e 5 CLI Client Command Descriptions 70 gt G EMULEX DCB Commands Example hbacmd h 10 190 103 165 m cim u root p Host001 n root emulex SetDCBParam 00 00 c9 3c f7 88 fcoepriority 3 SetDCBPriority This command sets the PFC priorities and the ETS priority groups priorities The values must be set according to the following rules e The priorities range from 0 to 7 e A priority 0 7 must exist in only one priority group e All priorities must appear once in any of the eight PGO PG7 priority groups or if available PG15 Note For an OCe14000 adapter you can use the PG15 priority group for RoCE priority only e To specify no priorities for a priority group use e Anyassigned PFC priority must be assigned as the single priority in a priority group for example no other priorities allowed in a group assigned the PFC priority e Any PG assigned one or more priorities should also be assigned a non zero bandwidth value see SetCnaPGBW The following rules are specific to FCoE and iSCSI adapters e A maximum of two PFC priorities can be assigned e If F

OneCommand™Manager Command Line Interface

Contents

Download Pdf Manuals

Related Search

Related Contents

OneCommand&trade;Manager Command Line Interface

Contents

Download Pdf Manuals

Related Search

Related Contents

OneCommand™Manager Command Line Interface