openvox 8.19.0

data/man/man8/puppet-agent.8

@@ -0,0 +1,135 @@
+.\" generated with Ronn-NG/v0.10.1
+.\" http://github.com/apjanke/ronn-ng/tree/0.10.1
+.TH "PUPPET\-AGENT" "8" "January 2025" "Vox Pupuli" "OpenVox manual"
+.SH "NAME"
+\fBpuppet\-agent\fR \- The puppet agent daemon provided by OpenVox
+.SH "SYNOPSIS"
+Retrieves the client configuration from the OpenVox server and applies it to the local host\.
+.P
+This service may be run as a daemon, run periodically using cron (or something similar), or run interactively for testing purposes\.
+.SH "USAGE"
+puppet agent [\-\-certname \fINAME\fR] [\-D|\-\-daemonize|\-\-no\-daemonize] [\-d|\-\-debug] [\-\-detailed\-exitcodes] [\-\-digest \fIDIGEST\fR] [\-\-disable [MESSAGE]] [\-\-enable] [\-\-fingerprint] [\-h|\-\-help] [\-l|\-\-logdest syslog|eventlog|\fIABS FILEPATH\fR|console] [\-\-serverport \fIPORT\fR] [\-\-noop] [\-o|\-\-onetime] [\-\-sourceaddress \fIIP_ADDRESS\fR] [\-t|\-\-test] [\-v|\-\-verbose] [\-V|\-\-version] [\-w|\-\-waitforcert \fISECONDS\fR]
+.SH "DESCRIPTION"
+This is the main puppet client\. Its job is to retrieve the local machine's configuration from a remote server and apply it\. In order to successfully communicate with the remote server, the client must have a certificate signed by a certificate authority that the server trusts; the recommended method for this, at the moment, is to run a certificate authority as part of the puppet server (which is the default)\. The client will connect and request a signed certificate, and will continue connecting until it receives one\.
+.P
+Once the client has a signed certificate, it will retrieve its configuration and apply it\.
+.SH "USAGE NOTES"
+\&'puppet agent' does its best to find a compromise between interactive use and daemon use\. If you run it with no arguments and no configuration, it goes into the background, attempts to get a signed certificate, and retrieves and applies its configuration every 30 minutes\.
+.P
+Some flags are meant specifically for interactive use \-\- in particular, 'test', 'tags' and 'fingerprint' are useful\.
+.P
+\&'\-\-test' runs once in the foreground with verbose logging, then exits\. It also exits if it can't get a valid catalog\. \fB\-\-test\fR includes the '\-\-detailed\-exitcodes' option by default and exits with one of the following exit codes:
+.IP "\(bu" 4
+0: The run succeeded with no changes or failures; the system was already in the desired state\.
+.IP "\(bu" 4
+1: The run failed, or wasn't attempted due to another run already in progress\.
+.IP "\(bu" 4
+2: The run succeeded, and some resources were changed\.
+.IP "\(bu" 4
+4: The run succeeded, and some resources failed\.
+.IP "\(bu" 4
+6: The run succeeded, and included both changes and failures\.
+.IP "" 0
+.P
+\&'\-\-tags' allows you to specify what portions of a configuration you want to apply\. Puppet elements are tagged with all of the class or definition names that contain them, and you can use the 'tags' flag to specify one of these names, causing only configuration elements contained within that class or definition to be applied\. This is very useful when you are testing new configurations \-\- for instance, if you are just starting to manage 'ntpd', you would put all of the new elements into an 'ntpd' class, and call puppet with '\-\-tags ntpd', which would only apply that small portion of the configuration during your testing, rather than applying the whole thing\.
+.P
+\&'\-\-fingerprint' is a one\-time flag\. In this mode 'puppet agent' runs once and displays on the console (and in the log) the current certificate (or certificate request) fingerprint\. Providing the '\-\-digest' option allows you to use a different digest algorithm to generate the fingerprint\. The main use is to verify that before signing a certificate request on the master, the certificate request the master received is the same as the one the client sent (to prevent against man\-in\-the\-middle attacks when signing certificates)\.
+.P
+\&'\-\-skip_tags' is a flag used to filter resources\. If this is set, then only resources not tagged with the specified tags will be applied\. Values must be comma\-separated\.
+.SH "OPTIONS"
+Note that any Puppet setting that's valid in the configuration file is also a valid long argument\. For example, 'server' is a valid setting, so you can specify '\-\-server \fIservername\fR' as an argument\. Boolean settings accept a '\-\-no\-' prefix to turn off a behavior, translating into '\-\-setting' and '\-\-no\-setting' pairs, such as \fB\-\-daemonize\fR and \fB\-\-no\-daemonize\fR\.
+.P
+See the configuration file documentation at https://puppet\.com/docs/puppet/latest/configuration\.html for the full list of acceptable settings\. A commented list of all settings can also be generated by running puppet agent with '\-\-genconfig'\.
+.IP "\(bu" 4
+\-\-certname: Set the certname (unique ID) of the client\. The master reads this unique identifying string, which is usually set to the node's fully\-qualified domain name, to determine which configurations the node will receive\. Use this option to debug setup problems or implement unusual node identification schemes\. (This is a Puppet setting, and can go in puppet\.conf\.)
+.IP "\(bu" 4
+\-\-daemonize: Send the process into the background\. This is the default\. (This is a Puppet setting, and can go in puppet\.conf\. Note the special 'no\-' prefix for boolean settings on the command line\.)
+.IP "\(bu" 4
+\-\-no\-daemonize: Do not send the process into the background\. (This is a Puppet setting, and can go in puppet\.conf\. Note the special 'no\-' prefix for boolean settings on the command line\.)
+.IP "\(bu" 4
+\-\-debug: Enable full debugging\.
+.IP "\(bu" 4
+\-\-detailed\-exitcodes: Provide extra information about the run via exit codes; works only if '\-\-test' or '\-\-onetime' is also specified\. If enabled, 'puppet agent' uses the following exit codes:
+.IP
+0: The run succeeded with no changes or failures; the system was already in the desired state\.
+.IP
+1: The run failed, or wasn't attempted due to another run already in progress\.
+.IP
+2: The run succeeded, and some resources were changed\.
+.IP
+4: The run succeeded, and some resources failed\.
+.IP
+6: The run succeeded, and included both changes and failures\.
+.IP "\(bu" 4
+\-\-digest: Change the certificate fingerprinting digest algorithm\. The default is SHA256\. Valid values depends on the version of OpenSSL installed, but will likely contain MD5, MD2, SHA1 and SHA256\.
+.IP "\(bu" 4
+\-\-disable: Disable working on the local system\. This puts a lock file in place, causing 'puppet agent' not to work on the system until the lock file is removed\. This is useful if you are testing a configuration and do not want the central configuration to override the local state until everything is tested and committed\.
+.IP
+Disable can also take an optional message that will be reported by the 'puppet agent' at the next disabled run\.
+.IP
+\&'puppet agent' uses the same lock file while it is running, so no more than one 'puppet agent' process is working at a time\.
+.IP
+\&'puppet agent' exits after executing this\.
+.IP "\(bu" 4
+\-\-enable: Enable working on the local system\. This removes any lock file, causing 'puppet agent' to start managing the local system again However, it continues to use its normal scheduling, so it might not start for another half hour\.
+.IP
+\&'puppet agent' exits after executing this\.
+.IP "\(bu" 4
+\-\-evaltrace: Logs each resource as it is being evaluated\. This allows you to interactively see exactly what is being done\. (This is a Puppet setting, and can go in puppet\.conf\. Note the special 'no\-' prefix for boolean settings on the command line\.)
+.IP "\(bu" 4
+\-\-fingerprint: Display the current certificate or certificate signing request fingerprint and then exit\. Use the '\-\-digest' option to change the digest algorithm used\.
+.IP "\(bu" 4
+\-\-help: Print this help message
+.IP "\(bu" 4
+\-\-job\-id: Attach the specified job id to the catalog request and the report used for this agent run\. This option only works when '\-\-onetime' is used\. When using Puppet Enterprise this flag should not be used as the orchestrator sets the job\-id for you and it must be unique\.
+.IP "\(bu" 4
+\-\-logdest: Where to send log messages\. Choose between 'syslog' (the POSIX syslog service), 'eventlog' (the Windows Event Log), 'console', or the path to a log file\. If debugging or verbosity is enabled, this defaults to 'console'\. Otherwise, it defaults to 'syslog' on POSIX systems and 'eventlog' on Windows\. Multiple destinations can be set using a comma separated list (eg: \fB/path/file1,console,/path/file2\fR)"
+.IP
+A path ending with '\.json' will receive structured output in JSON format\. The log file will not have an ending ']' automatically written to it due to the appending nature of logging\. It must be appended manually to make the content valid JSON\.
+.IP
+A path ending with '\.jsonl' will receive structured output in JSON Lines format\.
+.IP "\(bu" 4
+\-\-masterport: The port on which to contact the Puppet Server\. (This is a Puppet setting, and can go in puppet\.conf\. Deprecated in favor of the 'serverport' setting\.)
+.IP "\(bu" 4
+\-\-noop: Use 'noop' mode where the daemon runs in a no\-op or dry\-run mode\. This is useful for seeing what changes Puppet would make without actually executing the changes\. (This is a Puppet setting, and can go in puppet\.conf\. Note the special 'no\-' prefix for boolean settings on the command line\.)
+.IP "\(bu" 4
+\-\-onetime: Run the configuration once\. Runs a single (normally daemonized) Puppet run\. Useful for interactively running puppet agent when used in conjunction with the \-\-no\-daemonize option\. (This is a Puppet setting, and can go in puppet\.conf\. Note the special 'no\-' prefix for boolean settings on the command line\.)
+.IP "\(bu" 4
+\-\-serverport: The port on which to contact the Puppet Server\. (This is a Puppet setting, and can go in puppet\.conf\.)
+.IP "\(bu" 4
+\-\-sourceaddress: Set the source IP address for transactions\. This defaults to automatically selected\. (This is a Puppet setting, and can go in puppet\.conf\.)
+.IP "\(bu" 4
+\-\-test: Enable the most common options used for testing\. These are 'onetime', 'verbose', 'no\-daemonize', 'no\-usecacheonfailure', 'detailed\-exitcodes', 'no\-splay', and 'show_diff'\.
+.IP "\(bu" 4
+\-\-trace Prints stack traces on some errors\. (This is a Puppet setting, and can go in puppet\.conf\. Note the special 'no\-' prefix for boolean settings on the command line\.)
+.IP "\(bu" 4
+\-\-verbose: Turn on verbose reporting\.
+.IP "\(bu" 4
+\-\-version: Print the puppet version number and exit\.
+.IP "\(bu" 4
+\-\-waitforcert: This option only matters for daemons that do not yet have certificates and it is enabled by default, with a value of 120 (seconds)\. This causes 'puppet agent' to connect to the server every 2 minutes and ask it to sign a certificate request\. This is useful for the initial setup of a puppet client\. You can turn off waiting for certificates by specifying a time of 0\. (This is a Puppet setting, and can go in puppet\.conf\.)
+.IP "\(bu" 4
+\-\-write_catalog_summary After compiling the catalog saves the resource list and classes list to the node in the state directory named classes\.txt and resources\.txt (This is a Puppet setting, and can go in puppet\.conf\.)
+.IP "" 0
+.SH "EXAMPLE"
+.nf
+$ puppet agent \-\-server puppet\.domain\.com
+.fi
+.SH "DIAGNOSTICS"
+Puppet agent accepts the following signals:
+.TP
+SIGHUP
+Restart the puppet agent daemon\.
+.TP
+SIGINT and SIGTERM
+Shut down the puppet agent daemon\.
+.TP
+SIGUSR1
+Immediately retrieve and apply configurations from the puppet master\.
+.TP
+SIGUSR2
+Close file descriptors for log files and reopen them\. Used with logrotate\.
+.SH "AUTHOR"
+Luke Kanies
+.SH "COPYRIGHT"
+Copyright (c) 2011 Puppet Inc\. Copyright (c) 2024 Vox Pupuli Licensed under the Apache 2\.0 License

