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

NAME

6       puppet-key - Create, save, and remove certificate keys.
7

SYNOPSIS

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

DESCRIPTION

12       This  subcommand  manages  certificate  private  keys. Keys are created
13       automatically by puppet agent and when certificate requests are  gener‐
14       ated  with ´puppet certificate generate´; it should not be necessary to
15       use this subcommand directly.
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       destroy - Delete an object.
65              SYNOPSIS
66
67              puppet key destroy [--terminus _TERMINUS] [--extra HASH] key
68
69              DESCRIPTION
70
71              Delete an object.
72
73       find - Retrieve an object by name.
74              SYNOPSIS
75
76              puppet key find [--terminus _TERMINUS] [--extra HASH] [key]
77
78              DESCRIPTION
79
80              Retrieve an object by name.
81
82       info - Print the default terminus class for this face.
83              SYNOPSIS
84
85              puppet key info [--terminus _TERMINUS] [--extra HASH]
86
87              DESCRIPTION
88
89              Prints the default terminus class for this subcommand. Note that
90              different  run modes may have different default termini; when in
91              doubt, specify the run mode with the ´--run_mode´ option.
92
93       save - API only: create or overwrite an object.
94              SYNOPSIS
95
96              puppet key save [--terminus _TERMINUS] [--extra HASH] key
97
98              DESCRIPTION
99
100              API only: create or overwrite an object. As the Faces  framework
101              does  not  currently accept data from STDIN, save actions cannot
102              currently be invoked from the command line.
103
104       search - Search for an object or retrieve multiple objects.
105              SYNOPSIS
106
107              puppet key search [--terminus _TERMINUS] [--extra HASH] query
108
109              DESCRIPTION
110
111              Search for an object or retrieve multiple objects.
112

NOTES

114       This subcommand is an indirector  face,  which  exposes  find,  search,
115       save,  and destroy actions for an indirected subsystem of Puppet. Valid
116       termini for this face include:
117
118       ·   ca
119
120       ·   disabled_ca
121
122       ·   file
123
124       ·   memory
125
126
127

129       Copyright 2011 by Puppet Inc. Apache 2 license; see COPYING
130
131
132
133Puppet, Inc.                     January 2020                    PUPPET-KEY(8)
Impressum