Running orchestrator jobs from the command line

The puppet job run command can be used to enforce change on your agent nodes. For example, did you just add a new class parameter to a set of nodes ? Use the puppet job tool to enforce that change across those nodes. Or did you just deploy code to a new Puppet environment? Use this command to run Puppet across all the nodes in that environment.

Enforce change with puppet job run

The puppet job run command initiates an orchestration job. It creates a new Job ID, shows you all nodes included in the job, and proceeds to run Puppet on all nodes in the appropriate order. Puppet will compile a new catalog for all nodes included in the job.

If you run a job on a node that has relationships outside of the target (for example, it participates in an application that includes nodes not in the job target) the job will still only run on the node in the target you specified. In such cases, the orchestrator notifies you that external relationships exist. It prints the node with relationships, and it prints the applications that may be affected. For example:

**WARNING** target does not contain all nodes in this application.

You can run jobs to enforce change on three types of targets, but these targets cannot be combined:

  • An application or an application instance in an environment
  • A list of nodes or a single node
  • A PQL nodes query

When you execute a puppet job run command, the orchestrator shows the plan for the run and immediately runs the job.

Note: The first time you run a command, you need to authenticate. See the orchestrator installation instructions for information about setting RBAC permissions and token authorization.

Note: If you’re running this command from a managed or non-managed Windows workstation, you must specify the full path to the command. For example, c:\Program Files\Puppet Labs\Client\bin\puppet-job run.

Run a job on on a PQL query

Use a PQL nodes query as a Puppet job target when you want to target nodes that meet specific conditions. In this case, the orchestrator runs on a list of nodes returned from a PQL nodes query.

Tip: You can use -q in place of --query.

  1. Ensure you have the correct permissions to use PQL queries.

  2. Log into your Puppet master or client tools workstation and run the following command:

    puppet job run --query '<QUERY>' <OPTIONS>
    

Note: The following table shows some example targets and the associated PQL queries you could run with the orchestrator.

Be sure to wrap the entire query in single quotes and use double quotes inside the query.

Target PQL query
Single node by certname --query 'nodes { certname = "mynode" }'
All nodes with “web” in certname --query 'nodes { certname ~ "web" }'
All CentOS nodes --query 'inventory { facts.os.name = "CentOS" }'
All CentOS nodes with httpd managed --query 'inventory { facts.operatingsystem = "CentOS" and resources { type = "Service" and title = "httpd" } }'
All nodes with failed reports --query 'reports { latest_report? = true and status = "failed" }'
All nodes matching the environment for the last received catalog --query 'nodes { catalog_environment = "production" }'

Run a job on a list of nodes or a single node

Use a node list target for an orchestrator job when you need to run a job on a specific set of nodes that don’t easily resolve to a PQL query. Use a single node or a comma-separated list of nodes.

Tip: You can use -n in place of --nodes.

  1. Log into your Puppet master or client tools workstation and run one of the following commands:

    • To run a job on a single node:

      puppet job run --nodes <NODE NAME> <OPTIONS>
      
    • To run a job on a list of nodes, use a comma-separated list of node names:

      puppet job run --nodes <NODE NAME>,<NODE NAME>,<NODE NAME>,<NODE NAME> <OPTIONS>
      

      Important: Do not add spaces in the list of nodes.

Run a job on an application or an application instance in an environment

Use applications as a Puppet job target to enforce Puppet runs in order on all nodes found in a specific application instance, or to enforce Puppet runs in order on all nodes that are found in each instance of an application.

Tip: You can use -a in place of --application.

  1. Log into your Puppet master or client tools workstation and run one of the following commands:

    • To run a job on all instances of an application:

      puppet job run --application <APPLICATION> --environment <ENVIRONMENT>
      
    • To run a job on an instance of an application in an environment:

      puppet job run --application <APPLICATION INSTANCE> --environment <ENVIRONMENT>
      

Command options

The following are common options you may use with the run action. For a complete list of global options run puppet job --help.

Option Value Description
--noop Flag, default false Run a deployment job without executing the changes.
--environment -e Environment name

Overrides the environment specified in the orchestrator configuration file. The orchestrator uses this option to:

  • Instruct nodes what environment to run in (and if any nodes can’t run in the environment, those node runs will fail). A node will run in an environment if:
    • The node is included in an application in that environment. (These runs may fail if the node is classified into a different environment in the PE Node Manager.)
    • The node is classified into that environment in the PE Manager.
  • Load the application code used to plan node run oder.
--no-enforce-environment Flag, default false Ignores the environment set by the --environment flag for agent runs. When you use this flag, agents run in the environment specified by the PE Node Manager or their `puppet.conf` file.
--concurrency Integer

Limits how many nodes can run concurrently. (Default is unlimited.) You can tune concurrent compile requests in the PE console.

Post-run node status

After you run a Puppet job, the orchestrator returns a list of nodes and their run statuses.

Node runs can be in progress, completed, skipped, or failed.

  • For a completed node run, the orchestrator prints the following information:
    • The configuration version.
    • The transaction ID.
    • A summary of resource events.
    • A link to the full node run report in the PE console.
  • For an in progress node run, the orchestrator prints how many seconds ago the run started.

  • For a failed node run, the orchestrator prints an error message indicating why the run failed. In this case, any additional runs will be skipped.

When a run fails, the orchestrator also prints what applications were affected by the failure, as well as any applications that were affected by skipped node runs.

You can view the status of all running, completed, and failed jobs with the puppet job show command, or you can view them from the Job details page in the PE console.

Additionally, you can use the PE console to review a list of jobs or to view the details of jobs that have previously ran or are in progress. Refer to Reviewing jobs in the PE console for more information.

Terminating jobs

To terminate a running job, use CTRL+C.

When you terminate a job, any Puppet runs that are underway will finish. Any runs that have not started will not start.

Note: orchestrator jobs on Windows agents can’t be terminated with CTRL+C. If you need to stop an orchestration job running on a Windows agent, you can use the /command/stop API endpoint.


Related links:

↑ Back to top