data/man/man8/puppet-apply.8

@@ -0,0 +1,67 @@
+.\" generated with Ronn-NG/v0.10.1
+.\" http://github.com/apjanke/ronn-ng/tree/0.10.1
+.TH "PUPPET\-APPLY" "8" "January 2025" "Vox Pupuli" "OpenVox manual"
+.SH "NAME"
+\fBpuppet\-apply\fR \- Apply Puppet manifests locally via OpenVox
+.SH "SYNOPSIS"
+Applies a standalone Puppet manifest to the local system\.
+.SH "USAGE"
+puppet apply [\-h|\-\-help] [\-V|\-\-version] [\-d|\-\-debug] [\-v|\-\-verbose] [\-e|\-\-execute] [\-\-detailed\-exitcodes] [\-L|\-\-loadclasses] [\-l|\-\-logdest syslog|eventlog|\fIABS FILEPATH\fR|console] [\-\-noop] [\-\-catalog \fIcatalog\fR] [\-\-write\-catalog\-summary] \fIfile\fR
+.SH "DESCRIPTION"
+This is the standalone puppet execution tool; use it to apply individual manifests\.
+.P
+When provided with a modulepath, via command line or config file, puppet apply can effectively mimic the catalog that would be served by OpenVox server with access to the same modules, although there are some subtle differences\. When combined with scheduling and an automated system for pushing manifests, this can be used to implement a serverless site\.
+.P
+Most users should use 'puppet agent' and 'puppet master' for site\-wide manifests\.
+.SH "OPTIONS"
+Any setting that's valid in the configuration file is a valid long argument for puppet apply\. For example, 'tags' is a valid setting, so you can specify '\-\-tags \fIclass\fR,\fItag\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\. You can generate a commented list of all configuration options by running puppet with '\-\-genconfig'\.
+.IP "\(bu" 4
+\-\-debug: Enable full debugging\.
+.IP "\(bu" 4
+\-\-detailed\-exitcodes: Provide extra information about the run via exit codes\. If enabled, 'puppet apply' will use the following exit codes:
+.IP
+0: The run succeeded with no changes or failures; the system was already in the desired state\.
+.IP
+1: The run failed\.
+.IP
+2: The run succeeded, and some resources were changed\.
+.IP
+4: The run succeeded, and some resources failed\.
+.IP
+6: The run succeeded, and included both changes and failures\.
+.IP "\(bu" 4
+\-\-help: Print this help message
+.IP "\(bu" 4
+\-\-loadclasses: Load any stored classes\. 'puppet agent' caches configured classes (usually at /etc/puppetlabs/puppet/classes\.txt), and setting this option causes all of those classes to be set in your puppet manifest\.
+.IP "\(bu" 4
+\-\-logdest: Where to send log messages\. Choose between 'syslog' (the POSIX syslog service), 'eventlog' (the Windows Event Log), 'console', or the path to a log file\. Defaults to 'console'\. Multiple destinations can be set using a comma separated list (eg: \fB/path/file1,console,/path/file2\fR)"
+.IP
+A path ending with '\.json' will receive structured output in JSON format\. The log file will not have an ending ']' automatically written to it due to the appending nature of logging\. It must be appended manually to make the content valid JSON\.
+.IP
+A path ending with '\.jsonl' will receive structured output in JSON Lines format\.
+.IP "\(bu" 4
+\-\-noop: Use 'noop' mode where Puppet runs in a no\-op or dry\-run mode\. This is useful for seeing what changes Puppet will make without actually executing the changes\.
+.IP "\(bu" 4
+\-\-execute: Execute a specific piece of Puppet code
+.IP "\(bu" 4
+\-\-test: Enable the most common options used for testing\. These are 'verbose', 'detailed\-exitcodes' and 'show_diff'\.
+.IP "\(bu" 4
+\-\-verbose: Print extra information\.
+.IP "\(bu" 4
+\-\-catalog: Apply a JSON catalog (such as one generated with 'puppet master \-\-compile')\. You can either specify a JSON file or pipe in JSON from standard input\.
+.IP "\(bu" 4
+\-\-write\-catalog\-summary After compiling the catalog saves the resource list and classes list to the node in the state directory named classes\.txt and resources\.txt
+.IP "" 0
+.SH "EXAMPLE"
+.nf
+$ puppet apply \-e 'notify { "hello world": }'
+$ puppet apply \-l /tmp/manifest\.log manifest\.pp
+$ puppet apply \-\-modulepath=/root/dev/modules \-e "include ntpd::server"
+$ puppet apply \-\-catalog catalog\.json
+.fi
+.SH "AUTHOR"
+Luke Kanies
+.SH "COPYRIGHT"
+Copyright (c) 2011 Puppet Inc\. Copyright (c) 2024 Vox Pupuli Licensed under the Apache 2\.0 License

