Broadcom OneCommandManager Command Line Interface Version 6.1 User User Guide

Broadcom OneCommandManager Command Line Interface Version 6.1 User User Guide

OneCommand™ Manager Command Line Interface Version 6.1

User Manual

P007998-01A Rev. A

Emulex Connects™ Servers, Storage and People

Copyright © 2007–2012 Emulex. All rights reserved worldwide. No part of this document may be reproduced by any means or translated to any electronic medium without the prior written consent of Emulex.

Information furnished by Emulex is believed to be accurate and reliable. However, no responsibility is assumed by Emulex for its use; or for any infringements of patents or other rights of third parties which may result from its use. No license is granted by implication or otherwise under any patent, copyright or related rights of Emulex.

Emulex, the Emulex logo, AutoPilot Installer, AutoPilot Manager, BlockGuard, Connectivity Continuum, Convergenomics, Emulex Connect, Emulex Secure, EZPilot, FibreSpy, HBAnyware, InSpeed, LightPulse, MultiPulse, OneCommand, OneConnect, One Network. One Company., SBOD, SLI, and VEngine are trademarks of Emulex. All other brand or product names referenced herein are trademarks or registered trademarks of their respective companies or organizations.

Emulex provides this manual "as is" without any warranty of any kind, either expressed or implied, including but not limited to the implied warranties of merchantability or fitness for a particular purpose. Emulex may make improvements and changes to the product described in this manual at any time and without any notice. Emulex assumes no responsibility for its use, nor for any infringements of patents or other rights of third parties that may result. Periodic changes are made to information contained herein; although these changes will be incorporated into new editions of this manual, Emulex disclaims any undertaking to give notice of such changes.

Emulex, 3333 Susan Street Costa Mesa, CA 92626 OpenSolaris DHCHAP Notice. Contains portions of Covered Software subject to the Common Development and Distribution License (CDDL) Version 1.0. Such portions of Covered Software in Source Code form may be obtained from the 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.

2

OneCommand Manager Command Line Interface Version 6.1 User Manual P007998-01A Rev. A

Table of Contents

3

Table of Contents

1. Introduction .....................................................................................9

Overview................................................................................................ 9

Compatibility ...................................................................................... 9

Abbreviations ........................................................................................ 10

2. Installing and Uninstalling the CLI ........................................................ 12 Linux................................................................................................... 12

Citrix...............................................................................................12

Installing in Linux Without an Existing OneCommand CLI Kit .............................12

Installing in Linux With an Existing OneCommand CLI Kit .................................13

Updating (Preserving Existing Settings) .......................................................... 14 Performing a Clean Install (Removing Existing Settings)....................................... 14 Uninstalling in Linux.............................................................................14

Uninstalling Older HBAnyware Kits in Linux .................................................14

Solaris ................................................................................................. 15

Installing in Solaris...............................................................................15

Uninstalling in Solaris ...........................................................................16

VMware ESX/ESXi .................................................................................... 16

Installing in a New VMware ESX Server .......................................................16

Installing in a VMware ESX Server with an Existing HBAnyware or OneCommand Manager CLI .....................................................................17

Uninstalling in a VMware ESX Server..........................................................17

Uninstalling an Older HBAnyware or a OneCommand Manager Kit in a VMware ESX Server ..............................................................................17

Installing the CIM Provider for VMware ESXi Hosts .........................................18

Windows............................................................................................... 18

Installing in Windows............................................................................18

Attended Installation................................................................................ 18

Unattended Installation............................................................................. 19 Uninstalling in Windows.........................................................................19

Uninstalling through the Control Panel........................................................... 19 Uninstalling through the Command Line ......................................................... 19

Starting and Stopping Daemon Processes ...................................................... 20

Linux and Solaris .................................................................................20

VMware ESX Server ..............................................................................20

3. Updating to the OneCommand Manager Application Enterprise Kit ............... 21 Linux................................................................................................... 21

OneCommand Manager Command Line Interface Version 6.1 User Manual P007998-01A Rev. A

Table of Contents

4

Solaris ................................................................................................. 21

Windows............................................................................................... 22

4. CLI Client Command Usage ................................................................. 23 Overview.............................................................................................. 23 HbaCmd Syntax Usage.............................................................................. 23

CIM Interface ......................................................................................... 24

Device Management Using the CIM Interface ................................................24

Syntax Rules for the CIM Interface ............................................................25

Syntax Options and Setting CIM Credentials ..................................................... 25

Example of Using the CIM Interface to Display Adapters ...................................... 26

CLI Client Commands Supported in CIM Interface ..........................................27

CIM Provider 3.0 ..................................................................................... 29 CIM Provider 3.1 ..................................................................................... 29

CIM Provider 3.2 ..................................................................................... 30 CIM Provider 3.4.4 ................................................................................... 30 CIM Provider 3.5 ..................................................................................... 30

Commands Supported in Target-Mode Ports................................................... 30

Unsupported Commands per Operating System............................................... 32

Linux ...............................................................................................32

RHEL, SLES, and Oracle ............................................................................. 32 Citrix ................................................................................................... 32

Solaris..............................................................................................33

VMWare ESX.......................................................................................33

Windows...........................................................................................34

5. CLI Client Command Descriptions......................................................... 35

Help .................................................................................................... 40

Adapter License Management Commands...................................................... 43

InstallAdapterLicense ...........................................................................43

ShowAdapterLicenseFeatures ..................................................................44

ShowAdapterLicenseID ..........................................................................44

Attributes Commands .............................................................................. 45

HbaAttributes ....................................................................................45

PortAttributes ....................................................................................45

PortStatistics .....................................................................................46

ServerAttributes .................................................................................46

SetPfcThrottle....................................................................................46

SetPhyPortSpeed.................................................................................47

SetPortEnabled...................................................................................48

OneCommand Manager Command Line Interface Version 6.1 User Manual P007998-01A Rev. A

Table of Contents

5

Authentication Commands ........................................................................ 48

AuthConfigList....................................................................................49

DeleteAuthConfig ................................................................................49

GetAuthConfig....................................................................................49

GetAuthStatus ....................................................................................50

InitiateAuth .......................................................................................50

Parameters............................................................................................ 50 SetAuthConfig ....................................................................................50

SetPassword ......................................................................................51

Boot Commands...................................................................................... 52

EnableBootCode..................................................................................52

GetBootParams...................................................................................53

SetBootParam ....................................................................................53

CEE Commands....................................................................................... 54 DCB Commands ...................................................................................... 54

GetDCBParams ...................................................................................54

GetPGInfo .........................................................................................54

SetCnaPGBW ......................................................................................55

SetDCBParam .....................................................................................55

SetDCBPriority....................................................................................57

Diagnostic Commands .............................................................................. 59

EchoTest ..........................................................................................59

GetBeacon ........................................................................................59

GetXcvrData ......................................................................................60

LoadList ...........................................................................................60

LoopBackTest.....................................................................................61

LoopMap...........................................................................................62

PciData ............................................................................................62

PostTest ...........................................................................................63

SetBeacon .........................................................................................63

SetCableNVP ......................................................................................64

TDRTest ...........................................................................................64

Wakeup ............................................................................................65

Driver Parameter Commands ..................................................................... 65

DriverConfig ......................................................................................66

GetDriverParams .................................................................................66

GetDriverParamsGlobal .........................................................................66

SaveConfig ........................................................................................67

SetDriverParam...................................................................................67

OneCommand Manager Command Line Interface Version 6.1 User Manual P007998-01A Rev. A

Table of Contents

6

SetDriverParamDefaults ........................................................................68

Dump Commands .................................................................................... 68

DeleteDumpFiles .................................................................................68

Dump...............................................................................................69

GetDumpDirectory ...............................................................................69

GetDumpFile......................................................................................70

GetDumpFileNames..............................................................................71

GetRetentionCount ..............................................................................71

SetDumpDirectory ...............................................................................71

SetRetentionCount...............................................................................72

FCoE Commands ..................................................................................... 73

GetFCFInfo ........................................................................................73

GetFIPParams.....................................................................................73

SetFIPParam ......................................................................................74

Guardian Commands................................................................................ 74

iSCSI Commands ..................................................................................... 75

AddARPTableEntry ...............................................................................75

AddRouteTableEntry ............................................................................76

AddTarget .........................................................................................76

AddTargetPortal .................................................................................77

CleariSNSServer ..................................................................................78

DelARPTableEntry................................................................................79

DelRouteTableEntry .............................................................................79

DiscoveriSNSServer ..............................................................................79

ExportiSCSI........................................................................................80

GetInitiatorProperties...........................................................................80

GetiSCSILuns ......................................................................................80

GetiSCSIPortStats ................................................................................81

GetNetworkConfiguration ......................................................................81

GetSessionInfo....................................................................................81

ImportiSCSI........................................................................................82

iSCSIPing...........................................................................................83

ListSessions .......................................................................................83

RemoveTarget ....................................................................................83

RemoveTargetPortal.............................................................................84

SetBootTargetSession ...........................................................................84

SetInitiatorProperties ...........................................................................85

SetiSCSIBoot ......................................................................................86

SetNetworkConfiguration .......................................................................86

OneCommand Manager Command Line Interface Version 6.1 User Manual P007998-01A Rev. A

Table of Contents

7

SetTargetLoginProperties.......................................................................87

SetTargetProperties .............................................................................88

SetTPLoginProperties ...........................................................................89

ShowARPTable....................................................................................90

ShowiSNSServer ..................................................................................90

ShowRouteTable .................................................................................90

ShowTarget .......................................................................................91

ShowTargetPortal ................................................................................91

TargetLogin .......................................................................................92

TargetLogout .....................................................................................93

UpdateiSNSServer................................................................................93

LUN Masking Commands ........................................................................... 94

GetLunList ........................................................................................94

GetLunUnMaskByHBA............................................................................94

GetLunUnMaskByTarget.........................................................................95

RescanLuns........................................................................................95

SetLunMask .......................................................................................95

Miscellaneous Commands.......................................................................... 96

AddHost ...........................................................................................96

CnaClearEventLog ...............................................................................97

CnaGetEventLog .................................................................................97

Download..........................................................................................97

ExportSANInfo ....................................................................................98

GetCimCred.......................................................................................99

GetElxSecInfo.....................................................................................99

GetQoSInfo........................................................................................99

GetVPD .......................................................................................... 100 ListHBAs ......................................................................................... 100

RemoveHost .................................................................................... 101 Reset............................................................................................. 101

SetCimCred ..................................................................................... 102 TargetMapping ................................................................................. 102 Version........................................................................................... 102

Persistent Binding Commands ...................................................................103

AllNodeInfo ..................................................................................... 104 BindingCapabilities ............................................................................ 104 BindingSupport ................................................................................. 104

PersistentBinding .............................................................................. 105 RemoveAllPersistentBinding.................................................................. 105

OneCommand Manager Command Line Interface Version 6.1 User Manual P007998-01A Rev. A

Table of Contents

8

RemovePersistentBinding..................................................................... 105

SetBindingSupport ............................................................................. 106 SetPersistentBinding .......................................................................... 106

Personality Change Commands ..................................................................107

ChangePersonality ............................................................................. 108 ShowPersonalities.............................................................................. 108

Virtual Port (VPort) Commands..................................................................109

CreateVPort..................................................................................... 109 DeleteVPort..................................................................................... 109

EnableSRIOV .................................................................................... 110 ListVFunctions .................................................................................. 110

ListVMs........................................................................................... 111 ListVPorts ....................................................................................... 111

VPortTargets.................................................................................... 112

WWN Management Commands...................................................................112

ChangeWWN .................................................................................... 112

GetWWNCap .................................................................................... 113

ReadWWN ....................................................................................... 114 RestoreWWN .................................................................................... 114

OneCommand Manager Command Line Interface Version 6.1 User Manual P007998-01A Rev. A

1. Introduction Overview

9

1. Introduction

Overview

The OneCommand™ Manager Command Line Interface (CLI) utility is a comprehensive management utility for Emulex host bus adapters (HBAs) and universal converged network adapters (UCNAs). The CLI provides support for commonly used commands without requiring installation of the OneCommand Manager graphical user interface (GUI). The OneCommand Manager CLI console application name is HbaCmd. A single operation is performed by entering “hbacmd”, followed by a CLI client command and its possible parameters, at the command line.

The OneCommand Manager CLI allows you to:               Perform adapter license and personality management on OneConnect™ adapters.

View port statistics and adapter, port, and server attributes on LightPulse™ and OneConnect adapters.

Set priority-based flow control (PFC) throttle and physical layer (PHY) port speed on OneConnect adapters.

Enable and disable ports on LightPulse and OneConnect adapters.

Manage authentication on LightPulse adapters.

Manage boot code on LightPulse and OneConnect Fibre Channel over Ethernet (FCoE) adapters.

Manage data center bridging (DCB) on OneConnect adapters.

Run diagnostics commands on LightPulse and OneConnect adapters.

Manage driver parameters on LightPulse and OneConnect FCoE adapters.

Create dump files to assist with troubleshooting Emulex adapters.

Perform a variety of management operations on OneConnect FCoE and iSCSI adapters.

Manage logical unit number (LUN) masking and set up persistent binding on LightPulse and OneConnect FCoE adapters.

Manage virtual ports on LightPulse and OneConnect FCoE adapters.

Manage worldwide names on LightPulse and OneConnect FCoE adapters.

Compatibility

The OneCommand Manager CLI can be installed and run on multiple operating systems:     Linux (Citrix, RHEL, SLES, and Oracle) Solaris Windows VMware ESX 4.1 (using COS) OneCommand Manager Command Line Interface Version 6.1 User Manual P007998-01A Rev. A

1. Introduction Abbreviations

10

For VMware ESXi 4.1 and VMware ESXi 5.0 hosts, you can manage adapters using the OneCommand Manager on Windows, but you must install and use the appropriate Emulex CIM Provider.

Note:

For VMware ESXi 5.0 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.

Abbreviations

ARP ASIC BIOS CEE CHAP CIM CIMOM CIN CLI COS CSV DAC D_ID DCB DCBX DH DHCHAP FC FCoE FIP GUI HBA ICMP IP iSCSI iSNS address resolution protocol application-specific integrated circuit basic input-output system Converged Enhanced Ethernet Challenge Handshake Authentication Protocol Common Interface Model Common Information Model Object Manager Cisco, Intel, Nuova (data center bridging exchange) command line interface console operating system comma-separated values direct-attach copper destination ID data center bridging data center bridging exchange Diffie-Hellman Diffie-Hellman Challenge Handshake Authentication Protocol Fibre Channel Fibre Channel over Ethernet FCoE Initialization Protocol graphical user interface host bus adapter Internet Control Message Protocol Internet Protocol internet Small Computer System Interface internet Storage Name Server OneCommand Manager Command Line Interface Version 6.1 User Manual P007998-01A Rev. A

1. Introduction Abbreviations

11

LLDP LPFC LUN MAC NIC NVP PFC PGID PGBW PHY POST PXE RHEL RM RPM SAN SCSI SFCB SFP SLES SR-IOV SSH TCP TDR UCNA UEFI VPD VPort WWN WWNN WWPN VM XML link layer discovery protocol LightPulse Fibre Channel logical unit number media access control network interface card (or controller) normal velocity of propagation priority-based flow control priority group ID priority group bandwidth physical layer power-on self-test Pre-boot Execution Environment Red Hat Enterprise Linux remote management resource package manager storage area network Small Computer System Interface Small Footprint CIM Broker small form factor pluggable SUSE Linux Enterprise Server single root I/O virtualization Secure Shell Transmission Control Protocol time-domain reflectometer universal converged network adapter Unified Extensible Firmware Interface 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.1 User Manual P007998-01A Rev. A

