.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "PUPPET\-RESOURCE" "8" "September 2024" "Puppet, Inc." "Puppet manual"
.
.SH "NAME"
\fBpuppet\-resource\fR \- The resource abstraction layer shell
.
.SH "SYNOPSIS"
Uses the Puppet RAL to directly interact with the system\.
.
.SH "USAGE"
puppet resource [\-h|\-\-help] [\-d|\-\-debug] [\-v|\-\-verbose] [\-e|\-\-edit] [\-p|\-\-param \fIparameter\fR] [\-t|\-\-types] [\-y|\-\-to_yaml] \fItype\fR [\fIname\fR] [\fIattribute\fR=\fIvalue\fR \.\.\.]
.
.SH "DESCRIPTION"
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\.
.
.P
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\.
.
.P
If given a type, a name, and a series of \fIattribute\fR=\fIvalue\fR 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\.
.
.SH "OPTIONS"
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 \fIdirectory\fR\' as an argument\.
.
.P
See the configuration file documentation at https://puppet\.com/docs/puppet/latest/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\'\.
.
.TP
\-\-debug
Enable full debugging\.
.
.TP
\-\-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\.
.
.TP
\-\-help
Print this help message\.
.
.TP
\-\-param
Add more parameters to be outputted from queries\.
.
.TP
\-\-types
List all available types\.
.
.TP
\-\-verbose
Print extra information\.
.
.TP
\-\-to_yaml
Output found resources in yaml format, suitable to use with Hiera and create_resources\.
.
.TP
\-\-fail
Fails and returns an exit code of 1 if the resource could not be modified\.
.
.SH "EXAMPLE"
This example uses \fBpuppet resource\fR to return a Puppet configuration for the user \fBluke\fR:
.
.IP "" 4
.
.nf

$ 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\']
}
.
.fi
.
.IP "" 0
.
.SH "AUTHOR"
Luke Kanies
.
.SH "COPYRIGHT"
Copyright (c) 2011 Puppet Inc\., LLC Licensed under the Apache 2\.0 License