← Back to branch summary

~bkerensa/ubuntu/raring/puppet/new-upstream-release

« back to all changes in this revision

Viewing changes to man/man8/puppet-node.8

  • Committer: Bazaar Package Importer
  • Author(s): Chuck Short
  • Date: 2011-07-25 01:00:37 UTC
  • mfrom: (1.1.24 upstream) (3.1.25 sid)
  • Revision ID: james.westby@ubuntu.com-20110725010037-875vuxs10eboqgw3
Tags: 2.7.1-1ubuntu1
https://launchpad.net/bugs/641001
* Merge from debian unstable.  Remaining changes:
  - debian/puppetmaster-passenger.postinst: Use cacrl instead of hostcrl to
    set the location of the CRL in apache2 configuration. Fix apache2
    configuration on upgrade as well (LP: #641001)
  - move all puppet dependencies to puppet-common since all the code
    actually located in puppet-common.
  - move libagueas from a recommend to a dependency.

Show diffs side-by-side

added added

removed removed

Lines of Context:
man/man8/puppet-node.8
 
1
.\" generated with Ronn/v0.7.3
 
2
.\" http://github.com/rtomayko/ronn/tree/0.7.3
 
3
.
 
4
.TH "PUPPET\-NODE" "8" "June 2011" "Puppet Labs, LLC" "Puppet manual"
 
5
.
 
6
.SH "NAME"
 
7
\fBpuppet\-node\fR \- View and manage node definitions\.
 
8
.
 
9
.SH "SYNOPSIS"
 
10
puppet node \fIaction\fR [\-\-terminus TERMINUS]
 
11
.
 
12
.SH "DESCRIPTION"
 
13
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\.
 
14
.
 
15
.SH "OPTIONS"
 
16
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 is a valid configuration parameter, so you can specify \fB\-\-server <servername>\fR as an argument\.
 
17
.
 
18
.P
 
19
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\.
 
20
.
 
21
.TP
 
22
\-\-mode MODE
 
23
The run mode to use for the current action\. Valid modes are \fBuser\fR, \fBagent\fR, and \fBmaster\fR\.
 
24
.
 
25
.TP
 
26
\-\-render\-as FORMAT
 
27
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\.
 
28
.
 
29
.TP
 
30
\-\-verbose
 
31
Whether to log verbosely\.
 
32
.
 
33
.TP
 
34
\-\-debug
 
35
Whether to log debug information\.
 
36
.
 
37
.TP
 
38
\-\-terminus TERMINUS
 
39
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\.
 
40
.
 
41
.IP
 
42
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\.
 
43
.
 
44
.IP
 
45
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\.
 
46
.
 
47
.SH "ACTIONS"
 
48
.
 
49
.TP
 
50
\fBdestroy\fR \- Invalid for this subcommand\.
 
51
\fBSYNOPSIS\fR
 
52
.
 
53
.IP
 
54
puppet node destroy [\-\-terminus TERMINUS] \fIkey\fR
 
55
.
 
56
.IP
 
57
\fBDESCRIPTION\fR
 
58
.
 
59
.IP
 
60
Invalid for this subcommand\.
 
61
.
 
62
.TP
 
63
\fBfind\fR \- Retrieve a node object\.
 
64
\fBSYNOPSIS\fR
 
65
.
 
66
.IP
 
67
puppet node find [\-\-terminus TERMINUS] \fIhost\fR
 
68
.
 
69
.IP
 
70
\fBDESCRIPTION\fR
 
71
.
 
72
.IP
 
73
Retrieve a node object\.
 
74
.
 
75
.IP
 
76
\fBRETURNS\fR
 
77
.
 
78
.IP
 
79
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\.
 
80
.
 
81
.IP
 
82
RENDERING ISSUES: Rendering as string and json are currently broken; node objects can only be rendered as yaml\.
 
83
.
 
84
.TP
 
85
\fBinfo\fR \- Print the default terminus class for this face\.
 
86
\fBSYNOPSIS\fR
 
87
.
 
88
.IP
 
89
puppet node info [\-\-terminus TERMINUS]
 
90
.
 
91
.IP
 
92
\fBDESCRIPTION\fR
 
93
.
 
94
.IP
 
95
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 \'\-\-mode\' option\.
 
96
.
 
97
.TP
 
98
\fBsave\fR \- Invalid for this subcommand\.
 
99
\fBSYNOPSIS\fR
 
100
.
 
101
.IP
 
102
puppet node save [\-\-terminus TERMINUS]
 
103
.
 
104
.IP
 
105
\fBDESCRIPTION\fR
 
106
.
 
107
.IP
 
108
Invalid for this subcommand\.
 
109
.
 
110
.TP
 
111
\fBsearch\fR \- Invalid for this subcommand\.
 
112
\fBSYNOPSIS\fR
 
113
.
 
114
.IP
 
115
puppet node search [\-\-terminus TERMINUS] \fIquery\fR
 
116
.
 
117
.IP
 
118
\fBDESCRIPTION\fR
 
119
.
 
120
.IP
 
121
Invalid for this subcommand\.
 
122
.
 
123
.SH "EXAMPLES"
 
124
\fBfind\fR
 
125
.
 
126
.P
 
127
Retrieve an "empty" (no classes, no ENC\-imposed parameters, and an environment of "production") node:
 
128
.
 
129
.P
 
130
$ puppet node find somenode\.puppetlabs\.lan \-\-terminus plain \-\-render\-as yaml
 
131
.
 
132
.P
 
133
Retrieve a node using the puppet master\'s configured ENC:
 
134
.
 
135
.P
 
136
$ puppet node find somenode\.puppetlabs\.lan \-\-terminus exec \-\-mode master \-\-render\-as yaml
 
137
.
 
138
.P
 
139
Retrieve the same node from the puppet master:
 
140
.
 
141
.P
 
142
$ puppet node find somenode\.puppetlabs\.lan \-\-terminus rest \-\-render\-as yaml
 
143
.
 
144
.SH "NOTES"
 
145
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:
 
146
.
 
147
.IP "\(bu" 4
 
148
\fBactive_record\fR
 
149
.
 
150
.IP "\(bu" 4
 
151
\fBexec\fR
 
152
.
 
153
.IP "\(bu" 4
 
154
\fBldap\fR
 
155
.
 
156
.IP "\(bu" 4
 
157
\fBmemory\fR
 
158
.
 
159
.IP "\(bu" 4
 
160
\fBplain\fR
 
161
.
 
162
.IP "\(bu" 4
 
163
\fBrest\fR
 
164
.
 
165
.IP "\(bu" 4
 
166
\fByaml\fR
 
167
.
 
168
.IP "" 0
 
169
.
 
170
.SH "COPYRIGHT AND LICENSE"
 
171
Copyright 2011 by Puppet Labs Apache 2 license; see COPYING