.\" generated with Ronn/v0.7.3
.\" http://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "PUPPET\-NODE" "8" "January 2013" "Puppet Labs, LLC" "Puppet manual"
.
.SH "NAME"
\fBpuppet\-node\fR \- View and manage node definitions\.
.
.SH "SYNOPSIS"
puppet node \fIaction\fR [\-\-terminus TERMINUS] [\-\-extra HASH]
.
.SH "DESCRIPTION"
This subcommand interacts with node objects, which are used by Puppet 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 configuration parameter 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 configuration parameters, so you can specify \fB\-\-server <servername>\fR, or \fB\-\-run_mode <runmode>\fR as an argument\.
.
.P
See the configuration file documentation at \fIhttp://docs\.puppetlabs\.com/references/stable/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
\-\-extra HASH
A terminus can take additional arguments to refine the operation, which are passed as an arbitrary hash to the back\-end\. Anything passed as the extra value is just send direct to the back\-end\.
.
.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 everything a puppetmaster knows about a node\.
\fBSYNOPSIS\fR
.
.IP
puppet node clean [\-\-terminus TERMINUS] [\-\-extra HASH] [\-\-[no\-]unexport] \fIhost1\fR [\fIhost2\fR \.\.\.]
.
.IP
\fBDESCRIPTION\fR
.
.IP
Clean up everything a puppet master knows about a node, including certificates and storeconfigs data\.
.
.IP
The full list of info cleaned by this action is:
.
.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
\fIStored configs\fR \- (in database) The clean action can either remove all data from a host in your storeconfigs database, or, with the \fI\-\-unexport\fR option, turn every exported resource supporting ensure to absent so that any other host that collected those resources can remove them\. Without unexporting, a removed node\'s exported resources become unmanaged by Puppet, and may linger as cruft unless you are purging that resource type\.
.
.IP
\fBOPTIONS\fR \fI\-\-[no\-]unexport\fR \- Whether to remove this node\'s exported resources from other nodes
.
.TP
\fBdestroy\fR \- Invalid for this subcommand\.
\fBSYNOPSIS\fR
.
.IP
puppet node destroy [\-\-terminus TERMINUS] [\-\-extra HASH] \fIkey\fR
.
.IP
\fBDESCRIPTION\fR
.
.IP
Invalid for this subcommand\.
.
.TP
\fBfind\fR \- Retrieve a node object\.
\fBSYNOPSIS\fR
.
.IP
puppet node find [\-\-terminus TERMINUS] [\-\-extra HASH] \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] [\-\-extra HASH]
.
.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 \- Invalid for this subcommand\.
\fBSYNOPSIS\fR
.
.IP
puppet node save [\-\-terminus TERMINUS] [\-\-extra HASH] \fIkey\fR
.
.IP
\fBDESCRIPTION\fR
.
.IP
Invalid for this subcommand\.
.
.TP
\fBsearch\fR \- Invalid for this subcommand\.
\fBSYNOPSIS\fR
.
.IP
puppet node search [\-\-terminus TERMINUS] [\-\-extra HASH] \fIquery\fR
.
.IP
\fBDESCRIPTION\fR
.
.IP
Invalid for this subcommand\.
.
.SH "EXAMPLES"
\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 master\'s configured ENC:
.
.P
$ puppet node find somenode\.puppetlabs\.lan \-\-terminus exec \-\-run_mode master \-\-render\-as yaml
.
.P
Retrieve the same node from the puppet master:
.
.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
\fBactive_record\fR
.
.IP "\(bu" 4
\fBexec\fR
.
.IP "\(bu" 4
\fBldap\fR
.
.IP "\(bu" 4
\fBmemory\fR
.
.IP "\(bu" 4
\fBplain\fR
.
.IP "\(bu" 4
\fBrest\fR
.
.IP "\(bu" 4
\fBstore_configs\fR
.
.IP "\(bu" 4
\fBwrite_only_yaml\fR
.
.IP "\(bu" 4
\fByaml\fR
.
.IP "" 0
.
.SH "COPYRIGHT AND LICENSE"
Copyright 2011 by Puppet Labs Apache 2 license; see COPYING