Running Plans

Once you have checked in a plan, you can run it in order to perform operations on hosts.

How To View Running Plans

Steps

1. In the left-hand navigation menu, click plans.

   The HTML user interface displays the plans page, which lists the plans already checked in to the database.

2. Find the row listing the plan you're interested in, and click details.

   The HTML user interface displays a Plan Details page for the plan.

3. Near the bottom of the page, click the run button.

   The HTML user interface displays a Plan Details Run page.

4. Enter the required information and click run preflight only to verify that the plan will run successfully or click run plan (includes preflight) to run the plan.

How To Use a Component's Direct Run Procedures

For straightforward deployments that don't involve multiple components or synchronization among hosts, you may not need to write a plan at all. Instead, you may be able to use one of the “direct run” procedures that the provisioning software automatically generated when you checked in the component you want to deploy.

To use one of these “direct run” procedures, do the following:

Steps

1. In the left-hand navigation menu, click components.

   The HTML user interface displays the components page, which lists the components already checked in to the database.

2. In the table listing components, find the row describing the component you would like to deploy, and click details.

   The HTML user interface displays a Components Details page for the component.

3. In the component procedures table, click the checkbox next to the name of the procedure you want to run, and then click run.

   The HTML user interface displays the Plan Details Run page for the procedure.

4. Use the fields on the page to enter the variables and select the parameters you want to use when you run the plan.

   • In the plan parameters area, use the target host field to select the host on which you want to run this plan, or use the pull-down menu to select a target host set.

   • In the plan variables area, configure the variables you want to set. Whether there are variables to configure depends on the contents of the plan.

   • In the options area, select whether you want to perform a detailed preflight. Running a detailed preflight increases the amount of time preflight takes, but also increases the detail the preflight goes into.

   • In the limits area, limit the number of hosts running at the same time by entering the number of hosts in the field provided. You can also limit overall running time of plan or limit running time of native calls by entering a number in the fields provided, and then selecting the time unit, such as “minutes,” from pull-down menus.

5. Do one of the following:

   • To run just the preflight test of the procedure, click run preflight only.

   • To run the preflight test and then (assuming the preflight test finds no errors) to run the procedure itself, click run plan (includes preflight).

Summary of CLI Commands

Table 6–2 describes the CLI commands associated with running plans.

Table 6–2 Summary of the pe Commands

Command	Description
pe.h.prep	Prepares a set of hosts.
pe.p.en	Displays the output of an execNative 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 running
pe.pi.lo	Lists the parameters used to run a plan.