DocsBoltUsing Bolt commands
Bolt command reference

Bolt command reference

Sections

These subcommands, actions, and options are available for Bolt.

apply

NAME
    apply

USAGE
    bolt apply <manifest.pp> [options]

DESCRIPTION
    Apply Puppet manifest code on the specified targets.

EXAMPLES
    bolt apply manifest.pp --targets target1,target2
OptionDescription
-n, --nodes NODESAlias for --targetsDeprecated in favor of --targets
-t, --targets TARGETSIdentifies the targets of command.Enter a comma-separated list of target URIs or group names.Or read a target list from an input file '@<file>' or stdin '-'.Example: --targets localhost,node_group,ssh://nix.com:23,winrm://windows.puppet.comURI format is hostSSH is the default protocol; may be ssh, winrm, pcp, local, docker, remoteFor Windows targets, specify the winrm:// protocol if it has not be configuredFor SSH, port defaults to 22For WinRM, port defaults to 5985 or 5986 based on the --ssl setting
-q, --query QUERYQuery PuppetDB to determine the targets
--rerun FILTERRetry on nodes from the last run'all' all nodes that were part of the last run.'failure' nodes that failed in the last run.'success' nodes that succeeded in the last run.
--description DESCRIPTIONDescription to use for the job
-u, --user USERUser to authenticate as
-p, --password [PASSWORD]Password to authenticate with
--password-promptPrompt for user to input password
--private-key KEYPrivate ssh key to authenticate with
--[no-]host-key-checkCheck host keys with SSH
--[no-]sslUse SSL with WinRM
--[no-]ssl-verifyVerify remote host SSL certificate with WinRM
--run-as USERUser to run as using privilege escalation
--sudo-password [PASSWORD]Password for privilege escalation
--sudo-password-promptPrompt for user to input escalation password
--sudo-executable EXECSpecify an executable for running as another user.This option is experimental.
-c, --concurrency CONCURRENCYMaximum number of simultaneous connections (default: 100)
-i, --inventoryfile FILEPATHSpecify where to load inventory from (default: ~/.puppetlabs/bolt/inventory.yaml)
--[no-]save-rerunWhether to update the rerun file after this command.
-m, --modulepath MODULESList of directories containing modules, separated by ':'Directories are case-sensitive
--boltdir FILEPATHSpecify what Boltdir to load config from (default: autodiscovered from current working dir)
--configfile FILEPATHSpecify where to load config from (default: ~/.puppetlabs/bolt/bolt.yaml). Directory containing bolt.yaml will be used as the Boltdir.
--transport TRANSPORTSpecify a default transport: ssh, winrm, pcp, local, docker, remote
--connect-timeout TIMEOUTConnection timeout (defaults vary)
--[no-]ttyRequest a pseudo TTY on nodes that support it
--format FORMATOutput format to use: human or json
--[no-]colorWhether to show output in color
-v, --[no-]verboseDisplay verbose logging
--traceDisplay error stack traces
-h, --helpDisplay help
--versionDisplay the version
--debugDisplay debug logging
--noopExecute a task that supports it in noop mode
-e, --execute CODEPuppet manifest code to apply to the targets
--compile-concurrency CONCURRENCYMaximum number of simultaneous manifest block compiles (default: number of cores)

command run

NAME
    run

USAGE
    bolt command run <command> [options]

DESCRIPTION
    Run a command on the specified targets.

EXAMPLES
    bolt command run 'uptime' -t target1,target2
