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

NAME

6       puppet-config - Interact with Puppet´s settings.
7

SYNOPSIS

9       puppet config action [--section SECTION_NAME]
10

DESCRIPTION

12       This  subcommand  can  inspect  and modify settings from Puppet´s ´pup‐
13       pet.conf´ configuration file. For documentation about  individual  set‐
14       tings, see https://puppet.com/docs/puppet/latest/configuration.html.
15

OPTIONS

17       Note  that any setting that´s valid in the configuration file is also a
18       valid long argument, although it may or may  not  be  relevant  to  the
19       present action. For example, server and run_mode are valid settings, so
20       you can specify --server <servername>, or --run_mode  <runmode>  as  an
21       argument.
22
23       See    the    configuration    file   documentation   at   https://pup‐
24       pet.com/docs/puppet/latest/configuration.html for the full list of  ac‐
25       ceptable  parameters. A commented list of all configuration options can
26       also be generated by running puppet with --genconfig.
27
28       --render-as FORMAT
29              The format in which to render output. The  most  common  formats
30              are  json, s (string), yaml, and console, but other options such
31              as dot are sometimes available.
32
33       --verbose
34              Whether to log verbosely.
35
36       --debug
37              Whether to log debug information.
38
39       --section SECTION_NAME
40              The section of the puppet.conf configuration  file  to  interact
41              with.
42
43              The  three most commonly used sections are ´main´, ´server´, and
44              ´agent´. ´Main´ is the default, and is used by all Puppet appli‐
45              cations.  Other sections can override ´main´ values for specific
46              applications --- the ´server´ section affects Puppet Server, and
47              the ´agent´ section affects puppet agent.
48
49              Less  commonly  used is the ´user´ section, which affects puppet
50              apply. Any other section will be treated as the name of a legacy
51              environment  (a  deprecated  feature),  and can only include the
52              ´manifest´ and ´modulepath´ settings.
53

ACTIONS

55       delete - Delete a Puppet setting.
56              SYNOPSIS
57
58              puppet config delete [--section SECTION_NAME] setting
59
60              DESCRIPTION
61
62              Deletes a setting from the specified section.  (The  default  is
63              the section ´main´).
64
65              NOTES
66
67              By  default,  this action deletes the configuration setting from
68              the ´main´ configuration domain. Use the  ´--section´  flags  to
69              delete settings from other configuration domains.
70
71       print - Examine Puppet´s current settings.
72              SYNOPSIS
73
74              puppet config print [--section SECTION_NAME] all | setting [set‐
75              ting ...]
76
77              DESCRIPTION
78
79              Prints the value of a single setting or a list of settings.
80
81              This action is a replacement interface to the information avail‐
82              able with puppet <subcommand> --configprint.
83
84              NOTES
85
86              By  default,  this action reads the general configuration in the
87              ´main´ section. Use the ´--section´ and ´--environment´ flags to
88              examine other configuration domains.
89
90       set - Set Puppet´s settings.
91              SYNOPSIS
92
93              puppet  config set [--section SECTION_NAME] [setting_name] [set‐
94              ting_value]
95
96              DESCRIPTION
97
98              Updates values in the puppet.conf configuration file.
99
100              NOTES
101
102              By default, this action manipulates  the  configuration  in  the
103              ´main´  section.  Use  the  ´--section´ flag to manipulate other
104              configuration domains.
105

EXAMPLES

107       delete
108
109       Delete the setting ´setting_name´ from the ´main´ configuration domain:
110
111       $ puppet config delete setting_name
112
113       Delete the setting ´setting_name´ from the ´server´  configuration  do‐
114       main:
115
116       $ puppet config delete setting_name --section server
117
118       print
119
120       Get puppet´s runfile directory:
121
122       $ puppet config print rundir
123
124       Get a list of important directories from the server´s config:
125
126       $ puppet config print all --section server | grep -E "(path|dir)"
127
128       set
129
130       Set puppet´s runfile directory:
131
132       $ puppet config set rundir /var/run/puppetlabs
133
134       Set the vardir for only the agent:
135
136       $ puppet config set vardir /var/lib/puppet --section agent
137

139       Copyright 2011 by Puppet Inc. Apache 2 license; see COPYING
140
141
142
143Puppet, Inc.                     October 2023                 PUPPET-CONFIG(8)
Impressum