2. Installing and Uninstalling the CLI Linux

12

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 ESX/ESXi, and Windows. It also describes 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. Citrix XenServer 5.6 SP2 and Citrix XenServer 6.0 operating systems contain the OneCommand Manager CLI application. No additional installation is required.

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.

Note:

The OneCommand Manager application Web Launch Interface is not supported on Citrix XenServer.

Installing in Linux Without an Existing OneCommand CLI Kit

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.

    For i386 RHEL 5.5, RHEL 5.6, and RHEL 6, use the 32bit libnl library.

For x86_64 RHEL 5.5, RHEL 5.6, and RHEL 6, use the 64bit libnl library.

For ia64 RHEL 5.5, RHEL 5.6, and RHEL 6, use the 64bit libnl library.

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,  On OneConnect FCoE adapters:  For RHEL 5 and SLES 10 operating systems, use Linux driver version 8.2.0.33.3p, or later.

 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..rpm or OneCommand Manager Command Line Interface Version 6.1 User Manual P007998-01A Rev. A

2. Installing and Uninstalling the CLI Linux

13

 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.

On OneConnect NIC adapters (including iSCSI-NIC and FCoE-NIC adapters), use the NIC driver.

To install the OneCommand Manager CLI in Linux without an existing OneCommand CLI: 1. Copy the applications kit tar file to a directory on the installation machine.

2. Change to the directory where you copied the tar file.

3. Untar the file: tar zxvf elxocmcore---.tgz

4. Change to the core kit directory created in step 3.

cd elxocmcore--- 5. 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:   elxocmlibhbaapi-*.rpm (on 64-bit platforms that support 32-bit applications, there are two of these files) elxocmcore-*.rpm

Installing in Linux With an Existing OneCommand CLI Kit

Before installing the OneCommand Manager CLI, download the appropriate driver from the Emulex website and install the driver. For example:    On OneConnect FCoE adapters:  For RHEL 5.5and later and SLES10 SP3 and later operating systems, use Linux driver version 8.2.0.x.

 For RHEL6 and later and SL11 SP1 and later operating systems, use Linux driver version 8.3.5.x.

On OneConnect iSCSI adapters, use the iSCSI driver. 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:   Updating an existing installation – preserve existing settings Performing a clean install – overwrite existing settings OneCommand Manager Command Line Interface Version 6.1 User Manual P007998-01A Rev. A

2. Installing and Uninstalling the CLI Linux

14

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 12. The “.rpm” file handles the configuration file update. The install

script executes an rpm update (rpm -U *.rpm) to update the installed version of the core kit to the current version.

Note:

There is no update path from an HBAnyware 4.x or 3.x core kit 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 14.

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.

Note:

If an HBAnyware CLI or enterprise kit is installed, follow the procedure for

“Uninstalling Older HBAnyware Kits in Linux” on page 14.

Note:

Your configuration files are backed up by rpm with an “.rpmsave” extension.

2. Install the specific rpm file for your driver for Linux version. For information on

installing the rpm file, “Installing in Linux Without an Existing OneCommand CLI Kit” on page 12.

Uninstalling in Linux

To uninstall the OneCommand Manager CLI in Linux: 1. Log in as “root”.

2. Do one of the following:   Run the uninstall_ocmanager.sh script located in /usr/sbin/hbanyware/scripts.

Run the uninstall.sh script located in the installation tar file.

Uninstalling Older HBAnyware Kits in Linux

Uninstalling an Older HBAnyware Core Kit

1. Run the following command to remove the core kit.

rpm -e elxlinuxcorekit

Uninstalling an Older HBAnyware Enterprise kit:

1. Do one of the following:  Run the uninstall script located in /usr/sbin/hbanyware/scripts to remove the enterprise kit.

OneCommand Manager Command Line Interface Version 6.1 User Manual P007998-01A Rev. A

2. Installing and Uninstalling the CLI Solaris

15

 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”.

b. Change to the directory containing the tar file.

c. Extract the tar file using the tar -xvf command.

d. Change to the newly created directory.

e. Run the uninstall script with the ssc parameter specified. Type ./uninstall ssc 3. Uninstall the HBAnyware utility and the Application Helper module: a. Log on as “root”.

b. Change to the directory containing the tar file.

c. Extract the tar file using the tar -xvf command.

d. Change to the newly created directory.

e. Uninstall any previously installed versions. Type ./uninstall

Solaris

Installing in Solaris

Before installing the OneCommand Manager CLI, install the appropriate driver:   For FC/FCoE management, use the Solaris FC/FCoE driver version 2.60 or later.

For UCNA management, use the Solaris OCE NIC driver version 1.0 or later.

Note:

If Emulex OneConnect UNCAs are installed on the system, the NIC driver must be installed and reporting all NIC ports. Otherwise, the OneCommand Manager cannot manage the UNCAs.

To install the OneCommand Manager CLI in Solaris: 1. Copy the OneCommand Manager core kit to a temporary directory on the system.

2. Untar the core kit by typing: tar xvf elxocmcore-solaris-.tar

3. Change to the newly created elxocmcore-solaris- directory: cd ./elxocmcore-solaris-/ 4. Run the install script and follow the instructions.

./install OneCommand Manager Command Line Interface Version 6.1 User Manual P007998-01A Rev. A

2. Installing and Uninstalling the CLI VMware ESX/ESXi

16

If any of the following are already present on the system, the install script attempts to remove them first:     HBAnyware utility OneCommand Manager core kit OneCommand Manager application enterprise kit Solaris driver utilities

Uninstalling in Solaris

To uninstall the OneCommand Manager CLI in Solaris: 1. Log in as “root”.

2. Do one of the following:    Run /opt/ELXocm/scripts/uninstall.

Run the uninstall script located in the installation tar file.

Enter the command pkgrm ELXocmcore.

VMware ESX/ESXi

For installing and uninstalling the OneCommand Manager in VMware ESX, only VMware ESX 4.1 is supported. For VMware ESXi 4.1 and VMware ESXi 5.0 hosts, you must install and use the

appropriate Emulex CIM Provider. See “Installing the CIM Provider for VMware ESXi Hosts” on page 18.

Installing in a New VMware ESX Server

To install the OneCommand Manager CLI in a new VMware ESX system, install the specific rpm file for the driver for your VMware ESXversion.

The prerequisites for installation include the following:    To manage FCoE adapters, the LPFC driver version 8.2, or later, must be loaded.

To manage NIC or iSCSI adapters, driver version 2.102.440.0, or later, must be loaded.

To manage iSCSI adapters, the iSCSI driver must be loaded.

To install the OneCommand Manager CLI: 1. Log in to the VMware ESX server COS.

2. Copy the elxocmcore-esxNN-..rpm file to a directory on the install machine.

  “NN” is the VMware ESX version. It is “41” for VMware ESX 4.1.

represents the complete version.

is “x86_64” and is applicable to x64 or x86 architectures.

3. Change to the directory where you copied the rpm file.

OneCommand Manager Command Line Interface Version 6.1 User Manual P007998-01A Rev. A

2. Installing and Uninstalling the CLI VMware ESX/ESXi

17

4. Install the rpm file by typing: rpm -Uvh elxocmcore-esxNN-..rpm

 See the VMware ESX version, , and parameter descriptions in step 2.

The rpm contents are installed in /usr/sbin/ocmanager. The OneCommand Manager CLI is also located in this directory.

Installing in a VMware ESX Server with an Existing HBAnyware or OneCommand Manager CLI

To install the OneCommand Manager CLI: 1. Install the rpm file: # rpm -Uvh elxocmcore-esxNN-..rpm  “NN” is the VMware ESX version. It is “41” for VMware ESX 4.1.

  represents the complete version.

is “x86_64” and is applicable to x64 or x86 architectures.

Uninstalling in a VMware ESX Server

To uninstall the OneCommand Manager CLI from a VMware ESX server: 1. Log into the ESX server COS.

2. Type rpm -e elxocmcore-esxNN-  “NN” is the VMware ESX version. It is “41” for a VMware ESX 4.1.

Uninstalling an Older HBAnyware or a OneCommand Manager Kit in a VMware ESX Server

To uninstall an older HBAnyware or OneCommand Manager from a VMware server: 1. Log into the ESX server COS.

2. Type rpm -qa | grep elx Locate either of the following rpm files: elxvmwarecorekit- elxocmcore-esxNN-  “NN” is the VMware ESX version. It is “41” for VMware ESX 4.1.

3. Type one of the following: rpm -e elxvmwarecorekit- rpm -e elxocmcore-esxNN-  “NN” is the VMware ESX version. It is “41” for VMware ESX 4.1.

OneCommand Manager Command Line Interface Version 6.1 User Manual P007998-01A Rev. A

2. Installing and Uninstalling the CLI Windows

18

Installing the CIM Provider for VMware ESXi Hosts

For VMware ESXi 4.1 and VMware ESXi 5.0 hosts, you can manage adapters using the OneCommand Manager on Windows, but you must install and use the appropriate Emulex CIM Provider.

VMware ESXi comes with an inbox Emulex CIM Provider. The inbox Emulex CIM Provider enables you to manage Emulex LightPulse adapters, but not Emulex UCNAs. To manage Emulex UCNAs, 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 ESX Patch Management activities, see the VMware website.

To install the Emulex CIM Provider in a VMware ESXi hypevisor environment, use the esxupdate command line utility and perform the following steps: 1. Enable Secure Shell (SSH) on the VMware Visor host.

2. Transfer the Emulex CIM Provider vib file to the VMware hypervisor host.

3. Log into the VMware hypervisor host, and execute the following command: esxupdate -b file://Emulex Provider vibfilepath -–nosigcheck --maintenancemode update

Windows

Installing in Windows

There are two ways to install the OneCommand Manager CLI in Windows:   Attended installation – you are present during the installation. You will be prompted for more information for the installation to continue.

Unattended installation – you do not need to be present during the installation. Installation will complete on its own. Installation progress may be displayed as an option.

Attended Installation

To install the OneCommand Manager CLI, run the installation.exe file for a core Windows driver kit that does not include the OneCommand Manager GUI, and follow the installer directions.

Use the following syntax for the installation executable file: elxocmcore-windows--.exe

is either “x64” or “x86”.  represents the complete kit version.

For example, at the command prompt, type elxocmcore-windows-x64-5.0.2.14-1.exe

OneCommand Manager Command Line Interface Version 6.1 User Manual P007998-01A Rev. A

2. Installing and Uninstalling the CLI Windows

19 Note:

For Itanium 64 systems, install the x86 kit.

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. Use the following syntax for the installation executable file: elxocmcore-windows--.exe

For example, at the command prompt, type elxocmcore-windows-x64-5.01.00.10-4.exe /q2

Uninstalling in Windows

There are two ways to uninstall the OneCommand Manager CLI in Windows:   Through the control panel 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

>

Control Panel

>

Programs

>

Uninstall a Program.

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 \Emulex\Util\Uninstall 2. Type uninstall_OCManager_Core.bat

OneCommand Manager Command Line Interface Version 6.1 User Manual P007998-01A Rev. A

2. Installing and Uninstalling the CLI Starting and Stopping Daemon Processes

20

Starting and Stopping Daemon Processes

Linux and Solaris

On Linux machines, you can stop and start the OneCommand Manager daemon processes using the “stop_ocmanager”. On Solaris machines, use the “start_ocmanager” script. These are found in the following OneCommand Manager installation directory:   Linux – /usr/sbin/ocmanager Solaris – /opt/ELXocm There are three basic daemon processes, included with OneCommand Manager installations, that are affected by these scripts. They are:    elxhbamgrd – Remote management daemon which services requests from OneCommand Manager clients running on remote host machines.

mili2d – MILI daemon that routes major portions of the local OneCommand Manager client UCNA management requests.

elxdiscoveryd – Discovery daemon responsible for maintaining all discovery data (remote and local) for OneCommand Manager clients running on the local machine.

The elxhbamgrd and mili2d processes start at system boot time. The elxdiscoveryd process starts whenever the OneCommand Manager GUI process first runs on the host machine. Additionally, if the WebLaunch component of OneCommand Manager is installed, the daemon process, rmiserver, starts at system boot time. The start_weblaunch and stop_weblaunch scripts start and stop this daemon.

VMware ESX Server

Starting Daemon Processes

To start the OneCommand Manager daemon in VMware ESX 4.1: 1. Log in as “root”.

2. Change to the OneCommand Manager directory: cd /usr/sbin/ocmanager/ 3. Start the OneCommand Manager daemon: ./start_ocmanager

Stopping Daemon Processes

To stop the OneCommand Manager daemon in VMware ESX 4.1: 1. Log in as “root”.

2. Go to the OneCommand Manager directory: cd /usr/sbin/ocmanager/ 3. Stop the OneCommand Manager daemon: ./stop_ocmanager OneCommand Manager Command Line Interface Version 6.1 User Manual P007998-01A Rev. A

3. Updating to the OneCommand Manager Application Enterprise Kit Linux

21

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 ESX 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 script of the OneCommand Manager application enterprise kit.

The install script executes an rpm update (rpm -U *.rpm) to update the installed core kit to an enterprise kit.

Solaris

To update from the OneCommand Manager CLI to the full-featured OneCommand Manager application enterprise kit in Solaris: 1. Download the OneCommand Manager application enterprise kit to a temporary directory on your system.

2. Untar the OneCommand Manager application enterprise kit tar file: tar xvf elxocm-solaris-.tar

3. Change to the newly created elxocm- directory: cd ./elxocm-solaris-/ 4. Run the install script and follow the instructions: ./install OneCommand Manager Command Line Interface Version 6.1 User Manual P007998-01A Rev. A

3. Updating to the OneCommand Manager Application Enterprise Kit Windows

22

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--.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.1 User Manual P007998-01A Rev. A

4. CLI Client Command Usage Overview

23

4. CLI Client Command Usage

Overview

The CLI Client component of the OneCommand Manager application provides access to the capabilities of the Remote Management (RM) 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 [parameters] When the specified operation is completed, the command prompt is displayed. For a majority of commands, the first parameter following the command is the WWPN or MAC address of the port that the command is to act upon.

CLI in Read-Only Mode May Cause Error Message Note:

The CLI does not allow the execution of certain commands when it is configured for read-only mode. The following error message is returned if such a command is attempted: Error: Read-only management mode is currently set on this host. The requested command is not permitted in this mode.

HbaCmd Syntax Usage

The following syntax rules and usage are applicable for the HbaCmd application:     Parameters denoted within angle brackets < > are required.

Parameters denoted within square brackets [ ] are optional.

For Linux, Solaris, and VMware ESX (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.

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]] [parameters]  If the “h” option is omitted, the command is run on the local host.

  If the “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.

The “:port” option is optional. If omitted, the OneCommand Manager remote management protocol uses the default TCP port. If specified, it uses the user-specified TCP port.

OneCommand Manager Command Line Interface Version 6.1 User Manual P007998-01A Rev. A

4. CLI Client Command Usage CIM Interface

24

    Examples: Using the IP address: hbacmd h=138.239.91.121 ListHBAs Using the host name:  hbacmd h=cp-hp5670 ListHBAs The “h” option is available for all commands except for the AddHost

(page 96), RemoveHost (page 101), and the Version (page 102) commands.

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 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 UCNA port with the specified MAC address with an extended timeout value of “1”: hbacmd SetTargetProperties 00-11-22-33-44-55 iscsiTarget 1 For NIC ports, only the permanent MAC address is supported for the port address parameter on an HbaCmd command line.

Normally, for a UCNA port, the port’s permanent MAC address and current MAC address parameters are equal. However, it is possible to set a user-specified (current) MAC Address that is different from the permanent MAC address. Also, for some implementations, it is possible to have multiple UCNA 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 100.

CIM Interface

