Setup Guide

Broadcom OCM-CLI-LPE-UG124-100

Emulex OneCommand Manager Command Line Interface User Guide

Chapter 4: CLI Client Command Usage

The CLI Client component of the OneCommand Manager application provides access to the capabilities of the Remote

Management library or the CIM interface from a console command prompt to get the management information.

4.1 Overview

The CLI Client is intended for use in command shells or scripted operations from within shell scripts or batch files. The CLI

Client is a console application named HbaCmd. A single operation is performed by typing hbacmd at the command line,

followed by a CLI client command and its possible parameters. For example:

hbacmd [cli options] <command> [parameters]

The CLI options are specified for running the CLI commands on remote hosts or with Secure Management.

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 upon which the command is to act.

4.1.1 CLI in Read-Only Mode

The CLI does not allow the execution of some commands if 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.

4.2 HbaCmd Syntax Usage

The following syntax rules and usage apply to the HbaCmd application:

 Parameters denoted within angle brackets < > are required.

 Parameters denoted within square brackets [ ] are optional.

 For Linux and Solaris (which are case-sensitive), program names must be in lowercase letters. Therefore, the

command line must begin with hbacmd (rather than HbaCmd). Windows is not case-sensitive, so the program name is

not required to be in all lowercase letters.

 To run the command on a remote host, an IP address or a host name must be specified using the h option with the

following syntax:

hbacmd [h=IP_Address[:port] | Hostname[:port]] <command> [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 it is omitted, the OneCommand Manager remote management protocol uses the

default TCP port. If it is specified, it uses the user-specified TCP port.

– Examples:

Using the IP address:

hbacmd h=138.239.91.121 ListHBAs

Using the host name:

hbacmd h=<host_name> ListHBAs

–The h option is available for all commands except for the AddHost, RemoveHost, and Version commands.