beautypg.com

New command line tool parameter entry guidelines – HP Systems Insight Manager User Manual

Page 198

background image

Table 35 New Command Line Tool parameter entry guidelines

Entry guidelines

Parameter string assignment

Data entry required?

Parameter field

As when using the CLI, the
name of the new tool should
be descriptive of the tool's
function.

%1

Yes

Tool name

This is the new command
used to call the tool, and it
may include parameters.

%2

Yes

Tool command

If the Tool command includes
the %1 parameter, then this
field entry is required to
specify the destination
prompt.

%3

No

Prompt

Use this entry to specify the
location of the tool in the
menu. If left blank, the new
tool will be added to the
Tools

→Command Line Tools

menu.

%4

No

Tool menu category

Description of what the new
tool does.

%5

No

Tool description

Description of how to use
(invoke) the new tool.

%6

No

Tool help comment

If left blank, the new tool will
run as the Systems Insight
Manager user whose SSH
public key must be
configured on the managed
system using the
mxagentconfig
command. Refer to the
Systems Insight Manager
Installation and User Guide
for more information.

CAUTION!

If root is specified, any user
authorized to run this tool
may gain full access to the
managed system depending
on the definition of the
command and its
capabilities.

%7

No

Enter root execute as root

Path name of new tool.

Example: /var/opt/mx/
tools/mytool.xml

%8

No

File path to save tool

198 Custom tool definition files