data/man/man8/puppet-catalog.8

@@ -0,0 +1,194 @@
+.\" generated with Ronn-NG/v0.10.1
+.\" http://github.com/apjanke/ronn-ng/tree/0.10.1
+.TH "PUPPET\-CATALOG" "8" "January 2025" "Vox Pupuli" "OpenVox manual"
+.SH "NAME"
+\fBpuppet\-catalog\fR \- Compile, save, view, and convert catalogs\.
+.SH "SYNOPSIS"
+puppet catalog \fIaction\fR [\-\-terminus _TERMINUS]
+.SH "DESCRIPTION"
+This subcommand deals with catalogs, which are compiled per\-node artifacts generated from a set of Puppet manifests\. By default, it interacts with the compiling subsystem and compiles a catalog using the default manifest and \fBcertname\fR, but you can change the source of the catalog with the \fB\-\-terminus\fR option\. You can also choose to print any catalog in 'dot' format (for easy graph viewing with OmniGraffle or Graphviz) with '\-\-render\-as dot'\.
+.SH "OPTIONS"
+Note that any setting that's valid in the configuration file is also a valid long argument, although it may or may not be relevant to the present action\. For example, \fBserver\fR and \fBrun_mode\fR are valid settings, so you can specify \fB\-\-server <servername>\fR, or \fB\-\-run_mode <runmode>\fR as an argument\.
+.P
+See the configuration file documentation at \fIhttps://puppet\.com/docs/puppet/latest/configuration\.html\fR for the full list of acceptable parameters\. A commented list of all configuration options can also be generated by running puppet with \fB\-\-genconfig\fR\.
+.TP
+\-\-render\-as FORMAT
+The format in which to render output\. The most common formats are \fBjson\fR, \fBs\fR (string), \fByaml\fR, and \fBconsole\fR, but other options such as \fBdot\fR are sometimes available\.
+.TP
+\-\-verbose
+Whether to log verbosely\.
+.TP
+\-\-debug
+Whether to log debug information\.
+.TP
+\-\-terminus _TERMINUS
+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 \fBfind\fR, \fBsearch\fR, \fBsave\fR, and \fBdestroy\fR) from an arbitrary number of pluggable backends\. In Puppet parlance, these backends are called terminuses\.
+.IP
+Almost all indirected subsystems have a \fBrest\fR 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\.
+.IP
+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\.
+.SH "ACTIONS"
+.TP
+\fBapply\fR \- Find and apply a catalog\.
+\fBSYNOPSIS\fR
+.IP
+puppet catalog apply [\-\-terminus _TERMINUS]
+.IP
+\fBDESCRIPTION\fR
+.IP
+Finds and applies a catalog\. This action takes no arguments, but the source of the catalog can be managed with the \fB\-\-terminus\fR option\.
+.IP
+\fBRETURNS\fR
+.IP
+Nothing\. When used from the Ruby API, returns a Puppet::Transaction::Report object\.
+.TP
+\fBcompile\fR \- Compile a catalog\.
+\fBSYNOPSIS\fR
+.IP
+puppet catalog compile [\-\-terminus _TERMINUS]
+.IP
+\fBDESCRIPTION\fR
+.IP
+Compiles a catalog locally for a node, requiring access to modules, node classifier, etc\.
+.IP
+\fBRETURNS\fR
+.IP
+A serialized catalog\.
+.TP
+\fBdownload\fR \- Download this node's catalog from the puppet master server\.
+\fBSYNOPSIS\fR
+.IP
+puppet catalog download [\-\-terminus _TERMINUS]
+.IP
+\fBDESCRIPTION\fR
+.IP
+Retrieves a catalog from the puppet master and saves it to the local yaml cache\. This action always contacts the puppet master and will ignore alternate termini\.
+.IP
+The saved catalog can be used in any subsequent catalog action by specifying '\-\-terminus yaml' for that action\.
+.IP
+\fBRETURNS\fR
+.IP
+Nothing\.
+.IP
+\fBNOTES\fR
+.IP
+When used from the Ruby API, this action has a side effect of leaving Puppet::Resource::Catalog\.indirection\.terminus_class set to yaml\. The terminus must be explicitly re\-set for subsequent catalog actions\.
+.TP
+\fBfind\fR \- Retrieve the catalog for the node from which the command is run\.
+\fBSYNOPSIS\fR
+.IP
+puppet catalog find [\-\-terminus _TERMINUS] [\-\-facts_for_catalog] \fIcertname\fR, \fIfacts\fR
+.IP
+\fBDESCRIPTION\fR
+.IP
+Retrieve the catalog for the node from which the command is run\.
+.IP
+\fBOPTIONS\fR \fI\-\-facts_for_catalog\fR \- Not implemented for the CLI; facts are collected internally\.
+.IP
+\fBRETURNS\fR
+.IP
+A serialized catalog\. When used from the Ruby API, returns a Puppet::Resource::Catalog object\.
+.TP
+\fBinfo\fR \- Print the default terminus class for this face\.
+\fBSYNOPSIS\fR
+.IP
+puppet catalog info [\-\-terminus _TERMINUS]
+.IP
+\fBDESCRIPTION\fR
+.IP
+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\.
+.TP
+\fBsave\fR \- API only: create or overwrite an object\.
+\fBSYNOPSIS\fR
+.IP
+puppet catalog save [\-\-terminus _TERMINUS] \fIkey\fR
+.IP
+\fBDESCRIPTION\fR
+.IP
+API only: create or overwrite an object\. As the Faces framework does not currently accept data from STDIN, save actions cannot currently be invoked from the command line\.
+.TP
+\fBselect\fR \- Retrieve a catalog and filter it for resources of a given type\.
+\fBSYNOPSIS\fR
+.IP
+puppet catalog select [\-\-terminus _TERMINUS] \fIhost\fR \fIresource_type\fR
+.IP
+\fBDESCRIPTION\fR
+.IP
+Retrieves a catalog for the specified host, then searches it for all resources of the requested type\.
+.IP
+\fBRETURNS\fR
+.IP
+A list of resource references ("Type[title]")\. When used from the API, returns an array of Puppet::Resource objects excised from a catalog\.
+.IP
+\fBNOTES\fR
+.IP
+By default, this action will retrieve a catalog from Puppet's compiler subsystem; you must call the action with \fB\-\-terminus rest\fR if you wish to retrieve a catalog from the puppet master\.
+.IP
+FORMATTING ISSUES: This action cannot currently render useful yaml; instead, it returns an entire catalog\. Use json instead\.
+.SH "EXAMPLES"
+\fBapply\fR
+.P
+Apply the locally cached catalog:
+.P
+$ puppet catalog apply \-\-terminus yaml
+.P
+Retrieve a catalog from the master and apply it, in one step:
+.P
+$ puppet catalog apply \-\-terminus rest
+.P
+API example:
+.IP "" 4
+.nf
+# \|\.\|\.\|\.
+Puppet::Face[:catalog, '0\.0\.1']\.download
+# (Termini are singletons; catalog\.download has a side effect of
+# setting the catalog terminus to yaml)
+report  = Puppet::Face[:catalog, '0\.0\.1']\.apply
+# \|\.\|\.\|\.
+.fi
+.IP "" 0
+.P
+\fBcompile\fR
+.P
+Compile catalog for node 'mynode':
+.P
+$ puppet catalog compile mynode \-\-codedir \|\.\|\.\|\.
+.P
+\fBdownload\fR
+.P
+Retrieve and store a catalog:
+.P
+$ puppet catalog download
+.P
+API example:
+.IP "" 4
+.nf
+Puppet::Face[:plugin, '0\.0\.1']\.download
+Puppet::Face[:facts, '0\.0\.1']\.upload
+Puppet::Face[:catalog, '0\.0\.1']\.download
+# \|\.\|\.\|\.
+.fi
+.IP "" 0
+.P
+\fBselect\fR
+.P
+Ask the puppet master for a list of managed file resources for a node:
+.P
+$ puppet catalog select \-\-terminus rest somenode\.magpie\.lan file
+.SH "NOTES"
+This subcommand is an indirector face, which exposes \fBfind\fR, \fBsearch\fR, \fBsave\fR, and \fBdestroy\fR actions for an indirected subsystem of Puppet\. Valid termini for this face include:
+.IP "\(bu" 4
+\fBcompiler\fR
+.IP "\(bu" 4
+\fBjson\fR
+.IP "\(bu" 4
+\fBmsgpack\fR
+.IP "\(bu" 4
+\fBrest\fR
+.IP "\(bu" 4
+\fBstore_configs\fR
+.IP "\(bu" 4
+\fByaml\fR
+.IP "" 0
+.SH "COPYRIGHT AND LICENSE"
+Copyright 2011 by Puppet Inc\., Vox Pupuli Apache 2 license; see COPYING

