Creating custom tool definition files for HP Systems Insight Manager 5.1 or greater (481365-002, January 2009)

31
Appendix G: Tool parameter guidelines
Table G
-
1
lists guidelines for entering pa
rameter field data when creating new command line tools.
Table G
-
1
.
New Command Line Tool
parameter entry guidelines
Parameter Field
Data entry
required?
Parameter
string
assignment
Entry guidelines
Tool name
Yes
%1
As when
using the CLI, the name of the new tool
should be descriptive of the tool’s function.
Tool command
Yes
%2
This is the new command used to call the tool, and
it can include parameters.
Prompt
No
%3
If the Tool command includes the %1 parameter,
then this
field entry is required to specify the
destination prompt.
Tool menu category
No
%4
Use this entry to specify the location of the tool in
the menu. If left blank, the new tool
is
added to the
Tools
>
Custom Tools
menu.
Tool description
No
%5
Description
of what the new tool does.
Tool help comment
No
%6
Description of how to use (invoke) the new tool.
Enter “root” to
execute as root
No
%7
If left blank, the new tool runs as the HP SIM user
whose SSH public key must be configured on the
managed system us
ing the
mxagentconfig
command. Refer to the HP SIM 5.2 Installation and
Configuration Guides 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.
File path to save tool
No
%8
Path name of new tool.
Example:
/var/opt/mx/tools/mytool.xml