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

24
Appendix C: parameterized strings
Parameterized strings (
Table C
-
1
) allow tool developers to greatly enhance the options available in
creating TDEFs
. Parameterized strings contain replacement fields (similar to the format strings used in
the popular printf() function in the standard C library). These fields can be replaced by values entered
by the user at runtime (as defined by the tool parameters att
ribute), by some standard task properties
supplied by the Task Controller by values related to the selected target systems or system groups, or
by property values retrieved from a global tool properties file.
Table C
-
1
.
Param
eterized string substitution descriptions
Parameter
Description
Global attribute parameters
%t
Job ID for the task being executed
%u
Name of the user running this task
%e
Name of the user this task will execute as
%s
Management server hostname of the
core CMS running the tool (the HP SIM server
name)
%#
Substitute the value input by the user for the parameter referenced by the number (#)
provided, as a list index position (one
-
based positive whole integer... %1, %2, %3,
and so on). Up to 10 paramete
rs are allowed, %A is used for the 10th.
%y
SOAP logon token, for use with SOAP single sign
-
on Web applications
Current selected target parameters
%f
The system name of the target system.
%n
Network name (hostname, IP address, IPX address, or system na
me in that order).
%a
Network address (IP address, or IPX address, in that order).
%l
Link name in format specified by System Link Configuration security setting (name, IP
address, or full DNS name).
%p
IP address of WMI proxy, if any, for this target,
in the form
<ip address>:<port#></port#></ip>.
%g
HP SIM identifier or GUID of the target system.
%b
System type of the target system.
%c
System sub
-
type of the target system
%r%
{rt[.attribute]%}
Substitutes the related system that has the relationsh
ip type as specified in the
parameter rt. Valid relationship type strings are those that are stored in the
associationTypeNumber column in the device_associations table. If the [.attribute] is
specified, then one of the named system attributes would be ret
urned for the related
system. In addition, the common attributes such as Network name (.a) also work. For
example, to get the IP address of the server's management processor, use
%r%{MgmtProcToServer.a%}; to get the contact use
%r%{MgmtProcToServer.Contact
%}. If the related systems attribute is omitted, then
for each system, the network name and IP address are returned in the form "network
name|ip address." If more than one system is returned, then they are comma
-
delimited. Note that the relationship type "
MgmtProcToServer" can be used to return
related system information for all management processor relationship types.
%{attribute]%}
The value of the named attribute of the target system.
Multiple selected target parameters (not supported for Custom Comm
and Tools)
%( ... %)
Repeated pattern (only repeats if a current selection exists). If a current target
selection does not exist, the text between the delimiters is removed on expansion.