data/man/man8/puppet-config.8

@@ -0,0 +1,103 @@
+.\" generated with Ronn-NG/v0.10.1
+.\" http://github.com/apjanke/ronn-ng/tree/0.10.1
+.TH "PUPPET\-CONFIG" "8" "January 2025" "Vox Pupuli" "OpenVox manual"
+.SH "NAME"
+\fBpuppet\-config\fR \- Interact with OpenVox's settings\.
+.SH "SYNOPSIS"
+puppet config \fIaction\fR [\-\-section SECTION_NAME]
+.SH "DESCRIPTION"
+This subcommand can inspect and modify settings from OpenVox's 'puppet\.conf' configuration file\. For documentation about individual settings, see https://puppet\.com/docs/puppet/latest/configuration\.html\.
+.SH "OPTIONS"
+Note that any setting that's valid in the configuration file is also a valid long argument, although it may or may not be relevant to the present action\. For example, \fBserver\fR and \fBrun_mode\fR are valid settings, so you can specify \fB\-\-server <servername>\fR, or \fB\-\-run_mode <runmode>\fR as an argument\.
+.P
+See the configuration file documentation at \fIhttps://puppet\.com/docs/puppet/latest/configuration\.html\fR for the full list of acceptable parameters\. A commented list of all configuration options can also be generated by running puppet with \fB\-\-genconfig\fR\.
+.TP
+\-\-render\-as FORMAT
+The format in which to render output\. The most common formats are \fBjson\fR, \fBs\fR (string), \fByaml\fR, and \fBconsole\fR, but other options such as \fBdot\fR are sometimes available\.
+.TP
+\-\-verbose
+Whether to log verbosely\.
+.TP
+\-\-debug
+Whether to log debug information\.
+.TP
+\-\-section SECTION_NAME
+The section of the puppet\.conf configuration file to interact with\.
+.IP
+The three most commonly used sections are 'main', 'server', and 'agent'\. 'Main' is the default, and is used by all OpenVox applications\. Other sections can override 'main' values for specific applications \-\- the 'server' section affects Puppet Server, and the 'agent' section affects puppet agent\.
+.IP
+Less commonly used is the 'user' section, which affects puppet apply\. Any other section will be treated as the name of a legacy environment (a deprecated feature), and can only include the 'manifest' and 'modulepath' settings\.
+.SH "ACTIONS"
+.TP
+\fBdelete\fR \- Delete an OpenVox setting\.
+\fBSYNOPSIS\fR
+.IP
+puppet config delete [\-\-section SECTION_NAME] \fIsetting\fR
+.IP
+\fBDESCRIPTION\fR
+.IP
+Deletes a setting from the specified section\. (The default is the section 'main')\.
+.IP
+\fBNOTES\fR
+.IP
+By default, this action deletes the configuration setting from the 'main' configuration domain\. Use the '\-\-section' flags to delete settings from other configuration domains\.
+.TP
+\fBprint\fR \- Examine OpenVox's current settings\.
+\fBSYNOPSIS\fR
+.IP
+puppet config print [\-\-section SECTION_NAME] all | \fIsetting\fR [\fIsetting\fR \|\.\|\.\|\.]
+.IP
+\fBDESCRIPTION\fR
+.IP
+Prints the value of a single setting or a list of settings\.
+.IP
+This action is a replacement interface to the information available with \fBpuppet <subcommand> \-\-configprint\fR\.
+.IP
+\fBNOTES\fR
+.IP
+By default, this action reads the general configuration in the 'main' section\. Use the '\-\-section' and '\-\-environment' flags to examine other configuration domains\.
+.TP
+\fBset\fR \- Set OpenVox's settings\.
+\fBSYNOPSIS\fR
+.IP
+puppet config set [\-\-section SECTION_NAME] [setting_name] [setting_value]
+.IP
+\fBDESCRIPTION\fR
+.IP
+Updates values in the \fBpuppet\.conf\fR configuration file\.
+.IP
+\fBNOTES\fR
+.IP
+By default, this action manipulates the configuration in the 'main' section\. Use the '\-\-section' flag to manipulate other configuration domains\.
+.SH "EXAMPLES"
+\fBdelete\fR
+.P
+Delete the setting 'setting_name' from the 'main' configuration domain:
+.P
+$ puppet config delete setting_name
+.P
+Delete the setting 'setting_name' from the 'server' configuration domain:
+.P
+$ puppet config delete setting_name \-\-section server
+.P
+\fBprint\fR
+.P
+Get puppet's runfile directory:
+.P
+$ puppet config print rundir
+.P
+Get a list of important directories from the server's config:
+.P
+$ puppet config print all \-\-section server | grep \-E "(path|dir)"
+.P
+\fBset\fR
+.P
+Set puppet's runfile directory:
+.P
+$ puppet config set rundir /var/run/puppetlabs
+.P
+Set the vardir for only the agent:
+.P
+$ puppet config set vardir /opt/puppetlabs/puppet/cache \-\-section agent
+.SH "COPYRIGHT AND LICENSE"
+Copyright 2011 by Puppet Inc\., Vox Pupuli Apache 2 license; see COPYING