OptionDescription
-n, --nodes NODESAlias for --targetsDeprecated in favor of --targets
-t, --targets TARGETSIdentifies the targets of command.Enter a comma-separated list of target URIs or group names.Or read a target list from an input file '@<file>' or stdin '-'.Example: --targets localhost,node_group,ssh://nix.com:23,winrm://windows.puppet.comURI format is hostSSH is the default protocol; may be ssh, winrm, pcp, local, docker, remoteFor Windows targets, specify the winrm:// protocol if it has not be configuredFor SSH, port defaults to 22For WinRM, port defaults to 5985 or 5986 based on the --ssl setting
-q, --query QUERYQuery PuppetDB to determine the targets
--rerun FILTERRetry on nodes from the last run'all' all nodes that were part of the last run.'failure' nodes that failed in the last run.'success' nodes that succeeded in the last run.
--description DESCRIPTIONDescription to use for the job
-u, --user USERUser to authenticate as
-p, --password [PASSWORD]Password to authenticate with
--password-promptPrompt for user to input password
--private-key KEYPrivate ssh key to authenticate with
--[no-]host-key-checkCheck host keys with SSH
--[no-]sslUse SSL with WinRM
--[no-]ssl-verifyVerify remote host SSL certificate with WinRM
--run-as USERUser to run as using privilege escalation
--sudo-password [PASSWORD]Password for privilege escalation
--sudo-password-promptPrompt for user to input escalation password
--sudo-executable EXECSpecify an executable for running as another user.This option is experimental.
-c, --concurrency CONCURRENCYMaximum number of simultaneous connections (default: 100)
-i, --inventoryfile FILEPATHSpecify where to load inventory from (default: ~/.puppetlabs/bolt/inventory.yaml)
--[no-]save-rerunWhether to update the rerun file after this command.
-m, --modulepath MODULESList of directories containing modules, separated by ':'Directories are case-sensitive
--boltdir FILEPATHSpecify what Boltdir to load config from (default: autodiscovered from current working dir)
--configfile FILEPATHSpecify where to load config from (default: ~/.puppetlabs/bolt/bolt.yaml). Directory containing bolt.yaml will be used as the Boltdir.
--transport TRANSPORTSpecify a default transport: ssh, winrm, pcp, local, docker, remote
--connect-timeout TIMEOUTConnection timeout (defaults vary)
--[no-]ttyRequest a pseudo TTY on nodes that support it
--format FORMATOutput format to use: human or json
--[no-]colorWhether to show output in color
-v, --[no-]verboseDisplay verbose logging
--traceDisplay error stack traces
-h, --helpDisplay help
--versionDisplay the version
--debugDisplay debug logging

file upload

NAME
    upload

USAGE
    bolt file upload <src> <dest> [options]

DESCRIPTION
    Upload a local file or directory.

EXAMPLES
    bolt file upload /tmp/source /etc/profile.d/login.sh -t target1
OptionDescription
-n, --nodes NODESAlias for --targetsDeprecated in favor of --targets
-t, --targets TARGETSIdentifies the targets of command.Enter a comma-separated list of target URIs or group names.Or read a target list from an input file '@<file>' or stdin '-'.Example: --targets localhost,node_group,ssh://nix.com:23,winrm://windows.puppet.comURI format is hostSSH is the default protocol; may be ssh, winrm, pcp, local, docker, remoteFor Windows targets, specify the winrm:// protocol if it has not be configuredFor SSH, port defaults to 22For WinRM, port defaults to 5985 or 5986 based on the --ssl setting
-q, --query QUERYQuery PuppetDB to determine the targets
--rerun FILTERRetry on nodes from the last run'all' all nodes that were part of the last run.'failure' nodes that failed in the last run.'success' nodes that succeeded in the last run.
--description DESCRIPTIONDescription to use for the job
-u, --user USERUser to authenticate as
-p, --password [PASSWORD]Password to authenticate with
--password-promptPrompt for user to input password
--private-key KEYPrivate ssh key to authenticate with
--[no-]host-key-checkCheck host keys with SSH
--[no-]sslUse SSL with WinRM
--[no-]ssl-verifyVerify remote host SSL certificate with WinRM
--run-as USERUser to run as using privilege escalation
--sudo-password [PASSWORD]Password for privilege escalation
--sudo-password-promptPrompt for user to input escalation password
--sudo-executable EXECSpecify an executable for running as another user.This option is experimental.
-c, --concurrency CONCURRENCYMaximum number of simultaneous connections (default: 100)
-i, --inventoryfile FILEPATHSpecify where to load inventory from (default: ~/.puppetlabs/bolt/inventory.yaml)
--[no-]save-rerunWhether to update the rerun file after this command.
-m, --modulepath MODULESList of directories containing modules, separated by ':'Directories are case-sensitive
--boltdir FILEPATHSpecify what Boltdir to load config from (default: autodiscovered from current working dir)
--configfile FILEPATHSpecify where to load config from (default: ~/.puppetlabs/bolt/bolt.yaml). Directory containing bolt.yaml will be used as the Boltdir.
--transport TRANSPORTSpecify a default transport: ssh, winrm, pcp, local, docker, remote
--connect-timeout TIMEOUTConnection timeout (defaults vary)
--[no-]ttyRequest a pseudo TTY on nodes that support it
--format FORMATOutput format to use: human or json
--[no-]colorWhether to show output in color
-v, --[no-]verboseDisplay verbose logging
--traceDisplay error stack traces
-h, --helpDisplay help
--versionDisplay the version
--debugDisplay debug logging
--tmpdir DIRThe directory to upload and execute temporary files on the target

