Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Contact Us
Online Help
Domain Status
Man Pages

Virtual Servers

Topology Map

Server Agreement
Year 2038

USA Flag



Man Pages

Manual Reference Pages  -  PUPPET-RESOURCE (8)


puppet-resource - The resource abstraction layer shell



Uses the Puppet RAL to directly interact with the system.


puppet resource [-h|--help] [-d|--debug] [-v|--verbose] [-e|--edit] [-p|--param parameter] [-t|--types] [-y|--to_yaml] type [name] [attribute=value ...]


This command provides simple facilities for converting current system state into Puppet code, along with some ability to modify the current state using Puppet's RAL.

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

If given a type, a name, and a series of attribute=value pairs, puppet resource will modify the state of the specified resource. Alternately, if given a type, a name, and the '--edit' flag, puppet resource will write its output to a file, open that file in an editor, and then apply the saved file as a Puppet transaction.


Note that any setting that's valid in the configuration file is also a valid long argument. For example, 'ssldir' is a valid setting, 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.
--edit 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.
--host When specified, connect to the resource server on the named host and retrieve the list of resouces of the type specified.
--help Print this help message.
--param Add more parameters to be outputted from queries.
--types List all available types.
  Print extra information.
  Output found resources in yaml format, suitable to use with Hiera and create_resources.


This example uses puppet resource to return a 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 Kanies


Copyright (c) 2011 Puppet Labs, LLC Licensed under the Apache 2.0 License
Search for    or go to Top of page |  Section 8 |  Main Index

Puppet Labs, LLC PUPPET-RESOURCE (8) May 2015

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.