openvox 8.19.0

data/man/man8/puppet-lookup.8

@@ -0,0 +1,71 @@
+.\" generated with Ronn-NG/v0.10.1
+.\" http://github.com/apjanke/ronn-ng/tree/0.10.1
+.TH "PUPPET\-LOOKUP" "8" "January 2025" "Vox Pupuli" "OpenVox manual"
+.SH "NAME"
+\fBpuppet\-lookup\fR \- Interactive Hiera lookup for OpenVox
+.SH "SYNOPSIS"
+Does Hiera lookups from the command line\.
+.P
+Since this command needs access to your Hiera data, make sure to run it on a node that has a copy of that data\. This usually means logging into an OpenVox server node and running 'puppet lookup' with sudo\.
+.P
+The most common version of this command is:
+.P
+\&'puppet lookup \fIKEY\fR \-\-node \fINAME\fR \-\-environment \fIENV\fR \-\-explain'
+.SH "USAGE"
+puppet lookup [\-\-help] [\-\-type \fITYPESTRING\fR] [\-\-merge first|unique|hash|deep] [\-\-knock\-out\-prefix \fIPREFIX\-STRING\fR] [\-\-sort\-merged\-arrays] [\-\-merge\-hash\-arrays] [\-\-explain] [\-\-environment \fIENV\fR] [\-\-default \fIVALUE\fR] [\-\-node \fINODE\-NAME\fR] [\-\-facts \fIFILE\fR] [\-\-compile] [\-\-render\-as s|json|yaml|binary|msgpack] \fIkeys\fR
+.SH "DESCRIPTION"
+The lookup command is a CLI for Puppet's 'lookup()' function\. It searches your Hiera data and returns a value for the requested lookup key, so you can test and explore your data\. It is a modern replacement for the 'hiera' command\. Lookup uses the setting for global hiera\.yaml from puppet's config, and the environment to find the environment level hiera\.yaml as well as the resulting modulepath for the environment (for hiera\.yaml files in modules)\. Hiera usually relies on a node's facts to locate the relevant data sources\. By default, 'puppet lookup' uses facts from the node you run the command on, but you can get data for any other node with the '\-\-node \fINAME\fR' option\. If possible, the lookup command will use the requested node's real stored facts from PuppetDB; if PuppetDB isn't configured or you want to provide arbitrary fact values, you can pass alternate facts as a JSON or YAML file with '\-\-facts \fIFILE\fR'\.
+.P
+If you're debugging your Hiera data and want to see where values are coming from, use the '\-\-explain' option\.
+.P
+If '\-\-explain' isn't specified, lookup exits with 0 if a value was found and 1 otherwise\. With '\-\-explain', lookup always exits with 0 unless there is a major error\.
+.P
+You can provide multiple lookup keys to this command, but it only returns a value for the first found key, omitting the rest\.
+.P
+For more details about how Hiera works, see the Hiera documentation: https://puppet\.com/docs/puppet/latest/hiera_intro\.html
+.SH "OPTIONS"
+.IP "\(bu" 4
+\-\-help: Print this help message\.
+.IP "\(bu" 4
+\-\-explain Explain the details of how the lookup was performed and where the final value came from (or the reason no value was found)\.
+.IP "\(bu" 4
+\-\-node \fINODE\-NAME\fR Specify which node to look up data for; defaults to the node where the command is run\. Since Hiera's purpose is to provide different values for different nodes (usually based on their facts), you'll usually want to use some specific node's facts to explore your data\. If the node where you're running this command is configured to talk to PuppetDB, the command will use the requested node's most recent facts\. Otherwise, you can override facts with the '\-\-facts' option\.
+.IP "\(bu" 4
+\-\-facts \fIFILE\fR Specify a \.json or \.yaml file of key => value mappings to override the facts for this lookup\. Any facts not specified in this file maintain their original value\.
+.IP "\(bu" 4
+\-\-environment \fIENV\fR Like with most Puppet commands, you can specify an environment on the command line\. This is important for lookup because different environments can have different Hiera data\. This environment will be always be the one used regardless of any other factors\.
+.IP "\(bu" 4
+\-\-merge first|unique|hash|deep: Specify the merge behavior, overriding any merge behavior from the data's lookup_options\. 'first' returns the first value found\. 'unique' appends everything to a merged, deduplicated array\. 'hash' performs a simple hash merge by overwriting keys of lower lookup priority\. 'deep' performs a deep merge on values of Array and Hash type\. There are additional options that can be used with 'deep'\.
+.IP "\(bu" 4
+\-\-knock\-out\-prefix \fIPREFIX\-STRING\fR Can be used with the 'deep' merge strategy\. Specifies a prefix to indicate a value should be removed from the final result\.
+.IP "\(bu" 4
+\-\-sort\-merged\-arrays Can be used with the 'deep' merge strategy\. When this flag is used, all merged arrays are sorted\.
+.IP "\(bu" 4
+\-\-merge\-hash\-arrays Can be used with the 'deep' merge strategy\. When this flag is used, hashes WITHIN arrays are deep\-merged with their counterparts by position\.
+.IP "\(bu" 4
+\-\-explain\-options Explain whether a lookup_options hash affects this lookup, and how that hash was assembled\. (lookup_options is how Hiera configures merge behavior in data\.)
+.IP "\(bu" 4
+\-\-default \fIVALUE\fR A value to return if Hiera can't find a value in data\. For emulating calls to the 'lookup()' function that include a default\.
+.IP "\(bu" 4
+\-\-type \fITYPESTRING\fR: Assert that the value has the specified type\. For emulating calls to the 'lookup()' function that include a data type\.
+.IP "\(bu" 4
+\-\-compile Perform a full catalog compilation prior to the lookup\. If your hierarchy and data only use the $facts, $trusted, and $server_facts variables, you don't need this option; however, if your Hiera configuration uses arbitrary variables set by a Puppet manifest, you might need this option to get accurate data\. No catalog compilation takes place unless this flag is given\.
+.IP "\(bu" 4
+\-\-render\-as s|json|yaml|binary|msgpack Specify the output format of the results; "s" means plain text\. The default when producing a value is yaml and the default when producing an explanation is s\.
+.IP "" 0
+.SH "EXAMPLE"
+To look up 'key_name' using the Puppet Server node's facts: $ puppet lookup key_name
+.P
+To look up 'key_name' using the Puppet Server node's arbitrary variables from a manifest, and classify the node if applicable: $ puppet lookup key_name \-\-compile
+.P
+To look up 'key_name' using the Puppet Server node's facts, overridden by facts given in a file: $ puppet lookup key_name \-\-facts fact_file\.yaml
+.P
+To look up 'key_name' with agent\.local's facts: $ puppet lookup \-\-node agent\.local key_name
+.P
+To get the first value found for 'key_name_one' and 'key_name_two' with agent\.local's facts while merging values and knocking out the prefix 'foo' while merging: $ puppet lookup \-\-node agent\.local \-\-merge deep \-\-knock\-out\-prefix foo key_name_one key_name_two
+.P
+To lookup 'key_name' with agent\.local's facts, and return a default value of 'bar' if nothing was found: $ puppet lookup \-\-node agent\.local \-\-default bar key_name
+.P
+To see an explanation of how the value for 'key_name' would be found, using agent\.local's facts: $ puppet lookup \-\-node agent\.local \-\-explain key_name
+.SH "COPYRIGHT"
+Copyright (c) 2015 Puppet Inc\. Copyright (c) 2024 Vox Pupuli Licensed under the Apache 2\.0 License

