• Puppet.com
  • Forge
  • Compass
  • Try Puppet
  • Products
  • Puppet Enterprise
  • Open Source Puppet
  • Bolt
  • Puppet Comply
  • Puppet Development Kit
  • Puppet DB
  • Puppet Remediate
  • Puppet Plugin for VMware
  • Get
  • Technical Support Plans
  • Support Lifecycle Policy
  • New Puppet Enterprise Customer?
  • About Puppet
  • Company
  • Developer Experience
  • Community
  • Puppet Champions
  • Puppet Test Pilots
  • Community Calendar
  • Slack Channel

    PRODUCT AND VERSION

        • Welcome to Puppet documentation
        • Puppet 5 Platform
          • Puppet 5.5 release notes
          • Puppet known issues
          • System requirements
          • Component versions in puppet-agent
          • Puppet agent release notes
          • Puppet Server 5.3 release notes
          • Facter release notes
        • Quick start guides
          • Essential configuration tasks
            • NTP quick start guide
            • DNS quick start guide
            • Sudo quick start guide
            • Firewall quick start guide
        • Deprecated features
          • About deprecations in this version
          • Web servers
          • Upcoming operating system deprecations
          • Language features
          • Extension points and APIs
          • Settings
        • Installing and upgrading
          • Overview of Puppet's architecture
          • Pre-install tasks
          • Puppet Platform repositories
          • Install: Puppet Server
          • Install: Puppet agent
            • Install agent: Linux
            • Install agent: Windows
            • Install agent: macOS
          • Install: PuppetDB
          • Major upgrade from Puppet 3.8.x
            • File location changes since Puppet 3.8.x
            • Pre-upgrade tasks from 3.8
            • Upgrade agents from 3.8.x Puppet 5.x
            • Upgrade servers
            • Post-upgrade cleanup
          • Minor upgrades: From Puppet 4 and within Puppet 5.x
        • Configuration
          • About Puppet's settings
          • Short list of important settings
          • Config files
            • puppet.conf: The main config file
            • environment.conf: Per-environment settings
            • auth.conf (LEGACY): HTTPS authorization
            • fileserver.conf: Custom fileserver mount points
            • puppetdb.conf: PuppetDB server locations
            • hiera.yaml: Data lookup configuration
            • autosign.conf: Basic certificate autosigning
            • csr_attributes.yaml: Certificate extensions
            • custom_trusted_oid_mapping.yaml: Short names for cert extension OIDs
            • device.conf: Network hardware access
            • routes.yaml: Advanced plugin routing
          • Configuring Puppet Server
            • Puppet Server's config files
            • puppetserver.conf: Main config file
            • auth.conf: Access control
            • webserver.conf: Jetty web server config
            • web-routes.conf: Mount points for component services
            • global.conf: Trapperkeeper settings
            • ca.conf: CA service access control (deprecated)
            • master.conf: Authorization by HTTP header (deprecated)
            • product.conf: Configuring Product-level Interactions (optional)
            • logback.xml: Logging level and location
            • Advanced logging configuration
            • Bootstrap upgrade notes
          • Checking values of settings
          • Editing settings on the command line
          • Complete list of settings (configuration reference)
          • Settings that differ under Puppet Server
        • Important directories and files
          • Code and data directory (codedir)
          • Config directory (confdir)
          • Main manifest directory
          • The modulepath
          • SSL directory (ssldir)
          • Cache directory (vardir)
        • Environments
          • About environments
          • Creating environments
          • Environment isolation
        • Modules
          • Module fundamentals
          • Plug-ins in modules
          • Module cheat sheet
          • Installing and managing modules from the command line
          • Beginner's guide to writing modules
          • Module metadata
          • Documenting modules
          • Documenting modules with Puppet Strings
          • Puppet Strings style guide
          • Publishing modules
          • Contributing to Puppet modules
        • Puppet services and tools
          • Puppet commands
          • Running Puppet commands on Windows
          • Puppet master
            • Puppet Server
            • The rack Puppet master
            • Configuring a Server with Passenger and Apache
            • The WEBrick Puppet master
          • Puppet agent on *nix systems
          • Puppet agent on Windows
          • Puppet apply
          • Puppet device
        • Puppet Server
          • Index
          • About Puppet Server
          • Release notes
          • Deprecated features
          • Notable differences vs. the Apache/Passenger stack
          • Compatibility with Puppet agent
          • Installing Puppet Server
          • Configuring Puppet Server
          • Differing behavior in puppet.conf
          • Using and extending Puppet Server
            • Subcommands
            • Using Ruby gems
            • Using an external certificate authority
            • External SSL termination
            • Monitoring Puppet Server metrics
              • HTTP client metrics
            • Tuning guide
            • Applying metrics to improve performance
            • Scaling Puppet Server
            • Restarting Puppet Server
          • Known issues and workarounds
            • Known issues
            • SSL problems with load-balanced PuppetDB servers (“Server Certificate Change” error)
          • Administrative API endpoints
            • Environment cache
            • JRuby pool
          • Server-specific Puppet API endpoints
            • Environment classes
            • Environment modules
            • Static file content
          • Status API endpoints
            • Status services
          • Metrics API endpoints
            • v1 metrics
            • v2 (Jolokia) metrics
          • Developer information
            • Debugging
            • Running from source
            • Tracing code events
        • The Puppet language
          • Visual index
          • Basics
          • The Puppet language style guide
          • Handling file paths on Windows
          • Variables
          • Resources
          • Resources (advanced)
          • Relationships and ordering
          • Classes
          • Defined resource types
          • Bolt tasks
          • Type aliases
          • Expressions and operators
          • Conditional statements and expressions
          • Function calls
          • Docs for built-in functions
          • Node definitions
          • Comments
          • Facts and built-in variables
          • Reserved words and acceptable names
          • Writing functions (Puppet language)
          • Custom types
          • Provider development
          • Values and data types
            • About values and data types
            • Strings
            • Numbers
            • Booleans
            • Arrays
            • Hashes
            • Regular expressions
            • Sensitive
            • Timespan and Timestamp
            • Undef
            • Resource references
            • Resource types
            • Default
            • Data type syntax
            • Abstract data types
          • Templates
            • Using templates
            • Embedded Puppet (EPP) template syntax
            • Embedded Ruby (ERB) template syntax
          • Advanced constructs
            • Iteration and loops
            • Lambdas
            • Resource default statements
            • Resource collectors
            • Virtual resources
            • Exported resources
            • Tags
            • Run stages
          • Details of complex behaviors
            • Containment of resources
            • Scope
            • Namespaces and autoloading
        • Writing custom functions
          • Introduction to writing functions
          • Writing functions (Puppet language)
          • Writing functions (modern Ruby API)
            • Overview and examples
            • Defining signatures
            • Special features in implementation methods
            • Writing iterative functions
            • Documenting Ruby functions
          • Writing functions (legacy Ruby API — avoid)
        • Hiera
          • About Hiera
          • Getting started with Hiera
          • Configuring Hiera
          • Creating and editing data
          • Looking up data with Hiera
          • Writing new data backends
          • Upgrading to Hiera 5
        • Facter
          • Facter release notes
          • Facter: Core Facts
          • Writing custom facts
          • Custom facts walkthrough
          • Configuring Facter with facter.conf
        • Resource types
          • All resource types (single-page reference)
          • Core types cheat sheet
          • Optional resource types for Windows
          • augeas
          • Augeas tips and examples
          • computer
          • cron
          • exec
          • Exec tips and examples for Windows
          • file
          • File tips and examples for Windows
          • filebucket
          • group
          • User and group tips and examples for Windows
          • host
          • index
          • interface
          • k5login
          • macauthorization
          • mailalias
          • maillist
          • mcx
          • mount
          • nagios_command
          • nagios_contact
          • nagios_contactgroup
          • nagios_host
          • nagios_hostdependency
          • nagios_hostescalation
          • nagios_hostextinfo
          • nagios_hostgroup
          • nagios_service
          • nagios_servicedependency
          • nagios_serviceescalation
          • nagios_serviceextinfo
          • nagios_servicegroup
          • nagios_timeperiod
          • notify
          • package
          • Package tips and examples for Windows
          • resources
          • router
          • schedule
          • scheduled_task
          • Scheduled task tips and examples
          • selboolean
          • selmodule
          • service
          • Service tips and examples
          • ssh_authorized_key
          • sshkey
          • stage
          • tidy
          • user
          • User and group tips and examples for Windows
          • vlan
          • yumrepo
          • zfs
          • zone
          • zpool
        • Reports: Tracking Puppet's activity
          • About reporting
          • Built-in report processors
          • Writing custom report processors
          • Puppet::Transaction::Report object format
        • Extensions for assigning classes to nodes
          • External node classifiers
          • The LDAP node classifier
        • Misc. references (settings, functions, etc.)
          • Settings (configuration reference)
          • Functions
          • Metaparameters
          • Built-in report processors
          • Indirections and termini
          • Ruby API for developing extensions
        • Man pages
          • Index
          • Core tools
            • puppet agent
            • puppet apply
            • puppet cert
            • puppet master
            • puppet module
            • puppet resource
            • puppet lookup
          • Occasionally useful
            • puppet config
            • puppet describe
            • puppet device
            • puppet doc
            • puppet help
            • puppet man
            • puppet node
            • puppet parser
            • puppet plugin
          • Niche
            • puppet ca
            • puppet catalog
            • puppet certificate
            • puppet certificate_request
            • puppet certificate_revocation_list
            • puppet facts
            • puppet filebucket
            • puppet key
            • puppet report
            • puppet status
        • HTTP API
          • Index
          • PSON
          • Puppet v3 API
            • Catalog
            • Node
            • File bucket file
            • File content
            • File metadata
            • Report
            • Environments
            • Status
          • CA v1 API
            • Certificate
            • Certificate signing requests
            • Certificate status
            • Certificate revocation list
          • Schemas (JSON)
        • SSL and certificates
          • Configuring external certificate authority
          • Using an external CA with Puppet Server
          • External SSL termination with Puppet Server
          • Autosigning certificate requests
          • CSR attributes and certificate extensions
          • Regenerating all certificates in a Puppet deployment
        • Adding file server mount points
        • Puppet's internals
          • Agent-master HTTPS communications
          • Catalog compilation
        • Experimental features
          • Overview
          • Msgpack support

        Schemas (JSON)

        These JSON files contain schemas for the various HTTP API objects

        • catalog.json

        • environments.json

        • error.json

        • facts.json

        • file_metadata.json

        • host.json

        • json-meta-schema.json

        • node.json

        • report.json

        • status.json

        See an issue? Please file a JIRA ticket in our  [DOCUMENTATION] project.

        Puppet automates the delivery and operation of the software that powers some of the biggest brands in the world.

        • Legal
        • Privacy Policy
        • Terms of Use
        • Security
        • Sitemap © 2021
        • Puppet