Notes:

  In Linux and Solaris, you cannot use hbacmd as a CIM client.

The OneCommand Manager CLI running on the VMware ESX 4.1 COS does not support the management of adapters using the CIM interface.

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.

OneCommand Manager Command Line Interface Version 6.1 User Manual P007998-01A Rev. A

4. CLI Client Command Usage CIM Interface

25

For VMware ESXi 4.1 and VMware ESXi 5.0 hosts, you can manage adapters using the OneCommand Manager on Windows, but you must install and use the appropriate

Emulex CIM Provider. For installation, see “Installing the CIM Provider for VMware ESXi Hosts” on page 18.

Note:

For VMware ESXi 5.0 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

.

Syntax Rules for the CIM Interface

For the CIM interface, all the syntax rules in “HbaCmd Syntax Usage” on page 23

section 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 m=cim u=root p= n= InstallAdapterLicense 00-12-34-56-78-9A K:\lf1324.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 m=cim [u=userid] [p=password] [n=root/emulex]

Option B

hbacmd Before using the option B syntax, you must set the CIM credentials by doing one of the following:   Set the default CIM credentials using the SetCimCred command (see

page 102). This command sets only the CIM credentials. Once you have set

them, subsequent HbaCmd commands do not require you specify the CIM credentials on the command line. For example: hbacmd SetCimCred Add the host IP address with CIM credentials using the AddHost command. For example: hbacmd [u=userid] [p=password] [n=namespace] AddHost OneCommand Manager Command Line Interface Version 6.1 User Manual P007998-01A Rev. A

4. CLI Client Command Usage CIM Interface

26 Default CIM Credentials

If you specify the command with the discovery method “m=cim” without specifying the CIM credentials (userid, password, or namespace), the default value for the missing CIM credential is obtained in the following order: 1. The information entered using the addhost command is looked up.

2. If no values exist, the information entered using the setcimcred command is used. 3. If no values exist, the following defaults are used: username=root password=root namespace=root/emulex portnum=5988

Example of Using the CIM Interface to Display Adapters

In Windows, to display a list of adapters managed for a specified host using the CIM interface, run the following command: C:\Program Files\Emulex\Util\OCManager>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: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 ode: 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 OneCommand Manager Command Line Interface Version 6.1 User Manual P007998-01A Rev. A

4. CLI Client Command Usage CIM Interface

27

Mode: Initiator Discovery: cim C:\Program Files\Emulex\Util\OCManager>hbacmd h=10.192.113.128 m=cim u=root p=root n=root/emulex portattributes 10:00:00:00:c9:6b:62:2b Port Attributes for 10:00:00:00:c9:6b:62:2b Node WWN: 20 00 00 00 c9 6b 62 2b Port WWN: 10 00 00 00 c9 6b 62 2b Port Symname: Port FCID: 0000 Port Type: Fabric Port State: Unknown Port Service Type: 12 vNIC Name: vNIC Outer VLAN ID: vNIC Min. Bandwidth: vNIC Max. Bandwidth: Port Supported FC4: 00 00 01 20 00 00 00 01 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 Port Active FC4: 00 00 01 00 00 00 00 01 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 Max Frame Size: 2048 OS Device Name: Num Discovered Ports: 0 Fabric Name: 00 00 00 00 00 00 00 00 For a list of HbaCmd commands supported through the CIM interface, see the following section.

CLI Client Commands Supported in CIM Interface

Following is a list of HbaCmd commands supported through the CIM interface.

    AddHost AllNodeInfo CEEDownload ChangePersonality OneCommand Manager Command Line Interface Version 6.1 User Manual P007998-01A Rev. A

                                       ChangeWWN DeleteDumpFiles Download Dump EnableBootCode GetBeacon GetDCBParams GetDriverParams GetDriverParamsGlobal GetDumpDirectory GetDumpFile GetDumpFileNames GetFCFInfo GetFIPParams GetLunList GetPGInfo GetQosInfo GetRetentionCount GetVPD GetWWNCap GetXcvrData HbaAttributes InstallAdapterLicense ListHBAs LoadList LoopBackTest PciData PortAttributes PortStatistics ReadWWN RemoveHost Reset RestoreWWN ServerAttributes SetBeacon SetCnaPGBW SetDCBParam SetDCBPriority SetDriverParam OneCommand Manager Command Line Interface Version 6.1 User Manual 4. CLI Client Command Usage CIM Interface

28

P007998-01A Rev. A

4. CLI Client Command Usage CIM Interface

29

           SetDriverParamDefaults SetDumpDirectory SetFIPParam SetPFCthrottle SetPhyPortSpeed SetRetentionCount ShowAdapterLicenseFeatures ShowLicenseAdapterID ShowPersonalities TargetMapping Version

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:          

All the commands listed in the previous section for “CIM Provider 3.0” on page 29.

Dump GetDCBParams GetDumpDierctory GetDumpFile GetDumpFileNames GetFCFInfo GetFipParams GetRetentionCount GetPGInfo OneCommand Manager Command Line Interface Version 6.1 User Manual P007998-01A Rev. A

4. CLI Client Command Usage Commands Supported in Target-Mode Ports

30

      SetDCBParam SetCnaPgBw SetDCBPriority SetDumpDirectory SetFIPParam SetRetentionCount

CIM Provider 3.2

CIM Provider 3.2 supports the following commands:      

All the commands listed in the previous section for “CIM Provider 3.1” on page 29.

ChangePersonality InstallAdapterLicense ShowAdapterLicenseFeatures 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 30.

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 30.

SetPhyPortSpeed

Commands Supported in Target-Mode Ports

The following HbaCmd commands are supported for managing target-mode ports:         ChangePersonality CreateVPort DeleteDumpFiles DeleteVPort Download DriverConfig ExportSanInfo GetDCBParams OneCommand Manager Command Line Interface Version 6.1 User Manual P007998-01A Rev. A

4. CLI Client Command Usage Commands Supported in Target-Mode Ports

31

                               GetDriverParams GetDriverParamsGlobal GetDumpDirectory GetDumpFile GetFCFInfo GetFIPParams GetPGInfo GetRetentionCount GetVPD GetXcvrData HbaAttributes InstallAdapterLicense ListHbas ListVPorts PortAttributes PortStatistics Reset SaveConfig ServerAttributes SetCnaPGBW SetDCBParam SetDCBPriority SetDriverParam SetDriverParamDefaults SetFIPParam SetPhyPortSpeed SetPortEnabled SetRetentionCount ShowAdapterLicenseFeatures ShowLicenseAdapterID ShowPersonalities All other HbaCmd commands return the following error message: "Not Supported for Target Mode Adapters." OneCommand Manager Command Line Interface Version 6.1 User Manual P007998-01A Rev. A

4. CLI Client Command Usage Unsupported Commands per Operating System

32

Unsupported Commands per Operating System

For a list of all the supported commands, see Table 5-1, CLI Client Command Reference, on page 35.

Linux RHEL, SLES, and Oracle

RHEL, SLES, and Oracle do not support the following CLI commands:               BindingCapabilities BindingSupport GetCimCred GetLunUnMaskByHBA GetLunUnMaskByTarget ListVMs PersistentBinding RemoveAllPersistentBinding RemovePersistentBinding SetBindingSupport SetCimCred SetDumpDirectory SetLunMask SetPersistentBinding

Citrix

Citrix (acting as a hypervisor-style server for OneCommand Manager CLI) does not support the following CLI commands:              AuthConfigList BindingCapabilities BindingSupport CreateVPort DeleteVPort GetAuthConfig GetAuthStatus GetCimCred GetElxSecInfo GetLunList GetLunUnMaskByHBA GetLunUnMaskByTarget InitiateAuth OneCommand Manager Command Line Interface Version 6.1 User Manual P007998-01A Rev. A

4. CLI Client Command Usage Unsupported Commands per Operating System

33

          PersistentBinding RemoveAllPersistentBinding RemovePersistentBinding RescanLuns SetAuthConfig SetBindingSupport SetCimCred SetPersistentBinding SetLunMask SetPassword

Solaris

Solaris does not support the following CLI commands:        CnaClearEventLog CnaGetEventLog GetCimCred GetElxSecInfo ListVMs SetCimCred SetDumpDirectory]

VMWare ESX

VMWare ESX does not support the following CLI commands:                 AuthConfigList BindingCapabilities BindingSupport CreateVPort DeleteAuthConfig DeleteVPort GetAuthConfig GetAuthStatus GetCimCred GetElxSecInfo GetLunList GetLunUnMaskByHBA GetLunUnMaskByTarget ImportSCSI InitiateAuth PersistentBinding OneCommand Manager Command Line Interface Version 6.1 User Manual P007998-01A Rev. A

4. CLI Client Command Usage Unsupported Commands per Operating System

34

         RemoveAllPersistentBinding RemovePersistentBinding RescanLuns SetAuthConfig SetBindingSupport SetCimCred SetLunMask SetPersistentBinding SetPassword

Windows

Windows does not support the following CLI command:   SetDumpDirectory ListVMs OneCommand Manager Command Line Interface Version 6.1 User Manual P007998-01A Rev. A

5. CLI Client Command Descriptions

35 Command

AddARPTableEntry AddHost AddRouteTableEntry AddTarget AddTargetPortal AllNodeInfo AuthConfigList BindingCapabilities BindingSupport ChangePersonality ChangeWWN CleariSNSServer CnaClearEventLog CnaGetEventLog CreateVPort DelARPTableEntry DeleteAuthConfig DelRouteTableEntry DeleteDumpFiles DeleteVPort DiscoveriSNSServer Download DriverConfig Dump EchoTest EnableBootCode EnableSRIOV

5. CLI Client Command Descriptions

A check mark (  ) 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 Linux Citrix Solaris VMWare ESX Windows CIM 3.0 3.1 3.2 3.4.4 3.5

Page

                                                                                                                                               

75

96

76 76

77

104

49

104 104

108

112

78

97 97

109

79 79

97

66

69

49

79

68

109

59

52

110

OneCommand Manager Command Line Interface Version 6.1 User Manual P007998-01A Rev. A

5. CLI Client Command Descriptions

36 Table 5-1

CLI Client Command Reference

Command

ExportSANInfo ExportiSCSI GetBeacon GetAuthConfig GetAuthStatus GetBootParams GetCimCred GetDCBParams GetDriverParams GetDriverParamsGlobal GetDumpDirectory GetDumpFile GetDumpFileNames GetElxSecInfo GetFCFInfo GetFIPParams GetInitiatorProperties GetiSCSILuns GetiSCSIPortStats GetLunList GetLunUnMaskByHBA GetLunUnMaskByTarget GetNetwork Configuration GetPGInfo GetQosInfo GetRetentionCount GetSessionInfo GetVPD GetWWNCap GetXcvrData       

CIM Provider Linux Citrix Solaris VMWare ESX Windows CIM 3.0 3.1 3.2 3.4.4 3.5

Page

                                                                                                                                      

80 80

81

94 94

95

81

98

80

59

49

50

53

99

54

66 66

69

70

71

99

73 73

                                                   

54

99

71

81

100

113

60

OneCommand Manager Command Line Interface Version 6.1 User Manual P007998-01A Rev. A

5. CLI Client Command Descriptions

37 Command

HbaAttributes Help ImportiSCSI InitiateAuth InstallAdapterLicense iSCSIPing ListHBAs ListSessions ListVFunctions ListVMs ListVPorts VPortTargets LoadList LoopBackTest LoopMap PciData PersistentBinding PortAttributes PortStatistics PostTest ReadWWN RemoveAllPersistent Binding RemovePersistent Binding RemoveHost RemoveTarget RemoveTargetPortal RescanLuns Reset RestoreWWN SaveConfig

Table 5-1

CLI Client Command Reference

CIM Provider Linux Citrix Solaris VMWare ESX Windows CIM 3.0 3.1 3.2 3.4.4 3.5

Page

                                                                                                                     

105

45

46

63

114

105

45

40

82

50

43

83

100

83

60

61

62 62

110

111 111

112

                                               

105

101

83

84

95

101

114

67

OneCommand Manager Command Line Interface Version 6.1 User Manual P007998-01A Rev. A

5. CLI Client Command Descriptions

38 Table 5-1

CLI Client Command Reference

CIM Provider Command

ServerAttributes SetAuthConfig SetBeacon SetBindingSupport SetBootParam SetBootTargetSession SetCableNVP SetCnaPGBW SetCimCred SetDCBParam SetDCBPriority SetDriverParam SetDriverParamDefaults SetDumpDirectory SetFIPParam SetInitiatorProperties SetiSCSIBoot SetLunMask SetNetwork Configuration SetPassword SetPersistentBinding SetPfcThrottle SetPhyPortSpeed SetPortEnabled SetRetentionCount SetTargetLogin Properties SetTargetProperties SetTPLoginProperties ShowAdapterLicense Features

Linux Citrix Solaris VMWare ESX Windows CIM 3.0 3.1 3.2 3.4.4 3.5

Page

                                                                                                                   

86

95

86

53

84

64

55

46

50

63

106

68

71

74

85

102

55

57

67

                                                        

88

89

44

48

72

87

51

106

46

47

OneCommand Manager Command Line Interface Version 6.1 User Manual P007998-01A Rev. A

5. CLI Client Command Descriptions

39 Table 5-1

CLI Client Command Reference

Command

ShowARPTable ShowiSNSServer ShowLicenseAdapterID ShowPersonalities ShowRouteTable ShowTarget ShowTargetPortal TargetLogin TargetLogout TargetMapping TDRTest UpdateiSNSServer Version VPortTargets Wakeup

CIM Provider Linux Citrix Solaris VMWare ESX Windows CIM 3.0 3.1 3.2 3.4.4 3.5

Page

                                                                                    

90

91 91

92

90 90

44

108

93

102

64

93

102

112

65

OneCommand Manager Command Line Interface Version 6.1 User Manual P007998-01A Rev. A

5. CLI Client Command Descriptions Help

40

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, Citrix, Solaris, VMware ESX, and Windows

Syntax

Help [GroupName] [CmdName]

Parameters

