Section 8: administration and privileged commands
puppet-queue – Queuing daemon for asynchronous storeconfigs Synopsis Retrieves serialized storeconfigs records from a queue and processes them in order. Usage puppet queue [-d|–debug] [-v|–verbose] Description This application runs as a daemon and processes storeconfigs data, retrieving the data from a stomp server message queue and writing it to a database. For more information, including…
puppet-plugin – Interact with the Puppet plugin system. Synopsis puppet plugin action Description This subcommand provides network access to the puppet master’s store of plugins. The puppet master serves Ruby code collected from the lib directories of its modules. These plugins can be used on agent nodes to extend Facter and implement custom types and…
puppet-parser – Interact directly with the parser. Synopsis puppet parser 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…
puppet-node – View and manage node definitions. Synopsis puppet node action [–terminus TERMINUS] [–extra HASH] Description This subcommand interacts with node objects, which are used by Puppet to build a catalog. A node object consists of the node’s facts, environment, node parameters (exposed in the parser as top-scope variables), and classes. Options Note that any…
puppet-module – Creates, installs and searches for modules on the Puppet Forge. Synopsis puppet module action [–environment production ] [–modulepath $confdir/modules:/usr/share/puppet/modules ] Description This subcommand can find, install, and manage modules from the Puppet Forge, a repository of user-contributed Puppet code. It can also generate empty modules, and prepare locally developed modules for release on…
puppet-master – The puppet master daemon Synopsis The central puppet server. Functions as a certificate authority by default. Usage puppet master [-D|–daemonize|–no-daemonize] [-d|–debug] [-h|–help] [-l|–logdest file|console|syslog] [-v|–verbose] [-V|–version] [–compile node-name] Description This command starts an instance of puppet master, running as a daemon and using Ruby’s built-in Webrick webserver. Puppet master can also be managed…
puppet-man – Display Puppet manual pages. Synopsis puppet man action Description This subcommand displays manual pages for all Puppet subcommands. If the ronn gem (https://github.com/rtomayko/ronn/) is installed on your system, puppet man will display fully-formated man pages. If ronn is not available, puppet man will display the raw (but human-readable) source text in a pager….
puppet-kick – Remotely control puppet agent Synopsis Trigger a puppet agent run on a set of hosts. Usage puppet kick [-a|–all] [-c|–class class] [-d|–debug] [-f|–foreground] [-h|–help] [–host host] [–no-fqdn] [–ignoreschedules] [-t|–tag tag] [–test] [-p|–ping] host [host […]] Description This script can be used to connect to a set of machines running ‘puppet agent’ and trigger…
puppet-key – Create, save, and remove certificate keys. Synopsis puppet key action [–terminus TERMINUS] [–extra HASH] Description This subcommand manages certificate private keys. Keys are created automatically by puppet agent and when certificate requests are generated with ‘puppet certificate generate’; it should not be necessary to use this subcommand directly. Options Note that any configuration…
puppet-instrumentation_probe – Manage instrumentation probes. Synopsis puppet instrumentation_probe action [–terminus TERMINUS] [–extra HASH] Description This subcommand enables/disables or list instrumentation listeners. 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…
puppet-instrumentation_listener – Manage instrumentation listeners. Synopsis puppet instrumentation_listener action [–terminus TERMINUS] [–extra HASH] Description This subcommand enables/disables or list instrumentation listeners. 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…
puppet-instrumentation_data – Manage instrumentation listener accumulated data. Synopsis puppet instrumentation_data action [–terminus TERMINUS] [–extra HASH] Description This subcommand allows to retrieve the various listener data. 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….
puppet-inspect – Send an inspection report Synopsis Prepares and submits an inspection report to the puppet master. Usage puppet inspect [–archive_files] [–archive_file_server] Description This command uses the cached catalog from the previous run of ‘puppet agent’ to determine which attributes of which resources have been marked as auditable with the ‘audit’ metaparameter. It then examines…
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…
puppet-filebucket – Store and retrieve files in a filebucket Synopsis A stand-alone Puppet filebucket client. Usage puppet filebucket mode [-h|–help] [-V|–version] [-d|–debug] [-v|–verbose] [-l|–local] [-r|–remote] [-s|–server server] [-b|–bucket directory] file file … Puppet filebucket can operate in three modes, with only one mode per call: backup: Send one or more files to the specified file…
puppet-file – Retrieve and store files in a filebucket Synopsis puppet file action [–terminus TERMINUS] [–extra HASH] Description This subcommand interacts with objects stored in a local or remote filebucket. File objects are accessed by their MD5 sum; see the examples for the relevant syntax. Options Note that any configuration parameter that’s valid in the…
puppet-facts – Retrieve and store facts. Synopsis puppet facts action [–terminus TERMINUS] [–extra HASH] Description This subcommand manages facts, which are collections of normalized system information used by Puppet. It can read facts directly from the local system (with the default facter terminus), look up facts reported by other systems, and submit facts to the…
puppet-doc – Generate Puppet documentation and references Synopsis Generates a reference for all Puppet types. Largely meant for internal Puppet Labs use. WARNING: RDoc support is only available under Ruby 1.8.7 and earlier. Usage puppet doc [-a|–all] [-h|–help] [-o|–outputdir rdoc-outputdir] [-m|–mode text|pdf|rdoc] [-r|–reference reference-name] [–charset charset] [manifest-file] Description If mode is not ‘rdoc’, then this…
puppet-device – Manage remote network devices Synopsis Retrieves all configurations from the puppet master and apply them to the remote devices configured in /etc/puppet/device.conf. Currently must be run out periodically, using cron or something similar. Usage puppet device [-d|–debug] [–detailed-exitcodes] [-V|–version] [-h|–help] [-l|–logdest syslog|<file>|console] [-v|–verbose] [-w|–waitforcert <seconds>] Description Once the client has a signed certificate…
puppet-describe – Display help about resource types Synopsis Prints help about Puppet resource types, providers, and metaparameters. Usage puppet describe [-h|–help] [-s|–short] [-p|–providers] [-l|–list] [-m|–meta] Options –help Print this help text –providers Describe providers in detail for each type –list List all types –meta List all metaparameters –short List only parameters without detail Example $…