Poster of Linux kernelThe best gift for a Linux geek


Section: (8) Updated: August 2010
Local index Up
Use the Puppet RAL to directly interact with the system.puppet resource [-h|--help] [-d|--debug] [-v|--verbose] [-e|--edit]

              [-H|--host <host>] [-p|--param <param>] [-t|--types]
              type <name>
This command provides simple facilities for converting current system state into Puppet code, along with some ability to use Puppet to affect the current state.

By default, you must at least provide a type to list, which case puppet resource will tell you everything it knows about all instances of that type. You can optionally specify an instance name, and puppet resource will only describe that single instance.

You can also add +--edit+ as an argument, and puppet resource will write its output to a file, open that file in an editor, and then apply the file as a Puppet transaction. You can easily use this to use Puppet to make simple changes to a system.Note that any configuration parameter that's valid in the configuration file is also a valid long argument. For example, 'ssldir' is a valid configuration parameter, so you can specify '--ssldir directory' as an argument.

See the configuration file documentation at for the full list of acceptable parameters. A commented list of all configuration options can also be generated by running puppet with '--genconfig'.

debug: Enable full debugging.


Write the results of the query to a file, open the file in an editor, and read the file back in as an executable Puppet manifest.


When specified, connect to the resource server on the named host and retrieve the list of resouces of the type specified.


Print this help message.


Add more parameters to be outputted from queries.


List all available types.


Print extra information.This example uses puppet resource to return Puppet configuration for the user luke:

 $ puppet resource user luke
 user { 'luke':
   home => '/home/luke',
   uid => '100',
   ensure => 'present',
   comment => 'Luke Kanies,,,',
   gid => '1000',
   shell => '/bin/bash',
   groups => ['sysadmin','audio','video','puppet']
Luke KaniesCopyright (c) 2005-2007 Puppet Labs, LLC Licensed under the GNU Public License

This document was created by man2html, using the manual pages.
Time: 22:02:14 GMT, April 16, 2011