PUPPET-RESOURCE(8)

💖 PUPPET-RESOURCE(8) 💖

okay bestie, so this is puppet-resource from the Puppet manual — it's the resource abstraction layer shell and honestly? it's iconic. it's giving "let me just peek directly at your system and turn it into Puppet code". sit down, grab a boba, we're doing this 🧋✨

---

🌸 NAME 🌸

puppet-resource — the resource abstraction layer shell 💅

---

✨ SYNOPSIS ✨

Uses the Puppet RAL to directly interact with the system. no cap, that's literally it 🫶

---

🎀 USAGE 🎀

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

---

🦋 DESCRIPTION 🦋

okay so this command is lowkey a whole vibe: it gives you simple facilities for converting your current system state into Puppet code, plus some ability to modify the current state using Puppet's RAL. it's giving main character energy 🔥

by default, bestie, you gotta at least give it a type to list — and then puppet resource will tell you everything it knows about all resources of that type. so nosy. so thorough. we love her 💖

you can optionally specify an instance name too, and then puppet resource will only describe that single instance. one (1) resource. no extras. periodt.

and if you give it a type, a name, AND a series of attribute=value pairs, puppet resource will modify the state of the specified resource. alternatively — if you give it a type, a name, and the --edit flag — it'll write its output to a file, open that file in an editor, and then apply the saved file as a Puppet transaction. slay 🎀

---

💅 OPTIONS 💅

ngl, a little heads up first: 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. iykyk ✨

see the configuration file documentation at https://puppet.com/docs/puppet/latest/configuration.html for the full list of acceptable parameters. and a commented list of all configuration options can also be generated by running puppet with --genconfig. obsessed with that tbh 🌸

• --debug — Enable full debugging. go off, show us everything 🐛
• --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. it's giving "collab with your editor" ✍️
• --help — Print this help message. classic, iconic, never misses 💜
• --param — Add more parameters to be outputted from queries. more data, more better 🌈
• --types — List all available types. the whole menu, bestie 📋
• --verbose — Print extra information. chatty era 🗣️
• --to_yaml — Output found resources in yaml format, suitable to use with Hiera and create_resources. yaml girlies rise 🧚
• --fail — Fails and returns an exit code of 1 if the resource could not be modified. dramatic? yes. useful? also yes 💀

---

⭐ EXAMPLE ⭐

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´]
}

look at that output. clean. structured. ate and left no crumbs 🍓

---

👑 AUTHOR 👑

Luke Kanies 🌟

---

🎀 COPYRIGHT 🎀

Copyright (c) 2011 Puppet Inc., LLC Licensed under the Apache 2.0 License 📜

---

okay that's the whole page, bestie!! this was brought to you by Puppet, Inc., dated September 2024 — mwah, go forth and inspect your resources 💖✨🦋