Emulex OneCommand Manager Command Line Interface User Manual (P006980-01A Version 5.2, August 2011)

OneCommand Manager Command Line Interface User Manual Page 11
Using the OneCommand Manager Command-Line Interface
The Command Line Interface (CLI) Client component of the OneCommand Manager application
provides access to the capabilities of the Remote Management library from a console command prompt.
This component is intended for use in scripted operations from within shell scripts or batch files. The CLI
Client is a console application named HbaCmd. Each time you run this application from the command
line, a single operation is performed.
The first parameter of this command is the requested operation. When the specified operation is
completed, the command prompt is displayed. Most operations retrieve information about an entity on
the storage area network (SAN) and show that information on the console.
Most of the CLI Client commands require one or more additional parameters that specify the nature of
the command. For FC ports the world wide port name (WWPN) of the adapter must be specified.
For example, run the following command to display 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.
For example, run the following command to set the target properties for the CNA port with the specified
MAC address:
hbacmd SetTargetProperties 00-11-22-33-44-55 iscsiTarget 1
The command sets the extended timeout value to 1.
The OneCommand Manager CLI can be run in TCP/IP mode by making the first argument h=<host>. For
example:
hbacmd h=cp-hp5670 ListHBAs
hbacmd h=138.239.91.121 ListHBAs
Managing Devices using CIM
VMware on the Visor-based ESX platforms uses the Common Interface Model (CIM) as the only
standard management mechanism for device management. OneCommand Manager uses the standard
CIM interfaces to manage the adapters in the ESX COS and Visor environments and supports CIM-
based device and HBA management. OneCommand Manager also supports existing HBA management
functionality based on its proprietary management stack and the standard HBAAPI interface.
To manage the adapters on an ESX/ESXi host using OneCommand Manager, you must install the
Emulex CIM Provider on the host.
ESX/ESXi 3.5, 4.0 and 4.1 come with an inbox Emulex CIM Provider. The inbox Emulex CIM Provider
enables you to manage Emulex Light Pulse adapters, but not Emulex UCNA adapters. To manage
Emulex UCNA adapters, you must install the out-of-box Emulex CIM Provider. The Emulex CIM Provider
is available as a 'core kit' rpm in the ESX COS platform and as an offline bundle in ESXi platforms.
VMWare recommends using the offline bundle to upgrade software on VMWare platforms.
For more information about the ESX Patch Management activities, refer to the VMware website.
You can use the following syntax for issuing CIM-based commands:
A>
hbacmd <h=IPAddress[: port]> m=cim [u=userid] [p=password] [n=root/emulex]
command <WWPN>
B>
hbacmd <h=IPAddress [: port]> <m=cim> <cmd>