puppet-help (8) Linux Manual Page
puppet-help – Display Puppet help.
Synopsis
puppet help action
Options
Note that any configuration parameter that’s valid in the configuration file is also a valid long argument, although it may or may not be relevant to the present action. For example, server and run_mode are valid configuration parameters, so you can specify –server <servername>, or –run_mode <runmode> as an argument.
See the configuration file documentation at http://docs.puppetlabs.com/references/stable/configuration.html for the full list of acceptable parameters. A commented list of all configuration options can also be generated by running puppet with –genconfig.
- –render-as FORMAT
- The format in which to render output. The most common formats are json, s (string), yaml, and console, but other options such as dot are sometimes available.
- –verbose
- Whether to log verbosely.
- –debug
- Whether to log debug information.
Actions
- help – Display help about Puppet subcommands and their actions.
- SYNOPSIS
- puppet help [–version VERSION] [subcommand] [action]
- DESCRIPTION
- Display help about Puppet subcommands and their actions.
- OPTIONS –version VERSION – The version of the subcommand for which to show help.
- RETURNS
- Short help text for the specified subcommand or action.
- puppet help [–version VERSION] [subcommand] [action]
Examples
help
Get help for an action:
$ puppet help
Copyright And License
Copyright 2011 by Puppet Labs Apache 2 license; see COPYING