Go to main content

man pages section 8: System Administration Commands

Exit Print View

Updated: Wednesday, July 27, 2022

puppet-key (8)


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


puppet key action [--terminus _TERMINUS]


PUPPET-KEY(8)                    Puppet manual                   PUPPET-KEY(8)

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

       puppet key action [--terminus _TERMINUS]

       This  subcommand  manages  certificate  private  keys. Keys are created
       automatically by puppet agent and when certificate requests are  gener-
       ated  with  'puppet  ssl submit_request'; it should not be necessary to
       use this subcommand directly.

       Note that any setting 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, server and run_mode are valid settings, so
       you  can  specify  --server <servername>, or --run_mode <runmode> as an

       See   the   configuration   file    documentation    at    https://pup-
       pet.com/docs/puppet/latest/configuration.html  for  the  full  list  of
       acceptable parameters. A commented list of  all  configuration  options
       can also be generated by running puppet with --genconfig.

       --render-as FORMAT
              The  format  in  which to render output. The most common formats
              are json, s (string), yaml, and console, but other options  such
              as dot are sometimes available.

              Whether to log verbosely.

              Whether to log debug information.

       --extra HASH
              A  terminus  can  take additional arguments to refine the opera-
              tion, which are passed as an arbitrary  hash  to  the  back-end.
              Anything  passed  as  the extra value is just send direct to the

       --terminus _TERMINUS
              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 find,  search,  save,  and
              destroy) from an arbitrary number of pluggable backends. In Pup-
              pet parlance, these backends are called terminuses.

              Almost all indirected  subsystems  have  a  rest  terminus  that
              interacts with the puppet master's data. Most of them have addi-
              tional terminuses for various local data models,  which  are  in
              turn used by the indirected subsystem on the puppet master when-
              ever it receives a remote request.

              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.

       destroy - Delete an object.

              puppet key destroy [--terminus _TERMINUS] key


              Delete an object.

       find - Retrieve an object by name.

              puppet key find [--terminus _TERMINUS] [key]


              Retrieve an object by name.

       info - Print the default terminus class for this face.

              puppet key info [--terminus _TERMINUS]


              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 '--run_mode' option.

       save - API only: create or overwrite an object.

              puppet key save [--terminus _TERMINUS] key


              API only: create or overwrite an object. As the Faces  framework
              does  not  currently accept data from STDIN, save actions cannot
              currently be invoked from the command line.

       search - Search for an object or retrieve multiple objects.

              puppet key search [--terminus _TERMINUS] query


              Search for an object or retrieve multiple objects.

       See attributes(7) for descriptions of the following attributes:

       |Availability   | system/management/puppet |
       |Stability      | Volatile                 |

       This subcommand is an indirector  face,  which  exposes  find,  search,
       save,  and destroy actions for an indirected subsystem of Puppet. Valid
       termini for this face include:

       o   file

       o   memory

       Source code for open source software components in Oracle  Solaris  can
       be found at https://www.oracle.com/downloads/opensource/solaris-source-

       This    software    was    built    from    source     available     at
       https://github.com/oracle/solaris-userland.    The  original  community
       source was downloaded from  https://github.com/puppetlabs/puppet.

       Further information about this software can be found on the open source
       community website at http://puppetlabs.com/.

       Copyright 2011 by Puppet Inc. Apache 2 license; see COPYING

Puppet, Inc.                     January 2022                    PUPPET-KEY(8)