GroupName CmdName This optional parameter lists the commands in a particular group.

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} } or hbacmd { h={[}IPv6 Address{]:port} 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> hbacmd [u=userid][p=password][n=namespace] B> hbacmd 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 [u=userid] [p=password] [n=namespace] AddHost 2. Set the default CIM credentials using the SetCimCred command.

e.g. hbacmd SetCimCred Command Summary Help Commands Help Group: {AdapterLicense, Attributes, Authentication, Boot, CEE, DCB, Diagnostics, DriverParams, Dump, eAdapterManagement, eLunManagement, eLunMigration, FCoE, iSCSI, KeyManagerClientManagement, LUNMasking, Miscellaneous, PersistentBinding, Personality, PolicyManagement, OneCommand Manager Command Line Interface Version 6.1 User Manual P007998-01A Rev. A

5. CLI Client Command Descriptions Help

41

ServerKeyManagement, ServerLicenseManagement, VPort, WWN} Adapter License Management Commands ShowLicenseAdapterID, InstallAdapterLicense, ShowAdapterLicenseFeatures Attributes Commands HbaAttributes, PortAttributes, PortStatistics, ServerAttributes, SetPhyPortSpeed SetPortEnabled Authentication Commands AuthConfigList, DeleteAuthConfig, GetAuthConfig, GetAuthStatus, InitiateAuth, SetAuthConfig, SetPassword Boot Commands EnableBootCode, GetBootParams, SetBootParam CEE Commands (LP21000 series only) CEEDownload, GetCEEParams, SetCEEParam 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, GetDriverParamsGlobal, SaveConfig, SetDriverParam, SetDriverParamDefaults Dump Commands DeleteDumpFiles, Dump, GetDumpDirectory, SetDumpDirectory, GetRetentionCount, SetRetentionCount, GetDumpFileNames, GetDumpFile FCoE Commands GetFIPParams, SetFIPParam, GetFCFInfo Guardian Commands eAdapterManagement Commands ListEAdapters, SetSoftwareEncryption eLunManagement Commands AssociateELun, ExportELunAssociation, GetCryptoParams, GetELunInformation, GetELunStatus, ListELuns, ListCryptoParams, ProvisionELun, SetCryptoParams, UnprovisionELun eLunMigration Commands GetELunMigrationStatus, PauseELunMigration, ResumeLunMigration, StartELunMigration, StopELunMigration OneCommand Manager Command Line Interface Version 6.1 User Manual P007998-01A Rev. A

5. CLI Client Command Descriptions Help

42

KeyManagerClientManagement Commands ConfigureKeyManagerClient, GetKeyManagerClientParamsFile, GetKeyManagerVersion, InitializeKeyManagerClient PolicyManagement Commands ApplyPolicy, GetPolicyFile ServerKeyManagement Commands CreateServerKey, InstallServerKeys, ListServerKeys, ListServerKeyAttributes ServerLicenseManagement Commands InstallServerLicense, ListServerLicenses, RestoreServerLicenses iSCSI Commands AddARPTableEntry, AddRouteTableEntry, AddTarget, AddTargetPortal, CleariSNSServer, DelARPTableEntry, DelRouteTableEntry, DiscoveriSNSServer, ExportiSCSI, GetInitiatorProperties, GetiSCSILuns, GetiSCSIPortStats, GetNetworkConfiguration, GetSessionInfo, ImportiSCSI, iSCSIPing, ListSessions, RemoveTarget, RemoveTargetPortal, SetBootTargetSession, SetInitiatorProperties, SetiSCSIBoot, SetNetworkConfiguration, SetTargetLoginProperties, SetTargetProperties, SetTPLoginProperties, ShowARPTable, ShowRouteTable, ShowTarget, ShowTargetPortal, TargetLogin, ShowiSNSServer, TargetLogout, UpdateiSNSServer LUN Masking Commands GetLunList, GetLunUnmaskByHba, GetLunUnmaskByTarget, RescanLuns, SetLunMask Miscellaneous Commands AddHost, CnaGetEventLog, CnaClearEventLog, Download, ExportSANInfo, GetCimCred, GetElxSecInfo, GetQoSInfo, GetVPD, ListHBAs, ListVFuncs, RemoveHost, Reset, SetCimCred, SetPfcThrottle, TargetMapping, SRIOVEnable Persistent Binding Commands AllNodeInfo, BindingCapabilities, BindingSupport, PersistentBinding, RemoveAllPersistentBinding, RemovePersistentBinding, SetBindingSupport, SetPersistentBinding Personality Management Commands ShowPersonalities, ChangePersonality VPort Commands CreateVPort, DeleteVPort, ListVPorts, VPortTargets, ListVMs WWN Management Commands ChangeWWN, GetWWNCap, ReadWWN, RestoreWWN OneCommand Manager Command Line Interface Version 6.1 User Manual P007998-01A Rev. A

5. CLI Client Command Descriptions Adapter License Management Commands

43 Example 2

This help command example shows the details for the SetDCBParam command: hbacmd help setdcbparam The example output: SetDCBParam 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 values are 0 and 1: DcbxState, DcbxMode TxState, RxState, TxPortDesc, TxSysDesc, TxSysName, TxSysCap 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 defaults

Adapter License Management Commands

Note:

Adapter License Management commands are supported on OneConnect adapters only.

In these commands, the WWPN or MAC address argument specifies the adapter the command is acting upon. The the HbaCmd application uses the WWPN or MAC address to identify the adapter, but this does not mean that the command works successfully on the specified port.

InstallAdapterLicense

This command installs the license keys from a license file to enable specific features on the adapter.

Supported By

Linux, Citrix, Solaris, VMware ESX, and Windows

Syntax

InstallAdapterLicense OneCommand Manager Command Line Interface Version 6.1 User Manual P007998-01A Rev. A

5. CLI Client Command Descriptions Adapter License Management Commands

44 Parameters

WWPN MAC License File The FCoE port WWPN of the adapter.

The NIC or iSCSI port address of the adapter.

The path to the license key file containing the license keys obtained from the Emulex License website.

Examples

For non-VMware ESX/ESXi hosts: hbacmd InstallAdapterLicense 00-12-34-56-78-9A K:\lf1324.lic

For VMware ESX/ESXi hosts: hbacmd h= m=cim u=root p= n= InstallAdapterLicense 00-12-34-56-78-9A K:\lf1324.lic

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, Citrix, Solaris, VMware ESX, and Windows

Syntax

ShowAdapterLicenseFeatures

Parameters

WWPN MAC The FCoE port WWPN of the adapter.

The NIC or iSCSI port address of the adapter.

Examples

For non-VMware ESX/ESXi hosts: hbacmd ShowAdapterLicenseFeatures 00-12-34-56-78-9A For VMware ESX/ESXi hosts: hbacmd h= m=cim u=root p= n= ShowAdapterLicenseFeatures 00-12-34-56-78-9A

ShowAdapterLicenseID

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.

OneCommand Manager Command Line Interface Version 6.1 User Manual P007998-01A Rev. A

5. CLI Client Command Descriptions Attributes Commands

45 Supported By

Linux, Citrix, Solaris, VMware ESX, and Windows

Syntax

ShowLicenseAdapterID

Parameters

WWPN MAC The FCoE port WWPN of the adapter.

The NIC or iSCSI port address of the adapter.

Examples

For non-VMware ESX/ESXi hosts: hbacmd ShowLicenseAdapterID 00-12-34-56-78-9A For VMware ESX/ESXi hosts: hbacmd h= m=cim u=root p= n= 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, Citrix, Solaris, VMware ESX, and Windows

Syntax

HbaAttributes

Parameters

h WWPN The IP address of the host.

The WWPN of the adapter.

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, Citrix, Solaris, VMware ESX, and Windows OneCommand Manager Command Line Interface Version 6.1 User Manual P007998-01A Rev. A

5. CLI Client Command Descriptions Attributes Commands

46 Syntax

PortAttributes

Parameters

h WWPN MAC The IP address of the host.

The WWPN of the adapter.

The MAC address of the NIC or iSCSI port.

PortStatistics

This command shows all port statistics for the adapter. The type of information listed may vary according to the adapter model.

Supported By

Linux, Citrix, Solaris, VMware ESX, and Windows

Syntax

PortStatistics

Parameters

WWPN The WWPN of the adapter.

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, Citrix, Solaris, VMware ESX, and Windows

Syntax

ServerAttributes

Parameters

WWPN MAC The WWPN of the adapter.

The MAC address of the NIC or iSCSI port.

SetPfcThrottle

This command returns the PFC Throttle state as enabled or disabled.

Note:

The PFC Throttle state returns 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 OneCommand Manager Command Line Interface Version 6.1 User Manual P007998-01A Rev. A

5. CLI Client Command Descriptions Attributes Commands

47

adapters, the PFC Throttle state does not return when using the PortAttributes command.

Supported By

Linux, Citrix, Solaris, VMware ESX, and Windows

Syntax

SetPfcThrottle <0|1>

Parameters

WWPN 0|1 The WWPN of the adapter.

The PFC throttle state: 0 = Disabled 1 = Enabled

SetPhyPortSpeed

This command sets the port speed on OneConnect OCe11100-series adapters only.

Supported By

Linux, Citrix, Solaris, VMware ESX, and Windows

Syntax

SetPhyPortSpeed [Speed [Length]]

Parameters

WWPN MAC Mode Speed Length The WWPN of the FCoE port.

The MAC address of the CNA port.

The Mode number: 0 = Default 1 = Auto-negotiate; requires the argument.

2 = Force; requires the and arguments.

The Speed string.

When is 1 or 2, the argument is required. When is 0, the 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.

The length of the direct attach copper (DAC) cable in meters. Valid values are 0–10. A value is required when using a 10Gb SFP Plus transceiver.

When is 2, the argument is required. When is 0 or 1, the argument is ignored.

OneCommand Manager Command Line Interface Version 6.1 User Manual P007998-01A Rev. A

5. CLI Client Command Descriptions Authentication Commands

48 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 1Gb 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 value when is 2: ERROR: <431>: Cable length required for force mode and interface type

SetPortEnabled

This command enables or disables the FC or UCNA port.

Notes:

  Ensure that all I/Os on the port are stopped before disabling the port. Only OneConnect adapters do not require a reset when the adapter port is enabled or disabled. For all other adapters, when the SetPortEnabled command disables an FC port, the adapter must be reset to activate the new setting.

Supported By

Linux, Citrix, Solaris, VMware ESX, and Windows

Syntax

SetPortEnabled

Parameters

WWPN MAC PortEnabled The WWPN of the adapter.

The MAC address of the NIC or iSCSI port.

The port-enabled state: 0 = Disabled 1 = Enabled

Authentication Commands

Note:

Authentication commands are supported on FC adapter ports only.

These command returns the list of WWPNs that have an authentication connection configuration with the specified adapter. OneCommand Manager Command Line Interface Version 6.1 User Manual P007998-01A Rev. A

5. CLI Client Command Descriptions Authentication Commands

49

AuthConfigList

Supported By

Linux, Solaris, and Windows

Syntax

AuthConfigList

Parameters

WWPN The WWPN of the adapter.

DeleteAuthConfig

This command deletes the authentication configuration on the adapter.

Supported By

Linux, Solaris, and Windows

Syntax

DeleteAuthConfig

Parameters

WWPN1 WWPN2 PasswordType Password The WWPN of the adapter.

Use “ff:ff:ff:ff:ff:ff:ff:ff” for a switch or use the WWPN for a target.

1 = ASCII 2 = Hex (binary) 3 = Password not yet defined The current password value.

GetAuthConfig

This command retrieves the authentication configuration for the adapter.

Supported By

Linux, Solaris, and Windows

Syntax

hbacmd GetAuthConfig

Parameters

WWPN1 WWPN2 The WWPN of the adapter.

Use “ff:ff:ff:ff:ff:ff:ff:ff” for a switch or use the WWPN for a target.

OneCommand Manager Command Line Interface Version 6.1 User Manual P007998-01A Rev. A

5. CLI Client Command Descriptions Authentication Commands

50

GetAuthStatus

This command returns the current status for the authentication connection specified by WWPN 1 and WWPN2 (adapter and the switch). It includes the current authentication state (connected or failed). Currently authenticated connections specify the hash algorithm and DH group used in the DHCHAP associated with this connection. Failed status includes the failure reason.

Supported By

Linux, Solaris, and Windows

Syntax

GetAuthStatus

Parameters

WWPN1 WWPN2 The WWPN of the adapter.

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

Parameters

WWPN1 WWPN2 The WWPN of the adapter.

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

Note:

Where multiple parameters and values are used, separate them using commas. OneCommand Manager Command Line Interface Version 6.1 User Manual P007998-01A Rev. A

5. CLI Client Command Descriptions Authentication Commands

51 Parameters

WWPN1 WWPN2 PasswordType Password Param Value The WWPN of the adapter.

Use “ff:ff:ff:ff:ff:ff:ff:ff” for a switch or use the WWPN for a target.

1 = ASCII 2 = Hex (binary) 3 = Password not yet defined The current password value.

The parameter names:        Mode Timeout Bi-directional Hash-priority DH-priority Re-authentication Re-authentication-interval The value is based on the type of :        Mode: disabled, enabled, or passive Timeout: time in seconds Bi-directional = disabled or enabled Hash-priority: md5 or sha1 (md5 = first md5, then sha1; sha1 = first sha1, then md5) DH-priority: 1, 2, 3, 4, 5; any combination up to 5 digits Re-authentication: disabled or enabled Re-authentication-interval: 0, 10– 3600

SetPassword

This command sets the password for the adapter.

Supported By

Linux, Solaris, and Windows

Syntax

SetPassword

Parameters

WWPN1 WWPN2 The WWPN of the adapter.

Must be “ff:ff:ff:ff:ff:ff:ff:ff” for a switch or the actual WWPN for a target.

OneCommand Manager Command Line Interface Version 6.1 User Manual P007998-01A Rev. A

5. CLI Client Command Descriptions Boot Commands

52

Flag Cpt Cpw Npt Npw 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) Current password type: 1 = ASCII 2 = Hex (binary) 3 = Password not yet defined Current password value.

New password type: 1 = ASCII 2 = Hex (binary) New password value.

Boot Commands

EnableBootCode

Note:

This command is not supported for OneConnect adapters because the boot code is always enabled on OneConnect adapters.

This command enables or disables the boot code on the FC adapter or the Preboot Execution Environment (PXE) BIOS of the NIC on the UCNA. 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. Disabling the PXE BIOS on the UCNA’s NIC prevents booting from the NIC. Enabling the PXE BIOS on the UCNA’s NIC allows booting from the NIC.

Supported By

Linux, Citrix, Solaris, VMware ESX, and Windows

Syntax

EnableBootCode

Parameters

WWPN MAC Flag The WWPN of the adapter.

The MAC address of the NIC or iSCSI port.

D = Disable the boot code.

E = Enable the boot code.

OneCommand Manager Command Line Interface Version 6.1 User Manual P007998-01A Rev. A

5. CLI Client Command Descriptions Boot Commands

53

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, Citrix, Solaris, VMware ESX, and Windows

Syntax

GetBootParams

Parameters

WWPN Type The WWPN of the adapter.

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.

   When changing adapter parameters, omit the BootDev keyword and value; otherwise, an error is reported.

When changing boot device parameters for OpenBoot, omit the BootDev keyword and value; otherwise, an error is reported.

For boot device parameters for X86 or UEFI, you must provide the BootDev keyword and value.

Supported By

Linux, Citrix, Solaris, VMware ESX, and Windows

Syntax

SetBootParam [BootDev ]

Parameters

WWPN Type Param Value1 BootDev Value2 The WWPN of the adapter.

Possible values are X86, OpenBoot, or UEFI The parameter name.

The parameter value.

The boot device.

The boot device entry number: 0–7 OneCommand Manager Command Line Interface Version 6.1 User Manual P007998-01A Rev. A

5. CLI Client Command Descriptions CEE Commands

54

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.

DCB Commands

Note:

Data Center Bridging (DCB) commands are for DCB management of OneConnect adapters only. 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 UCNAs.

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 UCNAs.

Supported By

Linux, Citrix, Solaris, VMware ESX, and Windows

Syntax

GetDCBParams

Parameters

WWPN MAC The WWPN of the adapter.

The MAC address of the NIC or iSCSI port.

Example

hbacmd h=10.192.203.154 getdcbparams 00-00-c9-93-2f-d8

GetPGInfo

This command shows the bandwidth 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, Citrix, Solaris, VMware ESX, and Windows

Syntax

GetPGInfo OneCommand Manager Command Line Interface Version 6.1 User Manual P007998-01A Rev. A

5. CLI Client Command Descriptions DCB Commands

55 Parameters

WWPN MAC The WWPN address of the FCoE port.

The MAC address of the 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 (PG0–PG7) must total 100 (for 100%).

2. Bandwidth can be assigned to a priority group that has priorities.

Supported By

Linux, Citrix, Solaris, VMware ESX, and Windows

Syntax

SetCnaPGBW

Parameters

WWPN MAC BW0–BW7 The WWPN of the adapter.

The MAC address of the NIC or iSCSI port.

The bandwidths allocated for the priority groups 0–7.

Example

This command sets the bandwidth of PG0 to 50%, PG1 to 50%, and PG2–PG7 to 0%.

