Export (0) Print
Expand All

Launch Tool

Updated: November 1, 2013

Applies To: System Center 2012 - Orchestrator, System Center 2012 R2 Orchestrator, System Center 2012 SP1 - Orchestrator

The Launch Tool activity is used in a runbook to run a specified command on a specified server.

The following tables list the required properties and published data for this activity. For more information on configuring activities, see HP Operations Manager Activities.

Launch Tool Required Properties

 

Element

Description

Valid Values

Look up

Command

The unique ID of an existing tool on the management server, an executable with all parameters or a script.

String

No

Command Type

Specifies the type of command to be run.

server-defined

executable

vbscript

jscript

perl

wshost

Yes

Node

The fully qualified domain name of the node on which to run the command.

String

No

Launch Tool Optional Properties

 

Element

Description

Valid Values

Look up

Additional Parameters

Specifies parameters for an existing tool on the management server. The command type must be server-defined and the tool must allow operators to change parameters.

String

No

Replacement Variables

A semi-colon delimited of name=value pairs which the service uses to replace environment variables in the command of an existing tool on the management server. The command type must be server-defined.

String

No

Command User

Specifies the name of the user to run the command on the node. User can contain the name of a real operating system user or the string $AGENT_USER. By default, the command will use the same user as the user that HPOM is running under.

String

No

Command Password

Specifies the password of the user used to run the command.

String

No

Display

Contains a display environment variable, which the agent sets before it starts the tool. You can use this to redirect the display for X programs on nodes with a UNIX or Linux operating system.

String

No

Launch Tool Published Data

 

Element

Description

Value Type

Additional Parameters

Specifies parameters for an existing tool on the management server.

String

Command

The unique ID of an existing tool on the management server, an executable with all parameters or a script.

String

Command Output

The output generated by the command.

String

Command Type

Specifies the type of command to be run.

String

Command User

Specifies the name of the user to run the command on the node. User can contain the name of a real user or the string $AGENT_USER.

String

Display

Display environment variable which the agent sets before it starts the tool.

String

HPOM Host

The name or IP address of the HPOM management server.

String

HPOM Port

The port used to connect to the HPOM management server.

Integer

HPOM Username

The name of the HPOM used to connect to the HPOM management server.

String

Node

The fully qualified domain name of the node on which to run the command.

String

Replacement Variables

A semi-colon delimited of name=value pairs which the service uses to replace environment variables in the command of an existing tool on the management server.

String

Result Code

The result code returned from the command.

Integer

Time Finished

The time that the management server finished running the command.

DateTime

Tool Execution ID

The unique identifier of the running tool.

String

WarningWarning
When using the Launch Tool activity you must ensure that you have selected an HP Operations Manager Connection that is configured with a user that has sufficient privileges for launching tools in HP Operations Manager.

WarningWarning
When using the Launch Tool activity to launch a server-defined tool you should be careful to ensure that the Command field contains the unique ID of an existing tool. Specifying an invalid unique ID may cause the Launch Tool activity to become unresponsive for long periods of time when targeting some HP Operations Manager systems, in particular those hosted on HP-UX.

Other Activities

See Also

 
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft