PowerShell cmdlets

To use the PuppetBolt PowerShell module, see the installation documentation.

Cmdlet syntax

Bolt PowerShell cmdlets follow a verb-noun convention.

To view a full list of available cmdlets, use the Get-Command cmdlet:

Get-Command -Module PuppetBolt

Cmdlets

These PowerShell cmdlets are available in the Bolt PowerShell module.

Invoke-BoltApply

[0m Apply Puppet manifest code on the specified targets.[36m

</tr> </tr> </tr> </tr> </tr> </tr> </tbody> </table> ### Invoke-BoltCommand [0m Run a command on the specified targets.[36m

Option	Description	Mandatory?
`-Manifest`	The manifest to apply	✓
`-Targets`	Identifies the targets of the command. For more information, see 'bolt guide targets'.</td>
`-Query`	Query PuppetDB to determine the targets.
`-Rerun`	Retry on targets from the last run. Available filters are 'all', 'failure', and 'success'.</td>
`-User`	User to authenticate as.
`-Password`	Password to authenticate with.
`-PasswordPrompt`	Prompt for user to input password.
`-PrivateKey`	Path to private ssh key to authenticate with.
`-HostKeyCheck`	Check host keys with SSH.
`-Ssl`	Use SSL with WinRM.
`-SslVerify`	Verify remote host SSL certificate with WinRM.
`-RunAs`	User to run as using privilege escalation.
`-SudoPassword`	Password for privilege escalation.
`-SudoPasswordPrompt`	Prompt for user to input escalation password.
`-SudoExecutable`	Experimental. Specify an executable for running as another user.
`-Concurrency`	Maximum number of simultaneous connections.
`-Inventoryfile`	Specify where to load inventory from (default: <project>/inventory.yaml).
`-SaveRerun`	Whether to update the rerun file after this command.
`-Cleanup`	Whether to clean up temporary files created on targets.
`-Puppetdb`	The named PuppetDB instance to connect to by default.
`-Project`	Path to load the Bolt project from (default: autodiscovered from current dir).
`-Modulepath`	List of directories containing modules, separated by ':' Directories are case-sensitive.</td>
`-Transport`	Specify a default transport: docker, jail, local, lxd, podman, remote, ssh, winrm. For more information, see 'bolt guide transports'.</td>
`-ConnectTimeout`	Connection timeout in seconds (defaults vary).
`-TTY`	Request a pseudo TTY on targets that support it.
`-NativeSsh`	Experimental. Whether to shell out to native SSH or use the net-ssh Ruby library.
`-SshCommand`	Experimental. Executable to use instead of the net-ssh Ruby library.
`-CopyCommand`	Experimental. Command to copy files to remote hosts if using native SSH.
`-Format`	Output format to use: human, json, or rainbow.
`-Color`	Whether to show output in color.
`-Trace`	Display error stack traces.
`-Stream`	Stream output from scripts and commands to the console. Run with --no-verbose to prevent Bolt from displaying output a second time after the action is completed.</td>
`-LogLevel`	Set the log level for the console. Available options are trace, debug, info, warn, error, fatal.</td>
`-ClearCache`	Clear plugin, plan, and task caches before executing.
`-Noop`	See what changes Bolt will make without actually executing the changes.
`-Execute`	Puppet manifest code to apply to the targets.	✓
`-CompileConcurrency`	Maximum number of simultaneous manifest block compiles (default: number of cores).
`-HieraConfig`	Specify where to load Hiera config from (default: <project>/hiera.yaml).

</tr> </tr> </tr> </tr> </tr> </tr> </tbody> </table> ### Receive-BoltFile [0m Download a file or directory from one or more targets. Downloaded files and directories are saved to the a subdirectory matching the target's name under the destination directory. The destination directory is expanded relative to the downloads subdirectory of the project directory.[36m

Option	Description	Mandatory?
`-Command`	The command to execute	✓
`-Targets`	Identifies the targets of the command. For more information, see 'bolt guide targets'.</td>
`-Query`	Query PuppetDB to determine the targets.
`-Rerun`	Retry on targets from the last run. Available filters are 'all', 'failure', and 'success'.</td>
`-User`	User to authenticate as.
`-Password`	Password to authenticate with.
`-PasswordPrompt`	Prompt for user to input password.
`-PrivateKey`	Path to private ssh key to authenticate with.
`-HostKeyCheck`	Check host keys with SSH.
`-Ssl`	Use SSL with WinRM.
`-SslVerify`	Verify remote host SSL certificate with WinRM.
`-RunAs`	User to run as using privilege escalation.
`-SudoPassword`	Password for privilege escalation.
`-SudoPasswordPrompt`	Prompt for user to input escalation password.
`-SudoExecutable`	Experimental. Specify an executable for running as another user.
`-Concurrency`	Maximum number of simultaneous connections.
`-Inventoryfile`	Specify where to load inventory from (default: <project>/inventory.yaml).
`-SaveRerun`	Whether to update the rerun file after this command.
`-Cleanup`	Whether to clean up temporary files created on targets.
`-Puppetdb`	The named PuppetDB instance to connect to by default.
`-Project`	Path to load the Bolt project from (default: autodiscovered from current dir).
`-Modulepath`	List of directories containing modules, separated by ':' Directories are case-sensitive.</td>
`-Transport`	Specify a default transport: docker, jail, local, lxd, podman, remote, ssh, winrm. For more information, see 'bolt guide transports'.</td>
`-ConnectTimeout`	Connection timeout in seconds (defaults vary).
`-TTY`	Request a pseudo TTY on targets that support it.
`-NativeSsh`	Experimental. Whether to shell out to native SSH or use the net-ssh Ruby library.
`-SshCommand`	Experimental. Executable to use instead of the net-ssh Ruby library.
`-CopyCommand`	Experimental. Command to copy files to remote hosts if using native SSH.
`-Format`	Output format to use: human, json, or rainbow.
`-Color`	Whether to show output in color.
`-Trace`	Display error stack traces.
`-Stream`	Stream output from scripts and commands to the console. Run with --no-verbose to prevent Bolt from displaying output a second time after the action is completed.</td>
`-LogLevel`	Set the log level for the console. Available options are trace, debug, info, warn, error, fatal.</td>
`-ClearCache`	Clear plugin, plan, and task caches before executing.
`-EnvVar`	Environment variables to set on the target.

</tr> </tr> </tr> </tr> </tr> </tr> </tbody> </table> ### Send-BoltFile [0m Upload a local file or directory.[36m

Option	Description	Mandatory?
`-Source`	The source file or directory to download	✓
`-Destination`	The destination to download to	✓
`-Targets`	Identifies the targets of the command. For more information, see 'bolt guide targets'.</td>
`-Query`	Query PuppetDB to determine the targets.
`-Rerun`	Retry on targets from the last run. Available filters are 'all', 'failure', and 'success'.</td>
`-User`	User to authenticate as.
`-Password`	Password to authenticate with.
`-PasswordPrompt`	Prompt for user to input password.
`-PrivateKey`	Path to private ssh key to authenticate with.
`-HostKeyCheck`	Check host keys with SSH.
`-Ssl`	Use SSL with WinRM.
`-SslVerify`	Verify remote host SSL certificate with WinRM.
`-RunAs`	User to run as using privilege escalation.
`-SudoPassword`	Password for privilege escalation.
`-SudoPasswordPrompt`	Prompt for user to input escalation password.
`-SudoExecutable`	Experimental. Specify an executable for running as another user.
`-Concurrency`	Maximum number of simultaneous connections.
`-Inventoryfile`	Specify where to load inventory from (default: <project>/inventory.yaml).
`-SaveRerun`	Whether to update the rerun file after this command.
`-Cleanup`	Whether to clean up temporary files created on targets.
`-Puppetdb`	The named PuppetDB instance to connect to by default.
`-Project`	Path to load the Bolt project from (default: autodiscovered from current dir).
`-Modulepath`	List of directories containing modules, separated by ':' Directories are case-sensitive.</td>
`-Transport`	Specify a default transport: docker, jail, local, lxd, podman, remote, ssh, winrm. For more information, see 'bolt guide transports'.</td>
`-ConnectTimeout`	Connection timeout in seconds (defaults vary).
`-TTY`	Request a pseudo TTY on targets that support it.
`-NativeSsh`	Experimental. Whether to shell out to native SSH or use the net-ssh Ruby library.
`-SshCommand`	Experimental. Executable to use instead of the net-ssh Ruby library.
`-CopyCommand`	Experimental. Command to copy files to remote hosts if using native SSH.
`-Format`	Output format to use: human, json, or rainbow.
`-Color`	Whether to show output in color.
`-Trace`	Display error stack traces.
`-Stream`	Stream output from scripts and commands to the console. Run with --no-verbose to prevent Bolt from displaying output a second time after the action is completed.</td>
`-LogLevel`	Set the log level for the console. Available options are trace, debug, info, warn, error, fatal.</td>
`-ClearCache`	Clear plugin, plan, and task caches before executing.

</tr> </tr> </tr> </tr> </tr> </tr> </tbody> </table> ### Get-BoltGroup [0m Show the list of groups in the inventory.[36m

Option	Description	Mandatory?
`-Source`	The source file or directory to upload	✓
`-Destination`	The destination to upload to	✓
`-Targets`	Identifies the targets of the command. For more information, see 'bolt guide targets'.</td>
`-Query`	Query PuppetDB to determine the targets.
`-Rerun`	Retry on targets from the last run. Available filters are 'all', 'failure', and 'success'.</td>
`-User`	User to authenticate as.
`-Password`	Password to authenticate with.
`-PasswordPrompt`	Prompt for user to input password.
`-PrivateKey`	Path to private ssh key to authenticate with.
`-HostKeyCheck`	Check host keys with SSH.
`-Ssl`	Use SSL with WinRM.
`-SslVerify`	Verify remote host SSL certificate with WinRM.
`-RunAs`	User to run as using privilege escalation.
`-SudoPassword`	Password for privilege escalation.
`-SudoPasswordPrompt`	Prompt for user to input escalation password.
`-SudoExecutable`	Experimental. Specify an executable for running as another user.
`-Concurrency`	Maximum number of simultaneous connections.
`-Inventoryfile`	Specify where to load inventory from (default: <project>/inventory.yaml).
`-SaveRerun`	Whether to update the rerun file after this command.
`-Cleanup`	Whether to clean up temporary files created on targets.
`-Puppetdb`	The named PuppetDB instance to connect to by default.
`-Project`	Path to load the Bolt project from (default: autodiscovered from current dir).
`-Modulepath`	List of directories containing modules, separated by ':' Directories are case-sensitive.</td>
`-Transport`	Specify a default transport: docker, jail, local, lxd, podman, remote, ssh, winrm. For more information, see 'bolt guide transports'.</td>
`-ConnectTimeout`	Connection timeout in seconds (defaults vary).
`-TTY`	Request a pseudo TTY on targets that support it.
`-NativeSsh`	Experimental. Whether to shell out to native SSH or use the net-ssh Ruby library.
`-SshCommand`	Experimental. Executable to use instead of the net-ssh Ruby library.
`-CopyCommand`	Experimental. Command to copy files to remote hosts if using native SSH.
`-Format`	Output format to use: human, json, or rainbow.
`-Color`	Whether to show output in color.
`-Trace`	Display error stack traces.
`-Stream`	Stream output from scripts and commands to the console. Run with --no-verbose to prevent Bolt from displaying output a second time after the action is completed.</td>
`-LogLevel`	Set the log level for the console. Available options are trace, debug, info, warn, error, fatal.</td>
`-ClearCache`	Clear plugin, plan, and task caches before executing.
`-Tmpdir`	The directory to upload and execute temporary files on the target.

</tr> </tbody> </table> ### Get-BoltInventory [0m Show the list of targets an action would run on. This command will list all targets in the project's inventory by default. To filter the targets in the list, use the --targets, --query, or --rerun options. To view detailed configuration and data for targets, use the --detail option. To learn more about the inventory run 'bolt guide inventory'.[36m

Option	Description	Mandatory?
`-LogLevel`	Set the log level for the console. Available options are trace, debug, info, warn, error, fatal.</td>
`-ClearCache`	Clear plugin, plan, and task caches before executing.
`-Project`	Path to load the Bolt project from (default: autodiscovered from current dir).
`-Format`	Output format to use: human, json, or rainbow.
`-Inventoryfile`	Specify where to load inventory from (default: <project>/inventory.yaml).

</tr> </tr> </tr> </tbody> </table> ### Invoke-BoltLookup [0m Look up a value with Hiera.[36m

Option	Description	Mandatory?
`-Targets`	Identifies the targets of the command. For more information, see 'bolt guide targets'.</td>
`-Query`	Query PuppetDB to determine the targets.
`-Rerun`	Retry on targets from the last run. Available filters are 'all', 'failure', and 'success'.</td>
`-LogLevel`	Set the log level for the console. Available options are trace, debug, info, warn, error, fatal.</td>
`-ClearCache`	Clear plugin, plan, and task caches before executing.
`-Project`	Path to load the Bolt project from (default: autodiscovered from current dir).
`-Format`	Output format to use: human, json, or rainbow.
`-Inventoryfile`	Specify where to load inventory from (default: <project>/inventory.yaml).
`-Detail`	Show resolved configuration for the targets.

</tr> </tr> </tr> </tr> </tr> </tr> </tbody> </table> ### Add-BoltModule [0m Add a module to the project. Module declarations are loaded from the project's configuration file. Bolt will automatically resolve all module dependencies, generate a Puppetfile, and install the modules.[36m

Option	Description	Mandatory?
`-Key`	The key to look up	✓
`-Targets`	Identifies the targets of the command. For more information, see 'bolt guide targets'.</td>
`-Query`	Query PuppetDB to determine the targets.
`-Rerun`	Retry on targets from the last run. Available filters are 'all', 'failure', and 'success'.</td>
`-User`	User to authenticate as.
`-Password`	Password to authenticate with.
`-PasswordPrompt`	Prompt for user to input password.
`-PrivateKey`	Path to private ssh key to authenticate with.
`-HostKeyCheck`	Check host keys with SSH.
`-Ssl`	Use SSL with WinRM.
`-SslVerify`	Verify remote host SSL certificate with WinRM.
`-RunAs`	User to run as using privilege escalation.
`-SudoPassword`	Password for privilege escalation.
`-SudoPasswordPrompt`	Prompt for user to input escalation password.
`-SudoExecutable`	Experimental. Specify an executable for running as another user.
`-Concurrency`	Maximum number of simultaneous connections.
`-Inventoryfile`	Specify where to load inventory from (default: <project>/inventory.yaml).
`-SaveRerun`	Whether to update the rerun file after this command.
`-Cleanup`	Whether to clean up temporary files created on targets.
`-Puppetdb`	The named PuppetDB instance to connect to by default.
`-Project`	Path to load the Bolt project from (default: autodiscovered from current dir).
`-Modulepath`	List of directories containing modules, separated by ':' Directories are case-sensitive.</td>
`-Transport`	Specify a default transport: docker, jail, local, lxd, podman, remote, ssh, winrm. For more information, see 'bolt guide transports'.</td>
`-ConnectTimeout`	Connection timeout in seconds (defaults vary).
`-TTY`	Request a pseudo TTY on targets that support it.
`-NativeSsh`	Experimental. Whether to shell out to native SSH or use the net-ssh Ruby library.
`-SshCommand`	Experimental. Executable to use instead of the net-ssh Ruby library.
`-CopyCommand`	Experimental. Command to copy files to remote hosts if using native SSH.
`-Format`	Output format to use: human, json, or rainbow.
`-Color`	Whether to show output in color.
`-Trace`	Display error stack traces.
`-Stream`	Stream output from scripts and commands to the console. Run with --no-verbose to prevent Bolt from displaying output a second time after the action is completed.</td>
`-LogLevel`	Set the log level for the console. Available options are trace, debug, info, warn, error, fatal.</td>
`-ClearCache`	Clear plugin, plan, and task caches before executing.
`-HieraConfig`	Specify where to load Hiera config from (default: <project>/hiera.yaml).
`-PlanHierarchy`	Look up a value with Hiera in the context of a specific plan.

</tr> </tbody> </table> ### Register-BoltModuleTypes [0m Generate type references to register in plans. To learn more about Bolt modules, run 'bolt guide module'.[36m

Option	Description	Mandatory?
`-Module`	The name of the module to add to the Bolt project	✓
`-LogLevel`	Set the log level for the console. Available options are trace, debug, info, warn, error, fatal.</td>
`-ClearCache`	Clear plugin, plan, and task caches before executing.
`-Project`	Path to load the Bolt project from (default: autodiscovered from current dir).

</tr> </tr> </tbody> </table> ### Install-BoltModule [0m Install the project's modules. Module declarations are loaded from the project's configuration file. Bolt will automatically resolve all module dependencies, generate a Puppetfile, and install the modules.[36m

Option	Description	Mandatory?
`-LogLevel`	Set the log level for the console. Available options are trace, debug, info, warn, error, fatal.</td>
`-ClearCache`	Clear plugin, plan, and task caches before executing.
`-Project`	Path to load the Bolt project from (default: autodiscovered from current dir).
`-Modulepath`	List of directories containing modules, separated by ':' Directories are case-sensitive.</td>

</tr> </tr> </tbody> </table> ### Get-BoltModule [0m List modules available to the Bolt project. Providing the name of a module will display detailed documentation for the module.[36m

Option	Description	Mandatory?
`-LogLevel`	Set the log level for the console. Available options are trace, debug, info, warn, error, fatal.</td>
`-ClearCache`	Clear plugin, plan, and task caches before executing.
`-Project`	Path to load the Bolt project from (default: autodiscovered from current dir).
`-Force`	Force a destructive action.
`-Resolve`	Use --no-resolve to install modules listed in the Puppetfile without resolving modules configured in Bolt project configuration.</td>

</tr> </tr> </tbody> </table> ### Get-BoltPlan [0m Show available plans and plan documentation. Omitting the name of a plan will display a list of plans available in the Bolt project. Providing the name of a plan will display detailed documentation for the plan, including a list of available parameters.[36m

Option	Description	Mandatory?
`-Name`	The module to show
`-LogLevel`	Set the log level for the console. Available options are trace, debug, info, warn, error, fatal.</td>
`-ClearCache`	Clear plugin, plan, and task caches before executing.
`-Project`	Path to load the Bolt project from (default: autodiscovered from current dir).
`-Modulepath`	List of directories containing modules, separated by ':' Directories are case-sensitive.</td>

</tr> </tr> </tbody> </table> ### Invoke-BoltPlan [0m Run a plan on the specified targets.[36m

Option	Description	Mandatory?
`-Name`	The plan to show
`-LogLevel`	Set the log level for the console. Available options are trace, debug, info, warn, error, fatal.</td>
`-ClearCache`	Clear plugin, plan, and task caches before executing.
`-Project`	Path to load the Bolt project from (default: autodiscovered from current dir).
`-Modulepath`	List of directories containing modules, separated by ':' Directories are case-sensitive.</td>
`-Filter`	Filter tasks and plans by a matching substring.
`-Format`	Output format to use: human, json, or rainbow.

</tr> </tr> </tr> </tr> </tr> </tr> </tbody> </table> ### Convert-BoltPlan [0m Convert a YAML plan to a Puppet language plan and print the converted plan to stdout. Converting a YAML plan might result in a plan that is syntactically correct but has different behavior. Always verify a converted plan's functionality. Note that the converted plan is not written to a file.[36m

Option	Description	Mandatory?
`-Name`	The plan to run	✓
`-Targets`	Identifies the targets of the command. For more information, see 'bolt guide targets'.</td>
`-Query`	Query PuppetDB to determine the targets.
`-Rerun`	Retry on targets from the last run. Available filters are 'all', 'failure', and 'success'.</td>
`-User`	User to authenticate as.
`-Password`	Password to authenticate with.
`-PasswordPrompt`	Prompt for user to input password.
`-PrivateKey`	Path to private ssh key to authenticate with.
`-HostKeyCheck`	Check host keys with SSH.
`-Ssl`	Use SSL with WinRM.
`-SslVerify`	Verify remote host SSL certificate with WinRM.
`-RunAs`	User to run as using privilege escalation.
`-SudoPassword`	Password for privilege escalation.
`-SudoPasswordPrompt`	Prompt for user to input escalation password.
`-SudoExecutable`	Experimental. Specify an executable for running as another user.
`-Concurrency`	Maximum number of simultaneous connections.
`-Inventoryfile`	Specify where to load inventory from (default: <project>/inventory.yaml).
`-SaveRerun`	Whether to update the rerun file after this command.
`-Cleanup`	Whether to clean up temporary files created on targets.
`-Puppetdb`	The named PuppetDB instance to connect to by default.
`-Project`	Path to load the Bolt project from (default: autodiscovered from current dir).
`-Modulepath`	List of directories containing modules, separated by ':' Directories are case-sensitive.</td>
`-Transport`	Specify a default transport: docker, jail, local, lxd, podman, remote, ssh, winrm. For more information, see 'bolt guide transports'.</td>
`-ConnectTimeout`	Connection timeout in seconds (defaults vary).
`-TTY`	Request a pseudo TTY on targets that support it.
`-NativeSsh`	Experimental. Whether to shell out to native SSH or use the net-ssh Ruby library.
`-SshCommand`	Experimental. Executable to use instead of the net-ssh Ruby library.
`-CopyCommand`	Experimental. Command to copy files to remote hosts if using native SSH.
`-Format`	Output format to use: human, json, or rainbow.
`-Color`	Whether to show output in color.
`-Trace`	Display error stack traces.
`-Stream`	Stream output from scripts and commands to the console. Run with --no-verbose to prevent Bolt from displaying output a second time after the action is completed.</td>
`-LogLevel`	Set the log level for the console. Available options are trace, debug, info, warn, error, fatal.</td>
`-ClearCache`	Clear plugin, plan, and task caches before executing.
`-Params`	Parameters to a task or plan as json, a json file '@<file>', or on stdin '-'.
`-CompileConcurrency`	Maximum number of simultaneous manifest block compiles (default: number of cores).
`-Tmpdir`	The directory to upload and execute temporary files on the target.
`-HieraConfig`	Specify where to load Hiera config from (default: <project>/hiera.yaml).

</tr> </tr> </tbody> </table> ### New-BoltPlan [0m Create a new plan in the current project.[36m

Option	Description	Mandatory?
`-Name`	The plan to convert	✓
`-LogLevel`	Set the log level for the console. Available options are trace, debug, info, warn, error, fatal.</td>
`-ClearCache`	Clear plugin, plan, and task caches before executing.
`-Project`	Path to load the Bolt project from (default: autodiscovered from current dir).
`-Modulepath`	List of directories containing modules, separated by ':' Directories are case-sensitive.</td>

</tr> </tbody> </table> ### Get-BoltPlugin [0m Show available plugins.[36m

Option	Description	Mandatory?
`-Name`	The plan to create	✓
`-LogLevel`	Set the log level for the console. Available options are trace, debug, info, warn, error, fatal.</td>
`-ClearCache`	Clear plugin, plan, and task caches before executing.
`-Project`	Path to load the Bolt project from (default: autodiscovered from current dir).
`-Pp`	Create a new Puppet language plan.

</tr> </tr> </tbody> </table> ### Invoke-BoltPolicy [0m Apply a policy to the specified targets.

Option	Description	Mandatory?
`-LogLevel`	Set the log level for the console. Available options are trace, debug, info, warn, error, fatal.</td>
`-ClearCache`	Clear plugin, plan, and task caches before executing.
`-Color`	Whether to show output in color.
`-Format`	Output format to use: human, json, or rainbow.
`-Modulepath`	List of directories containing modules, separated by ':' Directories are case-sensitive.</td>
`-Project`	Path to load the Bolt project from (default: autodiscovered from current dir).

</tr> </tr> </tr> </tr> </tr> </tr> </tbody> </table> ### New-BoltPolicy [0m Create a new policy in the current project.

Option	Description	Mandatory?
`-Name`	The policy or policies to apply	✓
`-Targets`	Identifies the targets of the command. For more information, see 'bolt guide targets'.</td>
`-Query`	Query PuppetDB to determine the targets.
`-Rerun`	Retry on targets from the last run. Available filters are 'all', 'failure', and 'success'.</td>
`-User`	User to authenticate as.
`-Password`	Password to authenticate with.
`-PasswordPrompt`	Prompt for user to input password.
`-PrivateKey`	Path to private ssh key to authenticate with.
`-HostKeyCheck`	Check host keys with SSH.
`-Ssl`	Use SSL with WinRM.
`-SslVerify`	Verify remote host SSL certificate with WinRM.
`-RunAs`	User to run as using privilege escalation.
`-SudoPassword`	Password for privilege escalation.
`-SudoPasswordPrompt`	Prompt for user to input escalation password.
`-SudoExecutable`	Experimental. Specify an executable for running as another user.
`-Concurrency`	Maximum number of simultaneous connections.
`-Inventoryfile`	Specify where to load inventory from (default: <project>/inventory.yaml).
`-SaveRerun`	Whether to update the rerun file after this command.
`-Cleanup`	Whether to clean up temporary files created on targets.
`-Puppetdb`	The named PuppetDB instance to connect to by default.
`-Project`	Path to load the Bolt project from (default: autodiscovered from current dir).
`-Modulepath`	List of directories containing modules, separated by ':' Directories are case-sensitive.</td>
`-Transport`	Specify a default transport: docker, jail, local, lxd, podman, remote, ssh, winrm. For more information, see 'bolt guide transports'.</td>
`-ConnectTimeout`	Connection timeout in seconds (defaults vary).
`-TTY`	Request a pseudo TTY on targets that support it.
`-NativeSsh`	Experimental. Whether to shell out to native SSH or use the net-ssh Ruby library.
`-SshCommand`	Experimental. Executable to use instead of the net-ssh Ruby library.
`-CopyCommand`	Experimental. Command to copy files to remote hosts if using native SSH.
`-Format`	Output format to use: human, json, or rainbow.
`-Color`	Whether to show output in color.
`-Trace`	Display error stack traces.
`-Stream`	Stream output from scripts and commands to the console. Run with --no-verbose to prevent Bolt from displaying output a second time after the action is completed.</td>
`-LogLevel`	Set the log level for the console. Available options are trace, debug, info, warn, error, fatal.</td>
`-ClearCache`	Clear plugin, plan, and task caches before executing.
`-CompileConcurrency`	Maximum number of simultaneous manifest block compiles (default: number of cores).
`-HieraConfig`	Specify where to load Hiera config from (default: <project>/hiera.yaml).
`-Noop`	See what changes Bolt will make without actually executing the changes.

</tr> </tbody> </table> ### Get-BoltPolicy [0m Show available policies.

Option	Description	Mandatory?
`-Name`	The policy to create	✓
`-LogLevel`	Set the log level for the console. Available options are trace, debug, info, warn, error, fatal.</td>
`-ClearCache`	Clear plugin, plan, and task caches before executing.
`-Project`	Path to load the Bolt project from (default: autodiscovered from current dir).

</tr> </tbody> </table> ### New-BoltProject [0m Create a new Bolt project in the current working directory. Specify a name for the Bolt project. Defaults to the basename of the current working directory.[36m

Option	Description	Mandatory?
`-LogLevel`	Set the log level for the console. Available options are trace, debug, info, warn, error, fatal.</td>
`-ClearCache`	Clear plugin, plan, and task caches before executing.
`-Project`	Path to load the Bolt project from (default: autodiscovered from current dir).

</tr> </tr> </tbody> </table> ### Update-BoltProject [0m Migrate a Bolt project to use current best practices and the latest version of configuration files.[36m

Option	Description	Mandatory?
`-Name`	The name of the Bolt project to create
`-LogLevel`	Set the log level for the console. Available options are trace, debug, info, warn, error, fatal.</td>
`-ClearCache`	Clear plugin, plan, and task caches before executing.
`-Modules`	A comma-separated list of modules to install from the Puppet Forge when initializing a project. Resolves and installs all dependencies.</td>

</tr> </tbody> </table> ### Invoke-BoltScript [0m Run a script on the specified targets. Arguments passed to a script are passed literally and are not interpolated by the shell. Any arguments containing spaces or special characters should be quoted.[36m

Option	Description	Mandatory?
`-LogLevel`	Set the log level for the console. Available options are trace, debug, info, warn, error, fatal.</td>
`-ClearCache`	Clear plugin, plan, and task caches before executing.
`-Project`	Path to load the Bolt project from (default: autodiscovered from current dir).
`-Inventoryfile`	Specify where to load inventory from (default: <project>/inventory.yaml).

</tr> </tr> </tr> </tr> </tr> </tr> </tbody> </table> ### Protect-BoltSecret [0m Encrypt a value.[36m

Option	Description	Mandatory?
`-Script`	The script to execute	✓
`-Arguments`	The arguments to the script
`-Targets`	Identifies the targets of the command. For more information, see 'bolt guide targets'.</td>
`-Query`	Query PuppetDB to determine the targets.
`-Rerun`	Retry on targets from the last run. Available filters are 'all', 'failure', and 'success'.</td>
`-User`	User to authenticate as.
`-Password`	Password to authenticate with.
`-PasswordPrompt`	Prompt for user to input password.
`-PrivateKey`	Path to private ssh key to authenticate with.
`-HostKeyCheck`	Check host keys with SSH.
`-Ssl`	Use SSL with WinRM.
`-SslVerify`	Verify remote host SSL certificate with WinRM.
`-RunAs`	User to run as using privilege escalation.
`-SudoPassword`	Password for privilege escalation.
`-SudoPasswordPrompt`	Prompt for user to input escalation password.
`-SudoExecutable`	Experimental. Specify an executable for running as another user.
`-Concurrency`	Maximum number of simultaneous connections.
`-Inventoryfile`	Specify where to load inventory from (default: <project>/inventory.yaml).
`-SaveRerun`	Whether to update the rerun file after this command.
`-Cleanup`	Whether to clean up temporary files created on targets.
`-Puppetdb`	The named PuppetDB instance to connect to by default.
`-Project`	Path to load the Bolt project from (default: autodiscovered from current dir).
`-Modulepath`	List of directories containing modules, separated by ':' Directories are case-sensitive.</td>
`-Transport`	Specify a default transport: docker, jail, local, lxd, podman, remote, ssh, winrm. For more information, see 'bolt guide transports'.</td>
`-ConnectTimeout`	Connection timeout in seconds (defaults vary).
`-TTY`	Request a pseudo TTY on targets that support it.
`-NativeSsh`	Experimental. Whether to shell out to native SSH or use the net-ssh Ruby library.
`-SshCommand`	Experimental. Executable to use instead of the net-ssh Ruby library.
`-CopyCommand`	Experimental. Command to copy files to remote hosts if using native SSH.
`-Format`	Output format to use: human, json, or rainbow.
`-Color`	Whether to show output in color.
`-Trace`	Display error stack traces.
`-Stream`	Stream output from scripts and commands to the console. Run with --no-verbose to prevent Bolt from displaying output a second time after the action is completed.</td>
`-LogLevel`	Set the log level for the console. Available options are trace, debug, info, warn, error, fatal.</td>
`-ClearCache`	Clear plugin, plan, and task caches before executing.
`-Tmpdir`	The directory to upload and execute temporary files on the target.
`-EnvVar`	Environment variables to set on the target.

</tr> </tr> </tbody> </table> ### Unprotect-BoltSecret [0m Decrypt a value.[36m

Option	Description	Mandatory?
`-Text`	The text to encrypt	✓
`-LogLevel`	Set the log level for the console. Available options are trace, debug, info, warn, error, fatal.</td>
`-ClearCache`	Clear plugin, plan, and task caches before executing.
`-Project`	Path to load the Bolt project from (default: autodiscovered from current dir).
`-Modulepath`	List of directories containing modules, separated by ':' Directories are case-sensitive.</td>
`-Plugin`	Select the plugin to use.

</tr> </tr> </tbody> </table> ### New-BoltSecretKey [0m Create new encryption keys.[36m

Option	Description	Mandatory?
`-Text`	The text to decrypt	✓
`-LogLevel`	Set the log level for the console. Available options are trace, debug, info, warn, error, fatal.</td>
`-ClearCache`	Clear plugin, plan, and task caches before executing.
`-Project`	Path to load the Bolt project from (default: autodiscovered from current dir).
`-Modulepath`	List of directories containing modules, separated by ':' Directories are case-sensitive.</td>
`-Plugin`	Select the plugin to use.

</tr> </tr> </tbody> </table> ### Get-BoltTask [0m Show available tasks and task documentation. Omitting the name of a task will display a list of tasks available in the Bolt project. Providing the name of a task will display detailed documentation for the task, including a list of available parameters.[36m

Option	Description	Mandatory?
`-LogLevel`	Set the log level for the console. Available options are trace, debug, info, warn, error, fatal.</td>
`-ClearCache`	Clear plugin, plan, and task caches before executing.
`-Project`	Path to load the Bolt project from (default: autodiscovered from current dir).
`-Modulepath`	List of directories containing modules, separated by ':' Directories are case-sensitive.</td>
`-Plugin`	Select the plugin to use.
`-Force`	Force a destructive action.

</tr> </tr> </tbody> </table> ### Invoke-BoltTask [0m Run a task on the specified targets. Parameters take the form parameter=value.[36m

Option	Description	Mandatory?
`-Name`	The task to show
`-LogLevel`	Set the log level for the console. Available options are trace, debug, info, warn, error, fatal.</td>
`-ClearCache`	Clear plugin, plan, and task caches before executing.
`-Project`	Path to load the Bolt project from (default: autodiscovered from current dir).
`-Modulepath`	List of directories containing modules, separated by ':' Directories are case-sensitive.</td>
`-Filter`	Filter tasks and plans by a matching substring.
`-Format`	Output format to use: human, json, or rainbow.

</tr> </tr> </tr> </tr> </tr> </tr> </tbody> </table>

Option	Description	Mandatory?
`-Name`	The task to run	✓
`-Targets`	Identifies the targets of the command. For more information, see 'bolt guide targets'.</td>
`-Query`	Query PuppetDB to determine the targets.
`-Rerun`	Retry on targets from the last run. Available filters are 'all', 'failure', and 'success'.</td>
`-User`	User to authenticate as.
`-Password`	Password to authenticate with.
`-PasswordPrompt`	Prompt for user to input password.
`-PrivateKey`	Path to private ssh key to authenticate with.
`-HostKeyCheck`	Check host keys with SSH.
`-Ssl`	Use SSL with WinRM.
`-SslVerify`	Verify remote host SSL certificate with WinRM.
`-RunAs`	User to run as using privilege escalation.
`-SudoPassword`	Password for privilege escalation.
`-SudoPasswordPrompt`	Prompt for user to input escalation password.
`-SudoExecutable`	Experimental. Specify an executable for running as another user.
`-Concurrency`	Maximum number of simultaneous connections.
`-Inventoryfile`	Specify where to load inventory from (default: <project>/inventory.yaml).
`-SaveRerun`	Whether to update the rerun file after this command.
`-Cleanup`	Whether to clean up temporary files created on targets.
`-Puppetdb`	The named PuppetDB instance to connect to by default.
`-Project`	Path to load the Bolt project from (default: autodiscovered from current dir).
`-Modulepath`	List of directories containing modules, separated by ':' Directories are case-sensitive.</td>
`-Transport`	Specify a default transport: docker, jail, local, lxd, podman, remote, ssh, winrm. For more information, see 'bolt guide transports'.</td>
`-ConnectTimeout`	Connection timeout in seconds (defaults vary).
`-TTY`	Request a pseudo TTY on targets that support it.
`-NativeSsh`	Experimental. Whether to shell out to native SSH or use the net-ssh Ruby library.
`-SshCommand`	Experimental. Executable to use instead of the net-ssh Ruby library.
`-CopyCommand`	Experimental. Command to copy files to remote hosts if using native SSH.
`-Format`	Output format to use: human, json, or rainbow.
`-Color`	Whether to show output in color.
`-Trace`	Display error stack traces.
`-Stream`	Stream output from scripts and commands to the console. Run with --no-verbose to prevent Bolt from displaying output a second time after the action is completed.</td>
`-LogLevel`	Set the log level for the console. Available options are trace, debug, info, warn, error, fatal.</td>
`-ClearCache`	Clear plugin, plan, and task caches before executing.
`-Params`	Parameters to a task or plan as json, a json file '@<file>', or on stdin '-'.
`-Tmpdir`	The directory to upload and execute temporary files on the target.
`-Noop`	See what changes Bolt will make without actually executing the changes.