Home

User Manual

1. VMware Command Linux Solaris ESXi Windows CIM 3 0 3 1 3 2 3 4 4 3 5 Page GetVPD Y Y 4 Y Y 109 GetWWNCap 4 127 GetXcvrData Y Y 4 Y Y 69 HbaAttributes Y Y Y Y Y 51 Help Y Y Y Y 46 ImportiscSI v Y Y 91 InitiateAuth Y Y Y 56 InstallAdapterLicense v Y Y Y Y Y Y Y 49 iSCSIPing Y Y Y Y 92 List HBAs Y Y Y Y Y 109 ListSessions Y Y Y Y 92 ListVFunctions Y Y Y 124 ListVMs Y 125 ListVPorts Y Y Y 125 VPortTargets Y Y Y 125 LoadList Y Y Y Y Y Y 4 Y Y Y 169 LoopBackTest Y Y Y Y 70 LoopMap Y Y Y Y 71 PciData Y Y Y Y 4 71 PersistentBinding Y Y 114 PortAttributes Y Y Y Y 51 PortStatistics Y Y Y Y 51 PostTest Y Y 4 Y 72 ReadWWN Y Y Y Y vl lv Y Y 127 RemoveAllPersistent Y Y 115 Binding RemovePersistent Y Y 115 Binding RemoveHost Y Y Y v 110 RemoveTarget Y Y Y 92 RemoveTargetPortal Y Y Y 93 RescanLuns Y Y Y 104 OneCommand Manager Command Line Interface Version 6 4 User Manual P009667 01A Rev A 2G EMULEX Table 5 1 CLI Client Command Reference Continued 5 CLI Client Command Descriptions 44 CIM Provider VMware Command Linux Solaris ESXi Windows CIM 3 0 3 1 3 2 3 4 4 3 5 Page Reset Y Y Y Y Y Y Y 110 RestoreWWN Y Y Y 127 SaveConfig Y Y Y Y 76 ServerAttributes Y Y Y Y Y 52 SetAuthConfig Y Y Y 56 SetBeacon Y Y Y Y viv Viv Y Y 72 SetBi
2. m 74 Driver Parameter Commands 2 e ouiR ase Es bRuR ada ad i iv bra po n a n d k 74 DriverConfig csaccsatiuecasecstnecsaneuae cr srawslatagatuossnmmasauecuindeaacsni E EN EEEE 75 GetDriverP aras scsscsciiiecastesetecseses i r n ir REEE 75 GetDriverParamsGlobal ccccccceeececceeeeeeeeeeeeeeeeeesseseseeeseeeeeeeesesgggaes 75 Saver ONTO esscr b v ss ovo k n k no on nov v s no 76 SECDIVErP Aral ssa no r on 76 SetDriverParamDefaults ccccc cece cess eeee eee ee eee eeeeeesseseeeeeteeeeeeeeeesgugagees 77 Dump Commands 52 x piso vEE ni O Nan o IMMO SM 77 DeleteDumpkFiles eee ese ierit einir ER EE E ESSETEN ER v i v 77 PU ME R 78 erupit 78 Eur ISI rn k 79 GetDurmpFileNArmes suia Ra TEE enni rik ER REOR skeven keinens VR ERU FUTURE NE LAN a dd 80 GetRetentionCoUnt eie ereeei sere yi E AR E Na dees ET REO e dE ESSE E RUPEE eus ess 80 SECDUMPDINGClONY rr 80 SetRetentionCoUnt 2e i okov eese euh nne ae E e E a eR Nee RE RIA ERES eR E EVE eu Need 81 FCoE COMMANGS icsenwexs suus Gea ka k d k k i ao k a o i bin 82 GETFCFIN O 82 GetFIPParams 5 eese eee ena Rho a nu e E oV V n 82 SEIFI PPAT AM e suse sevice eu k kn YE E NR XSVe EN canes sees estes deste Ea OS e s FU Neg 83 iSCSI Commands sst aknn ko ds nr dan K E ENNE DE
3. 14 OCM Secure Management Configuration Requirements cessere 15 Secure Management Installation 5 512 eode eire see ee aee edes ehh ae opa edo vodu canada 16 Linux and Solaris s vsi dva s a nos ovi vec ee De EEE Qul ise wba ve Whee Eve o DU cee vee we EROR reus 16 WINGOWS a esi ons 16 Using OneCommand Manager with Secure Management Enabled 16 2 Installing and Uninstalling the CLI eeeeeeeeee eee eee enne nnne 17 LINUX fev 17 ed 17 Installing in Linux Without an Existing OneCommand CLI Kit eee cece e eee 17 Installing in Linux With an Existing OneCommand CLI Kit eee cee eee ee ee ewes 18 Updating Preserving Existing Settings o00ooooonnnnnnov ee eee eee nnn 19 Performing a Clean Install Removing Existing Settings scere 19 Uninstalling in Uc cd kos T H 19 Uninstalling Older HBAnyware Kits in Linux eeeeeeeeeeeee nnm enn 20 EIS EET TI T EU 20 l stalline IN SAlAN Sisa v ha ili icta seo EUR Pda tam on 20 Uninstalling in Solaris usiseseva oe err vadia a vk VE id vn ooo ky 21 VMWare ESXi uska sonde div ki no O nn i i i ii trh i o br n 22 Installing the CIM Provider for VMware ESXi Hosts ooooooonooonnnvoooonn
4. P009667 01A Rev A 2G EMULEX Table 5 1 CLI Client Command Reference Continued 5 CLI Client Command Descriptions 42 CIM Provider VMware Command Linux Solaris ESXi Windows CIM 3 0 3 1 3 2 3 4 4 3 5 Page EchoTest Y Y Y Y 68 EnableBootCode Y 58 ExportSANInfo Y Y Y Y 107 ExportiSCSl Y Y Y Y 89 FecEnable Y Y Y Y 107 GetBeacon Y Y Y Y viv v xy Y Y 68 GetAuthConfig Y Y Y 55 GetAuthStatus Y Y Y 55 GetBootParams Y Y Y Y 59 GetCimCred Y 108 GetDCBParams Y Y Y Y Y viv Y Y 63 GetDriverParams Y Y Y Y Y 75 GetDriverParamsGlobal Y Y Y Y Y 75 GetDumpDirectory Y Y Y 4 Y 78 GetDumpFile Y Y Y Y Y 79 GetDumpFileNames Y Y Y Y Y 80 GetElxSecInfo Y Y 108 GetFCFInfo Y v v Y 82 GetFIPParams Y Y Y Y 82 GetlnitiatorProperties Y Y v 4 89 GetiSCSILuns Y Y Y Y 89 GetiSCSIPortStats Y Y Y Y 90 GetLunList Y Y Y Y 103 GetLunUnMaskByHBA Y Y 103 GetLunUnMaskByTarget Y Y 104 GetNetwork Y v Y Y 90 Configuration GetPGInfo Y Y Y Y viv Y Y 164 GetOoslnfo Y Y v v 108 GetRetentionCount Y Y Y Y viv Y Y 80 GetSessionInfo Y Y Y Y 90 OneCommand Manager Command Line Interface Version 6 4 User Manual P009667 01A Rev A 2G EMULEX Table 5 1 CLI Client Command Reference Continued 5 CLI Client Command Descriptions 43 CIM Provider
5. Parameters MAC Address The MAC address of an iSCSI port Target IP IP address of the target portal Port Port number of the target portal value 1024 65535 ImmediateData 0 No 1 Yes default 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 CleariSNSServer This command clears the configured iSNS server and disables iSNS target discovery If no iSNS server is currently configured this command has no effect Supported By Linux Solaris VMware ESXi and Windows Syntax CleariSNSServer lt MAC Address gt Parameters MAC Address The MAC address of an iSCSI port OneCommand Manager Command Line Interface Version 6 4 User Manual P009667 01A Rev A is 5 CLI Client Command Descriptions 88 2 EMULEX iSCSI Commands DelARPTableEntry This command removes an ARP table entry Supported By Linux Solaris VMware ESXi and Windows Syntax DelARPTableEntry MAC Address lt Dest MAC Address lt Dest IP Address Parameters MAC Address The MAC address of an iSCSI port Dest MAC Address The destination MAC address to remove from the ARP
6. 3 The additional PFC priority must be assigned to a priority group that has no other priorities 4 The iSCSI priority must be assigned to a priority group that has no other priorities The following rules are specific to NIC adapters 1 Only one PFC priority can be configured 2 The PFC priority must be assigned to a priority group that has no other priorities Supported By Linux Solaris VMware ESXi and Windows Syntax hbacmd SetDCBPriority lt WWPN MAC gt lt PFC Priorities gt lt Priorities of PGIDO gt lt Priorities of PGID1 gt lt Priorities of PGID7 gt Parameters WWPN The WWPN of an FC or FCoE port MAC The MAC address of a NIC or iSCSI port PFCPriorities The PFC priority that is a comma separated list of up to seven values ranging from 0 7 OneCommand Manager Command Line Interface Version 6 4 User Manual P009667 01A Rev A 2G EMULEX Priorities of PGID Example 5 CLI Client Command Descriptions 68 Diagnostic Commands 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 hbacmd h 10 192 203 151 m cim setdcbpriority 10 00 00 00 c9 3c 7 88 3 0 1 2 4 5 6 7 3 0 0 0 0 0 0 Diagnostic Commands EchoTest This command runs the echo test on adapters Notes e This command is not supported for OneConnect or LPe16202 adapters e Support for rem
7. P009667 01A Rev A 5 CLI Client Command Descriptions gt lt EMULEX VPort Commands 123 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 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 to the specified virtual port Supported By Linux Solaris and Windows Syntax VPortTargets lt physical WWPN gt lt virtual WWPN gt OneCommand Manager Command Line Interface Version 6 4 User Manual P009667 01A Rev A 5 CLI Client Command Descriptions 2G EMULEX WWN Manage
8. WWPN The WWPN of an FCoE port 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 Value lt Param gt Description and lt Value gt DCBXState The DCBX protocol state 0 Disabled 1 Enabled DCBXMode The DCBX mode DCB or CIN 0 CIN 1 DCB The lt DCBXmode gt also configures the FIP mode If lt DCBXmode gt DCB FIP is enabled If lt DCBXmode gt CIN FIP is disabled PFCEnable Flow control in both directions transmit and receive 0 Disabled 1 Enabled FCoEPriority This parameter is applicable for FCoE adapters only A single priority must be specified The range of valid values is 0 7 iSCSIPriority This parameter is applicable for iSCSI adapters only A single priority must be specified The range of valid values is 0 7 PFCPriority A list of comma separated values where multiple PFC priorities supported The comma separated list can contain up to seven values ranging from 0 7 defaults Use to set the DCB parameters including priority groups to their default values For example hbacmd SetDCBParam lt WWPN MAC gt defaults OneCommand
9. Linux Solaris and Windows Syntax AuthConfigList lt WWPN gt Parameters WWPN The WWPN of an FC port OneCommand Manager Command Line Interface Version 6 4 User Manual P009667 01A Rev A 2G EMULEX 5 CLI Client Command Descriptions 55 Authentication Commands DeleteAuthConfig This command deletes the authentication configuration on the adapter Supported By Linux Solaris and Windows Syntax DeleteAuthConfig WWPN1 lt WWPN2 gt PasswordType Password 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 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 Solari
10. Re authentication Re authentication interval Value The value is based on the type of lt Param gt SetPassword Mode disabled enabled or passive Timeout time in seconds Bi directional disabled or enabled Hash priority md5 or shal md5 first md5 then sha1 shal first shal then md DH priority 1 2 3 4 5 any combination up to 5 digits Re authentication disabled or enabled Re authentication interval 0 10 3600 This command sets the password for the adapter Supported By Linux Solaris and Windows Syntax SetPassword WWPN1 WWPN2 Flag 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 ffff 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 OneCommand Manager Command Line Interface Version 6 4 User Manual P009667 01A Rev A 2G EMULEX Npt New password type 1 ASCII 2 Hex binary Npw New password value Boot Commands EnableBootCode This command is used to perform one of the following 5 CLI Client Command Descriptions 58 Boot Commands e Enable or disable network boot for NIC ports If network boot
11. The h option for specifying 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 IP address m cim version Parameters None OneCommand Manager Command Line Interface Version 6 4 User Manual P009667 01A Rev A DE EMULEX 5 CLI Client Command Descriptions 113 Persistent Binding Commands 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 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 Tor 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
12. 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 UCNAs Core Dump core extension e 16 Gb HBAs bin extension e Legacy LightPulse adapters dmp extension DeleteDumpFiles This command deletes all diagnostic dump files for the adapter OneCommand Manager Command Line Interface Version 6 4 User Manual P009667 01A Rev A 5 CLI Client Command Descriptions 2G EMULEX Dump Commands fe 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 UCNA To view inoperable UCNAs on the local host use the List HBAs down command See ListHBAs on page 109 Note For OneConnect UCNAs 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 WWPN MAC 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 UCNA Options For available options contact Emulex technical support GetDumpDirectory
13. lt Type gt 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 OneCommand Manager Command Line Interface Version 6 4 User Manual P009667 01A Rev A 2G EMULEX 5 CLI Client Command Descriptions 127 WWN Management Commands 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 WWPN Type Parameters WWPN The WWPN of an FC or FCoE port Type 0 Volatile 1 Non Volatile 2 Factory Default 3 Current 4 Configured 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 OneCommand Manager Command Line Interface Version 6 4 User Manual P009667 01A Rev A WWN Management Commands DE EMULEX 5 CLI Client Command Descriptions 128 Supported By Linux Solaris VMware ESX
14. 1 NIC 00 00 c9 bb cc ab 3 0 50 2 NIC 00 00 c9 bb cc ac 4 229 50 3 NIC 00 00 c9 bb cc ad 5 50 75 CMMode This command enables a channel management mode or disables channel management For UMC configurations the UMCEnable command can still be used to enable UMC only This command sets the channel management type at the adapter level A system reboot is required to make the change take effect Supported By Linux Solaris VMware ESXi and Windows Syntax hbacmd CMMode WWPN MAC Address None Type Parameters WWPN WWPN of an FCoE function on the physical port OneCommand Manager Command Line Interface Version 6 4 User Manual P009667 01A Rev A DE EMULEX 5 CLI Client Command Descriptions 62 Channel Management Commands MAC MAC address of any NIC function on the physical adapter port Type Specify None to disable channel management or a channel 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 ad ad aa CMSetBW This command sets the minimum and maximum bandwidths for each channel up to four on the physical port For UMC configurations this command can also be used to enable or disable a channel For UMC the UMCSetBW command can still be used instead of this command The total of the minimum bandwidths must add up to 100 The
15. 40 DG EMULEX Unsupported Commands per Operating System Windows Windows does not support the following CLI commands e SetDumpDirectory e ListVMs OneCommand Manager Command Line Interface Version 6 4 User Manual P009667 01A Rev A 2G EMULEX 5 CLI Client Command Descriptions 41 5 CLI Client Command Descriptions A check mark v designates a supported command for a particular operating system CIM interface and some CIM provider versions Table 5 1 CLI Client Command Reference CIM Provider VMware Command Linux Solaris ESXi Windows CIM 3 0 3 1 3 2 3 4 4 3 5 Page AddARPTableEntry 84 AddHost Y Y Y Y 105 AddRouteTableEntry Y Y Y Y 84 AddTarget Y Y Y Y 85 AddTargetPortal Y Y Y Y 86 AllNodelnfo Y Y Y Y Y 113 AuthConfigList Y Y Y 54 BindingCapabilities Y Y 113 BindingSupport Y Y 114 ChangePersonality Y Y Y Y 117 ChangeWWN Y Y Y Y viv 126 CleariSNSServer Y Y Y Y 87 CMGetParams Y Y Y Y 60 CMMode Y Y Y Y 61 CMSetBW Y Y Y Y 62 CnaClearEventLog Y Y Y 105 CnaGetEventLog Y Y Y 106 CreateVPort Y Y Y 123 DelARPTableEntry Y Y Y Y 88 DeleteAuthConfig Y Y Y 55 DelRouteTableEntry Y Y Y 88 DeleteDumpFiles Y Y Y Y 77 DeleteVPort Y Y Y 123 DiscoveriSNSServer Y Y Y Y 88 Download Y Y Y Y Y Vv viv Y Y 106 DriverConfig Y Y Y 75 Dump Y Y Y Y 4 Y Y Y Y 78 OneCommand Manager Command Line Interface Version 6 4 User Manual
16. EE SERE 105 POGHOSE cuxeseiziexstu ix Pewter obtu tua diia un abide ii nn none 105 CnaClearEyentLog 12 cix Te A eon ERR E CNN EAR KERN VAREXCEZXS ERE UE AR CAE TERUEL vk LARUM 105 Sarl ae A 106 DOW MOOG PT 106 ExportSANINTO isse id Ioa ud eR vis nok REOR IR saa QU EQUUM WEE Dd E eU VR DUAE kn VER NC 107 FecEnable c prove i eene SU eroina Pao cus DUM E dvo vo on T Cosas 107 E 8101 7 S9 108 GEtEIXSECINTO PTT 108 GEtTBOSIN O s si ods va Va crave o a SN dan 108 Ell pe RE 109 liStHBAS POP nl VEKKE ESKE EEEE OEKE 109 AMI nei E 110 OneCommand Manager Command Line Interface Version 6 4 User Manual P009667 01A Rev A 2c EMULEX Table of Contents 8 RESET PI 110 Erg i2 i ui a o 111 SRIOVENaDle EET UU LIU r ho ana 111 TArgetMappPINg 2s cccsecasvvcecessvees stit E tien eee KCE KREOLU VAERE TIRE EEEE 112 Mp I REOOO EEE EENET EE ERA 112 Persistent Binding Commands ccecccccccccccccccccccccccccccccccccccccececcccesseees 113 AlllNodelrifo aeuo ei eeu E EEEE ETENEE RU ER EEE EEE ENE EFE TEN 113 BindingCapablltles sive ve sa sexd Ver tierna Kok x RN onko v TEE K E VAY ER RE VENERE EK A VE 113 DINGINGSUP PONE cci eoesuvseCuputis ee i r du ie POL V LIN WEE Edad 114 PersistentBindine 2 ee oce rrr n E ER ESAE E ERU RERUEENREREAR E ER REOR U ETE ESAE 114 Removed PersistentBinding ccccccc
17. MAC address of an iSCSI port Target IP IP address of the target portal Port Port number of the target portal value 102 65535 iscsi target name Targe siSCSI name enclosed in quotes string length 11 255 OneCommand Manager Command Line Interface Version 6 4 User Manual P009667 01A Rev A 2G EMULEX ImmediateData HeaderDigest DataDigest Boot Login Auth TgtCHAPNam TgtSecret InitCHAPName InitSecret AddTargetPortal 5 CLI Client Command Descriptions 86 iSCSI Commands 0 No 1 Yes default 0 None default 1 CRC32C 0 None default 1 CRC32C 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 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 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 This command adds a new SendTarget Portal for the initiator and runs a target discovery once the SendTarget Portal is created This command requires that you specify a valid portal IP address lt Targ
18. Management operation See OCM Secure Management Configuration Requirements on page 15 for configuration instructions OneCommand Manager Command Line Interface Version 6 4 User Manual P009667 01A Rev A 2 Installing and Uninstalling the CLI 24 gt lt EMULEX Solaris 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 2 Copy the OneCommand Manager core kit to a temporary directory on the system Untar the core kit by typing tar xvf elxocmcore solaris lt kit version gt tar Change to the newly created elxocmcore solaris lt kit version gt directory cd elxocmcore solaris lt kit version gt Run the install script and follow the instructions install If any of the following are already present on the system the install script attempts to remove them first e HBAnyware utility e OneCommand Manager core kit e OneCommand Manager appli
19. Manager Command Line Interface Version 6 4 User Manual P009667 01A Rev A 2G EMULEX 5 CLI Client Command Descriptions 66 DCB Commands LLDP Settings for lt Param gt and lt Value gt lt Param gt TxState RxState TxPortDesc TxSysDesc TxSysName TxSysCap Example hbacmd h 10 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 System 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 192 203 151 m cim u root p Swamiji001 n root emulex setdcbparam 00 00 09 30 f7 88 fcoepriority 3 SetDCBPriority This command sets the priorities for a priority group The values must be set according to the following rul
20. OneCommand Manager CLI download the appropriate driver from the Emulex website and install the driver For example e On OneConnect 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 OneCommand Manager Command Line Interface Version 6 4 User Manual P009667 01A Rev A 18 DE EMULEX 2 Installing and Uninstalling the CLI 19 Linux 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 Manager 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 17 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 updat
21. 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 arch is either x64 or x86 e kit version 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 2 Usethe following syntax for the installation executable file elxocmcore windows arch kit version exe option 3 Activate the kit with switch q 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 Youcan select a Management Mode by adding the
22. P009667 01A Rev A 2G EMULEX 5 CLI Client Command Descriptions 48 Help ShowARPTable ShowRouteTable ShowTarget ShowTargetPortal TargetLogin ShowiSNSServer TargetLogout UpdateiSNSServer LUN Masking Commands GetLunList GetLunUnmaskByHba GetLunUnmaskByTarget RescanLuns SetLunMask Miscellaneous Commands AddHost CnaGetEventLog CnaClearEventLog Download SRIOVEnable argetMapping Persistent Binding Commands AllNodeInfo BindingCapabilities BindingSupport PersistentBinding RemoveAllPersistentBinding RemovePersistentBinding SetBindingSupport SetPersistentBinding Personality Management Commands ShowPersonalities ChangePersonality Universal Multichannel Commands UmcEnable UmcGetParams UmcSetBw UmcSetLPVID Virtual Port VPort Commands CreateVPort DeleteVPort ListVFunctions ListVPorts VPortTargets ListVMs WWN Management Commands ChangeWWN GetWWNCap ReadWWN RestoreWWN Example 2 This help command example shows the details for the SetDCBParam command hbacmd help setdcbparam The example output SetDCBParam lt WWPN MAC gt lt Param gt lt Value gt WWPN World Wide Port Name of FCoE Port MAC MAC address of iSCSI or NIC port Param Parameter Name Value Parameter Value Note 1 For FCoEPriority and iScsiPriority the valid range is 0 to 7 A single priority must be specified 2 For the following parameters the valid va
23. 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 OneCommand Manager Command Line Interface Version 6 4 User Manual P009667 01A Rev A DE EMULEX 5 CLI Client Command Descriptions 52 Attributes Commands 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 VMware ESXi and Windows Syntax ServerAttributes WWPN MAC Parameters WWPN The WWPN of an FC or FCoE port MAC The MAC address of a NIC or iSCSI port 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 WWPN 0 1 Parameters WWPN The WWPN of an FC or FCoE port OneC
24. 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 SRIOVEnable This command enables or disables SR IOV on a specified NIC port that is physical function Note 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 Supported By Linux Solaris VMware ESXi and Windows Syntax SRIOVEnable MAC 0 1 Parameters MAC The MAC address of a NIC port 011 0 Disables SR IOV 1 Enables SR IOV OneCommand Manager Command Line Interface Version 6 4 User Manual P009667 01A Rev A 2G EMULEX 5 CLI Client Command Descriptions 112 Miscellaneous Commands 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 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
25. Version 6 4 User Manual P009667 01A Rev A DE EMULEX 5 CLI Client Command Descriptions 115 Persistent Binding Commands RemoveAllPersistentBinding This command removes 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 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 WWPN BindType ID 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 OneCommand Manager Command Line Interface Version 6 4 User Manual P009667 01A Rev A DE EMULEX 5 CLI Client Command Descriptions 116 Persistent Binding Commands 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 Th
26. Y Y Y Y 119 UmcGetParams Y Y Y Y Y 120 UmcSetBw Y Y Y Y Y 121 UmcSetLPVID Y Y Y Y Y 121 UpdateiSNSServer Y Y Y Y 102 Version Y Y Y Y Y 112 VPortTargets Y Y Y Y 125 Wakeup Y Y Y Y 74 OneCommand Manager Command Line Interface Version 6 4 User Manual P009667 01A Rev A 45 5 CLI Client Command Descriptions DE EMULEX ee 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 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 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 a527 9876 Use the following syntax for issuing CIM based commands IPv4 only A gt hbacmd lt h IPv4 p
27. as a boot session and when the system reboots it will attempt 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 Qual Target IP parameter Supported By Linux Solaris VMware ESXi and Windows Syntax SetBootTargetSession MAC Address Target TSIH ISID Qual Target IP lt 0 1 gt Parameters MAC Address The MAC address of an iSCSI port Target Specifies the iSCSI name of the desired iSCSI target 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 OneCommand Manager Command Line Interface Version 6 4 User Manual P009667 01A Rev A 5 CLI Client Command Descriptions 94 2 EMULEX iSCSI Commands 011 Specifies the state of the BootProperty for the target 0 Disabled 1 Enabled 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 targ
28. do not 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 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 IP Address gt OneCommand Manager Command Line Interface Version 6 4 User Manual P009667 01A Rev A 2G EMULEX 4 CLI Client Command Usage 32 CIM Interface 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 used 3 If no values exist username root password root the information entered using the setcimcred command is the following defaults are used namespace root emulex portnum 5 988 Example of Using t he 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 EmulexNUtilNOCManager hbacmd 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
29. entered since LPVIDs cannot be set for storage channels When only three channels are available specifying LPVID3 will cause an error This command is not supported on 1 Gb ports 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 Examples All NIC gt hbacm NIC Plus Storage gt hbacm OneCommand Manager d UmcSetLPVID 00 00 c9 bb cc aa 1001 1002 1003 1004 d UmcSetLPVID 00 00 c9 bb cc aa 1001 0 1002 1003 Command Line Interface Version 6 4 User Manual P009667 01A Rev A 5 CLI Client Command Descriptions DG EMULEX VPort Commands 1l 23 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 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 physical WWPN gt virtual WWPN gt virtual WWNN gt
30. gt lt EMULEX OneCommand Manager Command Line Interface Version 6 4 User Manual P009667 01A Rev A Emulex Connects Servers Storage and People 2G EMULEX Copyright 2007 2013 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 an
31. 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 the EnableBootFromSan parameter is also enabled Supported By Linux Solaris VMware ESXi and Windows Syntax Parameters WWPN NIC MAC Flag NetworkBootMethod Examples The following examp C Program Files The WWPN of an FC port The MAC address of a NIC port D Disable the boot code E Enable the boot code EnableBootCode lt WWPN NIC MAC gt lt Flag gt lt NetworkBootMethod gt 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 le enables iBFT for a NIC Emulex Util OCManager gt HBACMD 00 00 c9 11 22 33 e iBFT OneCommand Manager Command Line Interface Version 6 4 User Manual EnableNetworkBoot P009667 01A Rev A DE EMULEX 5 CLI Client Command Des
32. is different from the permanent MAC address 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 109 OneCommand Manager Command Line Interface Version 6 4 User Manual P009667 01A Rev A is 4 CLI Client Command Usage 30 DG EMULEX Secure Management CLI Interface 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 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 Ma
33. match the currently 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 OneCommand Manager Command Line Interface Version 6 4 User Manual P009667 01A Rev A 2G EMULEX 5 CLI Client Command Descriptions 114 Persistent Binding Commands Supported By Solaris and Windows Syntax BindingCapabilities lt WWPN gt Parameters WWPN The WWPN of an FC or FCoE port BindingSupport This command shows the binding support for the adapter Supported By Solaris and Windows Syntax BindingSupport WWPN Source 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 WWPN Source Parameters WWPN The WWPN of an FC or FCoE port Source C Configuration support L Live support OneCommand Manager Command Line Interface
34. 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 OneCommand Manager Command Line Interface Version 6 4 User Manual P009667 01A Rev A 2 Installing and Uninstalling the CLI 2 EMULEX Mu A 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 possible 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 e excl This optional switch allows the non management host user to select whether the OneCommand Manager appl
35. the ExportiSCSI command see ExportiSCSI on page 89 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 iqn 2006 01 com openfiler target121 000 0n port 00 00 c9 be 1a 24 Added target iqn 2006 01 com openfiler target121 001 0n port 00 00 c9 be 1a 24 OneCommand Manager Command Line Interface Version 6 4 User Manual P009667 01A Rev A is 5 CLI Client Command Descriptions 92 2c EMULEX iSCSI Commands Added target iqn 2006 01 com openfiler target122 000 on port 00 00 c9 2f 45 1b Added target iqn 2006 01 com openfiler target122 001 on 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 reguest ListSessions This command lists all the sessions on a specified target The command gathers the information from the iSCSI targ
36. 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 port 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 physical WWPN virtual WWPN gt OneCommand Manager Command Line Interface Version 6 4 User Manual P009667 01A Rev A DE EMULEX 5 CLI Client Command Descriptions 124 VPort Commands Parameters physical WWPN The WWPN of an FC or FCoE port virtual WWPN The WWPN of the virtual port 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 OneCommand Manager Command Line Interface Version 6 4 User Manual VLADID Transmit Rate MAC Address VLADID Transmit Rate MAC Address VLADID Transmit Rate MAC Address VLADID Transmit Rate 10 100 Mbit sec 00 00 c9 12 34 cd 10 100 Mbit sec 00 00 c9 12 34 ef 10 1 bbit sec 00 00 c9 13 34 01 20 1 Gbit sec
37. 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 OneCommand Manager Command Line Interface Version 6 4 User Manual P009667 01A Rev A is 5 CLI Client Command Descriptions 99 2 EMULEX iSCSI Commands ShowARPTable This command shows the current ARP table for the specified port Supported By Linux Solaris VMware ESXi and Windows 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 This command also indicates whether or not iSNS discovery is enabled Supported By Linux Solaris VMware ESXi and Windows Syntax ShowiSNSServer lt 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 showroutetableentry 00 00 c9 a0 ce 77 OneCommand Manager Command Line Interface Ver
38. 0 and maximum to 75 Disables channel 2 if UMC Sets channel 3 s minimum bandwidth to 25 and maximum to 100 If UMC channels 0 1 and 3 would be enabled if their previous bandwidths were 0 DCB Commands This command shows the internal host PFC flag value and DCBX mode DCB version as well as the LLDP state for iSCSI FCoE and NIC adapters Notes e DCB commands are for DCB management of OneConnect adapters only e DCB or parts of DCB may not always be available on an adapter depending on its configuration For example if UMC is enabled priority groups are not available Therefore the SetCNAPGBW and SetDCBPriority commands would not be available 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 internal host PFC flag value and DCBX mode DCB version as well as the LLDP state for iSCSI FCoE and NIC adapters 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 6 4 User Manual P009667 01A Rev A is 5 CLI Client Command Descriptions 64 2 EMULEX DCB Commands GetPGlnfo This command shows the bandwidth
39. 00 00 c9 5b 3a 6d OneCommand Manager Command Line Interface Version 6 4 User Manual P009667 01A Rev A is 5 CLI Client Command Descriptions 83 2 EMULEX iSCSI Commands 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 Param Value 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 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 OxOefc99 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 The MAC address MAC Address of the UCNA port must be passed to each command as the first argument OneCommand Manager Command Line Interface Version 6 4 User Manual P009667 01A Rev A is 5 CLI Client Command Descriptions 84 2 EMULEX iSCSI Commands 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 en
40. 00 00 c9 6b 62 2b Fabric Name 00 00 00 00 00 00 00 00 Flags 00000000 Host Name eng ma emulex com Mfg Emulex Corporation Serial No BG73539764 Port Number n a Mode Initiator Discovery cim Port WWN 10 00 00 00 c9 6b 62 59 Node WWN 20 00 00 00 c9 6b 62 59 Fabric Name 00 00 00 00 00 00 00 00 Flags 00000000 Host Name eng ma emulex com Mfg Emulex Corporation Serial No BG73539764 Port Number n a Mode Initiator OneCommand Manager Command Line Interface Version 6 4 User Manual P009667 01A Rev A 2G EMULEX Discovery cim C Program Files m cim u root p root n root emulex portattributes 10 00 00 00 c9 6b 62 2b Port Node Port Port Port Port Port Port vNIC vNIC vNIC vNIC Port Attributes for 10 00 00 00 c9 6b 62 2b WWN 20 00 00 00 c9 6b 62 2b WWN 10 00 00 00 c9 6b 62 2b Symname FCID 0000 Type Fabric State Unknown Service Type 12 Name Outer VLAN ID Min Bandwidth Max Bandwidth 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
41. 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 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 OneCommand Manager Command Line Interface Version 6 4 User Manual P009667 01A Rev A 2G EMULEX 5 CLI Client Command Descriptions 51 Attributes Commands For VMware ESXi hosts hbacmd h IP Address 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 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 WWPN 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 Supported By Linux Solaris VMware ESXi and Windows Syntax PortAttributes lt WWPN MAC gt Parameters h
42. CP lt 0 1 gt gt lt IP Address Subnet Mask Gateway Parameters MAC Address The MAC address of an iSCSI port OneCommand Manager Command Line Interface Version 6 4 User Manual P009667 01A Rev A 5 CLI Client Command Descriptions 96 gt C EMULEX iSCSI Commands VLAN ENABLED 0 Disabled 1 Enabled VLAN ID VLAN ID of the interface The possible values are 0 4095 Priority VLAN priority of the interface The possible values are 0 7 DHCP 0 Disabled 1 Enabled IP Address New IP address For example 10 192 1 1 Subnet_Mask Subnet Mask For example 255 255 255 0 Gateway Gateway For example 10 192 1 1 Notes VLAN ID and Priority are required only if VLAN ENABLED is enabled otherwise these values should be omitted IP Address and Subnet Mask are required only if DHCP is disabled otherwise these values should be omitted SetTargetLoginProperties OneCommand Manager Command Line Interface Version 6 4 User Manual This command sets the login and authentication properties 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 val
43. ConfigList e BindingCapabilities e BindingSupport e CreateVPort e DeleteVPort e GetAuthConfig e GetAuthStatus e GetCimCred e GetElxSecInfo e GetLunList e GetLunUnMaskByHBA e GetLunUnMaskByTarget e InitiateAuth e PersistentBinding e RemoveAllPersistentBinding e RemovePersistentBinding e RescanLuns e SetAuthConfig e SetBindingSupport e SetCimCred e SetPersistentBinding e SetLunMask e SetPassword Solaris Solaris does not support the following CLI commands e CnaClearEventLog e CnaGetEventLog e DriverConfig OneCommand Manager Command Line Interface Version 6 4 User Manual P009667 01A Rev A 38 2G EMULEX GetCimCred GetElxSeclnfo ListVMs SetCimCred SetDumpDirectory VMWare ESXi VMWare ESXi does not support the following CLI commands AuthConfig List BindingCapabilities BindingSupport CreateVPort DeleteAuthConfig DeleteVPort GetAuthConfig GetAuthStatus GetCimCred GetElxSecInfo GetLunList GetLunUnMaskByHBA GetLunUnMaskBy Target GetProtocollnfo ImportSCSI InitiateAuth ListVFunctions ListVMs ListVPorts PersistentBinding RemoveAllPersistentBinding RemovePersistentBinding RescanLuns SetAuthConfig SetBindingSupport SetCimCred SetLunMask SetPersistentBinding SetPassword SetPortProtocol VportTargets OneCommand Manager Command Line Interface Version 6 4 User Manual 4 CLI Client Command Usage Unsupported Commands per Operating System P009667 01A Rev A 39 4 CLI Client Command Usage
44. 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 Parameters WWPN The WWPN of an FC or FCoE port MAC The MAC address of a NIC or iSCSI port filename The name of the dump file to be copied from the remote host Example hbacmd h 10 192 193 154 m cim u root p Swamiji001 n root emulex getdumpfile BG HBANYWARE 15 10000000c97d1314 20100120 032820421 dmp OneCommand Manager Command Line Interface Version 6 4 User Manual P009667 01A Rev A 5 CLI Client Command Descriptions 2G EMULEX Dump Commands zi 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 WWPN MAC 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 SetDumpDirectory This command sets the dump directory for the VMware ESXi hosts only Supported By VMware ESXi
45. Gb 2 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 This command results in an error because you must include a Length value when Mode is 2 OneCommand Manager Command Line Interface Version 6 4 User Manual P009667 01A Rev A is 5 CLI Client Command Descriptions 54 DG EMULEX Authentication Commands 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 Supported By Linux Solaris VMware ESXi and Windows Syntax SetPortEnabled lt WWPN MAC gt lt PortEnable gt 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 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
46. IC 00 00 c9 bb cc ac 4 25 50 3 NIC 00 00 c9 bb cc ad 5 50 75 NIC Plus Storage 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 1001 20 50 OneCommand Manager Command Line Interface Version 6 4 User Manual P009667 01A Rev A is 5 CLI Client Command Descriptions 121 2 EMULEX UMC Commands FCoE 00 00 c9 bb cc ab n a 50 100 2 NIC 00 00 c9 bb cc ac 1002 20 50 NIC 00 00 c9 bb cc ad 1003 10 75 UmcSetBw This command sets the minimum and maximum bandwidths for each channel up to four on the physical port The total of the minimum bandwidths must add up to 100 The maximum bandwidth must be greater than or equal to the minimum bandwidth and has a maximum value of 100 Setting the minimum bandwidth of a channel to 0 will disable the channel and setting it to a non zero value with enable the channel 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 Supported By Linux Solaris VMware ESXi and Windows Syntax UmcSetBW WWPN MAC Address Min0 Max0 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 on the physical port Min0 Max0 Minimum and maximum bandwidths for channel 0 Minl Max1 Minimum and maximum bandwidth
47. Linux Solaris VMware ESXi and Windows Syntax hbacmd UmcEnable WWPN MAC Address 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 port 0 Disables UMC 1 Enables UMC Example gt hbacmd UmcEnable 00 00 c9 bb cc aa 1 OneCommand Manager Command Line Interface Version 6 4 User Manual P009667 01A Rev A is 5 CLI Client Command Descriptions 120 2 EMULEX UMC Commands UmcGetParams Shows the current UMC configuration for an adapter s physical port The command s output is the current UMC state for the adapter and also a table showing the por s channels along with their UMC properties On some adapters only three channels will be shown instead of four because that is all the physical port supports Also the channel Type property shows the protocol that is running on the channel This is controlled by the CL s ChangePersonality command not the 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 il NIC 00 00 c9 bb cc ab 3 0 0 2 N
48. MC management CMGetParams This command shows the current channel management configuration for an adapter s physical port For UMC configurations the UMCGetParams command can still be used The command s output is the active booted channel management state for the adapter the configured state the configured management mode not applicable if the configured state is disabled and the available channel management modes This is followed by a table showing the por s channels along with their channel properties The Type column shows the protocol that is running on each channel Note For some adapters three channels will be shown instead of four because the physical port will only support three Supported By Linux Solaris VMware and Windows OneCommand Manager Command Line Interface Version 6 4 User Manual P009667 01A Rev A 5 CLI Client Command Descriptions 61 Channel Management Commands 2G EMULEX Syntax hbacmd CMGetParams lt WWPN MAC Address gt Parameters WWPN WWPN of an FCoE function on the physical port Type MAC address of any NIC function on the physical adapter port Example gt hbacmd CMGetParams 00 00 c9 12 34 56 Active state Disabled Configured mode None Available modes vNIC1 vNIC2 UFP gt hbacmd CMGetParams 00 00 c9 12 34 56 Active state Enabled Configured mode UMC Available modes vNIC1 vNIC2 UFP Func Type MAC Address LPVID Min BW Max BW 0 NIC 00 00 c9 bb cc aa 2 25 50
49. NM EM ME 83 AddARPTableEntry eer m ovo 84 AddRouteTableEntry i d eezuse sad ex raw Y rax uve deb X v z RE dov GR Raga GR Raa VE Va NC T RE EE 84 AddTatrget 5 iore v e IIR EVE Ue he E I Tren Vv NET e ue Pode ee v na 85 AddTatgetPOrtal iis cases aktovky io hn cere e ARRA REUE FAR ET Vira REV dea 86 CleariSNSServel i oso ada Eee rd te kes 87 DEIARP TADICEMLN E asinus eda eu soon Cog ERE dn Pda veta ea OE nik no 88 DelRoute Fable Entry i uui nako k okov k Ya nn isiu yv RE VAT ERAS M REOR Qa ER EUER 88 DiscoverlSNSServer oss ising ceca coed tee ening v EYE E Vr EE UE ER UE o 88 EXPOPtiSCS vide DTE 89 GetlnitiatorProperties ccceeeeseeeeeeee eee e enhn hehe eene 89 CAMILLE 89 GetiSCSIPortStats oerte tree teer sewed saa RU EPE A EN AE E YES E YR TESTE RR E VV TES e Tir 90 GetNetworkConfiguration 1 4 45 aea ebr ray kan nay n n nr Eg R ER aa RR Ra aU VO EE E EE vases 90 Get gt essiO0nlnfO EI ID TII TILES 90 OneCommand Manager Command Line Interface Version 6 4 User Manual P009667 01A Rev A 2c EMULEX Table of Contents 7 UIMPOPU ES eorr eve LI PT EE EERE 91 O 92 LISCSCSSIONS PRETI DID ID II phono vo an 92 REMOVETAMGEL ETPMTPT 92 Remove TargetPortal esses ccsiscsace caves vak E E ree lv 93 SetBootTarget5esslo nzicsoioes es k ra dovo fa REOR no v OUEST see 93 SetlnitiatorProperties ccc ccecece nese ee
50. 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 105 RemoveHost page 110 and the Version page 112 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 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
51. Ports The following HbaCmd commands are supported for managing target mode ports OneCommand Manager Command Line Interface Version 6 4 User Manual CreateVPort DeleteDumpFiles DeleteVPort P009667 01A Rev A 36 2G EMULEX Download DriverConfig ExportSanInfo GetDriverParams GetDriverParamsGlobal GetDumpDirectory GetDumpFile GetRetentionCount GetVPD GetXcvrData HbaAttributes ListHbas ListVPorts PortAttributes PortStatistics Reset SaveConfig ServerAttributes SetDriverParam SetDriverParamDefaults SetPortEnabled SetRetentionCount 4 CLI Client Command Usage 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 41 Linux RHEL SLES and Oracle RHEL SLES and Oracle do not support the following CLI commands BindingCapabilities BindingSupport GetCimCred GetLunUnMaskByHBA GetLunUnMaskBy Target ListVMs PersistentBinding RemoveAllPersistentBinding OneCommand Manager Command Line Interface Version 6 4 User Manual P009667 01A Rev A 37 2G EMULEX e RemovePersistentBinding e SetBindingSupport e SetCimCred e SetDumpbDirectory e SetLunMask e SetPersistentBinding Citrix 4 CLI Client Command Usage Unsupported Commands per Operating System Citrix acting as a hypervisor style server for OneCommand Manager CLI does not support the following CLI commands e Auth
52. R EET E ER SR EUER IEEE E I SO EUET E TEN UTS 58 GetBootParams 1 eec e kie eek eonun ue a RE eR VK RE REESE a eee Eee e RES 59 SetBootParalm ere eter er ERR Ee E E AS EI SEEN ER ER E Y ERE Pe TU e ET Ves 59 s z a a E a a a E 60 Channel Management Commands ccssscccccscccccccsscccccsscsscccsessccessssssseeseees 60 CMGetPaLralms x coved eoe kr n E senses EERE TEE ETE r EEE ERE S n E E YR 60 atta m 61 CMSEtBW a 62 DCB Coimiarids zu sako os pa aa EUN AERE VEM UAR UE RUN LAN QUEE ER UER EN 63 GetDCBParamls erre eere a E RE ERR AR RR ere Prev VE TRE ERE vee ates seeders 63 GetPGIN DE 64 SECCMAPGBW m 64 SetDGBPardatm i es derer E y RR e ERR E eaule when v 65 SECDCBPIMOMIlY PERPE 66 Diagnostic CommandsS ss sssssai s ss ss ee ne e rrr rere e n au aab he e v c vodo sov i vo vi asi 68 ECHOLESE e TIE 68 GEtbeacon 440k AEE EEE E 68 GetXcyvrData sss ssss0oovico k vosk kiss vos vi VIP VV SEEEN EE sv v r EE 69 oru eT 69 LoopBackTest oo oer rey ik xU rr E PUE ER P n UNS 70 LOOPMAD RET 71 lua Price 71 Ido jMIE Lidae S TETTE 72 OneCommand Manager Command Line Interface Version 6 4 User Manual P009667 01A Rev A 2c EMULEX Table of Contents 6 kn 72 SEtCADIONVP ELT EE EIMMRMATMTSMT 73 III 73 lr d
53. 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 Windows OneCommand Manager Command Line Interface Version 6 4 User Manual P009667 01A Rev A is 5 CLI Client Command Descriptions 79 DG EMULEX Dump Commands Syntax GetDumpDirectory lt WWPN MAC gt Parameters WWPN The WWPN of an FC or FCoE port MAC The MAC address of the UCNA 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 and is placed under the OneCommand Manager installation directory 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 usr sbin ocmanager Dump e For Solaris opt ELXocm
54. 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 dump files in that location OneCommand Manager Command Line Interface Version 6 4 User Manual P009667 01A Rev A is 5 CLI Client Command Descriptions 81 DG EMULEX Dump Commands 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 For VMware ESXi using the RM interface hbacmd h IP Aaddress port setdumpdirectory lt DumpDirectoryName gt For VMware ESXi using the CIM interface hbacmd h IP Address 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 roo
55. Windows Syntax GetNetworkConfiguration MAC Address Parameters MAC Address The MAC address of an iSCSI port 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 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 qualifier by running the ListSessions command OneCommand Manager Command Line Interface Version 6 4 User Manual P009667 01A Rev A 5 CLI Client Command Descriptions gt lt EMULEX iSCSI Commands ii Supported By Linux Solaris VMware ESXi and Windows Syntax GetSessionInfo MAC Address iscsi target name TSIH ISID Qual Target 1P gt gt Parameters MAC Address The MAC address of an iSCSI port iscsi target name Targe siSCSI name enclosed in quotes string length 11 255 TSIH TSIH value of the session value 1 65535 ISID Qual ISID qualifier of the session value 0 65535 Target_IP The Target s IP address ImportiSCSI This command imports iSCSI targets from a file to the iSCSI ports on the host Supported By Linux Solaris and Windows Syntax ImportiSCSI lt Import File gt clean Parameters Import File The name of XML file containing import information that was generated by
56. ace Version 6 4 User Manual P009667 01A Rev A 2G EMULEX S CLI Client Command Descriptions 108 Miscellaneous Commands 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 GetElxSeclnfo This command shows the version of the ElxSec system Supported By Windows and Linux Syntax GetElxSeclnfo 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 MAC Address OneCommand Manager Command Line Interface Version 6 4 User Manual P009667 01A Rev A DE EMULEX 5 CLI Client Command Descriptions 1Q9 Miscellaneous Commands Parameters MAC The MAC address of a NIC port Example hbacmd getgosinfo 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 List HBAs This command shows a list of the manageable Emulex adapters found by local remote in band FC and remote out of band TCP IP discovery For a NIC only or iSCSI adapter the MAC add
57. age Emulex FC adapters but not Emulex network adapters To manage Emulex network adapters you must install the out of box Emulex CIM Provider 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 5 0 or ESXi 5 1 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 the following command all on one line esxcli software vib update d vmware esx provider emulex cim provider 50 3 6 11 1 01 zip no sig check 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 OneCommand Manager Command Line Interface Version 6 4 User Manual P009667 01A Rev A DE EMULEX 2 Installing and Uninstalling the CLI 23 Windows Attended Installation To install the
58. anagement and port disable 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 28 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 h IP Address port gt m cim u root p lt password gt n lt namespace gt InstallAdapterLicense 00 12 34 56 78 9A K 1f 1324 lic Note If you specify the parameter m cim the CLI uses the CIM interface to talk to the CIM server running on ESXi to get the management information If you do not specify the parameter m cim the CLI uses the RM interface to talk to the RM server to get the management information Syntax Options and Setting CIM Credentials For issuing CIM based commands two main syntax options are available Option A hbacmd h IP Address port m cim u userid p password n root emulex command 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 111 This command sets only the CIM credentials Once you have set them subsequent HbaCmd commands
59. and Windows OneCommand Manager Command Line Interface Version 6 4 User Manual P009667 01A Rev A 2G EMULEX 5 CLI Client Command Descriptions 107 Miscellaneous Commands 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 VMware ESXi 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 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 16 Gb HBA adapters Supported By Linux Solaris VMware ESXi and Windows Syntax fecenable WWPN lt 0 1 gt OneCommand Manager Command Line Interf
60. c 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 Examples For non VMware ESXi hosts hbacmd InstallAdapterLicense 00 12 34 56 78 9A K 1f1324 lic For VMware ESXi hosts hbacmd h IP Address m cim u root p lt password gt n lt namespace gt InstallAdapterLicense 00 12 34 56 78 9A K M1f1324 1ic OneCommand Manager Command Line Interface Version 6 4 User Manual P009667 01A Rev A 2G EMULEX 5 CLI Client Command Descriptions 50 Adapter License Management Commands ShowAdapterLicenseFeatures This command displays the list of licensed and licensable features as well as features that are already licensed The output is a list of features with an indication of whether or not the feature has been licensed 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 IP Address m cim u root p lt password gt n lt namespace gt ShowAdapterLicenseFeatures
61. cation enterprise kit e Solaris driver utilities 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 2 Log on as root 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 OneCommand Manager Command Line Interface Version 6 4 User Manual P009667 01A Rev A is 2 Installing and Uninstalling the CLI 22 2G EMULEX VMware ESXi VMware ESXi For installing and uninstalling the Emulex CIM Provider in VMware systems only VMware ESXi 5 0 and 5 1 are supported For VMware ESXi 5 0 and 5 1 hosts 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 5 0 and 5 1 hosts you can manage adapters using the OneCommand Manager 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 man
62. cccceeeeeeccccceeeeeeeeeeeeeeeseecsgeenenenes 115 RemovePersistentBinding ccccccecccccceeeeeessssceeeeeeeeeeeeeeeseessaaaneeenes 115 SetBirdingSupport zosiku iot breit in slan dn na da bd dug od doe beue edid 116 SetPersistentBIndilg 2552 x xke uod dad Yan Ma EF VE ERE Ka vn lv 116 Personality Change COMMANGS ccececsccccccccccccccccccccccccccccccccceeccccsscccees 117 c halegePersonallby idu ue lehren ia t peus EERE r ohni 117 ShowPersonalitieS ss sssssasa esee eoo oi itse e nou e i lie 118 UMC COMMANGS 225 k non o on ns kni MER bxUEDUEAR nn ina k oo k 118 WIMCEN ABIES sic oer roter or Erro Sr ER e NR a mecssatasderccnes tease era EUER SES 119 UmcGetParams eere eR nho hun nu Ee o eR ne gag o ERES RR ER ee ku ne 120 UMGSECBW 121 WMCSECLPVID H 121 VPort GomimalTUls nis vue on UR CExx WEM A E RENEA REA REA AEN MEA SM RR in ai RUE 123 erige LE 123 DElELEVPOP boi cT 123 LISCVFUNCTIONS ccc sccescccudcccac ees v s cas sissit RR eed seeded es V U vii 124 Bra CERT 125 addons e ko Tv py v v 125 VPortTargets iiseieee cette sov vi Rue v oo ii v ii 125 WWN Management Commands sssscccccccccccccccecsccccccccccccececcesscccccscsseseses 126 Chahge WW usa s s lon a Fea o DO o ro CU noo bo 126 GETWWNCAD eose aerei niiret kilo o TETEE OEEO bose da ETT EE 127 Read WWN so sro sa n nn oo EEE EN a v 127 tried E 127 Appendi
63. criptions 59 Boot Commands The following example disables network boot C Program Files Emulex Util OCManager gt HBACMD EnableNetworkBoot 00 00 c9 11 22 33 d GetBootParams This command shows the boot parameters If any arguments are missing or invalid a suitable error is reported If all arguments are correct the data is displayed in tabular form Supported By Linux Solaris VMware ESXi and Windows Syntax 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 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 WWPN Type Param Valuel 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 OneCommand Manager Command Line Interface Version 6 4 User Manual P009667 01A Rev A is 5 CLI Client Command Desc
64. d Manager Application Enterprise Kit 26 DE EMULEX quis 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 You cannot update a OneCommand Manager CLI with a previous version of the OneCommand Manager application enterprise kit When the OneCommand Vision Sensor software is installed on production servers with Emulex adapters the Sensor software may load and use some of the software components included in the OneCommand Manager application or HBAnyware utility software stacks It is essential that the OneCommand Vision Sensor software be stopped before performing any updates to the OneCommand Manager application or HBAnyware software stack components For information on stopping the OneCommand Vision Sensor see the latest Emulex OneCommand Vision Installation and Configuration Manual Linux To update from the OneCommand Manager CLI to the full featured OneCommand Manager application enterprise kit in Linux run the install sh scri
65. dapters 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 OCManager gt hbacmd h 10 192 203 154 m cim u root p Swamiji001 n root emulex pcidata 00 00 c9 93 2f d6 The example output Vendor ID Ox19A2 Device ID 0x0700 Command 0x0406 Status 0x0010 Revision ID 0x02 Prog 1f 0x00 Subclass 0x00 Base Class 0x02 OneCommand Manager Command Line Interface Version 6 4 User Manual P009667 01A Rev A 5 CLI Client Command Descriptions 72 Diagnostic Commands 2G EMULEX Cache Line Size 0x10 Latency Timer 0x00 Header Type 0x80 Built In Self Test 0x00 Base Address 0 0x00000000 Base Address 1 OxDF478000 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 Interrupt Pin 0x01 Minimum Grant 0x00 Maximum Latency 0x00 Capabilities Ptr 0x40 Post Test Note Not supported for OneConnect and LPe15000 or LPe16000 series adapters This command runs the POST on the adapter Support for a remote adapter is through TCP IP access only 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 beac
66. 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 full 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 OneCommand Manager 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 Remote ma
67. dentials on page 32 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 OneCommand Manager Command Line Interface Version 6 4 User Manual P009667 01A Rev A 5 CLI Client Command Descriptions 2G EMULEX Miscellaneous Commands 100 This command clears the event log specified by the WWPN or MAC address Supported By Linux VMware ESXi and Windows Syntax CnaClearEventLog WWPN MAC 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 UCNA 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 Download Loads the firmware image to the port specified by the WWPN or MAC address Notes e For 16 Gb HBA firmware downloads OneCommand Manager 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 OneConnect adapter or a 16 Gb HBA Supported By Linux Solaris VMware ESXi
68. dentials are authenticated the OCM will determine which one of the four user groups you belong to and will allow command usage as appropriate OneCommand Manager Command Line Interface Version 6 4 User Manual P009667 01A Rev A 2 Installing and Uninstalling the CLI 17 2 EMULEX na 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 operating systems will require OCM CLI installation if it is needed 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 mac
69. dy 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 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 TargetSecret1 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 TargetSecreti InitCHAPName InitialSecretl Supported By Linux Solaris VMware ESXi and Windows Syntax SetTPLoginProperties 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 ImnediateData HeaderDigest DataDigest Auth TgtCHAPNam TgtSecret InitCHAPName InitSecret The MAC address of an iSCSI port The IP address of the target portal The port number of the target portal value 1024 65535 0 7 No 1 Yes default
70. e WWPN of an FC or FCoE port 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 WWPN Scope 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 OneCommand Manager Command Line Interface Version 6 4 User Manual P009667 01A Rev A DE EMULEX 5 CLI Client Command Descriptions 117 Personality Change Commands 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 Personality Change Commands The OneCommand Manager application enables you to change the personality or protocol running on OneConnect adapter
71. e adapters on VMware ESXi servers through the Common Information Model CIM interface e Manage the DCB Data Center Bridging settings on a UCNA or converged fabric adapter CFA e Manage a UCNA s Fibre Channel over Ethernet FCoE Initialization Protocol FIP OneCommand Manager Command Line Interface Version 6 4 User Manual P009667 01A Rev A 1 Introduction 11 DG EMULEX Overview Manage adapter licenses Manage protocol personalities Group hosts for easier parameter configuration and firmware download Retrieve adapter dump files from remote hosts Change an adapter s World Wide Port Name WWPN and World Wide Node Name WWNN Reset FC ports Configure persistent binding on FC targets Set FC FCoE adapter driver parameters simultaneously to multiple adapters using Batch Update Update firmware and FC boot code x86 BootBIOS OpenBoot or EFIBoot ona single adapter or multiple adapters using Batch Update Set global FC FCoE driver parameters Enable or disable adapter boot x86 BootBIOS FCode EFIBoot or PXE Boot Run diagnostic tests on adapter ports Locate adapter ports using beaconing Mask and unmask FC LUNs Create and delete FC virtual ports through N_Port_ID virtualization NPIV View FC virtual ports and virtual machine mapping information Configure FC boot from SAN Modify an IP port number of the remote management agent View vital product data VPD for the selected adapter port View transceiver informati
72. e path from an HBAnyware 4 x or 3 x core kit to a OneCommand Manager 5 1 or later core kit You must un install previous versions of the HBAnyware utility before installing a OneCommand Manager core kit For information on uninstalling older versions of HBAnyware see Uninstalling Older HBAnyware Kits in Linux on page 20 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 20 2 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 17 Uninstalling in Linux To uninstall the OneCommand Manager CLI in Linux 1 Logonas root 2 Doone of the following e Run the uninstall ocmanager sh script located in usr sbin hbanyware scripts e Runtheuninstall sh script located in the installation tar file OneCommand Manager Command Line Interface Version 6 4 User Manual P009667 01A Rev A 2G EMULEX 2 Installing and Uninstalling the CLI 20 Solaris Uninstalling Older HBAnyware Kits in Linux Uninstalling an Older HBAnyware Core Kit 1 Run the follo
73. es 1 The priorities range from 0 to 7 2 The PGIDs range from 0 to 7 3 A priority can exist in only one priority group 4 All priorities must appear once in any of the eight priority groups PGO PG7 OneCommand Manager Command Line Interface Version 6 4 User Manual P009667 01A Rev A 5 CLI Client Command Descriptions gt lt EMULEX DCB Commands 94 5 Each set of priorities for a group must be separated by a space 6 Specify multiple priorities for the same group by a comma separated list 7 To specify none use for the argument 8 The same priority values cannot be specified to different groups 9 All priorities 0 7 must be assigned to some PGID 10 Not all PGIDs must be assigned a priority 11 Not all adapters support two PFC priorities and eight priority groups For adapters if you exceed the PFC priorities or priority groups an error message appears The following rules are specific to FCoE adapters 1 A minimum of one and a maximum of two PFC priorities can be configured 2 One of the PFC priorities must match the FCoE priority 3 The additional PFC priority must be assigned to a priority group that has no other priorities 4 The FCoE priority must be assigned to a priority group that has no other priorities The following rules are specific to isCSI adapters 1 A minimum of one and a maximum of two PFC priorities can be configured 2 One of the PFC priorities must match the iSCSI priority
74. esets the adapter An adapter reset can require several seconds to complete especially for remote devices When the reset is completed the system command prompt is displayed 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 OneCommand Manager Command Line Interface Version 6 4 User Manual P009667 01A Rev A 2G EMULEX 5 CLI Client Command Descriptions 111 Miscellaneous Commands 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 Parameters username Login User ID of the VMware ESXi password The login password of the VMware ESXi namespace
75. et indicated by the lt iscsi_target_name gt parameter Supported By Linux Solaris VMware ESXi and Windows Syntax ListSessions MAC Address lt iscsi target name Parameters MAC Address The MAC address of the an iSCSI port iscsi target name Target s iSCSI name enclosed in quotes The string length is 11 255 Remove Target 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 MAC Address lt iscsi target name OneCommand Manager Command Line Interface Version 6 4 User Manual P009667 01A Rev A is 5 CLI Client Command Descriptions 93 2c EMULEX iSCSI Commands Parameters MAC Address The MAC address of an iSCSI port iscsi target name Target s iSCSI name enclosed in quotes The string length is 11 255 RemoveTargetPortal This command removes the SendTarget Portal containing the target IP Target IP and the port Port from the list of portals for the specified initiator Supported By Linux Solaris VMware ESXi and Windows Syntax RemoveTargetPortal MAC Address Target IP Port Parameters MAC Address The MAC address of an iSCSI port Target IP The target s IP address Port The port number of the target portal The possible values are 1024 65535 SetBootTargetSession This command enables and disables a iSCSI target s session as a boot session If a session is enabled
76. et 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 TargetSecretl InitCHAPName InitialSecretl Supported By Linux Solaris VMware ESXi and Windows Syntax SetInitiatorProperties MAC Address 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 Parameters MAC Address The MAC address of an iSCSI port Initiator Name Initiator iSCSI name enclosed in q
77. et to the list of targets seen by the initiator and logs into the target once it has been successfully created This command requires that you specify a valid target IP 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 TargetSecretl 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 TargtSecretl InitCHAPName InitialSecretl Supported By Linux Solaris VMware ESXi and Windows Syntax AddTarget MAC Address Target IP Port lt iscsi target name ImmediateData lt 0 1 gt HeaderDigest lt 0 1 gt DataDigest lt 0 1 gt Boot 0 1 Login lt 0 1 gt Auth lt 0 1 2 gt TgtCHAPName TgtSecret InitCHAPName InitSecret Parameters MAC Address The
78. et_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 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 AddTargetPortal 00 11 22 33 44 55 10 0 0 1 8000 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 AddTargetPortal 00 11 22 33 44 55 10 0 0 1 8000 Auth 2 TgtChapName TargetSecretl 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 OneCommand Manager Command Line Interface Version 6 4 User Manual P009667 01A Rev A 5 CLI Client Command Descriptions gt lt EMULEX iSCSI Commands 87 Supported By Linux Solaris VMware ESXi and Windows Syntax AddTargetPortal MAC Address Target IP Port 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
79. eteeeccceeeeenseetsccececceeseeeetentsseeaceees 94 SetiSCSI BOO E b ai k ine v v oni Pn hok Nik 95 SetNetworkConfig ration ccscccsspeudiieedswites book holi hr ERREUR CEPR SUO E Eu DN ead d 95 SetTargetLoginProperties csseeeeeeeeeeeeeeeee eene ne e enhn hne 96 SetTargetPropertles ses eeece esee en ER e yr o hr nre Ra NR eere sry ea Re YE eere eus 97 SetIPLoginPropertlies 1 o eren E rea ore ay aeg v pepe se e Res ep v vlna Pola 97 SNAWARPTADIB s244 6400 rmn 99 SHOWISNSSCNV EM ssa n ka k kk n v hada kina bk zh ky k nn rk VAT HE 99 SNOW ROULE Fable seitens senas errien o esir ore E E E E O EAE TEE E 99 ShowTarget lt lt soa avosssopovka inoks ustu Tuitis sE NEEE SKENEN E SKET ER EREKE KEEN 100 SHOW TArGOtP Ona ss sk dino te uo aha ad oaa eae VERRE E VE Klik Va 100 largetL 09N iso sson zas v v 101 TargetLog0out 102 Updatel gt N SerVe ssseisiv lus ssn do kak skn son nik in rn nhl 102 LUN Masking Commands eeooooooos osovo ooo ooo ooo oo oo osovo 103 GETLUNLIS E 103 GetLunUnMaskByHBA i iesus aso osse Va a a EE A VERE ka vn ini PE ap E Ad 103 GetLunUnM skB T ardet coucou dov aa ona AS ta rn ONERE QU MONEDA ono 104 RESCANLUMNS ce l EEE 104 SETLUNMASK eT 104 Miscellaneous Commiarids ees naso xu SE AR ERE SERORURNEREEPEUEEn RUSSE EAE NUMEN E
80. f an FC or FCoE port OneCommand Manager Command Line Interface Version 6 4 User Manual P009667 01A Rev A 2G EMULEX 5 CLI Client Command Descriptions 76 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 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 Make change global all adapters on this host Flag2 P Make change permanent persists across reboot T Make change temporary Param Name of t
81. fig GetAuthStatus InitiateAuth SetAuthConfig SetPassword Boot Commands EnableBootCode GetBootParams SetBootParam CEE Commands CEEDownload GetCEEParams SetCEEParam Channel Management Commands CMGetParams CMMode CMSetBW DCB Commands GetDCBParams SetDCBParam GetPGInfo SetDCBPriority SetCnaPGBW Diagnostic Commands EchoTest GetBeacon GetXcvrData LoadList LoopBackTest LoopMap PciData PostTest SetBeacon SetCableNVP TDRTest Wakeup Driver Parameter Commands DriverConfig GetDriverParams SetDriverParam SetDriverParamD Dump Commands DeleteDumpFiles Dump GetDumpD GetRetentionCount SetRetention FCoE GetFIPParams Commands SetFIPParam GetF iSCSI Commands AddARPTablel CleariSNSServer ExportiSCSI AddRouteTable DelARPTable GetInitiatorProper GetSes RemoveTarget Rem Entry E Ent GetNetworkConfiguration ListSessions GetDriverParamsGlobal SaveConfig efaults irectory SetDumpDirectory Count GetDumpFileNames GetDumpFile CFInfo Entry ry ties AddTarget DelRouteTableEntry DiscoveriSNSServer GetiSCSILuns GetiSCSIPortStats ImportiSCSI iSCSIPing AddTargetPortal sionInfo Setiscs SetTa SetInitiatorProperties SetTargetLoginProperties oveTargetPortal IBoot SetBootTargetSession SetNetworkConfiguration OneCommand Manager Command Line Interface Version 6 4 User rgetProperties SetTPLoginProperties Manual
82. files are copied from the Dump directory of the remote host to the Dump directory of the local host Specifying a local port identifier for this command returns an error since the source and destination directory are the same See GetDumpFile on page 79 ERROR 180 Authentication User unknown All The specified username is not valid or could not be authenticated by the system See OneCommand Manager Secure Management on page 14 for more information ERROR lt 181 gt Authentication Insufficient credentials All OneCommand Manager Command Line Interface Version 6 4 User Manual The specified username and password are valid and the user is a member of an OCM group however the OCM group does not have sufficient privileges to execute the specified command See OneCommand Manager Secure Management on page 14 for more information P009667 01A Rev A 2G EMULEX Table A 1 OneCommand Manager Error Messages Continued OneCommand Manager Error Messages Error Message Command s Description ERROR 183 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 OCM 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 gene
83. ge Handshake Authentication Protocol Common Interface Model Common Information Model Object Manager Cisco Intel Nuova data center bridging exchange command line interface direct attach copper 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 Protocol 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 P009667 01A Rev A 2G EMULEX MAC MILI MSI MTU NFS NIC NPVID NVP PFC PGID PGBW PHY POST PXE RHEL RM RPM SAN SCSI SFCB SFP SLES SR IOV SSH TCP TDR UCNA UEFI UFP UMC VPD VPort WWN WWNN WWPN VM XML 1 Introduction 13 Abbreviations media access control Management Interface Library message signaled interrupts maximum transmission unit network file system network interface card or controller N_Port_ID virtualization normal velocity of propagation priority based flow control priority group ID priority group bandwidth physical layer power on self test Pre boot Execution E
84. he 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 6 4 User Manual P009667 01A Rev A 2G EMULEX 5 CLI Client Command Descriptions 77 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 changes 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 txt
85. hine for Secure Management operation See OCM Secure Management Configuration Requirements on page 15 for configuration instructions For new systems before installing the OneCommand Manager CLI install the specific Linux driver rpm file Note On RHEL 5 5 and later and RHEL 6 and later the OneCommand Core rpm file requires the Libnl library This library is not installed by default but can be obtained from the operating system distribution media e For i386 RHEL 5 5 RHEL 5 6 and RHEL 6 use the 32bit libnl library e Forx86 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 32bit libnl library 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 OneCommand Manager Command Line Interface Version 6 4 User Manual P009667 01A Rev A 5 EMULEX 2 Installing and Uninstalling the CLI Linux o For RHEL 6 and later versions and SLES 11 SP1 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 g
86. i 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 6 4 User Manual P009667 01A Rev A 2G EMULEX Appendix A OneCommand Manager Error Messages 129 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 Description 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 28 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 126 There are no license features for this adapter ShowLicenseAdapterlD InstallAdapterLicense ShowAdapterLicenseFeatures Adapter License Management commands are not available on OCe11101 EM EX or OCe11102 EM EX adapters See Adapter License Management Commands on page 49 ERROR HBACMD GetDumpFile RM GetDumpFile call failed 2 ERROR 2 Not Supported GetDumpFile Dump
87. ication 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 2333 will be used 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 In Windows 2008 and Windows 2008 R2 select Start gt Control Panel gt Programs gt Uninstall a Program OneCommand Manager Command Line Interface Version 6 4 User Manual P009667 01A Rev A DE EMULEX 2 Installing and Uninstalling the CLI 25 Star
88. in CIM Interface on page 33 4 CLI Client Command Usage 33 CIM Interface Emulex Util OCManager gt hbacmd h 10 192 113 128 CLI Client Commands Supported in CIM Interface Following is a list of HbaCmd commands supported through the CIM interface e AddHost e AllNodelnfo e CEEDownload e ChangePersonality e ChangeWWN e CMGetParams OneCommand Manager Command Line Interface Version 6 4 User Manual P009667 01A Rev A is 4 CLI Client Command Usage 34 2c EMULEX CIM Interface e CMMode e CMSetBW e DeleteDumpFiles e Download e Dump e EnableBootCode e GetBeacon e GetDCBParams e GetDriverParams e GetDriverParamsGlobal e GetDumpbDirectory e GetDumplile e GetDumpFileNames e GetFCFInfo e GetFIPParams e GetLunList e GetPGInfo e GetQosInfo e GetRetentionCount e GetVPD e GetWWNCap e GetXcvrData e HbaAttributes e InstallAdapterLicense e ListHBAs e LoadList e LoopBackTest e PciData e PortAttributes e PortStatistics e ReadWWN e RemoveHost e Reset e RestoreWWN e ServerAttributes e SetBeacon e SetCnaPGBW e SetDCBParam e SetDCBPriority OneCommand Manager Command Line Interface Version 6 4 User Manual P009667 01A Rev A 2G EMULEX SetDriverParam SetDriverParamDefaults SetDumpDirectory SetFIPParam SetPFCthrottle SetPhyPortSpeed SetRetentionCount Show AdapterLicenseFeatures ShowLicenseAdapterID ShowPersonalities UmcEnable UmcGetParams UmcSetBw UmcSet LPVD TargetMapping Ve
89. 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 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 SetTPLoginProperties This command sets a target portal s login properties This command requires that you specify a valid Target IP lt Target_IP gt and Port lt Port gt However if you specify no options other than the Target IP and Port no changes are made You must change at least one of the optional parameters for this command to make any changes to the target portal s login properties OneCommand Manager Command Line Interface Version 6 4 User Manual P009667 01A Rev A 2G EMULEX 5 CLI Client Command Descriptions 98 iSCSI Commands 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 alrea
90. lues are 0 and 1 DcbxState DcbxMode TxState RxState TxPortDesc TxSysDesc TxSysName TxSysCap ExportSANInfo FecEnable GetCimCred GetElxSecInfo GetQoSInfo GetVPD ListHBAs ListVFunctions RemoveHost Reset SetCimCred SetPfcThrottle OneCommand Manager Command Line Interface Version 6 4 User Manual P009667 01A Rev A Adapter License Management Commands DE EMULEX 5 CLI Client Command Descriptions 49 PfcEnable PfcPriority 3 PfcPriority comma separated list where multiple PFC priorities supported 4 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 OneConnect adapters only They are not available on LPe16202 OCe11101 EM EX or OCe11102 EM EX 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 specifi
91. maximum bandwidths must be greater than or equal to the minimum bandwidth and has a maximum of 100 A reboot is not required to make these changes take effect when channel management is enabled For UMC mode you can disable a channel logical link state down by setting the minimum bandwidth and maximum to 0 Setting the minimum bandwidth to a value greater than 0 will enable the channel if it was previously disabled Note This command will fail if the current channel management mode is vNIC1 or UFP Supported By Linux Solaris VMware ESXi and Windows Syntax hbacmd CMSetBW WWPN MAC Address Min0 Max0 lt Minl Max1 gt lt Min2 Max2 gt Min3 Max3 Parameters MAC Address MAC address of any NIC function on the physical adapter port WWPN WWPN of an FCoE function on the physical port Min0 Max0 Minimum and maximum bandwidths for channel 0 Minl Maxi 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 Examples gt hbacmd CMSetBW 00 00 c9 bb cc aa 25 50 50 75 0 0 25 100 OneCommand Manager Command Line Interface Version 6 4 User Manual P009667 01A Rev A 5 CLI Client Command Descriptions gt lt EMULEX DCB Commands 63 For a port with a channel with the specified MAC address this command Sets channel 0 s minimum bandwidth to 25 and maximum to 50 Sets channel 1 s minimum bandwidth to 5
92. ment Commands 120 Parameters physical WWPN The WWPN of an FC or FCoE port virtual WWPN The WWPN of the virtual port WWN Management Commands Notes e Supported for FC FCoE adapter ports only e WWN management validates WWNs carefully to avoid name duplication 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 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 Supported By Linux Solaris VMware ESXi and Windows Syntax ChangeWWN lt WWPN gt lt New WWPN gt lt New WWNN gt
93. n 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 MAC Address Parameters MAC Address The MAC address of the NIC or iSCSI port Example hbacmd TDRTest MAC OneCommand Manager Command Line Interface Version 6 4 User Manual P009667 01A Rev A 5 CLI Client Command Descriptions 74 gt lt EMULEX Driver Parameter Commands 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 LPe16202 adapters This command wakes up 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 usi
94. nagement 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 28 apply Additionally the m sec parameter is required in the command for all users without root or Administrator privileges Usage Example In Windows to display a list of adapters managed for a specified host using the secure management interface run the following command hbacmd lt h 192 168 1 122 gt m sec u jsmith p lt joepassword gt download 00 12 34 56 78 9A 0c11 4 6 96 2 ufi 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 VMware ESXi 5 0 and 5 1 hosts you can manage adapters using the OneCommand Manager on Windows but you must install and use the appropriate Emulex CIM OneCommand Manager Command Line Interface Version 6 4 User Manual P009667 01A Rev A is 4 CLI Client Command Usage 31 2 EMULEX CIM Interface Provider For installation see Installing the CIM Provider for VMware ESXi Hosts on page 22 Note For VMware ESXi 5 0 and 5 1 hosts when advanced adapter management capabilities are required for example iSCSI M
95. nagement Using the Secure Management Interface ssu 30 Syntax Rules for the Secure Management Interface cesses 30 CIA Interface ue oeecesuoxeuxDERUR E EU EEERER vis is pn n a ni niako vn 30 Device Management Using the CIM Interface sssseeeeeeeeeeee eene 30 Syntax Rules for the CIM Interface iideeciee e eene pn eee nerunt kn sia 31 Syntax Options and Setting CIM Credentials cc cece cce eee e cece eee eeeeeeeeeeeee eens 31 Example of Using the CIM Interface to Display Adapters cessere 32 CLI Client Commands Supported in CIM Interface cece eeceece sense ee eeneeeeeeees 33 CIM Provider 3 0 csse ka EAE AAEE na erie UNUM E r on 35 CIM Provider A nn 35 CIM Provider 3 Z zistoval brno nr 36 CIM Provider 3 4 4 cec dansky nn v vonn 36 CIM Prodor 3 Dina hlavna brav srna EEEN ev vga vvn vs bv Vas nl vn 36 Commands Supported in Target Mode POrts cssesecsessccecsccsceccscecsessceesecees 36 Unsupported Commands per Operating System cceeeeeeee eee nennen 37 ETAIU p AAE E E E EE E E A E E E EE E A 37 RHEL SLES and Oracle cccc ce ecc cee eens eeeeeee ene eene hehehe hehehe heres 37 Aa ss pol bav an ah k diets Sidi nr 38 Ke CINEMA EIU a a 38 VMW abe ESX NCP kov UR 39 WINDOWS sis veins tendo bok vb lv r a a vi 40 5 CLI Client Command DeSCriptions cccscccccscccccc
96. nagement operations between two machines is allowed or denied depending on the OneCommand Manager secure management status of the machines OneCommand Manager Command Line Interface Version 6 4 User Manual P009667 01A Rev A 2G EMULEX 1 Introduction OneCommand Manager Secure Management 15 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 Denied Allowed Table 1 3 Active Commands 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 OCM Secure Management Configuration Requirements For systems to run in the OCM secure management environment they need to be configured to provide the following two capabilities e Authentication On Linux and Solaris this is done through the PAM interface and must be configured as follows o On Sola
97. ndingSupport Y Y 116 SetBootParam Y Y Y Y 59 SetBootTargetSession Y Y Y Y 93 SetCableNVP Y Y Y Y 73 SetCnaPGBW Y Y Y Y Y Y Y 64 SetCimCred Y 111 SetDCBParam Y Y Y Y Y 65 SetDCBPriority Y Y Y 4 4 66 SetDriverParam Y Y Y Y 4 76 SetDriverParamDefaults Y Y Y Y Y 77 SetDumpbDirectory Y Y 80 SetFIPParam Y Y 4 4 83 SetlnitiatorProperties Y Y Y 94 SetiSCSIBoot Y Y Y 95 SetLunMask Y Y 104 SetNetwork Y v Y Y 95 Configuration SetPassword Y Y Y 57 SetPersistentBinding Y Y 116 SetPfcThrottle Y Y Y Y Y 52 SetPhyPortSpeed Y Y Y Y Y Y 53 SetPortEnabled Y Y Y Y Y 54 SetRetentionCount Y Y Y Y Y v xy Y Y 81 SetTargetLogin Y Y Y Y 96 Properties SetTargetProperties Y Y Y Y 97 OneCommand Manager Command Line Interface Version 6 4 User Manual P009667 01A Rev A 2G EMULEX Table 5 1 CLI Client Command Reference Continued 5 CLI Client Command Descriptions CIM Provider VMware Command Linux Solaris ESXi Windows CIM 3 0 3 1 3 2 3 4 4 3 5 Page SetTPLoginProperties Y Y Y Y 97 ShowAdapterLicense Y Y Y Y Y Y Y Y 50 Features ShowARPTable Y Y Y Y 99 ShowiSNSServer Y Y Y Y 99 ShowLicenseAdapterlD Y Y Y Y 50 ShowPersonalities Y Y Y Y 118 ShowRouteTable Y Y Y Y 99 ShowTarget Y Y Y Y 100 ShowTargetPortal Y Y Y Y 100 SRIOVEnable Y Y Y Y 111 TargetLogin Y Y Y Y 101 TargetLogout Y Y Y Y 102 TargetMapping Y Y Y Y Y 112 TDRTest Y Y Y Y 73 UmcEnable Y
98. ng 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 OneCommand Manager Command Line Interface Version 6 4 User Manual P009667 01A Rev A DE EMULEX 5 CLI Client Command Descriptions 75 Driver Parameter Commands DriverConfig This command sets all driver parameters to the values in the dpv file type The dpv file s driver type must match the driver type of the host platform adapter 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 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 o
99. nve 22 WINDOWS sak rH on E EEE 22 Installing in NINGOWS ssao iaxozn on vavoki s kldavazuda ERR ska ns v zu sond RR MR dla RR Rad 22 Attended installati n srs 52 io eerte eter Ie ene ERI ERR slo rain 23 Unattended Installation 2 1o eerie Loo oe ure Enea to pee ore al nado e eae ga Ene CVs 23 Uninstalling in WIndOoWSs ozon dod vok s k Sa REPE ERES REA nn RE KE ERE 24 Uninstalling through the Control Panel c ccc cceeee eee eee eeeeeeeee eee eeeeeeseeeeeeeees 24 Uninstalling through the Command Line oooooo ono novo oo eee nn nene nee 25 Starting and Stopping Daemon Processes csscsccccsscccccssccccccccsccccssssccceeceees 25 kinux and Sold TS eua dece ees PER oou va balon ba nn ia i PPP MEAS 25 OneCommand Manager Command Line Interface Version 6 4 User Manual P009667 01A Rev A 3 2c EMULEX Table of Contents 4 3 Updating to the OneCommand Manager Application Enterprise Kit 26 LINUX a ER 26 SIR M 26 WHIDOWS CP C c 27 4 CLI Client Command Usage sc sisseiccssceccascscrsesssevecssnecccssececesseevedeseeesseansens 28 OVerVIBW o aeris EE DOKN dk EREMO ERE ERES ETE MEN UR L RO Mora ID ERR 28 HbaCmd Syntax Usage sa terret e ne dial vis pron naa koc rasa p s von hv e T DUE 28 Secure Management CLI Interface ssooooooooooooooonoooo ooo eene hne enn 30 Device Ma
100. nvironment 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 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 Interface Version 6 4 User Manual P009667 01A Rev A 7 1 Introduction 14 DG 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
101. 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 OneCommand Manager Command Line Interface Version 6 4 User Manual P009667 01A Rev A 5 CLI Client Command Descriptions gt lt EMULEX UMC Commands 113 Notes e The UMC command UmcSetChanLink is no longer available Its functionality can be performed by the UmcSetBw command 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 may be referred to as vNIC2 e The UMC commands are not available on OCe11101 EM EX or OCe11102 EM EX adapters The following error will be returned ERROR 251 Hardware or firmware does not support command UmcEnable This command enables or disables UMC 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 Supported By
102. ommand Manager Command Line Interface Version 6 4 User Manual P009667 01A Rev A 2G EMULEX 5 CLI Client Command Descriptions 53 Attributes Commands 011 The PEC throttle state 0 Disabled 1 Enabled SetPhyPortSpeed This command sets the port speed on OneConnect OCe11100 and LPe16202 adapters only Supported By Linux Solaris VMware ESXi and Windows Syntax SetPhyPortSpeed WWPN MAC Mode Speed Length Parameters WWPN The WWPN of an FCoE port MAC The MAC address of a NIC or iSCSI port Mode The Mode number 0 Default 1 Auto negotiate requires the lt Speed gt argument 2 Force requires the lt Speed gt and lt Length gt arguments Speed The Speed string When Mode is 1 or 2 the Speed argument is required When Mode is 0 the Speed argument is ignored The speed 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 Length The length of the direct attach copper cable in meters Valid values are 0 10 A Length value is required when using a 10Gb SFP Plus transceiver When Mode is 2 the Length argument is required When Mode is 0 or 1 the Length argument is ignored Examples The following example configures the PHY port to a forced speed of 1 Gb sec with a cable length of two meters hbacmd setphyportspeed 00 00 c9 ad ad ac 2 1
103. on for the selected adapter port View iSCSI target session information View vNIC data for supported adapters Create and save reports about discovered SAN elements Compatibility The OneCommand Manager application can be installed on multiple operating systems Windows Linux Solaris and VMware ESXi For VMware ESXi 5 0 and ESXi 5 1 hosts you can manage adapters using the OneCommand Manager on Windows but you must install and use the appropriate Emulex CIM Provider on those VMware hosts Note For VMware ESXi 5 0 and ESXi 5 1 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 For more details see the OneCommand Manager for VMware vCenter User Manual For supported versions of operating systems platforms and adapters see the Emulex website OneCommand Manager Command Line Interface Version 6 4 User Manual P009667 01A Rev A 2G EMULEX Abbreviations ARP ASIC BIOS CEE CFA CHAP CIM CIMOM CIN CLI DAC 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 OneCommand Manager Command Line Interface Version 6 4 User Manual 1 Introduction 12 Abbreviations address resolution protocol application specific integrated circuit basic input output system Converged Enhanced Ethernet converged fabric adapter Challen
104. on on or off Supported By Linux Solaris VMware ESXi and Windows Syntax SetBeacon WWPN BeaconState 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 6 4 User Manual P009667 01A Rev A 2G EMULEX 5 CLI Client Command Descriptions 73 Diagnostic Commands SetCableNVP Note This command supports only OCe11100 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 is supported on OneConnect and LPe16202 adapters only The TDR test attempts to determine if any cable faults are compromising the integrity of the link 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 a
105. 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 23 for more information Linux and Solaris Interactive Installation Enterprise OCM installations done in interactive mode will ask if OCM Secure Management mode should be enabled If the answer is yes the other management mode questions will be skipped If the answer is no to the OCM Secure Management mode question then the management mode installation questions will follow Unattended Installation with Install Script Switch Option Support Enterprise OCM installations done in unattended mode provides a switch option to enable OCM Secure Management If the OCM Secure Management switch is not used with the installation Secure Management will be disabled Windows During OCM installations done in interactive mode you will be presented with a management mode window where you can select Secure Management as the management mode Using OneCommand Manager with Secure Management Enabled 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 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 cre
106. ort 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 Command Summary Help Commands Help lt Group gt Group AdapterLicense Attributes Authentication Boot CEE Channel Management DCB Diagnostics DriverParams Dump AdapterManagement eLunManagement eLunMigration FCoE iSCSI KeyManagerClientManagement LUNMasking Miscellaneous PersistentBinding Personality PolicyManagement OneCommand Manager Command Line Interface Version 6 4 User Manual P009667 01A Rev A 2G EMULEX 5 CLI Client Command Descriptions Help 47 ServerKeyManagement Adapter Licens ShowLicenseAdapterID Attributes Commands HbaAttributes PortAttributes SetPhyPortSpeed SetPortEnabled Authentication Commands InstallAdapterLicense ServerLicenseManagement UMC VPort WWN Management Commands ShowAdapterLicenseFeatures PortStatistics ServerAttributes AuthConfigList DeleteAuthConfig GetAuthCon
107. ote adapter is TCP IP access only The EchoTest command fails if the target WWPN does not support the ECHO ELS command Supported By Linux Solaris VMware ESXi and Windows Syntax lt Pattern gt Parameters WWPN Source WWPN Destination Count StopOnError Pattern GetBeacon EchoTest lt WWPN Source gt lt WWPN Destination gt lt Count gt lt StopOnError gt The WWPN of the originating adapter The WWPN of the destination echoing adapter The number of times to run the test Use 0 to run the test indefinitely Checks if the test must be halted on error 0 No halt 1 Halt on error Hexadecimal data pattern to transmit up to 8 characters This command shows the current beacon state either on or off Supported By Linux Solaris VMware ESXi and Windows OneCommand Manager Command Line Interface Version 6 4 User Manual P009667 01A Rev A 5 CLI Client Command Descriptions 69 Diagnostic Commands 2G EMULEX Syntax GetBeacon lt WWPN MAC gt Parameters WWPN The WWPN of the adapter MAC The MAC address of the NIC or iSCSI port GetXcvrData Note GetXcvrData is not supported for OneConnect OCe11100 or LPe16202 adapters This command shows transceiver data such as vendor name and serial number 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 addres
108. percentages for all the priority groups for the port Additionally this command displays the number of priority groups supported by an adapter Supported By Linux Solaris VMware ESXi and Windows Syntax GetPGInfo WWPN MAC 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 SetCnaPGBW This command sets the bandwidth percentage of a priority group according to the following rules 1 Bandwidths BW0 BW7 for priority groups 0 7 PGO PG7 must total 100 for 100 2 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 BWO BW7 gt Parameters WWPN The WWPN of an FC or FCoE port MAC The MAC address of a NIC or iSCSI port BWO 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 f 7 88 50 500000 0 0 OneCommand Manager Command Line Interface Version 6 4 User Manual P009667 01A Rev A is 5 CLI Client Command Descriptions 65 2c EMULEX DCB Commands SetDCBParam This command configures the DCB and LLDP settings on a OneConnect adapter Supported By Linux Solaris VMware ESXi and Windows Syntax SetDCBParam lt WWPN MAC gt lt Param gt lt Value gt Parameters
109. pt 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 kit version tar 3 Change to the newly created elxocm kit version directory cd elxocm solaris kit version gt 4 Runthe install script and follow the instructions install OneCommand Manager Command Line Interface Version 6 4 User Manual P009667 01A Rev A 3 Updating to the OneCommand Manager Application Enterprise Kit 27 2G 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 elxocm windows 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 6 4 User Manual P009667 01A Rev A 2C EMULEX 4 CLI Client Command Usage 28 Overview 4 CLI Client Command Usage Ove
110. ral user authentication error See OneCommand Manager Secure Management on page 14 for more information ERROR lt 222 gt DCB not available GetDCBParams These commands are not available SetDCBParam on OCe11101 EM EX or OCe11102 EM EX adapters See GetPGinfo DCB Commands on page 63 SetDCBPriority SetCnaPGBW ERROR lt 251 gt Hardware or firmware SRIOVEnable These commands are not available does not support command UmcEnable on OCe11101 EM EX or UmcGetP OCe11102 EM EX adapters See Dee anne SRIOVEnable on page 111 and UmcSetBW UMC Commands on page 118 UmcSetLPVID 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 6 4 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 P009667 01A Rev A 130
111. re nic iscsi and fcoe OneCommand Manager Command Line Interface Version 6 4 User Manual P009667 01A Rev A 5 CLI Client Command Descriptions 118 gt lt EMULEX UMC Commands Example For non ESXi hosts hbacmd ChangePersonality 00 12 34 56 78 9A fcoe For ESXi hosts hbacmd h IP Adress m cim u root p lt password gt n lt namespace gt ChangePersonality 00 12 34 56 78 9A fcoe ShowPersonalities This command displays the list of personalities available on the adapter The personality type is displayed as either NIC iSCSI or FCoE Supported By Linux Solaris VMware ESXi and Windows Syntax ShowPersonalities lt WWPN MAC gt Parameters WWPN The WWPN of an FCoE port MAC The MAC address of a NIC 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 UMC Commands The adapter s physical ports provide a converged conduit for network and storage traffic Each channel has its own unique MAC address Each channel provides traffic management capabilities such as enabling and disabling minium and maximum transmit rates 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
112. ress 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 OneCommand Manager Command Line Interface Version 6 4 User Manual P009667 01A Rev A DE EMULEX 5 CLI Client Command Descriptions 110 Miscellaneous Commands 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 VMware ESXi 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 Parameters host address The host to remove IP Address The IP address of the host to remove Reset This command r
113. rget 1P gt gt Parameters MAC Address The MAC address of an iSCSI port iscsi target name The targe s iSCSI name enclosed in quotes string length 11 255 TSIH The TSIH value of the session The possible values are 1 65535 ISID Qual The ISID qualifier of the session The possible values are 0 65535 Target_IP The target s IP address UpdateiSNSServer This command updates the configured iSNS server 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 Supported By Linux Solaris VMware ESXi and Windows Syntax UpdateiSNSServer MAC Address Server IP Port Parameters MAC Address The MAC address of an iSCSI port Server IP IP address of the iSNS server to configure Port Port number of the iSNS server to configure value 1024 65535 OneCommand Manager Command Line Interface Version 6 4 User Manual P009667 01A Rev A is 5 CLI Client Command Descriptions 103 DG EMULEX LUN Masking Commands LUN Masking Commands Notes e Supported for FC FCoE ports only e Linux does not support the GetLunUnMaskByHBA GetLunUnMaskByTarget and SetLunMask 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 and Windows Syntax GetLunLi
114. riptions 60 2c EMULEX CEE Commands Value2 The boot device entry number 0 7 CEE Commands Three CEE commands are listed when you run the help command however the commands are only applicable for a discontinued product and should be ignored Channel Management Commands These commands enable and disable channel management of UCNAs and the setting of channel properties Channel management is not supported on LPe16202 CFAs Each adapter s physical port can be partitioned into a maximum of four isolated channels providing a converged conduit for network and storage traffic Each channel has its own unique 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 minium and maximum transmit rates 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 vNIC2 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 Notes e For IBM adapters UMC mode may be referred to as vNIC2 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 118 for information on U
115. ris 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 On Linux itis the etc pam d passwd file auth section or the equivalent e User Group Membership From the host machine OCM Secure Management must be able to access the OCM group to which the user belongs For Linux and Solaris systems it uses the getgrnam and getgrid C library API calls The equivalent to the API calls can be obtained by typing getent group from the shell command line If the four OCM group names are listed with their member users the machine is ready to use OCM secure management OneCommand Manager Command Line Interface Version 6 4 User Manual P009667 01A Rev A 7 1 Introduction 16 2 EMULEX OneCommand Manager Secure Management Secure Management Installation The enabling or disabling of the Secure Management feature is specified at OCM 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 OCM groups described above are not configured on the machine at the time of the OCM 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
116. rsion CIM Provider 3 0 CIM Provider 3 0 supports the following commands Download ChangeWWN GetWWNCap GetXcvrData LoadList Loopbacktest GetBeacon SetBeacon ReadWWN Reset RestoreWWN CIM Provider 3 1 CIM Provider 3 1 supports the following commands 4 CLI Client Command Usage CIM Interface All the commands listed in the previous section for CIM Provider 3 0 on page 35 Dump GetDCBParams GetDumpDirectory GetDumpFile OneCommand Manager Command Line Interface Version 6 4 User Manual P009667 01A Rev A 35 2G EMULEX GetDumpFileNames GetFCFInfo GetFipParams GetRetentionCount GetPGInfo SetDCBParam SetCnaPgBw SetDCBPriority SetDumpDirectory SetFIPParam SetRetentionCount CIM Provider 3 2 CIM Provider 3 2 supports the following commands 4 CLI Client Command Usage Commands Supported in Target Mode Ports All the commands listed in the previous section for CIM Provider 3 1 on page 35 ChangePersonality InstallAdapterLicense Show AdapterLicenseFeatures ShowLicenseAdapterID ShowPersonalities CIM Provider 3 4 4 CIM Provider 3 4 4 supports the following commands All the commands listed in the previous section for CIM Provider 3 2 on page 36 SetCableNVP CIM Provider 3 5 CIM Provider 3 5 supports the following commands All the commands listed in the previous section for CIM Provider 3 4 4 on page 36 SetPhyPortSpeed Commands Supported in Target Mode
117. rtal ip lt port gt ImmediateData lt 0 1 gt HeaderDigest lt 0 1 gt DataDigest lt 01 1 gt Auth lt 0 1 2 gt TgtCHAPName TgtSecret InitCHAPName InitSecret Parameters MAC Address The MAC address of an iSCSI port iscsi target The target s iSCSI name enclosed in quotes string length 11 255 name Port The port number of the target portal The possible values are 1024 65535 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 The Target CHAP name enclosed in quotes string length 1 255 TgtSecret The Target Secret enclosed in quotes string length 12 16 OneCommand Manager Command Line Interface Version 6 4 User Manual P009667 01A Rev A is S CLI Client Command Descriptions 102 2 EMULEX iSCSI Commands InitCHAPName The Initiator CHAP name enclosed in quotes string length 1 255 InitSecret The Initiator Secret enclosed in quotes string length 12 16 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 MAC Address lt iscsi target name TSIH lt ISID Qual Ta
118. rview 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 command 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 command 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 four 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
119. s When you change the personality of the adapter and reboot the host the adapter starts running the new personality or protocol The personalities that the OneConnect adapters currently run are NIC only NIC FCoE and NIC iSCSI 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 49 for more information Notes e The three different personalities 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 tis possible to install one or more driver kits for the current personality then change the personality and no longer have the drivers necessary to run the adapter If you change personalities you must install the appropriate drivers The appropriate drivers are available on the Emulex website e These commands are not available on LPe16202 adapters ChangePersonality This command changes the personality on the adapter After successful change a reboot is required Supported By Linux Solaris VMware ESXi and Windows Syntax ChangePersonality WWPN MAC personality type Parameters WWPN The WWPN of an FCoE port MAC The MAC address of a NIC or iSCSI port Personality Type The available values a
120. s and Windows OneCommand Manager Command Line Interface Version 6 4 User Manual P009667 01A Rev A 2G EMULEX 5 CLI Client Command Descriptions 56 Authentication Commands Syntax GetAuthStatus WWPN1 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 InitiateAuth This command initiates the authentication configuration on the adapter Supported By Linux Solaris and Windows Syntax InitiateAuth WWPN1 WWPN2 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 SetAuthConfig This command sets the authentication configuration for the adapter Supported By Linux Solaris and Windows Syntax SetAuthConfig WWPN1 lt WWPN2 gt PasswordType Password Param Value 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 OneCommand Manager Command Line Interface Version 6 4 User Manual P009667 01A Rev A 2G EMULEX 5 CLI Client Command Descriptions 57 Authentication Commands Param The parameter names Mode Timeout Bi directional Hash priority DH priority
121. s 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 When only three channels are available specifying Min3 Max3 will cause an error 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 UmcSetLPVID This command sets the LPVID for each channel on a physical port A reboot is not required to make these changes take effect when UMC is enabled OneCommand Manager Command Line Interface Version 6 4 User Manual P009667 01A Rev A DE EMULEX 5 CLI Client Command Descriptions 122 Suppo UMC Commands rted By Linux Solaris VMware ESXi and Windows Syntax UmcSetLPVID lt WWPN MAC Address lt LPVIDO gt LPVID1 LPVID2 LPVID3 Param WWPN eters WWPN of the FCoE function on the physical port MAC Address MAC address of any NIC function on the adapter port LPVIDO LPVID1 LPVID2 LPVID3 LPVID for channel 0 LPVID for channel 1 LPVID for channel 2 LPVID for channel 3 Considerations for Using UmcSetLPVID LPVID values are in the range of 2 4094 Every NIC channel on a physical port must have a unique LPVID For FCoE and iSCSI channels 0 must be
122. s 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 OCManager gt hbacmd 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 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 OneCommand Manager Command Line Interface Version 6 4 User Manual P009667 01A Rev A 2G EMULEX 5 CLI Client Command Descriptions 70 Diagnostic Commands Parameters WWPN The WWPN of the adapter LoopBackTest This command runs the loop test on the adapter specified by the WWPN or MAC address Note Loopback tests can be run on FC ports being managed locally or remotely through TCP IP based management Supported By Linux Solaris VMware ESXi and Windows Syntax LoopBackTest WWPN MAC Type Count StopOnError 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 tes
123. s of an iSCSI port Target IP IP address of the target portal Port Port number of the target portal OneCommand Manager Command Line Interface Version 6 4 User Manual P009667 01A Rev A is S CLI Client Command Descriptions 101 2 EMULEX iSCSI Commands TargetLogin This command logs in to a target The iSCSI target name lt iscsi target name 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 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 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 TargetSecretl InitCHAPName InitialSecret1 Supported By Linux Solaris VMware ESXi and Windows Syntax TargetLogin MAC Address lt iscsi target name target po
124. s possible parameters at the command line Use the OneCommand Manager application to do any of the following e Support for Dynamic Target Mode enabling an HBA COMSTAR port to be toggled between initiator mode and target mode without requiring a system reboot or adapter reset supported on Solaris 11U1 and later with LightPulse FC HBAs only e Configure COMSTAR Common Multiprotocol SCSI Target for Solaris 11 enabling the Emulex FC driver for Solaris EMLXS to make a host appear as a target to the SAN COMSTAR ports are supported on Solaris 11 with LightPulse FC HBAs only e Use Secure Management to enhance active management security by enabling administrators to define each user s privileges for managing or viewing both local and remote adapters e Provide increased flexibility in assigning protocols to individual ports on adapters e View and configure Universal Multichannel UMC and view properties of other multi channel types e Discover local and remote Emulex and OEM branded Emulex adapters as well as hosts targets virtual ports virtual machines and logical unit numbers LUNs over FC or TCP IP e Manage local FC remote and TCP IP accessed adapters e Remote TCP IP management of adapters on IPv6 hosts e Discover log in to and log out from iSCSI targets e Manage Emulex FC iSCSI FCoE and NIC Only UCNAs e Manage OneConnect OCe11100 series adapters NIC and iSCSI only e Manage LPe16202 CFAs FC and NIC e Manag
125. sion 6 4 User Manual P009667 01A Rev A is S CLI Client Command Descriptions 100 2 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 MAC Address 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 target s iSCSI 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 lt Target IP lt Port gt Parameters MAC Address The MAC addres
126. ssccccccsccceccsssccessssecs 41 hl rec N 46 Adapter License Management Commands cccceeeeeee esee e eene neenon 49 IristallAdapterLicense eee eror xe ne ren ov er xUy ve o 49 ShowAdapterLicenseF Battles iicuoa eee oa o Ed pl Pasa ivbe n 50 ShowAdapterLicenselD 5 55 2 2 soba E ER VeRO ax V d v vin lol nn 50 Attributes COMMANGS ecce ecw Ure vu eer Rave ER E EE e RF XRU FAN CIA e u k ria 51 HbaAttrib tes 15 reet torret ra pr repr e bee e rp E RE Fe EI repe A TEE nia 51 OneCommand Manager Command Line Interface Version 6 4 User Manual P009667 01A Rev A 2c EMULEX Table of Contents 5 PortAttribUtes vid ieie oe ree ETUR PA P vln 51 POMRtSCACISTIGS ep 51 SErverAttriDUtes e c issnsevedesendseelasegsvestedebenneeadadede b hn 52 SetPfcThrottle oes ree rente Er e ae ex TI EE rv One T lo REEL SEE 52 SetPhyPortSpeed iiesecvs e xuu da YE REL LEVA EUER UY KV rn kn E Ea 53 SetPortEnabled cccccce cece cece cece ee eeeeeeeeeeeeeeeeeeeeennsseeeeeseeeeeeessgggasees 54 Authentication COMMANGS 5 ie exe evE reus Qu tnaro ae o TRUM M EVE iv ME PU NE 54 Fay Sohle rk 54 DElELSAUEN CONTIG cT T lo von i nr 55 GOEAUEHCODTIE ax ssd on et Eee do deu rd Rue b rio 55 E ECT IC IULII 55 OSEE TOEIC TTL TID a nn 56 SETALILNK oU ARCET T T 56 SetPassWOLQ voee fo veas eve OE YE EE ne 57 ied NR 58 EnableBootCode reete reto RO E
127. st 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 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 OneCommand Manager Command Line Interface Version 6 4 User Manual P009667 01A Rev A 5 CLI Client Command Descriptions 104 DE EMULEX LUN Masking Commands 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 find any new LUNs Supported By Linux Solaris and Windows 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 S
128. t 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 2 3 Copy the applications kit tar file to a directory on the installation machine Change to the directory where you copied the tar file Untar the file tar zxvf elxocmcore lt supported os gt lt app ver gt lt rel gt tgz Change to the core kit directory created in step 3 cd elxocmcore lt supported os gt lt app ver gt lt rel gt Run the install sh script install sh The core kit consists of two or three rpm files for each supported architecture and each supported version of Linux For example 6 e elxocmlibhbaapi rpm on 64 bit platforms that support 32 bit applications there are two of these files e elxocmcore rpm 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
129. t emulex setdumpdirectory 10 00 00 00 c9 61 f2 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 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 NIC or iSCSI port Value The number of dump files to retain OneCommand Manager Command Line Interface Version 6 4 User Manual P009667 01A Rev A 5 CLI Client Command Descriptions gt lt EMULEX FCoE Commands 82 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 GetFCFInfo WWPN 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 Parameters WWPN The WWPN of an FCoE port Example hbacmd getfipparams 10 00
130. t is not supported via the CIM interface e 4 PHY loopback test only supported for OneConnect UCNAs e 5 MAC loopback test only supported for OneConnect UCNAs 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 6 4 User Manual P009667 01A Rev A DE EMULEX 5 CLI Client Command Descriptions 71 Diagnostic Commands LoopMap Note Supported for FC ports only 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 PciData This command shows the PCI configuration data The PCI registers displayed are specific to the function referenced in the OneCommand Manager CLI For example if you specify the WWPN for the FCoE function the PCI registers for that FCoE function return If you specify the MAC address for the NIC function on that same physical port the PCI registers for that NIC function return Only the base PCI registers return The extended PCI registers are not available on OneConnect or LPe16202 a
131. table Dest IP Address The destination IP address to remove from the ARP table DelRouteTableEntry This command removes a route table entry from the specified port Supported By Linux Solaris VMware ESXi and Windows Syntax DelRouteTableEntry MAC Address Dest IP Address Subnet Mask Gateway Parameters MAC Address MAC address of an iSCSI port Dest IP Address Destination IP address to delete from the route table Subnet Mask Subnet Mask to delete from the route table Gateway Gateway to delete from the route table DiscoveriSNSServer 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 MAC Address OneCommand Manager Command Line Interface Version 6 4 User Manual P009667 01A Rev A is 5 CLI Client Command Descriptions 89 2c EMULEX iSCSI Commands Parameters MAC Address The MAC address of an iSCSI port ExportiSCsl This command outputs iSCSI target information in XML format The output can be redirected to a specified file Supported By Linux Solaris and Windows 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 expor
132. ter 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 MAC Address Dest MAC Address Dest IP Address Parameters MAC Address The MAC address of the UCNA 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 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 OneCommand Manager Command Line Interface Version 6 4 User Manual P009667 01A Rev A is 5 CLI Client Command Descriptions 85 2 EMULEX iSCSI Commands Syntax AddRouteTableEntry MAC Address lt Dest IP Address Subnet Mask gt Gateway 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 add to the route table AddTarget This command adds a targ
133. 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 HbaCmd Syntax Usage The following syntax rules and usage are applicable for the HbaCmd application e Parameters denoted within angle brackets lt gt are required e Parameters denoted within square brackets are optional OneCommand Manager Command Line Interface Version 6 4 User Manual P009667 01A Rev A is 4 CLI Client Command Usage 29 DG EMULEX HbaCmd Syntax Usage 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 required to be in all lowercase letters e An optional IP address or host name can be specified 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
134. ting and Stopping Daemon Processes 2 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 3 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 Install Location gt Emulex Util Uninstall 2 Type uninstall OCManager Core bat Starting and Stopping Daemon Processes Linux and Solaris On Linux and Solaris machines you can stop and start the OneCommand Manager daemon processes using the stop ocmanager and start ocmanager scripts respectively These are found in the following OneCommand Manager installation 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 6 4 User Manual P009667 01A Rev A ys 3 Updating to the OneComman
135. tiscsi targets xml GetlnitiatorProperties This command shows all the initiator login options for the specified port These properties are set as the target portal s login properties to be used when discovering the targets on the target portal The discovered targets inherit these properties Supported By Linux Solaris VMware ESXi and Windows Syntax GetInitiatorProperties MAC Address 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 OneCommand Manager Command Line Interface Version 6 4 User Manual P009667 01A Rev A is 5 CLI Client Command Descriptions 90 2 EMULEX iSCSI Commands Syntax GetiSCSILuns MAC Address lt iscsi target name Parameters MAC Address The MAC address of an iSCSI port iscsi target name Targets 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 Parameters MAC Address The MAC address of an iSCSI port GetNetworkConfiguration This command lists a port s TCP IP information Supported By Linux Solaris VMware ESXi and
136. ue 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 TargetSecret1 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 TargetSecretl InitCHAPName InitialSecretl1 Supported By Linux Solaris VMware ESXi and Windows Syntax SetTargetLoginProperties MAC Address iscsi target name 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 P009667 01A Rev A is 5 CLI Client Command Descriptions 97 2c EMULEX iSCSI Commands Parameters MAC Address The MAC address 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 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
137. uotes string length 1 224 Initiator Alias Initiator iSCSI alias enclosed in quotes string length 0 32 ImmediateData 0 No 1 Yes default OneCommand Manager Command Line Interface Version 6 4 User Manual P009667 01A Rev A is 5 CLI Client Command Descriptions 95 2c EMULEX iSCSI Commands 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 MAC Address lt 0 1 gt Parameters MAC Address The MAC address of an iSCSI port 011 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 Syntax SetNetworkConfiguration MAC Address lt VLAN ENABLED lt 0 1 gt lt VLAN ID 0 4096 lt Priority lt 0 7 gt gt lt DH
138. upported 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 OneCommand Manager Command Line Interface Version 6 4 User Manual P009667 01A Rev A 5 CLI Client Command Descriptions 1Q5 2 EMULEX Miscellaneous Commands Option 0 Get information from the driver 1 Get information from the configuration make persistent 2 gt 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 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 VMware ESXi and Windows Syntax For the RM interface hbacmd AddHost host address Note The h option for specifying an optional IP address or host name after hbacmd is not available for the AddHost command For VMware ESXi using the CIM interface 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 Cre
139. wing 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 2 If the HBAnyware Security Configurator is installed follow these steps 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 ne S Run the uninstall script with the ssc parameter specified Type uninstall ssc 3 Uninstall the HBAnyware utility and the Application Helper module a Log on as root b Change to the directory containing the tar file c Extract the tar file using the tar xvf command d Change to the newly created directory e Uninstall any previously installed versions Type uninstall Solaris Installing in Solaris Note Prior to installation OneCommand groups must be configured on the LDAP network or the local host machine for Secure
140. x A OneCommand Manager Error Messages eee enne 129 OneCommand Manager Command Line Interface Version 6 4 User Manual P009667 01A Rev A 2G EMULEX List of Tables 9 List of Tables Table 1 1 Secure Management User Privileges ccce eene 14 Table 1 2 Active Commands machines on same domain cccccececeeeeeesseseeeeees 15 Table 1 3 Active Commands machines on different domain o00ooooooonnvnvvo ee 15 Table 1 4 Passive Commands machines on any domain eeeeeeeeeeeeeeee eese 15 Table 5 1 CLI Client Command Reference ccceeceeceeeeececeeeeeessssueeeeeeeeeeeeeees 41 Table 5 2 SannEIFIU Sm 84 Table A 1 OneCommand Manager Error Messages ceeeeceeeencceeeenseeeeeeeseeeeees 129 OneCommand Manager Command Line Interface Version 6 4 User Manual P009667 01A Rev A 2C EMULEX 1 Introduction 10 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 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 it
141. y 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 6 4 User Manual P009667 01A Rev A Table of Contents 2G EMULEX Table of Contents Listof Tables s nadavadin c v r b h v 9 1e INEFORU CEION err oki i av 10 OVE VIEW C uv s ok Nr a ink 10 Compatibilty PP 11 PDDREVIAUIONS M 12 OneCommand Manager Secure Management ccscsccccssscccccccccccccsssssceeececes 14 OVervieW fase

User Manual

Contents

Download Pdf Manuals

Related Search

Related Contents