group show

NAME
    show

USAGE
    bolt group show [options]

DESCRIPTION
    Show the list of groups in the inventory.
OptionDescription
-h, --helpDisplay help
--versionDisplay the version
--debugDisplay debug logging
--format FORMATOutput format to use: human or json
-i, --inventoryfile FILEPATHSpecify where to load inventory from (default: ~/.puppetlabs/bolt/inventory.yaml)
--boltdir FILEPATHSpecify what Boltdir to load config from (default: autodiscovered from current working dir)
--configfile FILEPATHSpecify where to load config from (default: ~/.puppetlabs/bolt/bolt.yaml). Directory containing bolt.yaml will be used as the Boltdir.

inventory show

NAME
    show

USAGE
    bolt inventory show [options]

DESCRIPTION
    Show the list of targets an action would run on.
OptionDescription
-n, --nodes NODESAlias for --targetsDeprecated in favor of --targets
-t, --targets TARGETSIdentifies the targets of command.Enter a comma-separated list of target URIs or group names.Or read a target list from an input file '@<file>' or stdin '-'.Example: --targets localhost,node_group,ssh://nix.com:23,winrm://windows.puppet.comURI format is hostSSH is the default protocol; may be ssh, winrm, pcp, local, docker, remoteFor Windows targets, specify the winrm:// protocol if it has not be configuredFor SSH, port defaults to 22For WinRM, port defaults to 5985 or 5986 based on the --ssl setting
-q, --query QUERYQuery PuppetDB to determine the targets
--rerun FILTERRetry on nodes from the last run'all' all nodes that were part of the last run.'failure' nodes that failed in the last run.'success' nodes that succeeded in the last run.
--description DESCRIPTIONDescription to use for the job
-h, --helpDisplay help
--versionDisplay the version
--debugDisplay debug logging
--format FORMATOutput format to use: human or json
-i, --inventoryfile FILEPATHSpecify where to load inventory from (default: ~/.puppetlabs/bolt/inventory.yaml)
--boltdir FILEPATHSpecify what Boltdir to load config from (default: autodiscovered from current working dir)
--configfile FILEPATHSpecify where to load config from (default: ~/.puppetlabs/bolt/bolt.yaml). Directory containing bolt.yaml will be used as the Boltdir.
--detailShow resolved configuration for the targets

plan convert

NAME
    convert

USAGE
    bolt plan convert <path> [options]

DESCRIPTION
    Convert a YAML plan to a Bolt plan.

    Converting a YAML plan may result in a plan that is syntactically
    correct but has different behavior. Always verify a converted plan's
    functionality.

EXAMPLES
    bolt plan convert path/to/plan/myplan.yaml
OptionDescription
-h, --helpDisplay help
--versionDisplay the version
--debugDisplay debug logging
-m, --modulepath MODULESList of directories containing modules, separated by ':'Directories are case-sensitive
--boltdir FILEPATHSpecify what Boltdir to load config from (default: autodiscovered from current working dir)
--configfile FILEPATHSpecify where to load config from (default: ~/.puppetlabs/bolt/bolt.yaml). Directory containing bolt.yaml will be used as the Boltdir.

