Start a Puppet/Bolt task run

step

Requests a new task run using the Relay API. It does not wait for the run to complete. Use the run-wait step if you need to wait on the run.

Specification

connection

Required

!Connection {type: puppet, name: my-puppet-connection}
environment
Optional
string
The Puppet environment to use for the run
scope

Required

name

Required

string
The qualified name of the task to run
params
Optional
object
The task's parameters
noop
Optional
boolean
Whether this should be a dry run
targets[]
Optional
array
An array of Bolt-compatible target specifications to use to connect to nodes

Outputs

id

Required

string
The Relay API identifier for the task run
jobID
Optional
string
If using Puppet Enterprise, the orchestrator job ID for the task run

Join our community

We’re excited to see and share in our community’s creation. Take a look at our community overview to learn how to begin contributing to Relay.