openvox 7.37.1

data/man/man8/puppet-filebucket.8

@@ -0,0 +1,166 @@
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.
+.TH "PUPPET\-FILEBUCKET" "8" "October 2024" "Puppet, Inc." "Puppet manual"
+.
+.SH "NAME"
+\fBpuppet\-filebucket\fR \- Store and retrieve files in a filebucket
+.
+.SH "SYNOPSIS"
+A stand\-alone Puppet filebucket client\.
+.
+.SH "USAGE"
+puppet filebucket \fImode\fR [\-h|\-\-help] [\-V|\-\-version] [\-d|\-\-debug] [\-v|\-\-verbose] [\-l|\-\-local] [\-r|\-\-remote] [\-s|\-\-server \fIserver\fR] [\-f|\-\-fromdate \fIdate\fR] [\-t|\-\-todate \fIdate\fR] [\-b|\-\-bucket \fIdirectory\fR] \fIfile\fR \fIfile\fR \.\.\.
+.
+.P
+Puppet filebucket can operate in three modes, with only one mode per call:
+.
+.P
+backup: Send one or more files to the specified file bucket\. Each sent file is printed with its resulting sha256 sum\.
+.
+.P
+get: Return the text associated with an sha256 sum\. The text is printed to stdout, and only one file can be retrieved at a time\.
+.
+.P
+restore: Given a file path and an sha256 sum, store the content associated with the sum into the specified file path\. You can specify an entirely new path to this argument; you are not restricted to restoring the content to its original location\.
+.
+.P
+diff: Print a diff in unified format between two checksums in the filebucket or between a checksum and its matching file\.
+.
+.P
+list: List all files in the current local filebucket\. Listing remote filebuckets is not allowed\.
+.
+.SH "DESCRIPTION"
+This is a stand\-alone filebucket client for sending files to a local or central filebucket\.
+.
+.P
+Note that \'filebucket\' defaults to using a network\-based filebucket available on the server named \'puppet\'\. To use this, you\'ll have to be running as a user with valid Puppet certificates\. Alternatively, you can use your local file bucket by specifying \'\-\-local\', or by specifying \'\-\-bucket\' with a local path\.
+.
+.IP "" 4
+.
+.nf
+
+  find /opt/puppetlabs/server/data/puppetserver/bucket \-type f \-mtime +45 \-atime +45 \-print0 | xargs \-0 rm
+.
+.fi
+.
+.IP "" 0
+.
+.IP "\(bu" 4
+Restrict the directory to a maximum size after which the oldest items are removed\.
+.
+.IP "" 0
+.
+.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
+\-\-bucket
+Specify a local filebucket path\. This overrides the default path set in \'$clientbucketdir\'\.
+.
+.TP
+\-\-debug
+Enable full debugging\.
+.
+.TP
+\-\-fromdate
+(list only) Select bucket files from \'fromdate\'\.
+.
+.TP
+\-\-help
+Print this help message\.
+.
+.TP
+\-\-local
+Use the local filebucket\. This uses the default configuration information and the bucket located at the \'$clientbucketdir\' setting by default\. If \'\-\-bucket\' is set, puppet uses that path instead\.
+.
+.TP
+\-\-remote
+Use a remote filebucket\. This uses the default configuration information and the bucket located at the \'$bucketdir\' setting by default\.
+.
+.TP
+\-\-server_list
+A list of comma separated servers; only the first entry is used for file storage\. This setting takes precidence over \fBserver\fR\.
+.
+.TP
+\-\-server
+The server to use for file storage\. This setting is only used if \fBserver_list\fR is not set\.
+.
+.TP
+\-\-todate
+(list only) Select bucket files until \'todate\'\.
+.
+.TP
+\-\-verbose
+Print extra information\.
+.
+.TP
+\-\-version
+Print version information\.
+.
+.SH "EXAMPLES"
+.
+.nf
+
+## Backup a file to the filebucket, then restore it to a temporary directory
+$ puppet filebucket backup /etc/passwd
+/etc/passwd: 429b225650b912a2ee067b0a4cf1e949
+$ puppet filebucket restore /tmp/passwd 429b225650b912a2ee067b0a4cf1e949
+
+## Diff between two files in the filebucket
+$ puppet filebucket \-l diff d43a6ecaa892a1962398ac9170ea9bf2 7ae322f5791217e031dc60188f4521ef
+1a2
+> again
+
+## Diff between the file in the filebucket and a local file
+$ puppet filebucket \-l diff d43a6ecaa892a1962398ac9170ea9bf2 /tmp/testFile
+1a2
+> again
+
+## Backup a file to the filebucket and observe that it keeps each backup separate
+$ puppet filebucket \-l list
+d43a6ecaa892a1962398ac9170ea9bf2 2015\-05\-11 09:27:56 /tmp/TestFile
+
+$ echo again >> /tmp/TestFile
+
+$ puppet filebucket \-l backup /tmp/TestFile
+/tmp/TestFile: 7ae322f5791217e031dc60188f4521ef
+
+$ puppet filebucket \-l list
+d43a6ecaa892a1962398ac9170ea9bf2 2015\-05\-11 09:27:56 /tmp/TestFile
+7ae322f5791217e031dc60188f4521ef 2015\-05\-11 09:52:15 /tmp/TestFile
+
+## List files in a filebucket within date ranges
+$ puppet filebucket \-l \-f 2015\-01\-01 \-t 2015\-01\-11 list
+<Empty Output>
+
+$ puppet filebucket \-l \-f 2015\-05\-10 list
+d43a6ecaa892a1962398ac9170ea9bf2 2015\-05\-11 09:27:56 /tmp/TestFile
+7ae322f5791217e031dc60188f4521ef 2015\-05\-11 09:52:15 /tmp/TestFile
+
+$ puppet filebucket \-l \-f "2015\-05\-11 09:30:00" list
+7ae322f5791217e031dc60188f4521ef 2015\-05\-11 09:52:15 /tmp/TestFile
+
+$ puppet filebucket \-l \-t "2015\-05\-11 09:30:00" list
+d43a6ecaa892a1962398ac9170ea9bf2 2015\-05\-11 09:27:56 /tmp/TestFile
+## Manage files in a specific local filebucket
+$ puppet filebucket \-b /tmp/TestBucket backup /tmp/TestFile2
+/tmp/TestFile2: d41d8cd98f00b204e9800998ecf8427e
+$ puppet filebucket \-b /tmp/TestBucket list
+d41d8cd98f00b204e9800998ecf8427e 2015\-05\-11 09:33:22 /tmp/TestFile2
+
+## From a Puppet Server, list files in the server bucketdir
+$ puppet filebucket \-b $(puppet config print bucketdir \-\-section server) list
+d43a6ecaa892a1962398ac9170ea9bf2 2015\-05\-11 09:27:56 /tmp/TestFile
+7ae322f5791217e031dc60188f4521ef 2015\-05\-11 09:52:15 /tmp/TestFile
+.
+.fi
+.
+.SH "AUTHOR"
+Luke Kanies
+.
+.SH "COPYRIGHT"
+Copyright (c) 2011 Puppet Inc\., LLC Licensed under the Apache 2\.0 License