data/man/man8/puppet-describe.8

@@ -0,0 +1,35 @@
+.\" generated with Ronn-NG/v0.10.1
+.\" http://github.com/apjanke/ronn-ng/tree/0.10.1
+.TH "PUPPET\-DESCRIBE" "8" "January 2025" "Vox Pupuli" "OpenVox manual"
+.SH "NAME"
+\fBpuppet\-describe\fR \- Display help about resource types available to OpenVox
+.SH "SYNOPSIS"
+Prints help about Puppet resource types, providers, and metaparameters installed on an OpenVox node\.
+.SH "USAGE"
+puppet describe [\-h|\-\-help] [\-s|\-\-short] [\-p|\-\-providers] [\-l|\-\-list] [\-m|\-\-meta]
+.SH "OPTIONS"
+.TP
+\-\-help
+Print this help text
+.TP
+\-\-providers
+Describe providers in detail for each type
+.TP
+\-\-list
+List all types
+.TP
+\-\-meta
+List all metaparameters
+.TP
+\-\-short
+List only parameters without detail
+.SH "EXAMPLE"
+.nf
+$ puppet describe \-\-list
+$ puppet describe file \-\-providers
+$ puppet describe user \-s \-m
+.fi
+.SH "AUTHOR"
+David Lutterkort
+.SH "COPYRIGHT"
+Copyright (c) 2011 Puppet Inc\. Copyright (c) 2024 Vox Pupuli Licensed under the Apache 2\.0 License