data/man/man8/puppet-module.8

@@ -0,0 +1,220 @@
+.\" generated with Ronn-NG/v0.10.1
+.\" http://github.com/apjanke/ronn-ng/tree/0.10.1
+.TH "PUPPET\-MODULE" "8" "January 2025" "Vox Pupuli" "OpenVox manual"
+.SH "NAME"
+\fBpuppet\-module\fR \- Creates, installs and searches for modules on the Puppet Forge\.
+.SH "SYNOPSIS"
+puppet module \fIaction\fR [\-\-environment production ] [\-\-modulepath ]
+.SH "DESCRIPTION"
+This subcommand can find, install, and manage modules from the Puppet Forge, a repository of user\-contributed Puppet code\. It can also generate empty modules, and prepare locally developed modules for release on the Forge\.
+.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
+\-\-environment production
+The environment in which Puppet is running\. For clients, such as \fBpuppet agent\fR, this determines the environment itself, which Puppet uses to find modules and much more\. For servers, such as \fBpuppet server\fR, this provides the default environment for nodes that Puppet knows nothing about\.
+.IP
+When defining an environment in the \fB[agent]\fR section, this refers to the environment that the agent requests from the primary server\. The environment doesn't have to exist on the local filesystem because the agent fetches it from the primary server\. This definition is used when running \fBpuppet agent\fR\.
+.IP
+When defined in the \fB[user]\fR section, the environment refers to the path that Puppet uses to search for code and modules related to its execution\. This requires the environment to exist locally on the filesystem where puppet is being executed\. Puppet subcommands, including \fBpuppet module\fR and \fBpuppet apply\fR, use this definition\.
+.IP
+Given that the context and effects vary depending on the config section \fIhttps://puppet\.com/docs/puppet/latest/config_file_main\.html#config\-sections\fR in which the \fBenvironment\fR setting is defined, do not set it globally\.
+.TP
+\-\-modulepath
+The search path for modules, as a list of directories separated by the system path separator character\. (The POSIX path separator is ':', and the Windows path separator is ';'\.)
+.IP
+Setting a global value for \fBmodulepath\fR in puppet\.conf is not allowed (but it can be overridden from the commandline)\. Please use directory environments instead\. If you need to use something other than the default modulepath of \fB<ACTIVE ENVIRONMENT'S MODULES DIR>:$basemodulepath\fR, you can set \fBmodulepath\fR in environment\.conf\. For more info, see \fIhttps://puppet\.com/docs/puppet/latest/environments_about\.html\fR
+.SH "ACTIONS"
+.TP
+\fBchanges\fR \- Show modified files of an installed module\.
+\fBSYNOPSIS\fR
+.IP
+puppet module changes \fIpath\fR
+.IP
+\fBDESCRIPTION\fR
+.IP
+Shows any files in a module that have been modified since it was installed\. This action compares the files on disk to the md5 checksums included in the module's checksums\.json or, if that is missing, in metadata\.json\.
+.IP
+\fBRETURNS\fR
+.IP
+Array of strings representing paths of modified files\.
+.TP
+\fBinstall\fR \- Install a module from the Puppet Forge or a release archive\.
+\fBSYNOPSIS\fR
+.IP
+puppet module install [\-\-force | \-f] [\-\-target\-dir DIR | \-i DIR] [\-\-ignore\-dependencies] [\-\-version VER | \-v VER] \fIname\fR
+.IP
+\fBDESCRIPTION\fR
+.IP
+Installs a module from the Puppet Forge or from a release archive file\. Note: Module install uses MD5 checksums, which are prohibited on FIPS enabled systems\.
+.IP
+The specified module will be installed into the directory specified with the \fB\-\-target\-dir\fR option, which defaults to the first directory in the modulepath\.
+.IP
+\fBOPTIONS\fR \fI\-\-force\fR | \fI\-f\fR \- Force overwrite of existing module, if any\. Implies \-\-ignore\-dependencies\.
+.IP
+\fI\-\-ignore\-dependencies\fR \- Do not attempt to install dependencies\. Implied by \-\-force\.
+.IP
+\fI\-\-target\-dir DIR\fR | \fI\-i DIR\fR \- The directory into which modules are installed; defaults to the first directory in the modulepath\.
+.IP
+Specifying this option will change the installation directory, and will use the existing modulepath when checking for dependencies\. If you wish to check a different set of directories for dependencies, you must also use the \fB\-\-environment\fR or \fB\-\-modulepath\fR options\.
+.IP
+\fI\-\-version VER\fR | \fI\-v VER\fR \- Module version to install; can be an exact version or a requirement string, eg '>= 1\.0\.3'\. Defaults to latest version\.
+.IP
+\fBRETURNS\fR
+.IP
+Pathname object representing the path to the installed module\.
+.TP
+\fBlist\fR \- List installed modules
+\fBSYNOPSIS\fR
+.IP
+puppet module list [\-\-tree]
+.IP
+\fBDESCRIPTION\fR
+.IP
+Lists the installed puppet modules\. By default, this action scans the modulepath from puppet\.conf's \fB[main]\fR block; use the \-\-modulepath option to change which directories are scanned\.
+.IP
+The output of this action includes information from the module's metadata, including version numbers and unmet module dependencies\.
+.IP
+\fBOPTIONS\fR \fI\-\-tree\fR \- Whether to show dependencies as a tree view
+.IP
+\fBRETURNS\fR
+.IP
+hash of paths to module objects
+.TP
+\fBuninstall\fR \- Uninstall a puppet module\.
+\fBSYNOPSIS\fR
+.IP
+puppet module uninstall [\-\-force | \-f] [\-\-ignore\-changes | \-c] [\-\-version=] \fIname\fR
+.IP
+\fBDESCRIPTION\fR
+.IP
+Uninstalls a puppet module from the modulepath (or a specific target directory)\. Note: Module uninstall uses MD5 checksums, which are prohibited on FIPS enabled systems\.
+.IP
+\fBOPTIONS\fR \fI\-\-force\fR | \fI\-f\fR \- Force the uninstall of an installed module even if there are local changes or the possibility of causing broken dependencies\.
+.IP
+\fI\-\-ignore\-changes\fR | \fI\-c\fR \- Uninstall an installed module even if there are local changes to it\. (Implied by \-\-force\.)
+.IP
+\fI\-\-version=\fR \- The version of the module to uninstall\. When using this option, a module matching the specified version must be installed or else an error is raised\.
+.IP
+\fBRETURNS\fR
+.IP
+Hash of module objects representing uninstalled modules and related errors\.
+.TP
+\fBupgrade\fR \- Upgrade a puppet module\.
+\fBSYNOPSIS\fR
+.IP
+puppet module upgrade [\-\-force | \-f] [\-\-ignore\-dependencies] [\-\-ignore\-changes | \-c] [\-\-version=] \fIname\fR
+.IP
+\fBDESCRIPTION\fR
+.IP
+Upgrades a puppet module\. Note: Module upgrade uses MD5 checksums, which are prohibited on FIPS enabled systems\.
+.IP
+\fBOPTIONS\fR \fI\-\-force\fR | \fI\-f\fR \- Force the upgrade of an installed module even if there are local changes or the possibility of causing broken dependencies\. Implies \-\-ignore\-dependencies\.
+.IP
+\fI\-\-ignore\-changes\fR | \fI\-c\fR \- Upgrade an installed module even if there are local changes to it\. (Implied by \-\-force\.)
+.IP
+\fI\-\-ignore\-dependencies\fR \- Do not attempt to install dependencies\. Implied by \-\-force\.
+.IP
+\fI\-\-version=\fR \- The version of the module to upgrade to\.
+.IP
+\fBRETURNS\fR
+.IP
+Hash
+.SH "EXAMPLES"
+\fBchanges\fR
+.P
+Show modified files of an installed module:
+.P
+$ puppet module changes /etc/puppetlabs/code/modules/vcsrepo/ warning: 1 files modified lib/puppet/provider/vcsrepo\.rb
+.P
+\fBinstall\fR
+.P
+Install a module:
+.P
+$ puppet module install puppetlabs\-vcsrepo Preparing to install into /etc/puppetlabs/code/modules \|\.\|\.\|\. Downloading from https://forgeapi\.puppet\.com \|\.\|\.\|\. Installing \-\- do not interrupt \|\.\|\.\|\. /etc/puppetlabs/code/modules └── puppetlabs\-vcsrepo (v0\.0\.4)
+.P
+Install a module to a specific environment:
+.P
+$ puppet module install puppetlabs\-vcsrepo \-\-environment development Preparing to install into /etc/puppetlabs/code/environments/development/modules \|\.\|\.\|\. Downloading from https://forgeapi\.puppet\.com \|\.\|\.\|\. Installing \-\- do not interrupt \|\.\|\.\|\. /etc/puppetlabs/code/environments/development/modules └── puppetlabs\-vcsrepo (v0\.0\.4)
+.P
+Install a specific module version:
+.P
+$ puppet module install puppetlabs\-vcsrepo \-v 0\.0\.4 Preparing to install into /etc/puppetlabs/modules \|\.\|\.\|\. Downloading from https://forgeapi\.puppet\.com \|\.\|\.\|\. Installing \-\- do not interrupt \|\.\|\.\|\. /etc/puppetlabs/code/modules └── puppetlabs\-vcsrepo (v0\.0\.4)
+.P
+Install a module into a specific directory:
+.P
+$ puppet module install puppetlabs\-vcsrepo \-\-target\-dir=/opt/puppetlabs/puppet/modules Preparing to install into /opt/puppetlabs/puppet/modules \|\.\|\.\|\. Downloading from https://forgeapi\.puppet\.com \|\.\|\.\|\. Installing \-\- do not interrupt \|\.\|\.\|\. /opt/puppetlabs/puppet/modules └── puppetlabs\-vcsrepo (v0\.0\.4)
+.P
+Install a module into a specific directory and check for dependencies in other directories:
+.P
+$ puppet module install puppetlabs\-vcsrepo \-\-target\-dir=/opt/puppetlabs/puppet/modules \-\-modulepath /etc/puppetlabs/code/modules Preparing to install into /opt/puppetlabs/puppet/modules \|\.\|\.\|\. Downloading from https://forgeapi\.puppet\.com \|\.\|\.\|\. Installing \-\- do not interrupt \|\.\|\.\|\. /opt/puppetlabs/puppet/modules └── puppetlabs\-vcsrepo (v0\.0\.4)
+.P
+Install a module from a release archive:
+.P
+$ puppet module install puppetlabs\-vcsrepo\-0\.0\.4\.tar\.gz Preparing to install into /etc/puppetlabs/code/modules \|\.\|\.\|\. Downloading from https://forgeapi\.puppet\.com \|\.\|\.\|\. Installing \-\- do not interrupt \|\.\|\.\|\. /etc/puppetlabs/code/modules └── puppetlabs\-vcsrepo (v0\.0\.4)
+.P
+Install a module from a release archive and ignore dependencies:
+.P
+$ puppet module install puppetlabs\-vcsrepo\-0\.0\.4\.tar\.gz \-\-ignore\-dependencies Preparing to install into /etc/puppetlabs/code/modules \|\.\|\.\|\. Installing \-\- do not interrupt \|\.\|\.\|\. /etc/puppetlabs/code/modules └── puppetlabs\-vcsrepo (v0\.0\.4)
+.P
+\fBlist\fR
+.P
+List installed modules:
+.P
+$ puppet module list /etc/puppetlabs/code/modules ├── bodepd\-create_resources (v0\.0\.1) ├── puppetlabs\-bacula (v0\.0\.2) ├── puppetlabs\-mysql (v0\.0\.1) ├── puppetlabs\-sqlite (v0\.0\.1) └── puppetlabs\-stdlib (v2\.2\.1) /opt/puppetlabs/puppet/modules (no modules installed)
+.P
+List installed modules in a tree view:
+.P
+$ puppet module list \-\-tree /etc/puppetlabs/code/modules └─┬ puppetlabs\-bacula (v0\.0\.2) ├── puppetlabs\-stdlib (v2\.2\.1) ├─┬ puppetlabs\-mysql (v0\.0\.1) │ └── bodepd\-create_resources (v0\.0\.1) └── puppetlabs\-sqlite (v0\.0\.1) /opt/puppetlabs/puppet/modules (no modules installed)
+.P
+List installed modules from a specified environment:
+.P
+$ puppet module list \-\-environment production /etc/puppetlabs/code/modules ├── bodepd\-create_resources (v0\.0\.1) ├── puppetlabs\-bacula (v0\.0\.2) ├── puppetlabs\-mysql (v0\.0\.1) ├── puppetlabs\-sqlite (v0\.0\.1) └── puppetlabs\-stdlib (v2\.2\.1) /opt/puppetlabs/puppet/modules (no modules installed)
+.P
+List installed modules from a specified modulepath:
+.P
+$ puppet module list \-\-modulepath /opt/puppetlabs/puppet/modules /opt/puppetlabs/puppet/modules (no modules installed)
+.P
+\fBuninstall\fR
+.P
+Uninstall a module:
+.P
+$ puppet module uninstall puppetlabs\-ssh Removed /etc/puppetlabs/code/modules/ssh (v1\.0\.0)
+.P
+Uninstall a module from a specific directory:
+.P
+$ puppet module uninstall puppetlabs\-ssh \-\-modulepath /opt/puppetlabs/puppet/modules Removed /opt/puppetlabs/puppet/modules/ssh (v1\.0\.0)
+.P
+Uninstall a module from a specific environment:
+.P
+$ puppet module uninstall puppetlabs\-ssh \-\-environment development Removed /etc/puppetlabs/code/environments/development/modules/ssh (v1\.0\.0)
+.P
+Uninstall a specific version of a module:
+.P
+$ puppet module uninstall puppetlabs\-ssh \-\-version 2\.0\.0 Removed /etc/puppetlabs/code/modules/ssh (v2\.0\.0)
+.P
+\fBupgrade\fR
+.P
+upgrade an installed module to the latest version
+.P
+$ puppet module upgrade puppetlabs\-apache /etc/puppetlabs/puppet/modules └── puppetlabs\-apache (v1\.0\.0 \-> v2\.4\.0)
+.P
+upgrade an installed module to a specific version
+.P
+$ puppet module upgrade puppetlabs\-apache \-\-version 2\.1\.0 /etc/puppetlabs/puppet/modules └── puppetlabs\-apache (v1\.0\.0 \-> v2\.1\.0)
+.P
+upgrade an installed module for a specific environment
+.P
+$ puppet module upgrade puppetlabs\-apache \-\-environment test /etc/puppetlabs/code/environments/test/modules └── puppetlabs\-apache (v1\.0\.0 \-> v2\.4\.0)
+.SH "COPYRIGHT AND LICENSE"
+Copyright 2012 by Puppet Inc\., Vox Pupuli Apache 2 license; see COPYING

