Go to main content

man pages section 8: System Administration Commands

Exit Print View

Updated: Wednesday, July 27, 2022
 
 

puppet-describe (8)

Name

puppet-describe - Display help about resource types

Synopsis

Prints help about Puppet resource types, providers, and metaparameters.

Description

PUPPET-DESCRIBE(8)               Puppet manual              PUPPET-DESCRIBE(8)



NAME
       puppet-describe - Display help about resource types

SYNOPSIS
       Prints help about Puppet resource types, providers, and metaparameters.

USAGE
       puppet  describe  [-h|--help] [-s|--short] [-p|--providers] [-l|--list]
       [-m|--meta]

OPTIONS
       --help Print this help text

       --providers
              Describe providers in detail for each type

       --list List all types

       --meta List all metaparameters

       --short
              List only parameters without detail

EXAMPLE
       $ puppet describe --list
       $ puppet describe file --providers
       $ puppet describe user -s -m

AUTHOR
       David Lutterkort

COPYRIGHT
       Copyright (c) 2011 Puppet Inc.,  LLC  Licensed  under  the  Apache  2.0
       License



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


       +---------------+--------------------------+
       |ATTRIBUTE TYPE |     ATTRIBUTE VALUE      |
       +---------------+--------------------------+
       |Availability   | system/management/puppet |
       +---------------+--------------------------+
       |Stability      | Volatile                 |
       +---------------+--------------------------+

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

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



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