Running plans from the console

Sections

Run ad hoc plans from the console.

Before you begin

Install the plans you want to use.

Make sure you have permission to run the plans.

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

Note: Running a plan does not update your Puppet configuration. If you run a plan that changes the state of a resource that Puppet is managing (such as upgrading a service or package), a subsequent Puppet run changes the state of that resource back to what is defined in your Puppet configuration.
  1. In the console, in the Orchestration section, select Plans.
  2. Click Run a plan in the upper right corner.
  3. Under Code environment, select the environment where you installed the module containing the plan you want to run. For example, production.
  4. Optional: Under Job description, provide a description. The text you enter here appears on the Plans page.
  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 value unless another value is specified.
  7. Select Run job.
Result:
Your plan status and output will appear on the Plans page.
How helpful was this page?

If you leave us your email, we may contact you regarding your feedback. For more information on how Puppet uses your personal information, see our privacy policy.

Puppet sites use proprietary and third-party cookies. By using our sites, you agree to our cookie policy.