data/man/man8/puppet-node.8

@@ -0,0 +1,142 @@
+.\" generated with Ronn-NG/v0.10.1
+.\" http://github.com/apjanke/ronn-ng/tree/0.10.1
+.TH "PUPPET\-NODE" "8" "January 2025" "Vox Pupuli" "OpenVox manual"
+.SH "NAME"
+\fBpuppet\-node\fR \- View and manage node definitions\.
+.SH "SYNOPSIS"
+puppet node \fIaction\fR [\-\-terminus _TERMINUS]
+.SH "DESCRIPTION"
+This subcommand interacts with node objects, which are used by OpenVox to build a catalog\. A node object consists of the node's facts, environment, node parameters (exposed in the parser as top\-scope variables), and classes\.
+.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
+\fBclean\fR \- Clean up signed certs, cached facts, node objects, and reports for a node stored by the puppetmaster
+\fBSYNOPSIS\fR
+.IP
+puppet node clean [\-\-terminus _TERMINUS] \fIhost1\fR [\fIhost2\fR \|\.\|\.\|\.]
+.IP
+\fBDESCRIPTION\fR
+.IP
+Cleans up the following information a puppet master knows about a node:
+.IP
+\fISigned certificates\fR \- ($vardir/ssl/ca/signed/node\.domain\.pem)
+.IP
+\fICached facts\fR \- ($vardir/yaml/facts/node\.domain\.yaml)
+.IP
+\fICached node objects\fR \- ($vardir/yaml/node/node\.domain\.yaml)
+.IP
+\fIReports\fR \- ($vardir/reports/node\.domain)
+.IP
+NOTE: this action now cleans up certs via Puppet Server's CA API\. A running server is required for certs to be cleaned\.
+.TP
+\fBdecrypt\fR \- Decrypt a value using the agent's own certificate
+\fBSYNOPSIS\fR
+.IP
+puppet node decrypt [\-\-terminus _TERMINUS] [\-d DATA | \-\-data DATA] [\-e VARIABLE | \-\-env VARIABLE]
+.IP
+\fBDESCRIPTION\fR
+.IP
+Decrypt a value using the agent's own certificate\. You have three ways to pass data for decryption\. You can pass it directly on the command line (if your kernel allows command strings that long), you can set it in an environment variable and pass the name of the variable, or you can pipe it using STDIN\.
+.IP
+\fBOPTIONS\fR \fI\-d DATA\fR | \fI\-\-data DATA\fR \- An string of data to decrypt
+.IP
+\fI\-e VARIABLE\fR | \fI\-\-env VARIABLE\fR \- An environment variable containing data to decrypt
+.TP
+\fBencrypt\fR \- Encrypt a value using a specified agent's certificate
+\fBSYNOPSIS\fR
+.IP
+puppet node encrypt [\-\-terminus _TERMINUS] [\-t CERTNAME | \-\-target CERTNAME] \fIstring\fR
+.IP
+\fBDESCRIPTION\fR
+.IP
+Encrypt a value using a specified agent's certificate useful for pasting into a manifest for a node_encrypted_file resource type, or for a data value for a datacat fragment\.
+.IP
+This will only run properly on a CA node with access to each node's signed public certificate\.
+.IP
+\fBOPTIONS\fR \fI\-t CERTNAME\fR | \fI\-\-target CERTNAME\fR \- Which agent to encrypt for
+.TP
+\fBfind\fR \- Retrieve a node object\.
+\fBSYNOPSIS\fR
+.IP
+puppet node find [\-\-terminus _TERMINUS] \fIhost\fR
+.IP
+\fBDESCRIPTION\fR
+.IP
+Retrieve a node object\.
+.IP
+\fBRETURNS\fR
+.IP
+A hash containing the node's \fBclasses\fR, \fBenvironment\fR, \fBexpiration\fR, \fBname\fR, \fBparameters\fR (its facts, combined with any ENC\-set parameters), and \fBtime\fR\. When used from the Ruby API: a Puppet::Node object\.
+.IP
+RENDERING ISSUES: Rendering as string and json are currently broken; node objects can only be rendered as yaml\.
+.TP
+\fBinfo\fR \- Print the default terminus class for this face\.
+\fBSYNOPSIS\fR
+.IP
+puppet node 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\.
+.SH "EXAMPLES"
+\fBdecrypt\fR
+.P
+$ puppet node decrypt \-\-data \fIencrypted blob of data\fR $ puppet node decrypt \-\-env \fIenvironment variable containing blob of encrypted data\fR $ echo \fIencrypted blob of data\fR | puppet node decrypt $ cat /file/with/encrypted/blob\.txt | puppet node decrypt
+.P
+\fBencrypt\fR
+.P
+$ puppet node encrypt \-\-certname testhost\.example\.com "some text to encrypt"
+.P
+\fBfind\fR
+.P
+Retrieve an "empty" (no classes, no ENC\-imposed parameters, and an environment of "production") node:
+.P
+$ puppet node find somenode\.puppetlabs\.lan \-\-terminus plain \-\-render\-as yaml
+.P
+Retrieve a node using the Puppet Server's configured ENC:
+.P
+$ puppet node find somenode\.puppetlabs\.lan \-\-terminus exec \-\-run_mode server \-\-render\-as yaml
+.P
+Retrieve the same node from the Puppet Server:
+.P
+$ puppet node find somenode\.puppetlabs\.lan \-\-terminus rest \-\-render\-as yaml
+.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
+\fBexec\fR
+.IP "\(bu" 4
+\fBjson\fR
+.IP "\(bu" 4
+\fBmemory\fR
+.IP "\(bu" 4
+\fBmsgpack\fR
+.IP "\(bu" 4
+\fBplain\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-parser.8