plan run

NAME
    run

USAGE
    bolt plan run <plan> [parameters] [options]

DESCRIPTION
    Run a plan on the specified targets.

EXAMPLES
    bolt plan run canary --targets target1,target2 command=hostname
OptionDescription
-n, --nodes NODESAlias for --targetsDeprecated in favor of --targets
-t, --targets TARGETSIdentifies the targets of command.Enter a comma-separated list of target URIs or group names.Or read a target list from an input file '@<file>' or stdin '-'.Example: --targets localhost,node_group,ssh://nix.com:23,winrm://windows.puppet.comURI format is hostSSH is the default protocol; may be ssh, winrm, pcp, local, docker, remoteFor Windows targets, specify the winrm:// protocol if it has not be configuredFor SSH, port defaults to 22For WinRM, port defaults to 5985 or 5986 based on the --ssl setting
-q, --query QUERYQuery PuppetDB to determine the targets
--rerun FILTERRetry on nodes from the last run'all' all nodes that were part of the last run.'failure' nodes that failed in the last run.'success' nodes that succeeded in the last run.
--description DESCRIPTIONDescription to use for the job
-u, --user USERUser to authenticate as
-p, --password [PASSWORD]Password to authenticate with
--password-promptPrompt for user to input password
--private-key KEYPrivate ssh key to authenticate with
--[no-]host-key-checkCheck host keys with SSH
--[no-]sslUse SSL with WinRM
--[no-]ssl-verifyVerify remote host SSL certificate with WinRM
--run-as USERUser to run as using privilege escalation
--sudo-password [PASSWORD]Password for privilege escalation
--sudo-password-promptPrompt for user to input escalation password
--sudo-executable EXECSpecify an executable for running as another user.This option is experimental.
-c, --concurrency CONCURRENCYMaximum number of simultaneous connections (default: 100)
-i, --inventoryfile FILEPATHSpecify where to load inventory from (default: ~/.puppetlabs/bolt/inventory.yaml)
--[no-]save-rerunWhether to update the rerun file after this command.
-m, --modulepath MODULESList of directories containing modules, separated by ':'Directories are case-sensitive
--boltdir FILEPATHSpecify what Boltdir to load config from (default: autodiscovered from current working dir)
--configfile FILEPATHSpecify where to load config from (default: ~/.puppetlabs/bolt/bolt.yaml). Directory containing bolt.yaml will be used as the Boltdir.
--transport TRANSPORTSpecify a default transport: ssh, winrm, pcp, local, docker, remote
--connect-timeout TIMEOUTConnection timeout (defaults vary)
--[no-]ttyRequest a pseudo TTY on nodes that support it
--format FORMATOutput format to use: human or json
--[no-]colorWhether to show output in color
-v, --[no-]verboseDisplay verbose logging
--traceDisplay error stack traces
-h, --helpDisplay help
--versionDisplay the version
--debugDisplay debug logging
--params PARAMETERSParameters to a task or plan as json, a json file '@<file>', or on stdin '-'
--compile-concurrency CONCURRENCYMaximum number of simultaneous manifest block compiles (default: number of cores)
--tmpdir DIRThe directory to upload and execute temporary files on the target

plan show

NAME
    show

USAGE
    bolt plan show [plan] [options]

DESCRIPTION
    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.

EXAMPLES
    Display a list of available tasks
      bolt plan show
    Display documentation for the canary task
      bolt plan show aggregate::count
OptionDescription
-h, --helpDisplay help
--versionDisplay the version
--debugDisplay debug logging
-m, --modulepath MODULESList of directories containing modules, separated by ':'Directories are case-sensitive
--boltdir FILEPATHSpecify what Boltdir to load config from (default: autodiscovered from current working dir)
--configfile FILEPATHSpecify where to load config from (default: ~/.puppetlabs/bolt/bolt.yaml). Directory containing bolt.yaml will be used as the Boltdir.