data/man/man8/puppet-generate.8

@@ -0,0 +1,84 @@
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.
+.TH "PUPPET\-GENERATE" "8" "October 2024" "Puppet, Inc." "Puppet manual"
+.
+.SH "NAME"
+\fBpuppet\-generate\fR \- Generates Puppet code from Ruby definitions\.
+.
+.SH "SYNOPSIS"
+puppet generate \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"
+.
+.TP
+\fBtypes\fR \- Generates Puppet code for custom types
+\fBSYNOPSIS\fR
+.
+.IP
+puppet generate types [\-\-format \fIformat\fR] [\-\-force]
+.
+.IP
+\fBDESCRIPTION\fR
+.
+.IP
+Generates definitions for custom resource types using Puppet code\.
+.
+.IP
+Types defined in Puppet code can be used to isolate custom type definitions between different environments\.
+.
+.IP
+\fBOPTIONS\fR \fI\-\-force\fR \- Forces the generation of output files (skips up\-to\-date checks)\.
+.
+.IP
+\fI\-\-format <format\fR> \- The generation output format to use\. Supported formats: pcore\.
+.
+.SH "EXAMPLES"
+\fBtypes\fR
+.
+.P
+Generate Puppet type definitions for all custom resource types in the current environment:
+.
+.IP "" 4
+.
+.nf
+
+$ puppet generate types
+.
+.fi
+.
+.IP "" 0
+.
+.P
+Generate Puppet type definitions for all custom resource types in the specified environment:
+.
+.IP "" 4
+.
+.nf
+
+$ puppet generate types \-\-environment development
+.
+.fi
+.
+.IP "" 0
+.
+.SH "COPYRIGHT AND LICENSE"
+Copyright 2016 by Puppet Inc\. Apache 2 license; see COPYING

data/man/man8/puppet-help.8

@@ -0,0 +1,67 @@
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.
+.TH "PUPPET\-HELP" "8" "October 2024" "Puppet, Inc." "Puppet manual"
+.
+.SH "NAME"
+\fBpuppet\-help\fR \- Display Puppet help\.
+.
+.SH "SYNOPSIS"
+puppet help \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"
+.
+.TP
+\fBhelp\fR \- Display help about Puppet subcommands and their actions\.
+\fBSYNOPSIS\fR
+.
+.IP
+puppet help [\-\-version VERSION] [\-\-ronn] [\fIsubcommand\fR] [\fIaction\fR]
+.
+.IP
+\fBDESCRIPTION\fR
+.
+.IP
+Display help about Puppet subcommands and their actions\.
+.
+.IP
+\fBOPTIONS\fR \fI\-\-ronn\fR \- Whether to render the help text in ronn format\.
+.
+.IP
+\fI\-\-version VERSION\fR \- The version of the subcommand for which to show help\.
+.
+.IP
+\fBRETURNS\fR
+.
+.IP
+Short help text for the specified subcommand or action\.
+.
+.SH "EXAMPLES"
+\fBhelp\fR
+.
+.P
+Get help for an action:
+.
+.P
+$ puppet help
+.
+.SH "COPYRIGHT AND LICENSE"
+Copyright 2011 by Puppet Inc\. Apache 2 license; see COPYING

data/man/man8/puppet-lookup.8

@@ -0,0 +1,107 @@
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.
+.TH "PUPPET\-LOOKUP" "8" "October 2024" "Puppet, Inc." "Puppet manual"
+.
+.SH "NAME"
+\fBpuppet\-lookup\fR \- Interactive Hiera lookup
+.
+.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 a Puppet 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\., LLC Licensed under the Apache 2\.0 License