@@ -0,0 +1,87 @@
+.\" generated with Ronn-NG/v0.10.1
+.\" http://github.com/apjanke/ronn-ng/tree/0.10.1
+.TH "PUPPET\-PARSER" "8" "January 2025" "Vox Pupuli" "OpenVox manual"
+.SH "NAME"
+\fBpuppet\-parser\fR \- Interact directly with the parser\.
+.SH "SYNOPSIS"
+puppet parser \fIaction\fR
+.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\.
+.SH "ACTIONS"
+.IP "\(bu" 4
+\fBdump\fR \- Outputs a dump of the internal parse tree for debugging: \fBSYNOPSIS\fR
+.IP
+puppet parser dump [\-\-e \fIsource\fR] [\-\-[no\-]validate] [\-\-format \fIold, pn, or json\fR] [\-\-pretty] [\-\-format \fIold|pn|json\fR] [\-\-pretty] { \-e \fIsource\fR | [\fItemplates\fR \|\.\|\.\|\.] }
+.IP
+\fBDESCRIPTION\fR
+.IP
+This action parses and validates the Puppet DSL syntax without compiling a catalog or syncing any resources\.
+.IP
+The output format can be controlled using the \-\-format \fIold|pn|json\fR where:
+.IP "\(bu" 4
+\&'old' is the default, but now deprecated format which is not API\.
+.IP "\(bu" 4
+\&'pn' is the Puppet Extended S\-Expression Notation\.
+.IP "\(bu" 4
+\&'json' outputs the same graph as 'pn' but with JSON syntax\.
+.IP "" 0
+.IP
+The output will be "pretty printed" when the option \-\-pretty is given together with \-\-format 'pn' or 'json'\. This option has no effect on the 'old' format\.
+.IP
+The command accepts one or more manifests (\.pp) files, or an \-e followed by the puppet source text\. If no arguments are given, the stdin is read (unless it is attached to a terminal)
+.IP
+The output format of the dumped tree is intended for debugging purposes and is not API, it may change from time to time\.
+.IP
+\fBOPTIONS\fR \fI\-\-e <source\fR> \- dump one source expression given on the command line\.
+.IP
+\fI\-\-format <old, pn, or json\fR> \- Get result in 'old' (deprecated format), 'pn' (new format), or 'json' (new format in JSON)\.
+.IP
+\fI\-\-pretty\fR \- Pretty print output\. Only applicable together with \-\-format pn or json
+.IP
+\fI\-\-[no\-]validate\fR \- Whether or not to validate the parsed result, if no\-validate only syntax errors are reported
+.IP
+\fBRETURNS\fR
+.IP
+A dump of the resulting AST model unless there are syntax or validation errors\.
+.IP "\(bu" 4
+\fBvalidate\fR \- Validate the syntax of one or more Puppet manifests\.: \fBSYNOPSIS\fR
+.IP
+puppet parser validate [\fImanifest\fR] [\fImanifest\fR \|\.\|\.\|\.]
+.IP
+\fBDESCRIPTION\fR
+.IP
+This action validates Puppet DSL syntax without compiling a catalog or syncing any resources\. If no manifest files are provided, it will validate the default site manifest\.
+.IP
+When validating multiple issues per file are reported up to the settings of max_error, and max_warnings\. The processing stops after having reported issues for the first encountered file with errors\.
+.IP
+\fBRETURNS\fR
+.IP
+Nothing, or the first syntax error encountered\.
+.IP "" 0
+.SH "EXAMPLES"
+\fBvalidate\fR
+.P
+Validate the default site manifest at /etc/puppetlabs/puppet/manifests/site\.pp:
+.P
+$ puppet parser validate
+.P
+Validate two arbitrary manifest files:
+.P
+$ puppet parser validate init\.pp vhost\.pp
+.P
+Validate from STDIN:
+.P
+$ cat init\.pp | puppet parser validate
+.SH "COPYRIGHT AND LICENSE"
+Copyright 2014 by Puppet Inc\., Vox Pupuli Apache 2 license; see COPYING