project init

NAME
    init

USAGE
    bolt project init [directory] [options]

DESCRIPTION
    Create a new Bolt project.

    Specify a directory to create a Bolt project in. Defaults to the
    curent working directory.

EXAMPLES
    Create a new Bolt project in the current working directory.
      bolt project init
    Create a new Bolt project at a specified path.
      bolt project init ~/path/to/project
OptionDescription
-h, --helpDisplay help
--versionDisplay the version
--debugDisplay debug logging

project migrate

NAME
    migrate

USAGE
    bolt project migrate [options]

DESCRIPTION
    Migrate a Bolt project to the latest version.

    Loads a Bolt project's inventory file and migrates it to the latest version. The
    inventory file is modified in place and will not preserve comments or formatting.
OptionDescription
-h, --helpDisplay help
--versionDisplay the version
--debugDisplay debug logging
-i, --inventoryfile FILEPATHSpecify where to load inventory from (default: ~/.puppetlabs/bolt/inventory.yaml)
--boltdir FILEPATHSpecify what Boltdir to load config from (default: autodiscovered from current working dir)
--configfile FILEPATHSpecify where to load config from (default: ~/.puppetlabs/bolt/bolt.yaml). Directory containing bolt.yaml will be used as the Boltdir.

puppetfile generate-types

NAME
    generate-types

USAGE
    bolt puppetfile generate-types [options]

DESCRIPTION
    Generate type references to register in plans.
OptionDescription
-h, --helpDisplay help
--versionDisplay the version
--debugDisplay debug logging
-m, --modulepath MODULESList of directories containing modules, separated by ':'Directories are case-sensitive
--boltdir FILEPATHSpecify what Boltdir to load config from (default: autodiscovered from current working dir)
--configfile FILEPATHSpecify where to load config from (default: ~/.puppetlabs/bolt/bolt.yaml). Directory containing bolt.yaml will be used as the Boltdir.

puppetfile install

NAME
    install

USAGE
    bolt puppetfile install [options]

DESCRIPTION
    Install modules from a Puppetfile into a Boltdir
OptionDescription
-h, --helpDisplay help
--versionDisplay the version
--debugDisplay debug logging
-m, --modulepath MODULESList of directories containing modules, separated by ':'Directories are case-sensitive
--boltdir FILEPATHSpecify what Boltdir to load config from (default: autodiscovered from current working dir)
--configfile FILEPATHSpecify where to load config from (default: ~/.puppetlabs/bolt/bolt.yaml). Directory containing bolt.yaml will be used as the Boltdir.

puppetfile show-modules

NAME
    show-modules

USAGE
    bolt puppetfile show-modules [options]

DESCRIPTION
    List modules available to the Bolt project.
OptionDescription
-h, --helpDisplay help
--versionDisplay the version
--debugDisplay debug logging
-m, --modulepath MODULESList of directories containing modules, separated by ':'Directories are case-sensitive
--boltdir FILEPATHSpecify what Boltdir to load config from (default: autodiscovered from current working dir)
--configfile FILEPATHSpecify where to load config from (default: ~/.puppetlabs/bolt/bolt.yaml). Directory containing bolt.yaml will be used as the Boltdir.

script run

NAME
    run

USAGE
    bolt script run <script> [arguments] [options]

DESCRIPTION
    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.

EXAMPLES
    bolt script run myscript.sh 'echo hello' --targets target1,target2
