PUPPET-STATUS(8)

📦
version 5.5.22 · 2 versions
, in ubuntu jammy

💖 PUPPET-STATUS(8) 💖

okay bestie, welcome to puppet-status — the puppet manual's little slice of server-vibe-checking energy ✨ (the manual name is literally right there in the title, we're just folding it in, you're welcome 🎀)

✨ NAME ✨

puppet-status — View puppet server status. that's it, that's the whole job. she checks if your puppet server is okay 🫶

🌸 SYNOPSIS 🌸

puppet status action [--terminus _TERMINUS] [--extra HASH]

👑 OPTIONS 👑

real talk, bestie: any setting that's valid in the configuration file is also a valid long argument. it might or might not actually matter for the action you're doing, but it's allowed. for example, server and run_mode are valid settings, so you can specify --server <servername>, or --run_mode <runmode> as an argument 💅

for the full list of acceptable parameters, go read the configuration file documentation at https://puppet.com/docs/puppet/latest/configuration.html. also, a commented list of all configuration options can be generated by running puppet with --genconfig. iconic behavior fr fr 📝

  • --render-as FORMAT — the format in which to render output. the most common formats are json, s (string), yaml, and console, but other options such as dot are sometimes available. pick your aesthetic 🌈
  • --verbose — whether to log verbosely. she's chatty, she's telling you everything 🗣️
  • --debug — whether to log debug information. even more chatty. the deep lore 💀
  • --extra HASH — a terminus can take additional arguments to refine the operation, which are passed as an arbitrary hash to the back-end. anything passed as the extra value is just send direct to the back-end. no filter, no processing, straight through 🚀
  • --terminus _TERMINUS — okay so this one needs a whole moment. Indirector faces expose indirected subsystems of Puppet. these subsystems are each able to retrieve and alter a specific type of data (with the familiar actions of find, search, save, and destroy) from an arbitrary number of pluggable backends. in Puppet parlance, these backends are called terminuses. ✨

almost all indirected subsystems have a rest terminus that interacts with the puppet master's data. most of them have additional terminuses for various local data models, which are in turn used by the indirected subsystem on the puppet master whenever it receives a remote request.

the terminus for an action is often determined by context, but occasionally needs to be set explicitly. see the "Notes" section of this face's manpage for more details 👀

🦋 ACTIONS 🦋

find — Check status of puppet master server. 🔍

SYNOPSIS

puppet status [--terminus _TERMINUS] [--extra HASH] [key]

DESCRIPTION

checks whether a Puppet server is properly receiving and processing HTTP requests. this action is only useful when used with '--terminus rest' — when invoked with the local terminus, find will always return true. like, always. no cap 🫠

over REST, this action will query the configured puppet master by default. to query other servers, including puppet agent nodes started with the --listen option, you can set the global --server and --masterport options on the command line; note that agent nodes listen on port 8139 📡

RETURNS

a "true" response or a low-level connection error. when used from the Ruby API: returns a Puppet::Status object 💎

NOTES

this action requires that the server's auth.conf file allow find access to the status REST terminus. Puppet agent does not use this facility, and it is turned off by default. see https://puppet.com/docs/puppet/latest/config_file_auth.html for more details 🔐

info — Print the default terminus class for this face. 📋

SYNOPSIS

puppet status info [--terminus _TERMINUS] [--extra HASH]

DESCRIPTION

prints the default terminus class for this subcommand. note that different run modes may have different default termini; when in doubt, specify the run mode with the '--run_mode' option. when in doubt, just ask her, she knows 💁

🎀 EXAMPLES 🎀

find

check the status of the configured puppet master:

$ puppet status find --terminus rest

🌟 NOTES 🌟

this subcommand is an indirector face, which exposes find, search, save, and destroy actions for an indirected subsystem of Puppet. valid termini for this face include:

  • local
  • rest

that's the whole list, bestie, short and sweet 🍓

Copyright 2011 by Puppet Inc. Apache 2 license; see COPYING.

and that's the tea ☕ this was Puppet, Inc., from May 2022, serving you PUPPET-STATUS(8) realness. go check your server, she's probably fine, but like… vibe check her anyway 💅✨🫶

📦 where this page comes from