data/man/man8/puppet-plugin.8

@@ -0,0 +1,50 @@
+.\" generated with Ronn-NG/v0.10.1
+.\" http://github.com/apjanke/ronn-ng/tree/0.10.1
+.TH "PUPPET\-PLUGIN" "8" "January 2025" "Vox Pupuli" "OpenVox manual"
+.SH "NAME"
+\fBpuppet\-plugin\fR \- Interact with the OpenVox plugin system\.
+.SH "SYNOPSIS"
+puppet plugin \fIaction\fR
+.SH "DESCRIPTION"
+This subcommand provides network access to the OpenVox server's store of plugins\.
+.P
+The OpenVox server serves Ruby code collected from the \fBlib\fR directories of its modules\. These plugins can be used on agent nodes to extend Facter and implement custom types and providers\. Plugins are normally downloaded by the OpenVox agent during the course of a run\.
+.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\.
+.SH "ACTIONS"
+.TP
+\fBdownload\fR \- Download plugins from the puppet master\.
+\fBSYNOPSIS\fR
+.IP
+puppet plugin download
+.IP
+\fBDESCRIPTION\fR
+.IP
+Downloads plugins from the configured OpenVox server\. Any plugins downloaded in this way will be used in all subsequent OpenVox activity\. This action modifies files on disk\.
+.IP
+\fBRETURNS\fR
+.IP
+A list of the files downloaded, or a confirmation that no files were downloaded\. When used from the Ruby API, this action returns an array of the files downloaded, which will be empty if none were retrieved\.
+.SH "EXAMPLES"
+\fBdownload\fR
+.P
+Retrieve plugins from the puppet master:
+.P
+$ puppet plugin download
+.P
+Retrieve plugins from the puppet master (API example):
+.P
+$ Puppet::Face[:plugin, '0\.0\.1']\.download
+.SH "COPYRIGHT AND LICENSE"
+Copyright 2011 by Puppet Inc\., Vox Pupuli Apache 2 license; see COPYING