hbacmd SetCnaPGBW 10:00:00:00:c9:3c:f7:88 50 50 0 0 0 0 0 0

SetDCBParam

This command configures the DCB and Link Layer Discovery Protocol (LLDP) settings on the OneConnect adapter.

Supported By

Linux, Citrix, Solaris, VMware ESX, and Windows

Syntax

SetDCBParam OneCommand Manager Command Line Interface Version 6.1 User Manual P007998-01A Rev. A

5. CLI Client Command Descriptions DCB Commands

56 Parameters

WWPN MAC Param Value The WWPN of the adapter.

The MAC address of the NIC or iSCSI port.

The parameter name. See the following “DCB Settings for and ” and “LLDP Settings for and ” sections.

The parameter value. See the following “DCB Settings for and ” and “LLDP Settings for and ” sections.

DCB Settings for and

DCBXState DCBXMode PFCEnable FCoEPriority iSCSIPriority PFCPriority defaults

Description and

The Data Center Bridging Exchange protocol (DCBX) state.

0 = Disabled 1 = Enabled The DCBX mode: DCB or CIN.

0 = CIN 1 = DCB The also configures the FCoE Initialization Protocol (FIP) mode. If = DCB, FIP is enabled. If = CIN, FIP is disabled.

Flow control in both directions (transmit and receive).

0 = Disabled 1 = Enabled This parameter is applicable for FCoE adapters only. A single priority must be specified. The range of valid values is 0-7. This parameter is applicable for iSCSI adapters only. A single priority must be specified. The range of valid values is 0-7. 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.

Use to set the UCNA DCB parameters (including priority groups) to their default values. For example: hbacmd SetDCBParam defaults

LLDP Settings for and

TxState

Description and

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 OneCommand Manager Command Line Interface Version 6.1 User Manual P007998-01A Rev. A

5. CLI Client Command Descriptions DCB Commands

57

RxState TxPortDesc TxSysDesc TxSysName TxSysCap 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

Example

hbacmd h=10.192.203.151 m=cim u=root p=Swamiji001 n=root/emulex setdcbparam 00-00-c9-3c-f7-88 fcoepriority 3

SetDCBPriority

This command sets the priorities for a priority group. The values must be set according to the following rules: 1. The priorities range from 0 to 7.

2. The 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 (PG0–PG7).

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.

OneCommand Manager Command Line Interface Version 6.1 User Manual P007998-01A Rev. A

5. CLI Client Command Descriptions DCB Commands

58

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.

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, Citrix, Solaris, VMware ESX, and Windows

Syntax

hbacmd SetDCBPriority ...

Parameters

WWPN MAC PFCPriorities Priorities of PGID The WWPN of the adapter.

The MAC address of the NIC or iSCSI port.

The PFC priority that is a comma-separated list of up to seven values, ranging from 0–7.

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.

Example

hbacmd h=10.192.203.151 m=cim setdcbpriority 10:00:00:00:c9:3c:f7:88 3 0,1,2,4,5,6,7 3 0 0 0 0 0 0 OneCommand Manager Command Line Interface Version 6.1 User Manual P007998-01A Rev. A

5. CLI Client Command Descriptions Diagnostic Commands

59

Diagnostic Commands

EchoTest

This command runs the echo test on adapters.

Notes:

  This command is not supported for OneConnect adapters.

Support for remote adapter is TCP/IP access only. The EchoTest command fails if the target WWPN does not support the ECHO ELS command.

Supported By

Linux, Citrix, Solaris, VMware ESX, and Windows

Syntax

EchoTest

Parameters

WWPN Source WWPN Destination Count StopOnError Pattern 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).

GetBeacon

This command shows the current beacon state (either “on” or “off”).

Supported By

Linux, Citrix, Solaris, VMware ESX, and Windows

Syntax

GetBeacon

Parameters

WWPN MAC The WWPN of the adapter.

The MAC address of the NIC or iSCSI port.

OneCommand Manager Command Line Interface Version 6.1 User Manual P007998-01A Rev. A

5. CLI Client Command Descriptions Diagnostic Commands

60

GetXcvrData

Note:

GetXcrvData is not supported for OneConnect OCe11100 series adapters.

This command shows transceiver data such as vendor name and serial number.

Supported By

Linux, Citrix, Solaris, VMware ESX, and Windows

Syntax

GetXcvrData [Type]

Parameters

WWPN MAC Type The WWPN of the adapter.

The MAC address of the NIC or iSCSI port.

The type of SFP data to display:   1 = Formatted data 2 = Raw data

Example

C:\Program Files\emulex\Util\OCManager>hbacmd h=10.192.203.154 m=cim u=root p=Swamiji001 n=root/emulex getxcvrdata 00-00-c9-93-2f-d6

LoadList

Note:

Not supported for OneConnect adapters.

This command shows the flash memory load list data for the adapter.

Supported By

Linux, Citrix, Solaris, VMware ESX, and Windows

Syntax

LoadList

Parameters

WWPN The WWPN of the adapter.

OneCommand Manager Command Line Interface Version 6.1 User Manual P007998-01A Rev. A

5. CLI Client Command Descriptions Diagnostic Commands

61

LoopBackTest

This command runs the loop test on the adapter specified by the WWPN or MAC address. Only PHY loopback test and MAC loopback tests are enabled for OneConnect adapters.

Note:

Loopback tests can be run on FC ports being managed locally or remotely through TCP/IP-based management.

Supported By

Citrix, Windows, Solaris, Linux, and VMware ESX

Syntax

LoopBackTest [Pattern]

Parameters

WWPN MAC Type Count StopOnError Pattern The WWPN of the FC or FCoE port.

The MAC address of the NIC or iSCSI port.

The type of loopback test to run:       0 = PCI loopback test. Not supported for OneConnect UCNAs.

1 = Internal loopback test. Not supported for OneConnect UCNAs.

2 = External loopback test (requires loopback plug) 3 = DMA loopback test. Only supported for OneConnect UCNAs. This DMA loopback test is not supported via the CIM interface.

4 = PHY loopback test. Only supported for OneConnect UCNAs.

5 = MAC loopback test. Only supported for OneConnect UCNAs.

Number of times to run the test. Possible values are 1–99,9999. To run the test infinitely, use 0.

Checks if the test must be halted on error.

0 = No halt 1 = Halt 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.1 User Manual P007998-01A Rev. A

5. CLI Client Command Descriptions Diagnostic Commands

62

LoopMap

Note:

Supported for FC ports only.

This command shows the arbitrated loop map data.

Supported By

Linux, Solaris, and Windows

Syntax

LoopMap

Parameters

WWPN The WWPN of the adapter.

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 a UCNA.

Supported By

Linux, Citrix, Solaris, VMware ESX, and Windows

Syntax

PciData

Parameters

WWPN MAC The WWPN of the adapter’s port.

The MAC address of the NIC or iSCSI port.

Example

C:\Program Files\emulex\Util\OCManager>hbacmd h=10.192.203.154 m=cim u=root p=Swamiji001 n=root/emulex pcidata 00-00-c9-93-2f-d6 The example output: Vendor ID: 0x19A2 Device ID: 0x0700 Command: 0x0406 Status: 0x0010 Revision ID: 0x02 Prog If: 0x00 Subclass: 0x00 Base Class: 0x02 Cache Line Size: 0x10 Latency Timer: 0x00 OneCommand Manager Command Line Interface Version 6.1 User Manual P007998-01A Rev. A

5. CLI Client Command Descriptions Diagnostic Commands

63

Header Type: 0x80 Built In Self Test: 0x00 Base Address 0: 0x00000000 Base Address 1: 0xDF478000 Base Address 2: 0xDF480004 Base Address 3: 0x00000000 Base Address 4: 0xDF4A0004 Base Address 5: 0x00000000 CIS: 0x00000000 SubVendor ID: 0x10DF SubSystem ID: 0xE622 ROM Base Address: 0x00000000 Interrupt Line: 0x00 Interrupt Pin: 0x01 Minimum Grant: 0x00 Maximum Latency: 0x00 Capabilities Ptr: 0x40

PostTest

Note:

Not supported for OneConnect adapters.

This command runs the POST on the adapter. Support for a remote adapter is through TCP/IP access only.

Supported By

Linux, Citrix, Solaris, VMware ESX, and Windows

Syntax

PostTest

Parameters

WWPN The WWPN of the adapter.

SetBeacon

This command turns the beacon on or off.

Supported By

Linux, Citrix, Solaris, VMware ESX, and Windows

Syntax

SetBeacon

Parameters

WWPN MAC BeaconState The WWPN of the FC port.

The MAC address of the NIC or iSCSI port.

Indicates the state of the beacon to be set to: 0 = Off 1 = On OneCommand Manager Command Line Interface Version 6.1 User Manual P007998-01A Rev. A

5. CLI Client Command Descriptions Diagnostic Commands

64

SetCableNVP

Note:

This command supports only OneConnect OCe11100 series adapters.

This command sets the nominal velocity of propagation (NVP), required for the TDRTest command, for the cable that connects to the physical port associated with the WWPN or MAC.

Supported By

Linux, Citrix, Solaris, VMware ESX, and Windows

Syntax

SetCableNVP

Parameters

WWPN MAC NVP The WWPN of the FC port.

The MAC address of the NIC or iSCSI port.

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 adapters only.

The time-domain reflectometry (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):   If a 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”. If one of two faults (a short or an open connection) is detected, the test output displays the fault type (“Shorted” or “Open”) and the distance to the fault (in meters).

Supported By

Linux, Citrix, Solaris, VMware ESX, and Windows

Syntax

TDRTest

Parameters

MAC_Address The MAC address of the NIC or iSCSI port.

OneCommand Manager Command Line Interface Version 6.1 User Manual P007998-01A Rev. A

5. CLI Client Command Descriptions Driver Parameter Commands

65 Example

hbacmd TDRTest 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 adapters.

This command wakes up the adapter.

Supported By

Linux, Citrix, Solaris, VMware ESX, and Windows

Syntax

Wakeup

Parameters

WWPN The WWPN of the adapter.

Driver Parameter Commands

Notes:

   Supported for FC and FCoE ports only.

Driver parameters that are set to temporary or global values (using the “T” and “G” flags, respectively) must be read using the GetDriverParams command to view the current value of the parameter. The GetDriverParamsGlobal command returns only permanently set driver parameter values. Additionally, if temporary and global values have been set for one or more driver parameters, the “SaveConfig” command must be run with the “N” flag (using the “N” flag is analogous to the GetDriverParams command) to force the driver parameter values for the specified adapter to be saved. Inaccurate values may be saved if the “G” flag is used for this command.

The DriverConfig and SetDriverParamDefaults commands are not supported for Solaris.

OneCommand Manager Command Line Interface Version 6.1 User Manual P007998-01A Rev. A

5. CLI Client Command Descriptions Driver Parameter Commands

66

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, Citrix, Solaris, VMware ESX, and Windows

Syntax

DriverConfig

Parameters

WWPN FileName Flag The WWPN of the adapter.

The name of the .dpv file, which is stored in the Emulex Repository directory.

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, Citrix, Solaris, VMware ESX, and Windows

Syntax

GetDriverParams

Parameters

WWPN The WWPN of the adapter.

GetDriverParamsGlobal

This command shows the name and the global value of each driver parameter.

Supported By

Linux, Citrix, Solaris, VMware ESX, and Windows

Syntax

GetDriverParamsGlobal

Parameters

WWPN The WWPN of the adapter.

OneCommand Manager Command Line Interface Version 6.1 User Manual P007998-01A Rev. A

5. CLI Client Command Descriptions Driver Parameter Commands

67

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.

Supported By

Linux, Citrix, Solaris, VMware ESX, and Windows

Syntax

SaveConfig

Parameters

WWPN FileName Flag The WWPN of the adapter.

Name of the file that contains the driver parameters list.

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, Citrix, Solaris, VMware ESX, and Windows

Syntax

SetDriverParam

Parameters

WWPN Flag1 Flag2 Param Value The WWPN of the adapter.

L = Make change local for this adapter only.

G = Make change global (all adapters on this host).

P = Make change permanent (persists across reboot).

T = Make change temporary.

Name of the parameter to modify.

New parameter value, decimal or hexadecimal (0xNNN).

OneCommand Manager Command Line Interface Version 6.1 User Manual P007998-01A Rev. A

5. CLI Client Command Descriptions Dump Commands

68

SetDriverParamDefaults

This command changes all values to the default for the adapter(s).

Supported By

Linux, Citrix, Solaris, VMware ESX, and Windows

Syntax

SetDriverParamDefaults

Parameters

WWPN Flag1 Flag2 The WWPN of the adapter.

L = Make change local for this adapter only.

G = Make change global (applies to all adapters on this host).

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” extension) and binary files. The extension for binary files depends on the adapter type:     OneConnect UCNAs (Enhanced FAT Dump) – “.edf” extension OneConnect UCNAs (Core Dump) – “.core” extension 16-Gb HBAs – “.bin” extension Legacy and LightPulse ™ adapters – “.dmp” extension

DeleteDumpFiles

This command deletes all diagnostic dump files for the adapter.

Supported By

Linux, Citrix, Solaris, VMware ESX, and Windows

Syntax

DeleteDumpFiles OneCommand Manager Command Line Interface Version 6.1 User Manual P007998-01A Rev. A

5. CLI Client Command Descriptions Dump Commands

69 Parameters

WWPN MAC The WWPN of the adapter.

The MAC address of the UCNA 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 “ListHBAs down”

command. See “ListHBAs” on page 100.

Note:

For OneConnect UCNAs, if the “core” optional parameter is not specified, an Enhanced FAT Dump is performed by default.

Supported By

Linux, Citrix, Solaris, VMware ESX, and Windows

Syntax

Dump [core [Options]]

Parameters

WWPN MAC core Options The WWPN of the adapter.

The MAC address of the UCNA port.

Perform a core dump on a OneConnect UCNA.

For available Options, contact Emulex technical support.

GetDumpDirectory

This command shows the dump file directory for the adapters in the host.

Note:

The dump directory can be set on VMware ESX hosts only.

Note:

The dump directory applies to all adapters in the server. There is not a separate dump directory for each adapter.

Supported By

Linux, Citrix, Solaris, VMware ESX, and Windows

Syntax

GetDumpDirectory OneCommand Manager Command Line Interface Version 6.1 User Manual P007998-01A Rev. A

5. CLI Client Command Descriptions Dump Commands

70 Parameters

WWPN MAC The WWPN of the adapter.

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: <2>: Not Supported Dump directory:     For Windows – C:\Program Files\Emulex\Util\Dump For Linux – /usr/sbin/ocmanager/Dump For Solaris – /opt/ELXocm/Dump For VMware ESX – The dump directory set using the SetDumpDirectory command.

Supported By

Linux, Citrix, Solaris, VMware ESX, and Windows

Syntax

GetDumpFile

Parameters

WWPN MAC filename The WWPN of the adapter.

The MAC address of the UCNA port.

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.1 User Manual P007998-01A Rev. A

5. CLI Client Command Descriptions Dump Commands

71

GetDumpFileNames

This command gets the names of the files in the remote host’s dump directory.

Supported By

Linux, Citrix, Solaris, VMware ESX, and Windows

Syntax

GetDumpFileNames

Parameters

WWPN MAC The WWPN of the adapter.

The MAC address of the UCNA 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, Citrix, Solaris, VMware ESX, and Windows

Syntax

GetRetentionCount

Parameters

WWPN MAC The WWPN of the adapter.

The MAC address of the UCNA port.

SetDumpDirectory

Note:

This command sets the dump directory for the VMware ESX/ESXi hosts only. For the “Dump” feature to work on a Vmware ESX host, the dump directory must be set.

To use the SetDumpDirectory command, you must have a directory 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.

