Install the Playbook Runner module

Run tasks through PE that you can execute Playbook Runner content on Ansible® inventory. You can run tasks on the Bolt CLI or you can run them as tasks in PE.

Before you begin:
  • To enable Playbook Runner you must acquire a license with the Puppet Edge add-on. Contact your Puppet Enterprise (PE) administrator or Contact our sales team to acquire a license and enable this feature.
If you have installed or upgraded to Puppet Enterprise 2025.6, the Playbook Runner is pre-installed and can be used by Puppet Enterprise and Puppet Enterprise Advanced customers who purchase the Edge add-on. To use the Edge add-on with an earlier version of PE you must install the Playbook Runner module from Puppet Forge. For more information.

  • Install the Ansible® control node and manage the node within PE.

  • Ensure the Ansible® inventory file on the control node includes SSH connectivity details.

SSH connectivity details may not exist in your Ansible® inventory.  However, this is needed for version 1 of the playbook_runner module.

To install the Playbook Runner module:

 

  • If you’ve purchased the Edge add-on but haven't upgraded to the latest PE or PEA version, follow the installation steps.

  • If you’ve purchased the Edge add-on and upgraded to the latest PE or PEA version, you can skip the installation steps.

  1. Install the Playbook Runner module from Puppet Forge to your PE server.

  2. Add puppetlabs-playbook_runner to PE using your preferred method. See Managing modules with a Puppetfile.