16

2

Using The omhelp Command

The omhelp command and its equivalent, <command> -?, accesses the detailed help-text interface of

Command Line Interface (CLI). You can get help at several levels of detail.

Each fully-qualified CLI command may have a variable number of distinct parts: the command

(command level 1), one or more subcommands (command level 2 and command level 3, if present), and one or more name= value pair(s).

By appending -?(space-dash-question mark) to any command, you can get help for that command.

Example Help Commands

When you type omconfig -?, you get general help about the omconfig command. The help at this level lists the available subcommands for omconfig:

• about

• preferences

• chassis

• system

When you type omconfig system -?, the CLI help lists all the subcommands available for omconfig system:

• alertaction

• alertlog

• assetinfo

• cmdlog

• esmlog

• events

• platformevents

• pedestinations

• recovery

• shutdown

• thrmshutdown

• webserver

Also parse the omconfig system assetinfo command as follows:

<command level 1 command level 2 command level 3> <name=value pair 1>

[name=value pair 2]

where command levels 1, 2, and 3 are represented by omconfig system assetinfo, name=value pair 1 is represented by info=depreciation , and name=value pair 2 is represented by method=straightline.

To set the depreciation method to straight line, type: omconfig system assetinfo info=depreciation method=straightline

The CLI responds with the following message:

Asset information set successfully.

When you type omconfig system assetinfo -?, the help that displays provides information about assigning values for the name and option fields. Partial results for the request omconfig system assetinfo

-? are as follows: assetinfo Set asset information.

For one info value, specify one or more optional parameter(s).

The following table displays the optional parameters for info=acquisition:

Table 2. Optional Parameters

Info Value

Info=acquisition

Optional parameters purchasecost=<num> waybill <num>installdate

=<mmddyy> purchasedate=<mmddyy> ponum=<num> signauth=<text> expensed=<yes|

no> costcenter=<text> info=depreciation method=<text> duration= <num> percent=<percent> unit=<months | years |

unknown>

17