Puppet's Commands

This version of Puppet is not included in Puppet Enterprise. The latest version of PE includes Puppet 4.10. A newer version is available; see the version menu above for details.

Puppet’s command line interface consists of a single puppet command with many subcommands.

Puppet Server and Puppet’s companion utilities, Facter and Hiera, have their own command line interfaces, which differ slightly from Puppet’s.

Core Services

The following subcommands are the main applications Puppet uses to manage systems. Every user should understand what they do.

Puppet Agent

Puppet agent manages systems, with the help of a Puppet master. It requests a configuration catalog from a Puppet master server, then ensures that all resources in that catalog are in their desired state.

For more information, see:

Puppet Master

Puppet master compiles and serves configuration catalogs for any number of Puppet agents, using Puppet modules and various other data sources.

For more information, see:

Puppet Server

Puppet Server compiles configurations for any number of Puppet agents, using Puppet code and various other data sources. It provides the same services as the classic Puppet master application and is meant to replace an Apache/Passenger Puppet master stack.

Puppet Server has its own subcommand, puppetserver, which isn’t prefaced by the usual puppet subcommand.

For more information, see:

Puppet Apply

Puppet apply manages systems without needing to contact a Puppet master server. It compiles its own configuration catalog, using Puppet modules and various other data sources, then immediately applies the catalog.

For more information, see:

Administrative Tools

Puppet Cert

Puppet cert helps manage Puppet’s built-in certificate authority (CA). It runs on the same server as the Puppet master application. You can use it to sign and revoke agent certificates.

For more information, see:

Puppet Module

Puppet module is a multi-purpose tool for working with Puppet modules. It can install and upgrade new modules from the Puppet Forge, help generate new modules, and package modules for public release.

For more information, see:

Puppet Resource

Puppet resource lets you interactively inspect and manipulate resources on a system. It can work with any resource type Puppet knows about.

For more information, see:

Puppet Config

Puppet config lets you view and change Puppet’s settings.

For more information, see:

Accessories

Puppet Parser

Puppet parser lets you validate Puppet code to make sure it contains no syntax errors. It can be a useful part of your continuous integration toolchain.

For more information, see:

Puppet Help and Puppet Man

Puppet help and Puppet man can display online help for Puppet’s other subcommands.

For more information, see:

Full List of Subcommands

Puppet has other subcommands, most of which aren’t as generally useful as the ones listed above. For a complete list, see:

↑ Back to top