data/man/man8/puppet-device.8

@@ -0,0 +1,83 @@
+.\" generated with Ronn-NG/v0.10.1
+.\" http://github.com/apjanke/ronn-ng/tree/0.10.1
+.TH "PUPPET\-DEVICE" "8" "January 2025" "Vox Pupuli" "OpenVox manual"
+.SH "NAME"
+\fBpuppet\-device\fR \- Manage remote network devices via OpenVox
+.SH "SYNOPSIS"
+Retrieves catalogs from the OpenVox server and applies them to remote devices\.
+.P
+This subcommand can be run manually; or periodically using cron, a scheduled task, or a similar tool\.
+.SH "USAGE"
+puppet device [\-h|\-\-help] [\-v|\-\-verbose] [\-d|\-\-debug] [\-l|\-\-logdest syslog|\fIfile\fR|console] [\-\-detailed\-exitcodes] [\-\-deviceconfig \fIfile\fR] [\-w|\-\-waitforcert \fIseconds\fR] [\-\-libdir \fIdirectory\fR] [\-a|\-\-apply \fIfile\fR] [\-f|\-\-facts] [\-r|\-\-resource \fItype\fR [name]] [\-t|\-\-target \fIdevice\fR] [\-\-user=\fIuser\fR] [\-V|\-\-version]
+.SH "DESCRIPTION"
+Devices require a proxy OpenVox agent to request certificates, collect facts, retrieve and apply catalogs, and store reports\.
+.SH "USAGE NOTES"
+Devices managed by the puppet\-device subcommand on an OpenVox agent are configured in device\.conf, which is located at $confdir/device\.conf by default, and is configurable with the $deviceconfig setting\.
+.P
+The device\.conf file is an INI\-like file, with one section per device:
+.P
+[\fIDEVICE_CERTNAME\fR] type \fITYPE\fR url \fIURL\fR debug
+.P
+The section name specifies the certname of the device\.
+.P
+The values for the type and url properties are specific to each type of device\.
+.P
+The optional debug property specifies transport\-level debugging, and is limited to telnet and ssh transports\.
+.P
+See https://puppet\.com/docs/puppet/latest/config_file_device\.html for details\.
+.SH "OPTIONS"
+Note that any setting that's valid in the configuration file is also a valid long argument\. For example, 'server' is a valid configuration parameter, so you can specify '\-\-server \fIservername\fR' as an argument\.
+.TP
+\-\-help, \-h
+Print this help message
+.TP
+\-\-verbose, \-v
+Turn on verbose reporting\.
+.TP
+\-\-debug, \-d
+Enable full debugging\.
+.TP
+\-\-logdest, \-l
+Where to send log messages\. Choose between 'syslog' (the POSIX syslog service), 'console', or the path to a log file\. If debugging or verbosity is enabled, this defaults to 'console'\. Otherwise, it defaults to 'syslog'\. Multiple destinations can be set using a comma separated list (eg: \fB/path/file1,console,/path/file2\fR)"
+.IP
+A path ending with '\.json' will receive structured output in JSON format\. The log file will not have an ending ']' automatically written to it due to the appending nature of logging\. It must be appended manually to make the content valid JSON\.
+.TP
+\-\-detailed\-exitcodes
+Provide transaction information via exit codes\. If this is enabled, an exit code of '1' means at least one device had a compile failure, an exit code of '2' means at least one device had resource changes, and an exit code of '4' means at least one device had resource failures\. Exit codes of '3', '5', '6', or '7' means that a bitwise combination of the preceding exit codes happened\.
+.TP
+\-\-deviceconfig
+Path to the device config file for puppet device\. Default: $confdir/device\.conf
+.TP
+\-\-waitforcert, \-w
+This option only matters for targets that do not yet have certificates and it is enabled by default, with a value of 120 (seconds)\. This causes +puppet device+ to poll the server every 2 minutes and ask it to sign a certificate request\. This is useful for the initial setup of a target\. You can turn off waiting for certificates by specifying a time of 0\.
+.TP
+\-\-libdir
+Override the per\-device libdir with a local directory\. Specifying a libdir also disables pluginsync\. This is useful for testing\.
+.IP
+A path ending with '\.jsonl' will receive structured output in JSON Lines format\.
+.TP
+\-\-apply
+Apply a manifest against a remote target\. Target must be specified\.
+.TP
+\-\-facts
+Displays the facts of a remote target\. Target must be specified\.
+.TP
+\-\-resource
+Displays a resource state as Puppet code, roughly equivalent to \fBpuppet resource\fR\. Can be filtered by title\. Requires \-\-target be specified\.
+.TP
+\-\-target
+Target a specific device/certificate in the device\.conf\. Doing so will perform a device run against only that device/certificate\.
+.TP
+\-\-to_yaml
+Output found resources in yaml format, suitable to use with Hiera and create_resources\.
+.TP
+\-\-user
+The user to run as\.
+.SH "EXAMPLE"
+.nf
+  $ puppet device \-\-target remotehost \-\-verbose
+.fi
+.SH "AUTHOR"
+Brice Figureau
+.SH "COPYRIGHT"
+Copyright (c) 2011\-2018 Puppet Inc\., Copyright (c) 2024 Vox Pupuli Licensed under the Apache 2\.0 License