OneCommand Manager Command Line Interface Version 6.1 User Manual P007998-01A Rev. A

5. CLI Client Command Descriptions Dump Commands

72 Note:

For VMware systems you must set a dump directory before initiating a dump. The dump directory must be a “Storage” partition (a datastore) under the directory /vmfs/volumes.

The application checks for the dump directory and creates the dump files in that location.

Note:

The dump directory applies to all adapters in the server. There is no separate dump directory for each adapter.

Supported By

Citrix and VMware ESX

Note:

In a 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 ESX/ESXi.

Syntax

For VMware ESX using the RM interface: hbacmd h=IP_Aaddress[:port] setdumpdirectory For VMware ESX/ESXi using the CIM interface: hbacmd h= m=cim [u=] [p=] [n=] setdumpdirectory

Parameters

DumpDirectoryName h The directory under /vmfs/volumes that you created to store the dump files.

The IP address of the host.

Example

This example shows the dump directory set to /vmfs/volumes/ocm-datastore: hbacmd h=10.192.203.173 m=cim u=root p=Swamiji001 n=root/emulex setdumpdirectory 10:00:00:00:c9:61: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, Citrix, Solaris, VMware ESX, and Windows OneCommand Manager Command Line Interface Version 6.1 User Manual P007998-01A Rev. A

5. CLI Client Command Descriptions FCoE Commands

73 Syntax

SetRetentionCount

Parameters

WWPN MAC Value The WWPN of the adapter.

The MAC address of the UCNA port.

The number of dump files to retain.

Example

hbacmd h=10.192.193.154 m=cim u=root p=Swamiji001 n=root/emulex SetRetentionCount 00-00-c9-93-2f-9f 6

FCoE Commands

Note:

These commands are supported only on OneConnect FCoE ports.

GetFCFInfo

This command shows the FCF information of the OneConnect adapter in FCoE mode.

Supported By

Linux, Citrix, Solaris, VMware ESX, and Windows

Syntax

GetFCFInfo

Parameters

WWPN The WWPN of the adapter.

Example

hbacmd getfcfinfo 10:00:00:00:c9:3c:f7:88

GetFIPParams

This command gets the FCoE Initialization Protocol (FIP) parameters of the OneConnect adapter in FCoE mode.

Supported By

Linux, Citrix, Solaris, VMware ESX, and Windows

Syntax

GetFIPParams OneCommand Manager Command Line Interface Version 6.1 User Manual P007998-01A Rev. A

5. CLI Client Command Descriptions Guardian Commands

74 Parameters

WWPN The WWPN of the adapter.

Example

hbacmd getfipparams 10:00:00:00:c9:5b:3a:6d

SetFIPParam

This command sets the FIP parameters of the OneConnect adapter in FCoE mode.

Supported By

Linux, Citrix, Solaris, VMware ESX, and Windows

Syntax

SetFIPParam

Parameters

WWPN Param Value The WWPN of the adapter.

The FIP parameter name:      pfabric pswitch vlanid fcmap cinvlanid The value based on the FIP parameter name:      pfabric: 8-byte fabric name (format XX:XX:XX:XX:XX:XX:XX:XX) pswitch: 8-byte switch name (format XX:XX:XX:XX:XX:XX:XX:XX) vlanid: 2-byte VLAN ID [0-4095] or “any” for any VLANID fcmap: 3-byte FC_map, 0x0EFCxx cinvlanid: 2-byte VLAN_ID [0-4095]

Example

hbacmd setfipparam 10:00:00:00:c9:5b:3a:6d fcmap 0x0efc99

Guardian Commands

Guardian commands are listed when you run the help command; however, these commands are used for internal purposes only and should be ignored.

OneCommand Manager Command Line Interface Version 6.1 User Manual P007998-01A Rev. A

5. CLI Client Command Descriptions iSCSI Commands

75

iSCSI Commands

The commands in this section support the iSCSI interface in the OneCommand Manager CLI.

Note:

iSCSI commands are supported only on OneConnect iSCSI ports.

The MAC address of the UCNA port must be passed to each command as the first argument. Some commands require values to be set in a format similar to: “option_name=value”.

Type the full option name or the abbreviated option name (shown in Table 5-2, Option Names) and enter the value. The abbreviations are not case sensitive.

Table 5-2

Option Names

Option Name

Auth DataDigest DHCP HeaderDigest ImmediateData Initiator_Alias Initiator_Name Priority VLAN_ENABLED VLAN_ID

Abbreviation

au dd dh hd id ia in pr ve vi

Example

au=1 dd=1 dh=1 hd=1 id=1 ia=”initiator_alias

in=”initiator_name” pr=1 ve=1 vi=1

AddARPTableEntry

This command adds an Address Resolution Protocol (ARP) table entry.

Supported By

Linux, Citrix, Solaris, VMware ESX, and Windows

Syntax

AddARPTableEntry

Parameters

MAC_Address Dest_MAC_Address Dest_IP_Address The MAC address of the UCNA port.

The destination MAC address to add to the ARP table.

The destination IP address to add to the ARP table.

OneCommand Manager Command Line Interface Version 6.1 User Manual P007998-01A Rev. A

5. CLI Client Command Descriptions iSCSI Commands

76

AddRouteTableEntry

This command adds a new route table entry to the route table of the specified port.

Supported By

Linux, Citrix, Solaris, VMware ESX, and Windows

Syntax

AddRouteTableEntry

Parameters

MAC_Address Dest_IP_Address Subnet_Mask Gateway MAC address of the UCNA port.

Destination IP address to add to the route table.

Subnet Mask to add to the route table.

Gateway to add to the route table.

AddTarget

This command adds a target to the list of targets seen by the initiator and logs into the target once it has been successfully created. This command requires that you specify a valid target IP , port number , and iSCSI name . If you do not specify the remaining options, these options are set to their default values. When you set the authentication method 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.

  If you set the authentication method to “One-Way CHAP” (=1), you must also specify the “Target CHAP Name” and “Target Secret.” For example: hbacmd AddTarget 00-11-22-33-44-55 192.168.1.1 8000 iscsitarget Auth=1 "TgtCHAPName" "TargetSecret1" If you set the authentication method to “Mutual CHAP” (=2), you must specify all four values. For example: hbacmd AddTarget 00-11-22-33-44-55 192.168.1.1 8000 iscsitarget Auth=1 "TgtCHAPName" "TargtSecret1" "InitCHAPName" "InitialSecret1"

Supported By

Linux, Citrix, Solaris, VMware ESX, and Windows

Syntax

AddTarget [ImmediateData=<0|1>] [HeaderDigest=<0|1>] [DataDigest=<0|1>] [Boot=<0|1>] [Login=<0|1>] [Auth=<0|1|2> "TgtCHAPName" "TgtSecret" "InitCHAPName" "InitSecret"] OneCommand Manager Command Line Interface Version 6.1 User Manual P007998-01A Rev. A

5. CLI Client Command Descriptions iSCSI Commands

77 Parameters

MAC_Address Target_IP Port iscsi_target_name ImmediateData HeaderDigest DataDigest Boot Login Auth TgtCHAPNam TgtSecret InitCHAPName InitSecret The MAC address of the UCNA port.

IP address of the target portal.

Port number of the target portal (value: 102–65535).

Target’s iSCSI name enclosed in quotes (string length: 11–255).

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).

AddTargetPortal

This command adds a new SendTarget Portal for the initiator and runs a target discovery once the SendTarget Portal is created. This command requires that you specify a valid portal IP address and a valid port number . If you do not specify the remaining options, these options are set to their default values. When you set the authentication method 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.

 If you set the authentication method to “One-Way CHAP” (=1), you must also specify the “Target CHAP Name” and “Target Secret.” For example: hbacmd AddTargetPortal 00-11-22-33-44-55 10.0.0.1 8000 Auth=1 "TgtCHAPName" "TargetSecret1" OneCommand Manager Command Line Interface Version 6.1 User Manual P007998-01A Rev. A

5. CLI Client Command Descriptions iSCSI Commands

78

 If you set the authentication method to “Mutual CHAP” (=2), you must specify all four values. For example: hbacmd AddTargetPortal 00-11-22-33-44-55 10.0.0.1 8000 Auth=2 "TgtChapName" "TargetSecret1" "InitCHAPName" "InitialSecret1" You must specify either the TSIH value or the ISID qualifier. If you specify the ISID qualifier, you must also specify the Target’s ID address.

Supported By

Linux, Citrix, Solaris, VMware ESX, and Windows

Syntax

AddTargetPortal [ImmediateData=<0|1>] [HeaderDigest=<0|1>] [DataDigest=<0|1>] [Auth=<0|1|2> "TgtCHAPName" "TgtSecret" "InitCHAPName" "InitSecret"]

Parameters

MAC_Address Target_IP Port ImmediateData HeaderDigest DataDigest Auth TgtCHAPNam TgtSecret InitCHAPName InitSecret The MAC address of the UCNA port.

IP address of the target portal.

Port number of the target portal (value: 1024-65535).

0 = No 1 = Yes (default) 0 = None (default) 1 = CRC32C 0 = None (default) 1 = CRC32C 0 = None (default) 1 = One-Way CHAP 2 = Mutual CHAP Target CHAP name enclosed in quotes (string length: 1-256).

Target Secret enclosed in quotes (string length: 12-16).

Initiator CHAP name enclosed in quotes (string length: 1-256).

Initiator Secret enclosed in quotes (string length: 12-16).

CleariSNSServer

This command clears the configured iSNS server and disables iSNS target discovery. If no iSNS server is currently configured, this command does nothing.

Supported By

Linux, Citrix, Solaris, VMware ESX, and Windows

Syntax

CleariSNSServer OneCommand Manager Command Line Interface Version 6.1 User Manual P007998-01A Rev. A

5. CLI Client Command Descriptions iSCSI Commands

79 Parameters

MAC_Address The MAC address of the UCNA port.

DelARPTableEntry

This command removes an Address Resolution Protocol (ARP) table entry.

Supported By

Linux, Citrix, Solaris, VMware ESX, and Windows

Syntax

DelARPTableEntry

Parameters

MAC_Address Dest_MAC_Address Dest_IP_Address The MAC address of the UCNA port.

The destination MAC address to remove from the ARP table.

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, Citrix, Solaris, VMware ESX, and Windows

Syntax

DelRouteTableEntry

Parameters

MAC_Address Dest_IP_Address Subnet_Mask Gateway MAC address of the UCNA port.

Destination IP address to delete from the route table.

Subnet Mask to delete from the route table.

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, Citrix, Solaris, VMware ESX, and Windows OneCommand Manager Command Line Interface Version 6.1 User Manual P007998-01A Rev. A

5. CLI Client Command Descriptions iSCSI Commands

80 Syntax

DiscoveriSNSServer

Parameters

MAC_Address The MAC address of the UCNA port.

ExportiSCSI

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 exportiscsi > targets.xml

GetInitiatorProperties

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, Citrix, Solaris, VMware ESX, and Windows

Syntax

GetInitiatorProperties

Parameters

MAC_Address The MAC address of the UCNA 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 parameter.

OneCommand Manager Command Line Interface Version 6.1 User Manual P007998-01A Rev. A

5. CLI Client Command Descriptions iSCSI Commands

81 Supported By

Linux, Citrix, Solaris, VMware ESX, and Windows

Syntax

GetiSCSILuns

Parameters

MAC_Address iscsi_target_name The MAC address of the UCNA port.

Target’s iSCSI name enclosed in quotes (string length: 11-255)

GetiSCSIPortStats

This command shows all the port statistics for a specified port.

Supported By

Linux, Citrix, Solaris, VMware ESX, and Windows

Syntax

GetiSCSIPortStats

Parameters

MAC_Address The MAC address of the UCNA port.

GetNetworkConfiguration

This command lists a port’s TCP/IP information.

Supported By

Linux, Citrix, Solaris, VMware ESX, and Windows

Syntax

GetNetworkConfiguration

Parameters

MAC_Address The MAC address of the UCNA port.

GetSessionInfo

This command lists all session information for a specified session. You must specify the and either the of the session or the session’s ISID Qualifier and the target’s IP address . These parameters tell the command to gather the information from the specified target and OneCommand Manager Command Line Interface Version 6.1 User Manual P007998-01A Rev. A

5. CLI Client Command Descriptions iSCSI Commands

82

session. You can find the TSIH and ISID qualifier by running the ListSessions command.

Supported By

Linux, Citrix, Solaris, VMware ESX, and Windows

Syntax

GetSessionInfo >

Parameters

MAC_Address iscsi_target_name TSIH ISID_Qual Target_IP The MAC address of the UCNA port.

Target’s iSCSI name enclosed in quotes (string length: 11–255).

TSIH value of the session (value: 1–65535).

ISID qualifier of the session (value: 0–65535).

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 [clean]

Parameters

Import_File clean The name of XML file containing import information that was

generated by the ExportiSCSI command (see “ExportiSCSI” on page 80).

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 OneCommand Manager Command Line Interface Version 6.1 User Manual P007998-01A Rev. A

5. CLI Client Command Descriptions iSCSI Commands

83

The example output: All existing targets have been removed.

Added target iqn.2006-01.com.openfiler:target121-000.on.port.00-00-c9-be-1a-24 Added target iqn.2006-01.com.openfiler:target121-001.on.port.00-00-c9-be-1a-24 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, Citrix, Solaris, VMware ESX, and Windows

Syntax

iSCSIPing

Parameters

MAC_Address IP_Address The MAC address of the UCNA port.

IP address of target to send ICMP echo request.

ListSessions

This command lists all the sessions on a specified target. The command gathers the information from the iSCSI target indicated by the parameter.

Supported By

Linux, Citrix, Solaris, VMware ESX, and Windows

Syntax

ListSessions

Parameters

MAC_Address iscsi_target_name The MAC address of the UCNA port.

Target’s iSCSI name enclosed in quotes. The string length is 11–255.

RemoveTarget

This command removes the target with the specified iSCSI target name .

Supported By

Linux, Citrix, Solaris, VMware ESX, and Windows OneCommand Manager Command Line Interface Version 6.1 User Manual P007998-01A Rev. A

5. CLI Client Command Descriptions iSCSI Commands

84 Syntax

RemoveTarget

Parameters

MAC_Address iscsi_target_name The MAC address of the UCNA port.

Target’s iSCSI name enclosed in quotes. The string length is 11–255.

RemoveTargetPortal

This command removes the SendTarget Portal containing the target IP and the port from the list of portals for the specified initiator.

Supported By

Linux, Citrix, Solaris, VMware ESX, and Windows

Syntax

RemoveTargetPortal

Parameters

MAC_Address Target_IP Port The MAC address of the UCNA port.

The target’s IP address.

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 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 parameter. If the target is not logged in, use the parameter.

Supported By

Linux, Citrix, Solaris, VMware ESX, and Windows

Syntax

SetBootTargetSession > <0|1>

Parameters

MAC_Address The MAC address of the desired iSCSI port.

OneCommand Manager Command Line Interface Version 6.1 User Manual P007998-01A Rev. A

5. CLI Client Command Descriptions iSCSI Commands

85

Target TSIH ISID_Qual 0|1 Specifies the iSCSI name of the desired iSCSI target.

TSIH value of the session. The possible values are 1–65535.

ISID qualifier of the session. The possible values are 0–65535.

Specifies the state of the BootProperty for the target: 0 = Disabled 1 = Enabled

SetInitiatorProperties

This command sets the initiator properties for the specified port. It allows you to specify an initiator name and an initiator alias . If you opt not to specify these fields, a default iSCSI name is assigned. Except for the and properties, these properties are set as the target portal’s login properties to be used when discovering the targets on the target portal. The targets inherit the target portal's properties when they are discovered. The discovered target's login properties can be changed using the SetTargetProperties command.