OptionDescription
-n, --nodes NODESAlias for --targetsDeprecated in favor of --targets
-t, --targets TARGETSIdentifies the targets of command.Enter a comma-separated list of target URIs or group names.Or read a target list from an input file '@<file>' or stdin '-'.Example: --targets localhost,node_group,ssh://nix.com:23,winrm://windows.puppet.comURI format is hostSSH is the default protocol; may be ssh, winrm, pcp, local, docker, remoteFor Windows targets, specify the winrm:// protocol if it has not be configuredFor SSH, port defaults to 22For WinRM, port defaults to 5985 or 5986 based on the --ssl setting
-q, --query QUERYQuery PuppetDB to determine the targets
--rerun FILTERRetry on nodes from the last run'all' all nodes that were part of the last run.'failure' nodes that failed in the last run.'success' nodes that succeeded in the last run.
--description DESCRIPTIONDescription to use for the job
-u, --user USERUser to authenticate as
-p, --password [PASSWORD]Password to authenticate with
--password-promptPrompt for user to input password
--private-key KEYPrivate ssh key to authenticate with
--[no-]host-key-checkCheck host keys with SSH
--[no-]sslUse SSL with WinRM
--[no-]ssl-verifyVerify remote host SSL certificate with WinRM
--run-as USERUser to run as using privilege escalation
--sudo-password [PASSWORD]Password for privilege escalation
--sudo-password-promptPrompt for user to input escalation password
--sudo-executable EXECSpecify an executable for running as another user.This option is experimental.
-c, --concurrency CONCURRENCYMaximum number of simultaneous connections (default: 100)
-i, --inventoryfile FILEPATHSpecify where to load inventory from (default: ~/.puppetlabs/bolt/inventory.yaml)
--[no-]save-rerunWhether to update the rerun file after this command.
-m, --modulepath MODULESList of directories containing modules, separated by ':'Directories are case-sensitive
--boltdir FILEPATHSpecify what Boltdir to load config from (default: autodiscovered from current working dir)
--configfile FILEPATHSpecify where to load config from (default: ~/.puppetlabs/bolt/bolt.yaml). Directory containing bolt.yaml will be used as the Boltdir.
--transport TRANSPORTSpecify a default transport: ssh, winrm, pcp, local, docker, remote
--connect-timeout TIMEOUTConnection timeout (defaults vary)
--[no-]ttyRequest a pseudo TTY on nodes that support it
--format FORMATOutput format to use: human or json
--[no-]colorWhether to show output in color
-v, --[no-]verboseDisplay verbose logging
--traceDisplay error stack traces
-h, --helpDisplay help
--versionDisplay the version
--debugDisplay debug logging
--tmpdir DIRThe directory to upload and execute temporary files on the target

secret createkeys

NAME
    createkeys

USAGE
    bolt secret createkeys [options]

DESCRIPTION
    Create new encryption keys.
OptionDescription
-h, --helpDisplay help
--versionDisplay the version
--debugDisplay debug logging
-m, --modulepath MODULESList of directories containing modules, separated by ':'Directories are case-sensitive
--boltdir FILEPATHSpecify what Boltdir to load config from (default: autodiscovered from current working dir)
--configfile FILEPATHSpecify where to load config from (default: ~/.puppetlabs/bolt/bolt.yaml). Directory containing bolt.yaml will be used as the Boltdir.
--plugin PLUGINSelect the plugin to use

secret decrypt

NAME
    decrypt

USAGE
    bolt secret decrypt <ciphertext> [options]

DESCRIPTION
    Decrypt a value.
OptionDescription
-h, --helpDisplay help
--versionDisplay the version
--debugDisplay debug logging
-m, --modulepath MODULESList of directories containing modules, separated by ':'Directories are case-sensitive
--boltdir FILEPATHSpecify what Boltdir to load config from (default: autodiscovered from current working dir)
--configfile FILEPATHSpecify where to load config from (default: ~/.puppetlabs/bolt/bolt.yaml). Directory containing bolt.yaml will be used as the Boltdir.
--plugin PLUGINSelect the plugin to use

secret encrypt

NAME
    encrypt

USAGE
  bolt secret encrypt <plaintext> [options]

DESCRIPTION
    Encrypt a value.
OptionDescription
-h, --helpDisplay help
--versionDisplay the version
--debugDisplay debug logging
-m, --modulepath MODULESList of directories containing modules, separated by ':'Directories are case-sensitive
--boltdir FILEPATHSpecify what Boltdir to load config from (default: autodiscovered from current working dir)
--configfile FILEPATHSpecify where to load config from (default: ~/.puppetlabs/bolt/bolt.yaml). Directory containing bolt.yaml will be used as the Boltdir.
--plugin PLUGINSelect the plugin to use