data/man/man8/puppet-report.8

@@ -0,0 +1,84 @@
+.\" generated with Ronn-NG/v0.10.1
+.\" http://github.com/apjanke/ronn-ng/tree/0.10.1
+.TH "PUPPET\-REPORT" "8" "January 2025" "Vox Pupuli" "OpenVox manual"
+.SH "NAME"
+\fBpuppet\-report\fR \- Create, display, and submit reports\.
+.SH "SYNOPSIS"
+puppet report \fIaction\fR [\-\-terminus _TERMINUS]
+.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
+\fBinfo\fR \- Print the default terminus class for this face\.
+\fBSYNOPSIS\fR
+.IP
+puppet report 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: submit a report\.
+\fBSYNOPSIS\fR
+.IP
+puppet report save [\-\-terminus _TERMINUS] \fIreport\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\.
+.IP
+\fBRETURNS\fR
+.IP
+Nothing\.
+.TP
+\fBsubmit\fR \- API only: submit a report with error handling\.
+\fBSYNOPSIS\fR
+.IP
+puppet report submit [\-\-terminus _TERMINUS] \fIreport\fR
+.IP
+\fBDESCRIPTION\fR
+.IP
+API only: Submits a report to the OpenVox server\. This action is essentially a shortcut and wrapper for the \fBsave\fR action with the \fBrest\fR terminus, and provides additional details in the event of a failure\.
+.SH "EXAMPLES"
+\fBsave\fR
+.P
+From the implementation of \fBpuppet report submit\fR (API example):
+.P
+begin Puppet::Transaction::Report\.indirection\.terminus_class = :rest Puppet::Face[:report, "0\.0\.1"]\.save(report) Puppet\.notice "Uploaded report for #{report\.name}" rescue => detail Puppet\.log_exception(detail, "Could not send report: #{detail}") end
+.P
+\fBsubmit\fR
+.P
+API example:report = Puppet::Face[:catalog, '0\.0\.1']\.apply Puppet::Face[:report, '0\.0\.1']\.submit(report) return report
+.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
+\fBjson\fR
+.IP "\(bu" 4
+\fBmsgpack\fR
+.IP "\(bu" 4
+\fBprocessor\fR
+.IP "\(bu" 4
+\fBrest\fR
+.IP "\(bu" 4
+\fByaml\fR
+.IP "" 0
+.SH "COPYRIGHT AND LICENSE"
+Copyright 2011 by Puppet Inc\., Vox Pupuli Apache 2 license; see COPYING