data/man/man8/puppet-doc.8

@@ -0,0 +1,30 @@
+.\" generated with Ronn-NG/v0.10.1
+.\" http://github.com/apjanke/ronn-ng/tree/0.10.1
+.TH "PUPPET\-DOC" "8" "January 2025" "Vox Pupuli" "OpenVox manual"
+.SH "NAME"
+\fBpuppet\-doc\fR \- Generate Puppet references for OpenVox
+.SH "SYNOPSIS"
+Generates a reference for all Puppet types\. Largely meant for internal use\. (Deprecated)
+.SH "USAGE"
+puppet doc [\-h|\-\-help] [\-l|\-\-list] [\-r|\-\-reference \fIreference\-name\fR]
+.SH "DESCRIPTION"
+This deprecated command generates a Markdown document to stdout describing all installed Puppet types or all allowable arguments to puppet executables\. It is largely meant for internal use and is used to generate the reference documents which can be posted to a website\.
+.P
+For Puppet module documentation (and all other use cases) this command has been superseded by the "puppet\-strings" module \- see https://github\.com/puppetlabs/puppetlabs\-strings for more information\.
+.P
+This command (puppet\-doc) will be removed once the puppetlabs internal documentation processing pipeline is completely based on puppet\-strings\.
+.SH "OPTIONS"
+.TP
+\-\-help
+Print this help message
+.TP
+\-\-reference
+Build a particular reference\. Get a list of references by running 'puppet doc \-\-list'\.
+.SH "EXAMPLE"
+.nf
+$ puppet doc \-r type > /tmp/type_reference\.markdown
+.fi
+.SH "AUTHOR"
+Luke Kanies
+.SH "COPYRIGHT"
+Copyright (c) 2011 Puppet Inc\. Copyright (c) 2024 Vox Pupuli Licensed under the Apache 2\.0 License