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

NAME

6       puppet-certificate_request - Manage certificate requests.
7

SYNOPSIS

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

DESCRIPTION

12       This  subcommand  retrieves  and  submits  certificate signing requests
13       (CSRs).
14

OPTIONS

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

ACTIONS

62       find - Retrieve a single CSR.
63              SYNOPSIS
64
65              puppet certificate_request find [--terminus _TERMINUS]  [--extra
66              HASH] [host]
67
68              DESCRIPTION
69
70              Retrieve a single CSR.
71
72              RETURNS
73
74              A  single  certificate  request.  When  used  from the Ruby API,
75              returns a Puppet::SSL::CertificateRequest object.
76
77              Defaults to the current nodes certname.
78
79       info - Print the default terminus class for this face.
80              SYNOPSIS
81
82              puppet certificate_request info [--terminus _TERMINUS]  [--extra
83              HASH]
84
85              DESCRIPTION
86
87              Prints the default terminus class for this subcommand. Note that
88              different run modes may have different default termini; when  in
89              doubt, specify the run mode with the ´--run_mode´ option.
90
91       save - API only: submit a certificate signing request.
92              SYNOPSIS
93
94              puppet  certificate_request save [--terminus _TERMINUS] [--extra
95              HASH] x509_CSR
96
97              DESCRIPTION
98
99              API only: create or overwrite an object. As the Faces  framework
100              does  not  currently accept data from STDIN, save actions cannot
101              currently be invoked from the command line.
102
103       search - Retrieve all outstanding CSRs.
104              SYNOPSIS
105
106              puppet   certificate_request   search   [--terminus   _TERMINUS]
107              [--extra HASH] dummy_text
108
109              DESCRIPTION
110
111              Retrieve all outstanding CSRs.
112
113              RETURNS
114
115              A  list  of  certificate  requests. When used from the Ruby API,
116              returns an array of Puppet::SSL::CertificateRequest objects.
117
118              NOTES
119
120              Although this action always returns  all  CSRs,  it  requires  a
121              dummy search key; this is a known bug.
122

EXAMPLES

124       find
125
126       Retrieve a single CSR from the puppet master´s CA:
127
128       $  puppet  certificate_request  find somenode.puppetlabs.lan --terminus
129       rest
130
131       search
132
133       Retrieve all CSRs from the local CA (similar to ´puppet cert list´):
134
135       $ puppet certificate_request search x --terminus ca
136

NOTES

138       This subcommand is an indirector  face,  which  exposes  find,  search,
139       save,  and destroy actions for an indirected subsystem of Puppet. Valid
140       termini for this face include:
141
142       ·   ca
143
144       ·   disabled_ca
145
146       ·   file
147
148       ·   memory
149
150       ·   rest
151
152
153

155       Copyright 2011 by Puppet Inc. Apache 2 license; see COPYING
156
157
158
159Puppet, Inc.                      April 2020     PUPPET-CERTIFICATE_REQUEST(8)
Impressum