Running plans from the console

Run ad hoc plans from the console.

Before you begin

Install the tasks you want to use.

Make sure you have permissions necessary to run tasks.

When you set up a plan run from the console, the orchestrator creates an ID to track the plan run, shows the nodes included in the plan, and runs the plan on those nodes in the appropriate order. Puppet compiles a new catalog for each node included in the plan run.

  1. In the console, in the Orchestration section, select Plans and then click Run a plan.
  2. Under Code environment, select the environment where you installed the module containing the plan you want to run. For example, production.
  3. Optional: Under Job description, provide a description. This text appears on the Plans page.
  4. Optional: If you want to limit how long the plan can run before being automatically cancelled, select Yes for Timeout and select the duration and unit (such as thirty minutes).
  5. Under Plan, select the plan you want to run.
  6. Under Plan parameters, add optional parameters, then enter values for the optional and required parameters on the list. Click Add parameter for each optional parameter-value pair you add to the plan.
    To view information about required and optional parameters for the plan, select view plan metadata below the Plan field.
    Express values as strings, arrays, objects, integers, or booleans (true or false). You must express empty strings as two double quotes with no space (""). Structured values, like an array, must be valid JSON.
    Plans with default values run using the default unless you specify another value.
  7. Under Schedule, select Later and choose a start date, time, time zone, and frequency for the job to run.
  8. Select Run job.
Results
Your plan status and output appear on the Plans page.
What to do next

If you need to stop an in-progress plan, click Stop Plan on the plan's run details page in the console or use the POST /command/stop_plan endpoint. This prevents new events from starting and allows in-progress events to finish. If you need to force stop an in-progress task from a stopped plan, refer to Stop a task in progress.

Edit a scheduled plan

You can view and edit a scheduled plan if, for example, you want to specify a timeout or modify parameters.

If you want to edit a scheduled plan created by another user, you must have the appropriate role-based permissions to do so.

  1. In the console, go to Plans and switch to the Scheduled Plans tab.
  2. In the list of scheduled plans, locate the plan you want to edit and click the view icon.
  3. Click Actions > Edit in the upper-right corner.
  4. Make your required changes and click Save changes.

Delete a scheduled plan

If you want to delete a scheduled plan created by another user, you must have the appropriate role-based permissions to do so.

  1. In the console, go to Plans and switch to the Scheduled Plans tab.
  2. In the list of scheduled plans, locate the plan you want to edit and click the trashcan icon.
  3. Confirm that you want to remove the scheduled plan job.