Emulex® OneCommand® Manager Command Line Interface User Guide Release 12.
Broadcom, the pulse logo, Connecting everything, Avago Technologies, Avago, the A logo, Brocade, ClearLink, Emulex, and OneCommand are among the trademarks of Broadcom and/or its affiliates in the United States, certain other countries, and/ or the EU. Copyright © 2003–2019 Broadcom. All Rights Reserved. The term “Broadcom” refers to Broadcom Inc. and/or its subsidiaries. For more information, please visit www.broadcom.com.
Emulex OneCommand Manager Command Line Interface User Guide Table of Contents Chapter 1: Introduction ...................................................................................................................... 8 1.1 Abbreviations ............................................................................................................................................................9 1.2 OneCommand Manager Secure Management........................................................................
Emulex OneCommand Manager Command Line Interface User Guide 4.4 CIM Client Interface.................................................................................................................................................25 4.4.1 Device Management Using the CIM Interface ................................................................................................25 4.4.2 Syntax Rules for the CIM Interface ...........................................................................................
Emulex OneCommand Manager Command Line Interface User Guide 5.7 Diagnostic Commands ...........................................................................................................................................49 5.7.1 D_Port.............................................................................................................................................................50 5.7.2 EchoTest...................................................................................................
Emulex OneCommand Manager Command Line Interface User Guide 5.12 Miscellaneous Commands ...................................................................................................................................69 5.12.1 AddHost ........................................................................................................................................................69 5.12.2 Download .......................................................................................................
Emulex OneCommand Manager Command Line Interface User Guide 5.16 vPort Commands ..................................................................................................................................................99 5.16.1 CreateVPort ..................................................................................................................................................99 5.16.2 DeleteVPort................................................................................................
Emulex OneCommand Manager Command Line Interface User Guide Chapter 1: Introduction The OneCommand® Manager command line interface (CLI) is a comprehensive management utility for Emulex® adapters. The CLI provides support for commonly used commands without requiring the installation of the OneCommand Manager graphical user interface (GUI). The OneCommand Manager CLI console application name is HbaCmd.
Emulex OneCommand Manager Command Line Interface User Guide 1.
Emulex OneCommand Manager Command Line Interface User Guide QSFP quad small form-factor pluggable RHEL Red Hat Enterprise Linux Rx receive SAN storage area network SCSI Small Computer Systems Interface SFCB Small Footprint CIM Broker SFP small form-factor pluggable SLES SUSE Linux Enterprise Server TCP Transmission Control Protocol Tx transmit UEFI Unified Extensible Firmware Interface VLAN virtual local area network VLAN ID VLAN identifier VPD vital product data vPort virtual
Emulex OneCommand Manager Command Line Interface User Guide 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, appear in the output of this command. NOTE: Although users can belong to the administrator group or be a root user, they will not have full privileges to run the OneCommand Manager unless they are also a member of the ocmadmin group.
Emulex OneCommand Manager Command Line Interface User Guide User Group Membership – From the host machine, OneCommand Manager Secure Management must be able to access the OneCommand Manager group to which the user belongs. For Linux and Solaris systems, it uses the getgrnam and getgrid C-library API calls. The equivalent to the API calls can be obtained by typing getent group from the shell command line.
Emulex OneCommand Manager Command Line Interface User Guide 1.4 Setting Secure Management Mode for Linux and Solaris To set the Secure Management mode for the Linux and Solaris operating systems, perform these steps: 1. Log on as root. 2. Set Secure Management: – To set Secure Management mode for Linux, type the following command: # /usr/sbin/ocmanager/set_operating_mode – To set Secure Management mode for Ubuntu 14, type the following command: # /opt/emulex/ocmanager/scripts/set_operating_mode.
Emulex OneCommand Manager Command Line Interface User Guide Chapter 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, and Windows. It also describes the Secure Management capability and the procedure for starting and stopping daemon processes. 2.
Emulex OneCommand Manager Command Line Interface User Guide The core kit consists of three or four rpm files for each supported architecture and each supported version of Linux. For example: elxocmlibhbaapi-*.rpm (on 64-bit platforms that support 32-bit applications, there are two of these files) elxocmcore-*.rpm elxocmcorelibs-*.rpm 6.
Emulex OneCommand Manager Command Line Interface User Guide NOTE: There is no update path from an HBAnyware 4.x or 3.x core kit to a OneCommand Manager 5.1 or later core kit. You must uninstall previous versions of the HBAnyware utility before installing a OneCommand Manager core kit. For information on uninstalling older versions of HBAnyware, see Section 2.1.4, Uninstalling Older HBAnyware Kits in Linux. 2.1.2.2 Performing a Clean Installation (Overwriting Existing Settings) 1.
Emulex OneCommand Manager Command Line Interface User Guide c. Extract the tar file using the tar -xvf command. d. Change to the newly created directory. e. Type the following uninstall script with the ssc parameter specified: ./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.
Emulex OneCommand Manager Command Line Interface User Guide 5. When you are prompted, choose whether 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'.
Emulex OneCommand Manager Command Line Interface User Guide 2.4 Windows The following instructions are for installing and uninstalling the OneCommand Manager CLI on Windows operating systems. Install the OneCommand Manager CLI in Windows in one of two ways: Attended installation – You are present during the installation. You are prompted for more information for the installation to continue. Unattended installation – You do not need to be present during the installation.
Emulex OneCommand Manager Command Line Interface User Guide For example, at the command prompt, type the following command: elxocm-windows-x64-5.01.00.10-4.
Emulex OneCommand Manager Command Line Interface User Guide 2.4.3.2 Uninstalling through the Command Line To uninstall the OneCommand Manager CLI in Windows through the command line, perform these steps: 1. Change to the appropriate uninstall directory: cd \Emulex\Util\Uninstall 2. Type the following command: uninstall_OCManager_Core.bat 2.
Emulex OneCommand Manager Command Line Interface User Guide Chapter 3: Updating the OneCommand Manager CLI to the OneCommand Manager Enterprise Kit NOTE: The full-featured OneCommand Manager enterprise kit is not supported on the VMware ESXi server. This chapter details procedures for updating the OneCommand Manager CLI to the OneCommand Manager enterprise kit in Linux, Solaris, and Windows operating systems.
Emulex OneCommand Manager Command Line Interface User Guide Chapter 4: CLI Client Command Usage 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. 4.1 Overview The CLI Client is intended for use in command shells or scripted operations from within shell scripts or batch files. The CLI Client is a console application named HbaCmd.
Emulex OneCommand Manager Command Line Interface User Guide For FC functions, 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 ( ). If space separators are used, the entire WWPN must be enclosed in quotation marks (“ ”).
Emulex OneCommand Manager Command Line Interface User Guide 4.4 CIM Client Interface NOTE: In Linux and Solaris, you cannot use HbaCmd as a CIM client. 4.4.1 Device Management Using the CIM Interface VMware on the hypervisor-based ESXi platforms uses the CIM as the only standard management mechanism for device management.
Emulex OneCommand Manager Command Line Interface User Guide 4.4.2.1.1 Default CIM Credentials If you specify the command with the CIM method m=cim without specifying the CIM credentials (userid, password, or namespace), the default value for the missing CIM credential is obtained in the following order: 1. The information entered using the addhost command is looked up. 2. If no values exist, the information entered using the setcimcred command is used. 3.
Emulex OneCommand Manager Command Line Interface User Guide Chapter 5: CLI Client Command Descriptions CLI Client commands are organized by command groups. Two tables are presented for your convenience: a table organized by command group and another by alphabetically listing CLI Client commands. The following table displays each command group with a short description and the commands in each group.
Emulex OneCommand Manager Command Line Interface User Guide Table 5: CLI Client Command Reference Functional Groups (Continued) Command Group Description Commands Diagnostic Commands This group provides commands that enable you to detect cabling D_Port problems, to examine transceiver data, and to flash memory load lists. EchoTest Additionally, you can run specific diagnostic tests, such as the Loopback FcTraceRoute test and the POST.
Emulex OneCommand Manager Command Line Interface User Guide Table 5: CLI Client Command Reference Functional Groups (Continued) Command Group Description Commands NVMe Commands This group contains commands that are specifically used for NVMe over nvme-attach-ns FC targets.
Emulex OneCommand Manager Command Line Interface User Guide Table 6: CLI Client Command Reference Linux Command RHEL, SLES, Ubuntu, Oracle Solaris Windows CIM elxvcpcmd Section AddHost Section 5.12.1, AddHost AllNodeInfo Section 5.14.1, AllNodeInfo AuthConfigList Section 5.3.
Emulex OneCommand Manager Command Line Interface User Guide Table 6: CLI Client Command Reference (Continued) Linux Command RHEL, SLES, Ubuntu, Oracle Solaris Windows CIM elxvcpcmd Section GetVPD Section 5.12.6, GetVPD GetWWNCap Section 5.17.2, GetWWNCap GetXcvrData Section 5.7.5, GetXcvrData HbaAttributes Help N/A InitiateAuth Section 5.2.1, HbaAttributes Section 5.1, Help Section 5.3.
Emulex OneCommand Manager Command Line Interface User Guide Table 6: CLI Client Command Reference (Continued) Linux Command RHEL, SLES, Ubuntu, Oracle Solaris Windows SaveConfig ServerAttributes SetAuthConfig CIM elxvcpcmd Section Section 5.8.4, SaveConfig Section 5.2.5, ServerAttributes Section 5.3.8, SetAuthConfig SetAuthConfigParams Section 5.3.9, SetAuthConfigParams SetAuthConfigSecret Section 5.3.
Emulex OneCommand Manager Command Line Interface User Guide Syntax Help [GroupName] [CmdName] Parameters GroupName This optional parameter lists the commands in a particular group. CmdName This optional parameter displays the details for a particular CLI command. Examples This Help command example lists all the commands in their respective groups: hbacmd help This Help command example displays the details for the SetDCBParam command: hbacmd help setdcbparam 5.
Emulex OneCommand Manager Command Line Interface User Guide Driver Name: Driver Version: Device ID: HBA Type: Operational FW: IEEE Address: Boot Code: Boot Version: Board Temperature: Function Type: Sub Device ID: PCI Bus Number: PCI Func Number: Sub Vendor ID: IPL Filename: Service Processor FW Name: ULP FW Name: FC Universal BIOS Version: FC x86 BIOS Version: FC EFI BIOS Version: FC FCODE Version: Flash Firmware Version: elxfc 11.0.247.0 E300 LPe32002-M2 11.1.38.61 00 90 fa 94 26 af Enabled 11.1.38.
Emulex OneCommand Manager Command Line Interface User Guide 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 Port Supported Speed: 4 8 16 Gbit/sec Configured Port Speed: Auto Detect Port Speed: Not Available Max Frame Size: 2048 OS Device Name: \\.\Scsi5: Num Discovered Ports: 0 Fabric Name: 00 00 00 00 00 00 00 00 Function Type: FC FEC: Disabled 5.2.3 PortStatistics This command displays all function statistics for the specified function.
Emulex OneCommand Manager Command Line Interface User Guide Parameters WWPN The WWPN of an FC function. MAC The MAC address of a NIC function. 5.2.6 SetPhyPortSpeed This command sets the port speed on PPC CNAs. PPC CNAs have configurable physical port speeds. Depending on the port module or transceiver installed in the physical port, the speed settings can be forced to a specific value (for example, 1 Gb/s) or to a range of values for autonegotiation with the switch (for example, 10 Gb/1 Gb/100 Mb).
Emulex OneCommand Manager Command Line Interface User Guide The following example tries to configure the PHY port to a forced speed of 100 Mb/s: hbacmd setphyportspeed 00-00-c9-a9-41-88 2 100Mb If the command is successful, the following is displayed: Successfully changed speed settings on port. If the Mode parameter is 2, this command results in the following error because you must include a value for the Length parameter: ERROR: <431>: Cable length required for force mode and interface type 5.2.
Emulex OneCommand Manager Command Line Interface User Guide 5.3.2 DeleteAuthConfig This command deletes the authentication configuration on LPe12000-series adapters only. NOTE: The RemoveAuthConfig command is deprecating this command. Supported By Linux, Solaris, and Windows Syntax DeleteAuthConfig Parameters WWPN1 The WWPN of an FC function. WWPN2 Either use ff:ff:ff:ff:ff:ff:ff:ff for a switch or use the WWPN for a target.
Emulex OneCommand Manager Command Line Interface User Guide 5.3.5 InitiateAuth This command initiates the authentication configuration on the adapter. Supported By Linux, Solaris, Windows, and Windows + CIM Provider on a VMware host Syntax InitiateAuth Parameters WWPN1 The WWPN of an FC function. WWPN2 Either use ff:ff:ff:ff:ff:ff:ff:ff for a switch or use the WWPN for a target. 5.3.
Emulex OneCommand Manager Command Line Interface User Guide Entity pair LocalEntity or RemoteEntity LocalEntity = Source WWPN RemoteEntity = Destination WWPN Use all to delete the entire authentication configuration. 5.3.8 SetAuthConfig This command sets the authentication configuration on LPe12000-series adapters only. NOTE: The SetAuthConfigParams command is deprecating this command.
Emulex OneCommand Manager Command Line Interface User Guide 5.3.9 SetAuthConfigParams This command sets one or more authentication configuration parameters for the FC port. Supported By Linux, Solaris, and Windows Syntax setauthconfigParams Parameters WWPN1 The WWPN of an FC function. WWPN2 Either use ff:ff:ff:ff:ff:ff:ff:ff for a switch or use the actual WWPN for a target.
Emulex OneCommand Manager Command Line Interface User Guide 5.3.11 SetPassword This command sets the password on LPe12000-series adapters only for an authenticated connection to the switch. NOTE: The SetAuthConfigSecret command is deprecating this command. NOTE: The SetPassword command will not be available in future releases. Supported By Linux, Solaris, and Windows Syntax SetPassword Parameters WWPN1 The WWPN of an FC function.
Emulex OneCommand Manager Command Line Interface User Guide Supported By Linux, Solaris, Windows, and Windows + CIM Provider on a VMware host Syntax EnableBootCode Parameters WWPN The WWPN of an FC function. Flag D = Disable the boot code. E = Enable the boot code. Examples The following example enables boot code: hbacmd EnableBootCode 10:00:00:00:c9:20:20:20 e 5.4.2 GetBootParams This command displays the FC boot parameters.
Emulex OneCommand Manager Command Line Interface User Guide Syntax SetBootParam [BootDev ] Parameters WWPN The WWPN of an FC port. Type x86, EFI, OB AdapterParam The parameter name. Value1 The parameter value. BootDev The boot device.
Emulex OneCommand Manager Command Line Interface User Guide NOTE: This command is not supported on PPC CNAs. Use the SetPhyPortSpeed command instead. Supported By Linux, Solaris, Windows, and Windows + CIM Provider on a VMware host Syntax SetPortSpeed Parameters WWPN The WWPN of an FC port. LinkSpeed A numeric value representing a supported link speed. For a list of port speeds supported by the adapter, use the PortAttributes command.
Emulex OneCommand Manager Command Line Interface User Guide Param The name of the congestion parameter to be set. CGN-MODE = Congestion mode Value 0 = Off; congestion management is disabled. 1 = Fixed; use only if instructed by Broadcom Technical Support. 2 = Adaptive-Conservative; a minimum level of congestion management is performed. 3 = Adaptive-Moderate; a medium level of congestion management is performed. 4 = Adaptive-Aggressive; a strong level of congestion is performed.
Emulex OneCommand Manager Command Line Interface User Guide Syntax GetPGInfo Parameters WWPN The WWPN of an FC function on the port. MAC The MAC address of a NIC function on the port. Example hbacmd getpginfo 00-00-c9-93-2f-d8 5.6.3 SetCnaPGBW This command sets the ETS priority group bandwidth percentages on a port of a PPC CNA according to the following rules: Bandwidths (BW0–BW7) for priority groups 0 to 7 (PG0 to PG7) must total 100 (for 100 percent).
Emulex OneCommand Manager Command Line Interface User Guide Value The parameter value. See DCB Settings for and and LLDP Settings for and . DCB Settings for and Description and DCBXState The DCBX protocol state. 0 = Disabled 1 = Enabled PFCEnable Flow control in both directions (transmit and receive). 0 = Disabled 1 = Enabled PFCPriority A list of comma-separated values where multiple PFC priorities are supported.
Emulex OneCommand Manager Command Line Interface User Guide 5.6.5 SetDCBPriority This command sets the PFC priorities and the ETS priorities. The values must be set according to the following rules: The priorities range from 0 to 7. A priority (0 to 7) must exist in only one priority group. All priorities must appear once in any of the eight (PG0 to PG7) priority groups, or if available, PG15. To not specify priorities for a priority group, use a dash (-).
Emulex OneCommand Manager Command Line Interface User Guide 5.7.1 D_Port D_Port, also called ClearLink®, is a set of diagnostic tests that detects physical cabling issues that result in increased error rates and intermittent behavior. (Not supported on LPe12000-series adapters.) This command is supported only for FC adapters connected to D_Port-enabled Brocade® switches. Bidirectional D_Port testing is supported. The switch or initiator can initiate D_Port testing.
Emulex OneCommand Manager Command Line Interface User Guide Successful Test > hbacmd DPortTest 10:00:00:00:c9:d1:a2:d0 Running D_Port Tests. Please wait. Polling for results...........................
Emulex OneCommand Manager Command Line Interface User Guide Frame Size: 2112 Round Trip Latency: 1898 nanoseconds Estimated Cable Length: 172 meters ================================================================================= Test Phase Result Latency Local Errors Remote Errors ================================================================================= Electrical Loopback Passed 127 Optical Loopback Passed 1898 Reverse Optical Loopback Skipped 0 Link Traffic Failed n/a 5.7.
Emulex OneCommand Manager Command Line Interface User Guide Example > hbacmd fctraceroute 10:00:00:90:fa:5d:05:a9 50:06:01:60:90:20:5C:38 Test to be run: FC Trace Route (FTR) FC trace route test status: Test pending. Polling for results… Test running ..........
Emulex OneCommand Manager Command Line Interface User Guide Ingress Port Name: Ingress Port Num: Egress Port Name: Egress Port Num: 30:2a:0F:01:39:27:01:27 42 30:09:05:01:39:27:01:27 9 5.7.4 GetBeacon This command displays the current beacon state (either on or off). Supported By Linux, Solaris, Windows, and Windows + CIM Provider on a VMware host Syntax GetBeacon Parameters WWPN The WWPN of the FC function on the port. MAC The MAC address of the NIC function on the port. 5.7.
Emulex OneCommand Manager Command Line Interface User Guide Parameters WWPN The WWPN of the FC function on the adapter. 5.7.7 LoopBackTest This command runs one of the loopback tests available on the adapter port specified by the WWPN or MAC address. NOTE: Adapters and port information are not available during diagnostic loopback tests. Internal and External loopback tests on trunking-enabled ports do not support Infinite test cycles.
Emulex OneCommand Manager Command Line Interface User Guide Syntax LoopMap Parameters WWPN The WWPN of the FC function. 5.7.9 PciData This command displays the PCI configuration data (if available). The PCI registers displayed are specific to the function referenced in the OneCommand Manager CLI. For example, if you specify the MAC address for the NIC function, the PCI registers for that NIC function are returned.
Emulex OneCommand Manager Command Line Interface User Guide MSI-X PBA Offset: VPD Address/Nxt/ID: VPD Data: PCIE Capabilities/Nxt/ID: PCIE Device Cap.
Emulex OneCommand Manager Command Line Interface User Guide 5.7.11 SetBeacon This command turns the beacon on or off on the adapter port and sets the beacon’s duration. Supported By Linux, Solaris, Windows, and Windows + CIM Provider on a VMware host Syntax SetBeacon [BeaconDuration] Parameters WWPN The WWPN of an FC function on the port. MAC The MAC address of a NIC function on the port. BeaconState Indicates the state of the beacon.
Emulex OneCommand Manager Command Line Interface User Guide Additionally, if temporary and global values are set for one or more driver parameters, the SaveConfig command must be run with the N flag (using the N flag is analogous to using the GetDriverParams command) to force the driver parameter values for the specified adapter to be saved. Inaccurate values can be saved if the G flag is used for this command.
Emulex OneCommand Manager Command Line Interface User Guide 5.8.4 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: = The command saves either the values of the global set or those specific to the adapter in the Emulex Repository directory.
Emulex OneCommand Manager Command Line Interface User Guide 5.8.6 SetDriverParamDefaults This command changes all values to the default for the adapter. Supported By Linux and Windows Syntax SetDriverParamDefaults Parameters WWPN The WWPN of an FC function. Flag1 L = Make the change local for only this function. G = Make the change global (applies to all FC functions on this host). Flag2 P = Make the change permanent (the change persists across reboot).
Emulex OneCommand Manager Command Line Interface User Guide 5.9.2 Dump This command creates a diagnostic dump file in the HbaCmd dump file directory. Supported By Linux, Solaris, Windows, and Windows + CIM Provider on a VMware host Syntax Dump Parameters WWPN The WWPN of an FC port. MAC The MAC address of a NIC port. 5.9.3 GetDumpDirectory This command displays the dump file directory for the adapters in the host. NOTE: The dump directory can be set only on VMware ESXi hosts.
Emulex OneCommand Manager Command Line Interface User Guide Syntax GetDumpFile [WWPN|MAC] Parameters WWPN Obsolete; ignored if specified. MAC Obsolete; ignored if specified. filename The name of the dump file to be copied from the remote host. Example hbacmd GetDumpFile h=10.192.193.154 BG-HBANYWARE-15_10000000c97d1314_20100120-032820421.dmp 5.9.5 GetDumpFileNames This command gets the names of the files in the host’s dump directory.
Emulex OneCommand Manager Command Line Interface User Guide 5.9.7 SetDumpDirectory This command sets the dump directory (valid only on VMware ESXi hosts). Supported By Windows + CIM Provider on a VMware host To use the SetDumpDirectory command, you must have a directory (which must be a storage partition) mapped under /vmfs/volumes where the files are 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.
Emulex OneCommand Manager Command Line Interface User Guide 5.10 Firmware Commands These commands enable you to view and configure firmware parameters. 5.10.1 getfwparams This command displays a list of all configurable firmware parameters. Supported By Windows, Linux, and Windows + CIM Provider on a VMware host NOTE: The CGN-MODE,CGN-DETECT-METHOD,CGN-DRV-RESP, and CGN-ACR parameters are not supported on LPe12000-series and LPe15000-series adapters.
Emulex OneCommand Manager Command Line Interface User Guide param The parameter to modify. FA-PWWN - Enables or disables the FA-PWWN parameter. NOTE: The link is toggled if FA-PWWN is enabled, but the switch does not support FA-PWWN. NOTE: You must reset the adapter port to activate new FA-PWWN parameter setting, and you must reload the OneCommand Manager application to display the new setting.
Emulex OneCommand Manager Command Line Interface User Guide 5.11 LUN Masking Commands The LUN Masking Commands group manages LUN masking activities. LUN masking commands are supported only for FC functions. NOTE: Linux, Solaris, and Windows + CIM Provider on a VMware host do not support the following commands: GetLunUnMaskByHBA GetLunUnMaskByTarget RescanLuns SetLunMask 5.11.1 GetLunList This command queries for the presence of any masked LUNs.
Emulex OneCommand Manager Command Line Interface User Guide 5.11.3 GetLunUnMaskByTarget This command queries for any unmasked LUNs by target. Supported By Windows Syntax GetLunUnMaskByTarget
Emulex OneCommand Manager Command Line Interface User Guide MaskOp A = Mask the LUN B = Clear unmask the target level C = Clear unmask the HBA level D = Unmask the LUN E = Unmask the target level F = Unmask the HBA level 5.12 Miscellaneous Commands Commands in the Miscellaneous Command group do not fit in other groups. See specific commands for adapter limitations. 5.12.1 AddHost This command adds a host to the hosts file for remote TCP/IP management in the OneCommand Manager application.
Emulex OneCommand Manager Command Line Interface User Guide 5.12.2 Download This command downloads a firmware image to the port function or adapter specified by the WWPN or MAC address. Considerations If you attempt to update unauthenticated firmware for an LPe31000-series or LPe32000-series adapter, the following error message is displayed: ERROR: Download Failed due to invalid firmware digital signature. Please contact customer support for additional help.
Emulex OneCommand Manager Command Line Interface User Guide 5.12.3 ExportSANInfo For reporting purposes, this command captures the SAN information in .xml for XML-formatted files and .csv for CSV-formatted files. NOTE: This command can take a long time on large SAN configurations because of the large amount of information that must be obtained and reported. The output can also be redirected to a file if required.
Emulex OneCommand Manager Command Line Interface User Guide Syntax GetCimCred Parameters None. 5.12.6 GetVPD This command displays the port’s vital product data (VPD). Supported By Linux, Solaris, Windows, and Windows + CIM Provider on a VMware host Syntax GetVPD Parameters WWPN The WWPN of an FC function. MAC The MAC address of a NIC function. 5.12.7 ListHBAs This command displays a list of the manageable Broadcom Emulex adapters found by local discovery.
Emulex OneCommand Manager Command Line Interface User Guide Syntax For the remote management interface: RemoveHost host_address For VMware ESXi using the CIM interface: m=cim RemoveHost 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. m The CIM version of the VMware ESXi. 5.12.
Emulex OneCommand Manager Command Line Interface User Guide namespace The namespace where the Emulex CIM provider is registered in the SFCB CIMOM of VMware ESXi, specifically root/emulex. portnum The port number of the SFCB that CIMOM is listening to, that is, 5988 (HTTP) or 5989 (HTTPS). 5.12.11 TargetMapping This command displays a list of mapped targets and the LUNs for an FC function on a port.
Emulex OneCommand Manager Command Line Interface User Guide To determine whether namespace management is supported by the target, issue the nvme-id-ctrl command (see Section 5.13.7, nvme-id-ctrl), and examine the value displayed in the Namespace Management field. Some commands require you to enter parameters, such as the Target WWPN, NQN, and CtrlID. To determine these parameters, issue the nvme-list command (see Section 5.13.9, nvme-list).
Emulex OneCommand Manager Command Line Interface User Guide Syntax hbacmd nvme-create-ns [CtrlID=] [Size=] [Capacity=] [LBAF=] [MDT=][DPS=] [NMIC=] Parameters WWPN The WWPN of the FC initiator port. Target WWPN The WWPN of an FC port on an NVMe-capable device. NQN The qualified name of the NVMe subsystem. ctrlid The controller that processes the request, in hexadecimal.
Emulex OneCommand Manager Command Line Interface User Guide This example displays a generic failure: hbacmd nvme-create-ns 10:00:00:90:fa:e0:63:48 20:03:00:11:0d:a5:70:00 nqn.2014-08.org.
Emulex OneCommand Manager Command Line Interface User Guide This example deletes all namespaces: hbacmd nvme-delete-ns 10:00:00:90:fa:5d:05:a9 50:06:01:60:90:20:5C:38 nqn.201408.com.example:nvme.host.sys.xyz all 5.13.4 nvme-detach-ns The nvme-detach-ns command detaches a namespace from one or more controllers to which it is attached. NOTE: Use this command to detach a namespace from its controllers before using the nvme-delete-ns command to delete the namespace.
Emulex OneCommand Manager Command Line Interface User Guide Parameters WWPN The WWPN of the FC initiator port. Target WWPN The WWPN of an FC port on an NVMe-capable device. NQN The qualified name of the NVMe subsystem.
Emulex OneCommand Manager Command Line Interface User Guide tempselect The temperature threshold value to be retrieved: 0x00 = Over-temperature threshold value for composite temperature 0x01 = Over-temperature threshold value for temperature sensor 1 0x02 = Over-temperature threshold value for temperature sensor 2 ...
Emulex OneCommand Manager Command Line Interface User Guide Examples This example displays no optional parameters specified: hbacmd nvme-get-feature 10:00:00:90:fa:5d:05:a9 50:06:01:60:90:20:5C:38 nqn.201408.com.example:nvme.host.sys.
Emulex OneCommand Manager Command Line Interface User Guide 0030: 35 4d 5a 2d 45 4c 58 20 20 20 20 20 52 03 00 48 0040: 00 3a 00 00 41 41 31 32 32 31 4a 30 43 32 50 20 This example displays the temperature threshold feature selected: hbacmd nvme-get-feature 10:00:00:90:fa:5d:05:a9 50:06:01:60:90:20:5C:38 nqn.201408.com.example:nvme.host.sys.
Emulex OneCommand Manager Command Line Interface User Guide Information similar to the following is displayed: Feature: Interrupt Coalescing Value(Current) 1024 2048 Attribute Name Aggregation Threshold Aggregation Time (ms) This example displays the interrupt vector configuration feature selected: hbacmd nvme-get-feature 10:00:00:90:fa:5d:05:a9 50:06:01:60:90:20:5C:38 nqn.201408.com.example:nvme.host.sys.
Emulex OneCommand Manager Command Line Interface User Guide This example displays the host memory buffer feature selected: hbacmd nvme-get-feature 10:00:00:90:fa:5d:05:a9 50:06:01:60:90:20:5C:38 nqn.201408.com.example:nvme.host.sys.
Emulex OneCommand Manager Command Line Interface User Guide Human-readable sample output: Attribute Name Host Identifier Value(Current) 0xa7a5b1323132 This example displays the reservation notification mask feature selected: hbacmd nvme-get-feature 10:00:00:90:fa:5d:05:a9 50:06:01:60:90:20:5C:38 nqn.201408.com.example:nvme.host.sys.
Emulex OneCommand Manager Command Line Interface User Guide Parameters WWPN The WWPN of the FC initiator port. Target WWPN The WWPN of an FC port on an NVMe-capable device (optional). Example hbacmd nvme-get-sstable 10:00:00:90:fa:5d:05:a9 Information similar to the following is displayed: NVMe Qualified Name : nqn.2014-08.com.example1:nvme.host.sys.xyz Port WWN : 50:06:01:60:90:20:5C:38 Node WWN : 50:06:01:60:10:20:5C:38 CtrlID : 0X0001 NVMe Qualified Name : nqn.2014-08.com.example2:nvme.host.sys.
Emulex OneCommand Manager Command Line Interface User Guide Information similar to the following is displayed: Attributes for Controller 0x0001: IEEE OUI Identifier : 032957 Maximum data transfer size : 5120 NVMe version supported : 1.2.
Emulex OneCommand Manager Command Line Interface User Guide 0C80: 0C90: 0CA0: 0CB0: …………: …………: …………: 0FF0: 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 Th
Emulex OneCommand Manager Command Line Interface User Guide NSID The namespace identifier, in hexadecimal; use it to list only controllers attached to the specified namespace. Set to 0xFFFFFFFF to retrieve capabilities that are common across all namespaces. Type The namespace identifier type: 0 = Active 1 = Allocated Must be set to 0 if NDSID=0xFFFFFFFF. ctrlid The controller that processes the request, in hexadecimal. raw Specifies that the output is to be provided in hexadecimal format (optional).
Emulex OneCommand Manager Command Line Interface User Guide IEEE Extended Unique Identifier Size Capacity Usage Logical Block Size Multi-path Access LBA Format Number of Supported LBA Formats End-to-end Data Protection Reservations : : : : : : : : : : 00-00-03-25-01-FF-00-03 32768 (Logical Blocks) 32768 (Logical Blocks) 32768 (Logical Blocks) 1024 Bytes Yes 0 0 Disabled Not Supported Namespace Features: Thin Provisioning : Supported Unwritten Logical Block Error: Supported NAWUN, NAWUPF, NAWCWU : Not Su
Emulex OneCommand Manager Command Line Interface User Guide This example displays the raw parameter specified: hbacmd nvme-id-ns 10:00:00:90:fa:5d:05:a9 50:06:01:60:90:20:5C:38 nqn.201408.com.example:nvme.host.sys.
Emulex OneCommand Manager Command Line Interface User Guide Syntax hbacmd nvme-list [Target WWPN] Parameters WWPN The WWPN of the FC initiator port. Target WWPN The WWPN of an FC port on an NVMe-capable device (optional). Example hbacmd nvme-list 10:00:00:90:fa:5d:05:a9 Information similar to the following is displayed: Discovered NVMe Subsystems for 10:00:00:90:fa:5d:05:a9 NVMe Qualified Name : nqn.2014-08.com.example:nvme.host.sys.
Emulex OneCommand Manager Command Line Interface User Guide Example hbacmd nvme-list-ctrl 10:00:00:90:fa:5d:05:a9 50:06:01:60:90:20:5C:38 nqn.201408.com.example:nvme.host.sys.xyz Information similar to the following is displayed: Controllers for subsystem nqn.2014-08.com.example:nvme.host.sys.xyz Number of Controllers: 3 Controller ID: 0x0000 Controller ID: 0x0001 Controller ID: 0x0002 5.13.11 nvme-list-ns The nvme-list-ns command lists the namespaces for a specified NVMe target.
Emulex OneCommand Manager Command Line Interface User Guide Namespace ID : 0x00000003 Namepsece ID : 0x00000004 This example displays active namespace identifiers selected: hbacmd nvme-list-ns 10:00:00:90:fa:5d:05:a9 50:06:01:60:90:20:5C:38 nqn.201408.com.example:nvme.host.sys.
Emulex OneCommand Manager Command Line Interface User Guide The size of the Admin Submission Queue for the specified controller. The range of valid values is 2 to 4096. This parameter is required if Action = 1; otherwise, it is optional. SQSize Example hbacmd nvme-set-sstable 10:00:00:90:fa:5d:05:a9 50:06:01:60:90:20:5C:38 nqn.201408.com.example:nvme.host.sys.
Emulex OneCommand Manager Command Line Interface User Guide 5.14.2 BindingCapabilities This command displays the binding capabilities of the adapter. If a binding is configured, it is maintained across reboots. Supported By Solaris and Windows Syntax BindingCapabilities Parameters WWPN The WWPN of an FC function. 5.14.3 BindingSupport This command displays the binding support for an FC function.
Emulex OneCommand Manager Command Line Interface User Guide 5.14.5 RemoveAllPersistentBinding This command removes all persisting bindings for an FC function. Supported By Solaris and Windows Syntax RemoveAllPersistentBinding Parameters WWPN The WWPN of an FC function. 5.14.6 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, a target WWNN, or a target D_ID.
Emulex OneCommand Manager Command Line Interface User Guide Parameters WWPN The WWPN of an FC function. 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 5.14.
Emulex OneCommand Manager Command Line Interface User Guide 5.15.1 GetTrunkInfo The GetTrunkInfo command displays the following trunking configuration information for LPe35002 and LPe35004 adapters.
Emulex OneCommand Manager Command Line Interface User Guide Supported By Linux, Solaris, and Windows Syntax CreateVPort auto [vname] -orCreateVPort [vname] Parameters physical WWPN The WWPN of an FC function. 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. 5.16.
Emulex OneCommand Manager Command Line Interface User Guide 5.16.4 VPortTargets This command lists targets visible to the specified virtual port. Supported By Linux, Solaris, Windows, and Windows + CIM Provider on a VMware host Syntax VPortTargets Parameters physical WWPN The WWPN of an FC function. virtual WWPN The WWPN of the virtual port. 5.17 WWN Management Commands NOTE: These commands are supported only for FC functions.
Emulex OneCommand Manager Command Line Interface User Guide If you are using the CIM interface to access functions, after changing the WWN of a function, you must restart the CIMOM (that is, SFCB) on the ESXi system before trying to access the function on that system. For information on restarting the CIMOM, refer to the VMware documentation.
Emulex OneCommand Manager Command Line Interface User Guide 5.17.4 RestoreWWN This command changes the WWNs to the factory default or nonvolatile values. The change is nonvolatile. NOTE: A reboot is required to activate the new value. NOTE: This command is disabled when FA-PWWN is enabled on the adapter port. For VMware ESXi: After changing the WWN of an function, you must reboot the ESXi system before trying to access the adapter on that system.
Emulex OneCommand Manager Command Line Interface User Guide Appendix A: OneCommand Manager Error and Return Messages Table 7 contains a list of some of the error messages that might be encountered during a OneCommand Manager session. Table 7: OneCommand Manager Error and Warning Messages Error Message Commands Description Error: Read-only management mode is currently set on this host. The requested command is not permitted in this mode.
Emulex OneCommand Manager Command Line Interface User Guide Table 7: OneCommand Manager Error and Warning Messages (Continued) Error Message Commands ERROR: Download Failed due to invalid Download firmware digital signature. Please contact customer support for additional help.
Emulex OneCommand Manager Command Line Interface User Guide Appendix B: License Notices B.1 Secure Hash Algorithm (SHA-1) Notice /* * Written by Aaron D. Gifford * * Copyright 1998, 2000 Aaron D. Gifford. All rights reserved. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions * are met: * 1.
Emulex OneCommand Manager Command Line Interface User Guide * are met: * * 1. Redistributions of source code must retain the above copyright * notice, this list of conditions and the following disclaimer. * * 2. Redistributions in binary form must reproduce the above copyright * notice, this list of conditions and the following disclaimer in * the documentation and/or other materials provided with the * distribution. * * 3.
Emulex OneCommand Manager Command Line Interface User Guide * in documentation (online or textual) provided with the package. * * Redistribution and use in source and binary forms, with or without * modification, are permitted provided that the following conditions * are met: * 1. Redistributions of source code must retain the copyright * notice, this list of conditions and the following disclaimer. * 2.
