Go to main content

man pages section 8: System Administration Commands

Exit Print View

Updated: Thursday, June 13, 2019
 
 

puppet-status (8)

Name

puppet-status - View puppet server status.

Synopsis

puppet status action [--terminus _TERMINUS] [--extra HASH]

Description

PUPPET-STATUS(8)                 Puppet manual                PUPPET-STATUS(8)



NAME
       puppet-status - View puppet server status.

SYNOPSIS
       puppet status action [--terminus _TERMINUS] [--extra HASH]

OPTIONS
       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
       argument.

       See   the  configuration  file  documentation  at  https://docs.puppet-
       labs.com/puppet/latest/reference/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.

       --verbose
              Whether to log verbosely.

       --debug
              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
              back-end.

       --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.

ACTIONS
       find - Check status of puppet master server.
              SYNOPSIS

              puppet status [--terminus _TERMINUS] [--extra HASH] [key]

              DESCRIPTION

              Checks  whether  a  Puppet server is properly receiving and pro-
              cessing HTTP requests. This action is only useful when used with
              '--terminus  rest';  when  invoked with the local terminus, find
              will always return true.

              Over REST, this action will query the configured  puppet  master
              by default. To query other servers, including puppet agent nodes
              started with  the  --listen  option,  you  can  set  the  global
              --server and --masterport options on the command line; note that
              agent nodes listen on port 8139.

              RETURNS

              A "true" response or a low-level  connection  error.  When  used
              from the Ruby API: returns a Puppet::Status object.

              NOTES

              This action requires that the server's auth.conf file allow find
              access to the status REST terminus. Puppet agent  does  not  use
              this   facility,   and   it   is  turned  off  by  default.  See
              https://docs.puppetlabs.com/puppet/latest/reference/con-
              fig_file_auth.html for more details.

       info - Print the default terminus class for this face.
              SYNOPSIS

              puppet status info [--terminus _TERMINUS] [--extra HASH]

              DESCRIPTION

              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.

EXAMPLES
       find

       Check the status of the configured puppet master:

       $ puppet status find --terminus rest


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


       +---------------+--------------------------+
       |ATTRIBUTE TYPE |     ATTRIBUTE VALUE      |
       +---------------+--------------------------+
       |Availability   | system/management/puppet |
       +---------------+--------------------------+
       |Stability      | Volatile                 |
       +---------------+--------------------------+
NOTES
       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   local

       o   rest



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


       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/ar-
       chive/5.5.0.tar.gz

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



Puppet, Inc.                      March 2018                  PUPPET-STATUS(8)