The pe commands provide tools for running, stopping, and monitoring plans.
Table 10–1 Summary of the pe Commands
Command |
Description |
---|---|
pe.h.prep |
Prepares a set of hosts. |
pe.p.en |
Displays the output of an <execNative> or an <execJava> step. |
pe.p.la |
Lists running and completed plans. |
pe.p.lo |
Lists information about a running or completed plan. |
pe.p.del |
Deletes the history of a completed plan run. |
pe.p.lp |
Lists the subplans and targets associated with a plan. |
pe.p.run |
Runs a plan. |
pe.p.stop |
Stops a plan that is currently running. |
pe.pi.lo |
Lists the parameters used to run a plan. |
This command prepares a set of hosts.
Table 10–2 Argument and Result of the pe.h.prep Command
Argument/Result |
Syntax |
Description |
|
---|---|---|---|
tar |
[R] |
HostIDSet |
A comma-separated list of host IDs to prepare |
result |
TaskID |
The ID of the preparation plan run |
This command displays the output of an <execNative> or an <execJava> step.
Table 10–3 Arguments and Result for the pe.p.en Command
Argument/Result |
Syntax |
Description |
|
---|---|---|---|
ID |
[R] |
StepID |
Which step in the plan to display. This can be gathered from the output of the pe.p.lo command. |
output |
[O] |
Either “so” or “se” |
Show only stdout or stderr. Default: only stdout shown. |
result |
UIExecNativeOutput |
Output of the step. |
This command lists running and completed plans.
Table 10–4 Arguments and Result for the pe.p.la Command
Argument/Result |
Syntax |
Description |
|
---|---|---|---|
max |
[O] |
Integer |
The maximum number of plans to list. This argument is ignored if there are more running plans than the given number. |
plan |
[O] |
String |
Restrict results to plans with this name |
result |
RunningPlan- BeanArray |
All the running plans and some completed ones |
This command reports on the status of a plan that is running or that has finished running. It displays the StepID of each step.
Table 10–5 Arguments for the pe.p.lo Command
Argument |
Syntax |
Description |
|
---|---|---|---|
ID |
[R] |
TaskID |
The ID of the plan run to view |
old |
[O] |
Boolean |
Whether to show old messages; default is false |
new |
[O] |
Boolean |
Whether to poll for new messages; default is true |
This command deletes the history of a completed plan run.
Table 10–6 Arguments for the pe.p.del Command
Argument |
Syntax |
Description |
|
---|---|---|---|
ID |
[R] |
TaskID |
The ID of the plan run to delete |
This command lists the subplans and targets associated with a plan. The named plan is listed first.
Table 10–7 Argument and Result for the pe.p.lp Command
Argument/Result |
Syntax |
Description |
||
---|---|---|---|---|
ID |
[R] |
ExecutionPlanID |
The ID of the execution plan |
|
result |
SubplanPrompt- Array |
Array of subplans and targets |
This command runs a plan. If there are plan prompt variables, it interactively queries the user for responses.
Table 10–8 Arguments and Result for the pe.p.run Command
Argument/Result |
Syntax |
Description |
|
---|---|---|---|
PID |
[R] |
ExecutionPlanID |
The ID of the execution plan to run |
tar |
[R] |
HostIDArrayArray |
Individual hosts or host sets on which to run the plan and each of its subplans, ordered according to subplan prompts |
comp |
[O/R] |
StringArrayArray |
Selection of component versions to install as part of plan and subplans. Ordered according to component selectors within subplan prompts. Use version number, or "+" for default, "#" for recommended, and "-" for latest. Do not specify when there are no component versions. |
vs |
[O/R] |
StringArrayArray |
Selection of variable settings to use with each selected component version. Use variable settings name, or "+" for default. Do not specify when there are no variable settings. |
po |
[O] |
Boolean |
True if only preflight should be run |
pdp |
[O] |
Boolean |
True if detailed preflight should be run; default false. |
hr1 |
[O] |
Integer |
Limit number of hosts running at the same time; default set by server config file. |
pto |
[R] |
TimeInterval |
The maximum plan execution time |
nto |
[R] |
TimeInterval |
The maximum native call execution time |
f |
[O] |
ReaderWrapper |
Plan variables can be passed with a file or standard input; default is standard input |
result |
TaskID |
The ID of the plan run |
This command stops a plan that is running.
Table 10–9 Argument and Result for the pe.p.stop Command
Argument/Result |
Syntax |
Description |
|
---|---|---|---|
ID |
[R] |
TaskID |
The ID of the plan to stop running. |
result |
Boolean |
True if the plan was stopped successfully. |
This command lists the parameters used to run a plan.
Table 10–10 Argument and Result of the pe.pi.lo Command
Argument/Result |
Syntax |
Description |
|
---|---|---|---|
ID |
[R] |
TaskID |
The ID of the plan run. |
result |
TaskInfo |
The plan run parameters |