Runs a Bolt task or plan

step

Performs a Bolt run.

Specification

type

Required

string
The type of Bolt action.
name

Required

string
The name of the Bolt task to plan to run.
parameters
Optional
object
The task- or plan-specific parameter data to use for this run.
projectDir
Optional
string
The Bolt project directory. When the `git` setting is used, a relative directory may be specified.
modulePaths[]
Optional
array
A list of additional directories outside of the project directory to add to the Bolt module path.
installModules
Optional
boolean
Download and install modules listed in a `Puppetfile`.
transport
Optional
object
The default transport to use when connecting to the target nodes.
transport.type
Optional
string
The transport type.
transport.user
Optional
string
The username to use to connect.
transport.password
Optional
string
The password to use to connect.
transport.privateKey
Optional
string
The name of a key in the `credentials` setting to use as the default SSH private key.
transport.run_as
Optional
string
The username to use to run the task/plan
transport.useSSL
Optional
boolean
If using the WinRM transport, whether to use SSL to connect.
transport.verifyHost
Optional
boolean
Whether to verify host integrity when connecting to remote nodes.
targets[]
Optional
stringarray
The list of target nodes to connect to, either in the same format as Bolt expects (a comma-separated string), or as a list.
credentials
Optional
object
A map of sensitive credential file names to content encoded using Base64.
git
Optional
object
A git repository to clone.
git.connection
Optional
A Relay SSH connection to use.Connection docs
!Connection {type: ssh, name: my-ssh-connection}
git.knownHosts
Optional
string
SSH known hosts file.
git.name

Required

string
A directory name for the git clone.
git.branch
Optional
string
The Git branch to clone.
git.repository

Required

string
The git repository URL.

Outputs

output

Required

string
Output from the Puppet Bolt CLI command

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.