1PUPPET-NODE(8)                   Puppet manual                  PUPPET-NODE(8)
2
3
4

NAME

6       puppet-node - View and manage node definitions.
7

SYNOPSIS

9       puppet node action [--terminus _TERMINUS] [--extra HASH]
10

DESCRIPTION

12       This  subcommand  interacts with node objects, which are used by Puppet
13       to build a catalog. A node object consists of the node´s  facts,  envi‐
14       ronment,  node  parameters  (exposed  in  the parser as top-scope vari‐
15       ables), and classes.
16

OPTIONS

18       Note that any setting that´s valid in the configuration file is also  a
19       valid  long  argument,  although  it  may or may not be relevant to the
20       present action. For example, server and run_mode are valid settings, so
21       you  can  specify  --server <servername>, or --run_mode <runmode> as an
22       argument.
23
24       See   the   configuration   file    documentation    at    https://pup‐
25       pet.com/docs/puppet/latest/configuration.html  for  the  full  list  of
26       acceptable parameters. A commented list of  all  configuration  options
27       can also be generated by running puppet with --genconfig.
28
29       --render-as FORMAT
30              The  format  in  which to render output. The most common formats
31              are json, s (string), yaml, and console, but other options  such
32              as dot are sometimes available.
33
34       --verbose
35              Whether to log verbosely.
36
37       --debug
38              Whether to log debug information.
39
40       --extra HASH
41              A  terminus  can  take additional arguments to refine the opera‐
42              tion, which are passed as an arbitrary  hash  to  the  back-end.
43              Anything  passed  as  the extra value is just send direct to the
44              back-end.
45
46       --terminus _TERMINUS
47              Indirector faces expose indirected subsystems of  Puppet.  These
48              subsystems  are  each able to retrieve and alter a specific type
49              of data (with the familiar actions of find,  search,  save,  and
50              destroy) from an arbitrary number of pluggable backends. In Pup‐
51              pet parlance, these backends are called terminuses.
52
53              Almost all indirected  subsystems  have  a  rest  terminus  that
54              interacts with the puppet master´s data. Most of them have addi‐
55              tional terminuses for various local data models,  which  are  in
56              turn used by the indirected subsystem on the puppet master when‐
57              ever it receives a remote request.
58
59              The terminus for an action is often determined by  context,  but
60              occasionally needs to be set explicitly. See the "Notes" section
61              of this face´s manpage for more details.
62

ACTIONS

64       clean - Clean up signed certs, cached facts, node objects, and  reports
65       for a node stored by the puppetmaster
66              SYNOPSIS
67
68              puppet  node  clean  [--terminus _TERMINUS] [--extra HASH] host1
69              [host2 ...]
70
71              DESCRIPTION
72
73              Cleans up the following information a puppet master knows  about
74              a node:
75
76              Signed certificates - ($vardir/ssl/ca/signed/node.domain.pem)
77
78              Cached facts - ($vardir/yaml/facts/node.domain.yaml)
79
80              Cached node objects - ($vardir/yaml/node/node.domain.yaml)
81
82              Reports - ($vardir/reports/node.domain)
83
84       find - Retrieve a node object.
85              SYNOPSIS
86
87              puppet node find [--terminus _TERMINUS] [--extra HASH] host
88
89              DESCRIPTION
90
91              Retrieve a node object.
92
93              RETURNS
94
95              A  hash  containing the node´s classes, environment, expiration,
96              name, parameters (its facts, combined with any  ENC-set  parame‐
97              ters),  and  time.  When  used from the Ruby API: a Puppet::Node
98              object.
99
100              RENDERING ISSUES: Rendering as string  and  json  are  currently
101              broken; node objects can only be rendered as yaml.
102
103       info - Print the default terminus class for this face.
104              SYNOPSIS
105
106              puppet node info [--terminus _TERMINUS] [--extra HASH]
107
108              DESCRIPTION
109
110              Prints the default terminus class for this subcommand. Note that
111              different run modes may have different default termini; when  in
112              doubt, specify the run mode with the ´--run_mode´ option.
113

EXAMPLES

115       find
116
117       Retrieve  an  "empty"  (no  classes,  no ENC-imposed parameters, and an
118       environment of "production") node:
119
120       $ puppet node find somenode.puppetlabs.lan --terminus plain --render-as
121       yaml
122
123       Retrieve a node using the puppet master´s configured ENC:
124
125       $  puppet  node find somenode.puppetlabs.lan --terminus exec --run_mode
126       master --render-as yaml
127
128       Retrieve the same node from the puppet master:
129
130       $ puppet node find somenode.puppetlabs.lan --terminus rest  --render-as
131       yaml
132

NOTES

134       This  subcommand  is  an  indirector  face, which exposes find, search,
135       save, and destroy actions for an indirected subsystem of Puppet.  Valid
136       termini for this face include:
137
138       ·   exec
139
140       ·   ldap
141
142       ·   memory
143
144       ·   msgpack
145
146       ·   plain
147
148       ·   rest
149
150       ·   store_configs
151
152       ·   write_only_yaml
153
154       ·   yaml
155
156
157

159       Copyright 2011 by Puppet Inc. Apache 2 license; see COPYING
160
161
162
163Puppet, Inc.                      April 2020                    PUPPET-NODE(8)
Impressum