When you set the authentication method 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.

  If you set the authentication method to “One-Way CHAP” (=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" "TargetSecret1" If you set the authentication method to “Mutual CHAP” (=2), you must specify all four values. For example: hbacmd SetInitiatorProperties 00-11-22-33-44-55 Auth=2 "TgtChapName" "TargetSecret1" "InitCHAPName" "InitialSecret1"

Supported By

Linux, Citrix, Solaris, VMware ESX, and Windows

Syntax

SetInitiatorProperties [Initiator_Name="initiator_name"] [Initiator_Alias="initiator_alias"] [ImmediateData=<0|1>] [HeaderDigest=<0|1>] [DataDigest=<0|1>] [Auth=<0|1|2> "TgtCHAPName" "TgtSecret" "InitCHAPName" "InitSecret"]

Parameters

MAC_Address Initiator_Name The MAC address of the UCNA port.

Initiator iSCSI name enclosed in quotes (string length: 1–224).

OneCommand Manager Command Line Interface Version 6.1 User Manual P007998-01A Rev. A

5. CLI Client Command Descriptions iSCSI Commands

86

Initiator_Alias ImmediateData HeaderDigest DataDigest Auth TgtCHAPNam TgtSecret InitCHAPName InitSecret Initiator iSCSI alias enclosed in quotes (string length: 0–32).

0 = No 1 = Yes (default) 0 = None (default) 1 = CRC32C 0 = None (default) 1 = CRC32C 0 = None (default) 1 = One-Way CHAP 2 = Mutual CHAP Target CHAP name enclosed in quotes (string length: 1–256).

Target Secret enclosed in quotes (string length: 12–16).

Initiator CHAP name enclosed in quotes (string length: 1–256).

Initiator Secret enclosed in quotes (string length: 12–16).

SetiSCSIBoot

This command defines whether a specific iSCSI function’s Boot ROM is active.

Supported By

Linux, Citrix, Solaris, VMware ESX, and Windows

Syntax

SetiSCSIBoot <0|1>

Parameters

MAC_Address 0|1 The MAC address of the desired iSCSI port.

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 and .

Supported By

Linux, Citrix, Solaris, VMware ESX, and Windows

Syntax

SetNetworkConfiguration [> >] > [ [Gateway]] OneCommand Manager Command Line Interface Version 6.1 User Manual P007998-01A Rev. A

5. CLI Client Command Descriptions iSCSI Commands

87 Parameters

MAC_Address VLAN_ENABLED VLAN_ID Priority DHCP IP_Address Subnet_Mask Gateway The MAC address of the UCNA port.

0 = Disabled 1 = Enabled VLAN ID of the interface. The possible values are 0–4095.

VLAN priority of the interface. The possible values are 0–7.

0 = Disabled 1 = Enabled New IP address. For example: 10.192.1.1.

Subnet Mask. For example: 255.255.255.0.

Gateway. For example: 10.192.1.1.

Note:

VLAN_ID and Priority are required only if VLAN_ENABLED is enabled; otherwise, these values should be omitted.

Note:

IP_Address and Subnet_Mask are required only if DHCP is disabled; otherwise these values should be omitted.

SetTargetLoginProperties

This command sets the login and authentication properties associated with a specific target. This command requires that you specify a valid iSCSI target name . If you do not specify some of the remaining properties, these options are set to their default values. However, if no properties are changed, an error is generated. You must change at least one property for this command to return successfully. When you set the authentication method 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.

  If you set the authentication method to “One-Way CHAP” (=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" If you set the authentication method to “Mutual CHAP” (=2), you must specify all four values. For example: hbacmd SetTargetLoginProperties 00-11-22-33-44-55 iscsitarget Auth=2 "TgtChapName" "TargetSecret1" "InitCHAPName" "InitialSecret1"

Supported By

Linux, Citrix, Solaris, VMware ESX, and Windows OneCommand Manager Command Line Interface Version 6.1 User Manual P007998-01A Rev. A

5. CLI Client Command Descriptions iSCSI Commands

88 Syntax

SetTargetLoginProperties [ImmediateData=<0|1>] [HeaderDigest=<0|1>] [DataDigest=<0|1>] [Auth=<0|1|2> "TgtCHAPName" "TgtSecret" "InitCHAPName" "InitSecret"]

Parameters

MAC_Address iscsi_target_name ImmediateData HeaderDigest DataDigest Auth TgtCHAPNam TgtSecret InitCHAPName InitSecret The MAC address of the UCNA port.

Target’s iSCSI name enclosed in quotes (string length: 11–255).

0 = No 1 = Yes (default) 0 = None (default) 1 = CRC32C 0 = None (default) 1 = CRC32C 0 = None (default) 1 = One-Way CHAP 2 = Mutual CHAP Target CHAP name enclosed in quotes (string length: 1–256).

Target Secret enclosed in quotes (string length: 12–16).

Initiator CHAP name enclosed in quotes (string length: 1–256).

Initiator Secret enclosed in quotes (string length: 12–16).

SetTargetProperties

This command sets the Extended TimeOut (ETO) value of a target.

Supported By

Linux, Citrix, Solaris, VMware ESX, and Windows

Syntax

SetTargetProperties

Parameters

MAC_Address iscsi_target_name ETO The MAC address of the UCNA port.

Target’s iSCSI name enclosed in quotes (string length: 11–255) The extended timeout option for the target:   For Windows, valid values are 0–3600.

For Citrix, Linux, Solaris, and VMware ESX, valid values are 0–30.

OneCommand Manager Command Line Interface Version 6.1 User Manual P007998-01A Rev. A

5. CLI Client Command Descriptions iSCSI Commands

89

SetTPLoginProperties

This command sets a target portal’s login properties. This command requires that you specify a valid Target IP and Port . However, if you specify no options other than the Target IP and Port, no changes are made. You must change at least one of the optional parameters for this command to make any changes to the target portal's login properties. These properties are used when discovering the targets on the target portal. The targets inherit the target portal's properties when they are discovered. Targets already discovered do not inherit the updated properties, only newly discovered targets inherit the properties.

When you set the authentication method 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.

  If you set the authentication method to “One-Way CHAP” (=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" If you set the authentication method to “Mutual CHAP” (=2), you must specify all four values. For example: hbacmd SetTPLoginProperties 00-11-22-33-44-55 10.192.1.1 5050 Auth=2 "TgtChapName" "TargetSecret1" "InitCHAPName" "InitialSecret1"

Supported By

Linux, Citrix, Solaris, VMware ESX, and Windows

Syntax

SetTPLoginProperties [ImmediateData=<0|1>] [HeaderDigest=<0|1>] [DataDigest=<0|1>] [Auth=<0|1|2> TgtCHAPName TgtSecret InitCHAPName InitSecret]

Parameters

MAC_Address Target_IP Port ImmediateData HeaderDigest DataDigest The MAC address of the UCNA port.

The IP address of the target portal.

The port number of the target portal (value: 1024–65535).

0 = No 1 = Yes (default) 0 = None (default) 1 = CRC32C 0 = None (default) 1 = CRC32C OneCommand Manager Command Line Interface Version 6.1 User Manual P007998-01A Rev. A

5. CLI Client Command Descriptions iSCSI Commands

90

Auth TgtCHAPNam TgtSecret InitCHAPName InitSecret 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).

ShowARPTable

This command shows the current ARP table for the specified port.

Supported By

Linux, Solaris, VMware ESX, and Windows

Syntax

ShowARPTable

Parameters

MAC_Address The MAC address of the UCNA 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, Citrix, Solaris, VMware ESX, and Windows

Syntax

ShowiSNSServer

Parameters

MAC_Address The MAC address of the UCNA port.

ShowRouteTable

This command shows the route table for a specific port.

Supported By

Linux, Citrix, Solaris, VMware ESX, and Windows OneCommand Manager Command Line Interface Version 6.1 User Manual P007998-01A Rev. A

5. CLI Client Command Descriptions iSCSI Commands

91 Syntax

ShowRouteTable

Parameters

MAC_Address The MAC address of the UCNA port.

Example

hbacmd h=10.192.203.240 showroutetableentry 00-00-c9-a0-ce-77

ShowTarget

This command shows the properties for a specified target. If you do not specify the iSCSI target name , all targets and their associated properties return. If you specify in place of the , all targets are refreshed before returning the information. If you do not provide a or value, only the targets from the last refresh are displayed.

Supported By

Linux, Citrix, Solaris, VMware ESX, and Windows

Syntax

ShowTarget [ | refreshtargets]

Note:

Only one command option can be specified with this command. That is, you can only specify either or .

Parameters

MAC_Address iscsi_target_name refreshtargets The MAC address of the UCNA port.

The target’s iSCSI name enclosed in quotes (string length: 11–255).

Refresh all targets before displaying the information.

ShowTargetPortal

This command shows the properties for a specified SendTarget Portal. If the and are not specified, all SendTarget Portals and their associated properties return.

Supported By

Linux, Solaris, and Windows

Syntax

ShowTargetPortal [ ] OneCommand Manager Command Line Interface Version 6.1 User Manual P007998-01A Rev. A

Parameters

MAC_Address Target_IP Port The MAC address of the UCNA port.

IP address of the target portal.

Port number of the target portal.

TargetLogin

This command logs in to a target. The iSCSI target name is the only mandatory option. The and 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 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.

  If you set the authentication method to “One-Way CHAP” (=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" "TargetSecret1" If you set the authentication method to “Mutual CHAP” (=2), you must specify all four values. For example: hbacmd TargetLogin 00-11-22-33-44-55 iscsitarget Auth=2 "TgtChapName" "TargetSecret1" "InitCHAPName" "InitialSecret1"

Supported By

Linux, Citrix, Solaris, VMware ESX, and Windows

Syntax

TargetLogin [target_portal_ip ] [ImmediateData=<0|1>] [HeaderDigest=<0|1>] [DataDigest=<0|1>] [Auth=<0|1|2> "TgtCHAPName" "TgtSecret" "InitCHAPName" "InitSecret"]

Parameters

MAC_Address iscsi_target_name Port ImmediateData HeaderDigest DataDigest The MAC address of the UCNA port.

The target’s iSCSI name enclosed in quotes (string length: 11–255).

The port number of the target portal. The possible values are 1024–65535.

0 = No 1 = Yes (default) 0 = None (default) 1 = CRC32C 0 = None (default) 1 = CRC32C OneCommand Manager Command Line Interface Version 6.1 User Manual 5. CLI Client Command Descriptions iSCSI Commands

92

P007998-01A Rev. A

5. CLI Client Command Descriptions iSCSI Commands

93

Auth TgtCHAPNam TgtSecret InitCHAPName InitSecret 0 = None (default) 1 = One-Way CHAP 2 = Mutual CHAP The Target CHAP name enclosed in quotes (string length: 1–255).

The Target Secret enclosed in quotes (string length: 12–16).

The Initiator CHAP name enclosed in quotes (string length: 1–255).

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 and either the TSIH of the session, or the session’s ISID Qualifier and the target’s IP address .

Supported By

Linux, Citrix, Solaris, VMware ESX, and Windows

Syntax

TargetLogout >

Parameters

MAC_Address iscsi_target_name TSIH ISID_Qual Target_IP The MAC address of the UCNA port.

The target’s iSCSI name enclosed in quotes (string length: 11–255).

The TSIH value of the session. The possible values are 1–65535.

The ISID qualifier of the session. The possible values are 0–65535.

The target's IP address.

UpdateiSNSServer

This command updates the configured iSNS server. This command requires the server IP and port number of the iSNS server to be available to respond to the iSNS requests.

Supported By

Linux, Citrix, Solaris, VMware ESX, and Windows OneCommand Manager Command Line Interface Version 6.1 User Manual P007998-01A Rev. A

5. CLI Client Command Descriptions LUN Masking Commands

94 Syntax

UpdateiSNSServer

Parameters

MAC_Address Server_IP Port The MAC address of the UCNA port.

IP address of the iSNS server to configure.

Port number of the iSNS server to configure (value: 1024–65535).

LUN Masking Commands

Notes:

   Supported for FC/FCoE ports only.

Linux does not support the GetLunUnMaskByHBA, GetLunUnMaskByTarget, and SetLunMask commands.

Citrix, Solaris, and VMware ESX 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

GetLunList

Parameters

HBA WWPN Target WWPN Option The WWPN of the adapter.

The WWPN of the target.

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

5. CLI Client Command Descriptions LUN Masking Commands

95 Parameters

HBA WWPN Option The WWPN of the adapter.

0 = Get information from the driver.

1 = Get information from the configuration.

GetLunUnMaskByTarget

This command queries for any unmasked LUNs by target.

Supported By

Solaris and Windows

Syntax

GetLunUnMaskByTarget

Parameters

HBA WWPN Target WWPN Option The WWPN of the adapter.

The WWPN of the target.

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

Parameters

HBA WWPN Target WWPN The WWPN of the adapter.

The WWPN of the target.

SetLunMask

This command masks the specified LUNs.

Supported By

Solaris and Windows OneCommand Manager Command Line Interface Version 6.1 User Manual P007998-01A Rev. A

5. CLI Client Command Descriptions Miscellaneous Commands

96 Syntax

SetLunMask

Parameters

HBA WWPN Target WWPN Option Lun LunCount MaskOp The WWPN of the adapter.

The WWPN of the target.

0 = Get information from the driver.

1 = Get information from the configuration (make persistent).

2 = Send information to both.

The starting LUN number.

The number of LUNs.

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, Citrix, Solaris, VMware ESX, 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 ESX/ESXi using the CIM interface: hbacmd m=cim [u=] [p=] [n=]addhost

If the username, password, and namespace are not specified, see “Default CIM Credentials” on page 26.

OneCommand Manager Command Line Interface Version 6.1 User Manual P007998-01A Rev. A

Parameters

host_address IP_Address The IP address (using the IPv4 or IPv6 format) or the host name.

The IP address of the host.

CnaClearEventLog

Note:

Supported for OneConnect adapters only.

This command clears the UCNA event log specified by the WWPN or MAC address.

Supported By

Linux, Citrix, VMware ESX, and Windows

Syntax

CnaClearEventLog

Parameters

WWPN MAC The WWPN of the UCNA FCoE port.

The MAC address of the NIC or iSCSI port of the UCNA.

CnaGetEventLog

Note:

Supported for OneConnect adapters only.

This command shows the UCNA event log specified by the WWPN or MAC address.

Supported By

Linux, Citrix, VMware ESX, and Windows

Syntax

CnaGetEventLog

Parameters

WWPN MAC The WWPN of the adapter port.

The MAC address of the NIC or iSCSI port.

Download

Loads the firmware image to the FC or UCNA port specified by the WWPN or MAC address.

Notes:

 For 16-Gb HBA firmware downloads, OneCommand Manager only accepts “.grp” files.

OneCommand Manager Command Line Interface Version 6.1 User Manual 5. CLI Client Command Descriptions Miscellaneous Commands

97

P007998-01A Rev. A

5. CLI Client Command Descriptions Miscellaneous Commands

98

 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, Citrix, Solaris, VMware ESX, and Windows

Syntax

Download

Parameters

WWPN MAC FileName The WWPN of the adapter port.

The MAC address of the NIC or iSCSI port.

The name and location of the firmware image (any file accessible to the CLI client).

ExportSANInfo

Notes:

  Emulex recommends that you redirect this output to a file with proper extension: “.xml” for XML-formatted files and “.csv” for CSV-formatted files.

Due to the amount of information that must be obtained and reported, this command can take a long time on large SAN configurations.

For reporting purposes, this command captures the SAN information in xml or csv format. Since this command can output a large amount of information, Emulex recommends that you re-direct the output to a file.

Supported By

Linux, Citrix, Solaris, VMware ESX, 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:   csv xml

Note:

Leaving the blank shows the data in xml format (default).

OneCommand Manager Command Line Interface Version 6.1 User Manual P007998-01A Rev. A

5. CLI Client Command Descriptions Miscellaneous Commands

99

GetCimCred

This command shows the default credentials set for the CIM client.

Note:

The password is encrypted.

Supported By

Windows

Syntax

GetCimCred

Parameters

None.

GetElxSecInfo

This command shows the version of the ElxSec system.

Supported By

Windows and Linux

Syntax

GetElxSecInfo

Parameters

None

GetQoSInfo

This command shows the QoS information for a specified NIC port.

Supported By

Linux, Citrix, Solaris, VMware ESX, and Windows

Syntax

GetQoSInfo

Parameters

h WWPN MAC The IP address of name of the host.

The WWPN of the adapter port.

The MAC address of the NIC or iSCSI port.

OneCommand Manager Command Line Interface Version 6.1 User Manual P007998-01A Rev. A

5. CLI Client Command Descriptions Miscellaneous Commands

100 Example

C:\Program Files\emulex\Util\OCManager>hbacmd h=10.192.203.154 m=cim u=root p=Swamiji001 n=root/emulex getqosinfo 00-00-c9-93-2f-d6

GetVPD

This command shows the port’s Vital Product Data (VPD).

Supported By

Linux, Citrix, Solaris, VMware ESX, and Windows

Syntax

GetVPD

Parameters

WWPN MAC The WWPN of the adapter.

The MAC address of the NIC or iSCSI port.

ListHBAs

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 address is displayed rather than the Port WWN. The Node WWN and Fabric WWN are not displayed. The type of information listed may vary according to the adapter model.

Supported By

Linux, Citrix, Solaris, VMware ESX, and Windows

Syntax

listhbas [local] [m=model] [pt=type] [down]

Parameters

local m=model pt=type down Only display local adapters.

Model filter. Append * to the end of the model name for a wildcard match. For example: LP9* The port type filter. Valid types are NIC, iSCSI, FC, and FCoE.

Display only the NIC functions of inoperative OneConnect UCNAs on the local system.

OneCommand Manager Command Line Interface Version 6.1 User Manual P007998-01A Rev. A

5. CLI Client Command Descriptions Miscellaneous Commands

101

RemoveHost

This command removes a host from the hosts file use for TCP/IP management in the OneCommand Manager application GUI. The can be an IP address, using the IPv4 or IPv6 format, or a host name.

Supported By

Linux, Citrix, Solaris, VMware ESX, and Windows

Syntax

For the RM interface: hbacmd RemoveHost host_address For VMware ESX/ESXi using the CIM interface: hbacmd 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 IP_Address The host to remove.

The IP address of the host to remove.

Reset

Notes:

  Supported for FC and FCoE ports only.

For OneConnect FCoE ports, this command only resets the driver to update changed driver parameters that require a driver reset. It does not cause a hardware reset of the adapter port.

This command resets the adapter. An adapter reset can require several seconds to complete, especially for remote devices. When the reset is completed, the system command prompt is displayed.

Supported By

Linux, Citrix, Solaris, VMware ESX, and Windows

Syntax

Reset

Parameters

WWPN The WWPN of the adapter.

OneCommand Manager Command Line Interface Version 6.1 User Manual P007998-01A Rev. A

5. CLI Client Command Descriptions Miscellaneous Commands

102

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

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 password namespace portnum Login User ID of the VMware ESX.

The login password of the VMware ESX.

The namespace where the Emulex provider is registered in the SFCB CIMOM of VMware ESX, specifically “root/emulex”.

The port number of the SFCB CIMOM listening to, that is, 5988 (HTTP) or 5989 (HTTPS).

TargetMapping

This command shows a list of mapped targets and the LUNs for the port.

Supported By

Linux, Citrix, Solaris, VMware ESX, and Windows

Syntax

TargetMapping

Parameters

WWPN The WWPN of the adapter.

Version

This command shows the current version of the OneCommand Manager CLI Client.

Supported By

Linux, Citrix, Solaris, VMware ESX, and Windows OneCommand Manager Command Line Interface Version 6.1 User Manual P007998-01A Rev. A

5. CLI Client Command Descriptions Persistent Binding Commands

103 Syntax

For the RM interface: hbacmd Version

Note:

The “h=” option (for specifying an optional IP address or host name) after “hbacmd” is not available for the Version command.

For VMware ESX/ESXi using the CIM interface: hbacmd h= m=cim version

Parameters

None

Persistent Binding Commands

Notes:

   These commands are supported for FC/FCoE ports only.

The following persistent binding commands are not supported on Linux or VMware ESX:   BindingCapabilities BindingSupport      PersistentBinding RemoveAllPersistentBinding RemovePersistentBinding SetPersistentBinding SetBindingSupport In a remote environment, you can perform persistent bindings operations from a host running any operating system (including Linux or VMware ESX), but only to a remote host that is running Windows or Solaris.

For a binding to take effect immediately (that is, SetPersistentBinding parameter: Scope = I or B), the and 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 and parameters are available to be persistently bound. Also, the parameter must match the currently active bind type. Otherwise, you are notified that you must reboot the system to cause the persistent binding to become active.

OneCommand Manager Command Line Interface Version 6.1 User Manual P007998-01A Rev. A

5. CLI Client Command Descriptions Persistent Binding Commands

104

AllNodeInfo

This command shows target node information for each target accessible by the adapter.

Supported By

Linux, Citrix, Solaris, VMware ESX, and Windows

Syntax

AllNodeInfo

Parameters

WWPN The WWPN of the adapter.

BindingCapabilities

This command shows the binding capabilities of the adapter. If a binding is configured, it is maintained across reboots.

Supported By

Solaris and Windows

Syntax

BindingCapabilities

Parameters

WWPN The WWPN of the adapter.

BindingSupport

This command shows the binding support for the adapter.

Supported By

Solaris and Windows

Syntax

BindingSupport

Parameters

WWPN Source The WWPN of the adapter.

C = Configuration support L = Live support OneCommand Manager Command Line Interface Version 6.1 User Manual P007998-01A Rev. A

5. CLI Client Command Descriptions Persistent Binding Commands

105

PersistentBinding

This command specifies which set of persistent binding information (configuration or live state) is requested.

Supported By

Solaris and Windows

Syntax

PersistentBinding

Parameters

WWPN Source The WWPN of the adapter.

C = Configuration support L = Live support

RemoveAllPersistentBinding

This command removes all persisting bindings for the adapter.

Supported By

Solaris and Windows

Syntax

RemoveAllPersistentBinding

Parameters

WWPN The WWPN of the adapter.

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

Parameters

WWPN The WWPN of the adapter.

OneCommand Manager Command Line Interface Version 6.1 User Manual P007998-01A Rev. A

5. CLI Client Command Descriptions Persistent Binding Commands

106

BindType ID SCSIBus SCSITarget P = Remove binding by WWPN.

N = Remove binding by WWNN.

D = Remove binding by D_ID.

The type of ID based on :    Target WWPN if = P Target WWNN if = N Target D_ID if = D The bus number of the SCSI device.

The target number of the SCSI device.

SetBindingSupport

This command enables and sets the binding support(s) for the adapter.

Supported By

Solaris and Windows

Syntax

SetBindingSupport

Parameters

WWPN BindFlag The WWPN of the adapter.

The type of binding support for the adapter:        D = Binding by D_ID (not available for Storport Miniport driver) P = Binding by WWPN N = Binding by WWNN (not available for Storport Miniport driver) A = Binding by automap (not available for Storport Miniport 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 OneCommand Manager Command Line Interface Version 6.1 User Manual P007998-01A Rev. A

5. CLI Client Command Descriptions Personality Change Commands

107 Syntax

SetPersistentBinding

Parameters

WWPN Scope BindType TargetId SCSIBus SCSITarget The WWPN of the adapter.

P = Permanent binding (survives reboot).

I = Immediate binding.

B = Binding is both permanent and immediate.

P = Enable binding by WWPN N = Enable binding by WWNN D = Enable binding by D_ID If BindType = P, Target WWPN If BindType = N, Target WWNN If BindType = D, Target D_ID The bus number of the SCSI device.

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 adapters. When you change the personality of the adapter and reboot the host, the adapter starts running the new personality or protocol. The personalities that 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 43 for more information.

Note:

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.

Note:

It is 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.

OneCommand Manager Command Line Interface Version 6.1 User Manual P007998-01A Rev. A

5. CLI Client Command Descriptions Personality Change Commands

108

ChangePersonality

This command changes the personality on the adapter. After successful change, a reboot is required.

Supported By

Linux, Citrix, Solaris, VMware ESX, and Windows

Syntax

ChangePersonality

Parameters

WWPN MAC Personality Type The WWPN of the UCNA.

The MAC address of the NIC or iSCSI port.

The available values are nic, iscsi, and fcoe.

Example

For non-ESXi hosts: hbacmd ChangePersonality 00-12-34-56-78-9A fcoe For ESXi hosts: hbacmd h= m=cim u=root p= n= 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, Citrix, Solaris, VMware ESX, and Windows

Syntax

ShowPersonalities

Parameters

WWPN MAC The WWPN of the UCNA.

The MAC address of the NIC or iSCSI port.

Example

For non-ESXi hosts: hbacmd ShowPersonalities 00-12-34-56-78-9A OneCommand Manager Command Line Interface Version 6.1 User Manual P007998-01A Rev. A

5. CLI Client Command Descriptions Virtual Port (VPort) Commands

109

For ESXi hosts: hbacmd h= m=cim u=root p= n= showpersonalities 00-12-34-56-78-9A

Virtual Port (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 auto [vname] -or CreateVPort [vname]

Parameters

physical WWPN auto vname virtual WWPN virtual WWNN The WWPN of the object adapter.

The virtual WWPN is automatically generated for the virtual port.

The virtual port’s name (optional).

The virtual WWPN to create.

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 OneCommand Manager Command Line Interface Version 6.1 User Manual P007998-01A Rev. A

5. CLI Client Command Descriptions Virtual Port (VPort) Commands

110 Parameters

physical WWPN virtual WWPN The WWPN of the adapter.

The WWPN of the virtual port

EnableSRIOV

This command enables or disables single root I/O virtualization (SR-IOV) on a specified NIC port (that is, physical function).

Supported By

Linux, Citrix, Solaris, VMware ESX, and Windows

Syntax

EnableSRIOV <0|1>

Parameters

MAC 0|1 The MAC address of the port.

0 = Disables SR-IOV.

1 = Enables SR-IOV.

Example

The following command enables SR-IOV on NIC physical function with MAC address 00-00-c9-12-34-56: hbacmd EnableSRIOV 00-00-c9-12-34-56 1

ListVFunctions

This command lists the virtual functions on a specified NIC port (that is, physical function).

Supported By

Linux, Citrix, Solaris, VMware ESX, and Windows

Syntax

ListVFunctions

Parameters

MAC The MAC address of the port.

Example

hbacmd ListVFunctions 00-00-c9-12-34-56 The example output: Virtual Functions for 00-00-c9-12-34-56: OneCommand Manager Command Line Interface Version 6.1 User Manual P007998-01A Rev. A

5. CLI Client Command Descriptions Virtual Port (VPort) Commands

111

MAC Address : 00-00-c9-12-34-ab VLADID : 10 Transmit Rate : 100 Mbit/sec.

MAC Address : 00-00-c9-12-34-cd VLADID : 10 Transmit Rate : 100 Mbit/sec.

MAC Address : 00-00-c9-12-34-ef VLADID : 10 Transmit Rate : 1 bbit/sec.

MAC Address : 00-00-c9-13-34-01 VLADID : 20 Transmit Rate : 1 Gbit/sec.

ListVMs

This command lists all virtual machines and their information for all manageable ports. If you specify the host with the “h=” 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. The virtual machine name is only displayed if the virtual port is associated with a virtual machine on VMware ESX 4.1. If you are running this command on any other server that has virtual ports, you will not see the virtual machine name.

Supported By

Citrix and VMware ESX

Syntax

ListVMs

Parameters

physical WWPN virtual WWPN The WWPN of the adapter.

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.

OneCommand Manager Command Line Interface Version 6.1 User Manual P007998-01A Rev. A

5. CLI Client Command Descriptions WWN Management Commands

112 Supported By

Linux, Citrix, Solaris, VMware ESX, and Windows

Syntax

ListVPorts

Parameters

physical WWPN The WWPN of the adapter.

VPortTargets

This command lists targets visible to the specified virtual port.

Supported By

Linux, Citrix, Solaris, VMware ESX, and Windows

Syntax

VPortTargets

Parameters

physical WWPN virtual WWPN The WWPN of the adapter.

The WWPN of the virtual port.

WWN Management Commands

Notes:

  Supported for FC/FCoE adapter ports only.

WWN Management validates WWNs carefully to avoid name duplication. Therefore, you may see error and warning messages if a name duplication is detected. Emulex strongly recommends that the activation requirement be fulfilled after each WWN change or restore. When running with “pending changes”, some diagnostic and maintenance features are not allowed.

ChangeWWN

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:

  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.

For VMware ESX: OneCommand Manager Command Line Interface Version 6.1 User Manual P007998-01A Rev. A

5. CLI Client Command Descriptions WWN Management Commands

113

   After changing the WWN of an adapter, update your zoning settings before you reboot your ESX server. If the zoning is not updated before your reboot, the subsequent boot may take a long time.

After changing the WWN of an adapter, you must reboot the ESX system before trying to access the adapter on that system. For information on rebooting the ESX system, refer to the VMware documentation. For ESX COS: If you are using the CIM interface to access adapters, after changing the WWN of an adapter, you must restart the CIMOM (that is, SFCB) on the ESX COS system before trying to access the adapter on that system. For information on restarting the CIMOM, refer to the VMware documentation.

Supported By

Linux, Citrix, Solaris, VMware ESX, and Windows

Syntax

ChangeWWN

Parameters

WWPN New WWPN New WWNN Type The WWPN of the adapter.

The WWPN of the new adapter.

The WWNN of the new adapter.

0 = Volatile 1 = Non-Volatile

GetWWNCap

This command shows if volatile change is supported for the WWPN.

Supported By

Linux, Citrix, Solaris, VMware ESX, and Windows

Syntax

GetWWNCap

Parameters

WWPN The WWPN of the adapter.

OneCommand Manager Command Line Interface Version 6.1 User Manual P007998-01A Rev. A

5. CLI Client Command Descriptions WWN Management Commands

114

ReadWWN

This command reads different types of WWNs.

Supported By

Linux, Citrix, Solaris, VMware ESX, and Windows

Syntax

ReadWWN

Parameters

WWPN Type The WWPN of the adapter.

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:

   A reboot is required to activate the new setting.

For VMware ESX: After changing the WWN of an adapter, you must reboot the ESX system before trying to access the adapter on that system. For information on rebooting the ESX system, see the VMware documentation. For ESX COS: If you are using the CIM interface to access adapters, after changing the WWN of an adapter, you must restart the CIMOM (that is, SFCB) on the ESX COS system before trying to access the adapter on that system. For information on restarting the CIMOM, see the VMware documentation.

Supported By

Linux, Citrix, Solaris, VMware ESX, and Windows

Syntax

RestoreWWN

Parameters

WWPN Type The WWPN of the adapter.

0 = Restore Default WWNs.

1 = Restore NVRAM WWNs.

OneCommand Manager Command Line Interface Version 6.1 User Manual P007998-01A Rev. A

Was this manual useful for you? yes no
Thank you for your participation!

* Your assessment is very important for improving the work of artificial intelligence, which forms the content of this project

Download PDF

advertisement