task run

NAME
    run

USAGE
    bolt task run <task> [parameters] [options]

DESCRIPTION
    Run a task on the specified targets.

    Parameters take the form <parameter>=<value>.

EXAMPLES
    bolt task run package --targets target1,target2 action=status name=bash
OptionDescription
-n, --nodes NODESAlias for --targetsDeprecated in favor of --targets
-t, --targets TARGETSIdentifies the targets of command.Enter a comma-separated list of target URIs or group names.Or read a target list from an input file '@<file>' or stdin '-'.Example: --targets localhost,node_group,ssh://nix.com:23,winrm://windows.puppet.comURI format is hostSSH is the default protocol; may be ssh, winrm, pcp, local, docker, remoteFor Windows targets, specify the winrm:// protocol if it has not be configuredFor SSH, port defaults to 22For WinRM, port defaults to 5985 or 5986 based on the --ssl setting
-q, --query QUERYQuery PuppetDB to determine the targets
--rerun FILTERRetry on nodes from the last run'all' all nodes that were part of the last run.'failure' nodes that failed in the last run.'success' nodes that succeeded in the last run.
--description DESCRIPTIONDescription to use for the job
-u, --user USERUser to authenticate as
-p, --password [PASSWORD]Password to authenticate with
--password-promptPrompt for user to input password
--private-key KEYPrivate ssh key to authenticate with
--[no-]host-key-checkCheck host keys with SSH
--[no-]sslUse SSL with WinRM
--[no-]ssl-verifyVerify remote host SSL certificate with WinRM
--run-as USERUser to run as using privilege escalation
--sudo-password [PASSWORD]Password for privilege escalation
--sudo-password-promptPrompt for user to input escalation password
--sudo-executable EXECSpecify an executable for running as another user.This option is experimental.
-c, --concurrency CONCURRENCYMaximum number of simultaneous connections (default: 100)
-i, --inventoryfile FILEPATHSpecify where to load inventory from (default: ~/.puppetlabs/bolt/inventory.yaml)
--[no-]save-rerunWhether to update the rerun file after this command.
-m, --modulepath MODULESList of directories containing modules, separated by ':'Directories are case-sensitive
--boltdir FILEPATHSpecify what Boltdir to load config from (default: autodiscovered from current working dir)
--configfile FILEPATHSpecify where to load config from (default: ~/.puppetlabs/bolt/bolt.yaml). Directory containing bolt.yaml will be used as the Boltdir.
--transport TRANSPORTSpecify a default transport: ssh, winrm, pcp, local, docker, remote
--connect-timeout TIMEOUTConnection timeout (defaults vary)
--[no-]ttyRequest a pseudo TTY on nodes that support it
--format FORMATOutput format to use: human or json
--[no-]colorWhether to show output in color
-v, --[no-]verboseDisplay verbose logging
--traceDisplay error stack traces
-h, --helpDisplay help
--versionDisplay the version
--debugDisplay debug logging
--params PARAMETERSParameters to a task or plan as json, a json file '@<file>', or on stdin '-'
--tmpdir DIRThe directory to upload and execute temporary files on the target

task show

NAME
    show

USAGE
    bolt task show [task] [options]

DESCRIPTION
    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.

EXAMPLES
    Display a list of available tasks
      bolt task show
    Display documentation for the canary task
      bolt task show canary
OptionDescription
-h, --helpDisplay help
--versionDisplay the version
--debugDisplay debug logging
-m, --modulepath MODULESList of directories containing modules, separated by ':'Directories are case-sensitive
--boltdir FILEPATHSpecify what Boltdir to load config from (default: autodiscovered from current working dir)
--configfile FILEPATHSpecify where to load config from (default: ~/.puppetlabs/bolt/bolt.yaml). Directory containing bolt.yaml will be used as the Boltdir.
How helpful was this page?
Puppet sites use proprietary and third-party cookies. By using our sites, you agree to our cookie policy.