Go to main content

man pages section 8: System Administration Commands

Exit Print View

Updated: Wednesday, February 9, 2022
 
 

puppet-generate (8)

Name

puppet-generate - Generates Puppet code from Ruby definitions.

Synopsis

puppet generate action

Description

PUPPET-GENERATE(8)               Puppet manual              PUPPET-GENERATE(8)



NAME
       puppet-generate - Generates Puppet code from Ruby definitions.

SYNOPSIS
       puppet generate action

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

       --verbose
              Whether to log verbosely.

       --debug
              Whether to log debug information.

ACTIONS
       types - Generates Puppet code for custom types
              SYNOPSIS

              puppet generate types [--format format] [--force]

              DESCRIPTION

              Generates definitions for custom  resource  types  using  Puppet
              code.

              Types  defined in Puppet code can be used to isolate custom type
              definitions between different environments.

              OPTIONS --force - Forces the generation of output  files  (skips
              up-to-date checks).

              --format  <format>  -  The generation output format to use. Sup-
              ported formats: pcore.

EXAMPLES
       types

       Generate Puppet type definitions for all custom resource types  in  the
       current environment:



           $ puppet generate types



       Generate  Puppet  type definitions for all custom resource types in the
       specified environment:



           $ puppet generate types --environment development



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



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.                       July 2020                PUPPET-GENERATE(8)