• Puppet.com
  • Forge
  • Compass
  • Try Puppet
  • Products
  • Puppet Enterprise
  • Open Source Puppet
  • Bolt
  • Puppet Comply
  • Continuous Delivery
  • 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 Enterprise® 2021.4
          • PE software architecture
          • Component versions in recent PE releases
          • FIPS 140-2 enabled PE
          • Getting support
          • Using the PE docs
          • Puppet platform documentation for PE
          • API index
        • Release notes
          • PE release notes
          • PE known issues
          • Platform release notes
            • Puppet release notes
            • Puppet known issues
            • Puppet Server release notes
            • Puppet Server known Issues
            • PuppetDB release notes (link)
            • Facter release notes
            • Facter known issues
            • What's new since Puppet 6?
            • Upgrading from Puppet 6 to Puppet 7
        • Getting started with Puppet Enterprise
          • Install PE
          • Add nodes to the inventory
          • Add code and set up Code Manager
          • Manage Apache configuration on *nix targets
            • Add a module
            • Configure your desired state
            • Organize webserver configurations with roles and profiles
          • Manage IIS configuration on Windows targets
            • Add a module
            • Configure your desired state
            • Organize webserver configurations with roles and profiles
          • Next steps
        • Installing
          • Supported architectures
          • System requirements
            • Hardware requirements
            • Supported operating systems
            • Supported browsers
            • System configuration
          • What gets installed and where?
          • Installing PE
          • Purchasing and installing a license key
          • Installing agents
          • Installing compilers
          • Installing client tools
          • Uninstalling
        • Upgrading
          • Upgrading Puppet Enterprise
          • Upgrading agents
        • Configuring Puppet Enterprise
          • Tuning infrastructure nodes
          • Methods for configuring PE
          • Configuring Puppet Server
          • Configuring PuppetDB
          • Configuring security settings
          • Configuring proxies
          • Configuring the console
          • Configuring orchestration
          • Configuring ulimit
          • Writing configuration files
          • Analytics data collection
          • Static catalogs
        • Configuring disaster recovery
          • Disaster recovery
          • Configure disaster recovery
        • Accessing the console
        • Managing access
          • User permissions and user roles
          • Creating and managing local users and user roles
          • LDAP authentication
            • Connecting LDAP external directory services to PE
            • Working with user groups from a LDAP external directory
          • SAML authentication
            • Connect a SAML identity provider to PE
            • Connect Microsoft ADFS to PE
          • Token-based authentication
          • RBAC API
            • Forming RBAC API requests
            • RBAC service errors
            • RBAC API v1
              • Users endpoints
              • User group endpoints
              • User roles endpoints
              • Permissions endpoints
              • Token endpoints
              • LDAP endpoints
              • SAML endpoints
              • Password endpoints
            • RBAC API v2
              • User group endpoints
              • Tokens endpoints
              • LDAP endpoints
          • Activity service API
            • Forming activity service API requests
            • Event types reported by the activity service
            • Events endpoints
        • Monitoring and reporting
          • Monitoring infrastructure state
          • Viewing and managing packages
          • Value report
          • Infrastructure reports
          • Analyzing changes across Puppet runs
          • Viewing and managing Puppet Server metrics
            • Getting started with Graphite
            • Available Graphite metrics
          • Status API
            • Authenticating to the status API
            • Forming requests to the status API
            • Status API: services endpoint
            • Status API: services plaintext endpoint
            • Status API: metrics endpoint
            • Metrics API
        • Managing nodes
          • Adding and removing agent nodes
          • Adding and removing agentless nodes
          • How nodes are counted
          • Running Puppet on nodes
          • Grouping and classifying nodes
          • Making changes to node groups
          • Environment-based testing
          • Preconfigured node groups
          • Managing Windows nodes
          • Designing system configs: roles and profiles
            • The roles and profiles method
            • Roles and profiles example
            • Designing advanced profiles
            • Designing convenient roles
          • Node classifier API v1
            • Forming node classifier requests
            • Groups endpoint
            • Groups endpoint examples
            • Classes endpoint
            • Classification endpoint
            • Commands endpoint
            • Environments endpoint
            • Nodes check-in history endpoint
            • Group children endpoint
            • Rules endpoint
            • Import hierarchy endpoint
            • Last class update endpoint
            • Update classes endpoint
            • Validation endpoints
            • Node classifier errors
          • Node classifier API v2
            • Classification endpoint
              • POST /v2/classified/nodes/<name>
          • Node inventory API
        • Managing patches
          • Configuring patch management
          • Patching nodes
        • Orchestrating Puppet runs, tasks, and plans
          • How Puppet orchestrator works
          • Setting up the orchestrator workflow
          • Configuring Puppet orchestrator
          • Running Puppet on demand
            • Running Puppet on demand from the console
            • Running Puppet on demand from the CLI
            • Running Puppet on demand with the API
          • Tasks in PE
            • Installing tasks
            • Running tasks in PE
              • Running tasks from the console
              • Running tasks from the command line
              • Stop a task in progress
              • Inspecting tasks
            • Writing tasks
          • Plans in PE
            • Plans in PE versus Bolt plans
            • Installing plans
            • Running plans in PE
              • Running plans from the console
              • Running plans from the command line
              • Inspecting plans
            • Writing plans
              • Writing plans in Puppet language
              • Writing plans in YAML
          • Orchestrator API v1 endpoints
            • Forming orchestrator API requests
            • Command endpoints
            • Events endpoints
            • Inventory endpoints
            • Jobs endpoints
            • Scheduled jobs endpoints
            • Plans endpoints
            • Plan jobs endpoints
            • Tasks endpoints
            • Root endpoints
            • Usage endpoints
            • Scopes endpoints
            • Orchestrator API error responses
          • Migrating Bolt tasks and plans to PE
        • Managing and deploying Puppet code
          • Managing environments with a control repository
          • Managing environment content with a Puppetfile
          • Managing code with Code Manager
            • How Code Manager works
            • Set up Code Manager
            • Configure Code Manager
            • Deploying Code without blocking requests to Puppet Server
            • Customize Code Manager configuration in Hiera
            • Triggering Code Manager on the command line
            • Triggering Code Manager with a webhook
            • Triggering Code Manager with custom scripts
            • Troubleshooting Code Manager
            • Code Manager API
          • Managing code with r10k
            • Set up r10k
            • Configure r10k
            • Customizing r10k configuration
            • Deploying environments with r10k
            • r10k command reference
          • About file sync
        • SSL and certificates
          • Regenerate the console certificate
          • Regenerate infrastructure certificates
          • Use an independent intermediate certificate authority
          • Use a custom SSL certificate for the console
          • Generate a custom Diffie-Hellman parameter file
          • Enable TLSv1
        • Maintenance
          • Backing up and restoring Puppet Enterprise
          • Database maintenance
          • Rotating the inventory service secret key
        • Troubleshooting
          • Log locations
          • Troubleshooting installation
          • Troubleshooting disaster recovery
          • Troubleshooting puppet infrastructure run commands
          • Troubleshooting connections between components
          • Troubleshooting the databases
          • Troubleshooting SAML connections
          • Troubleshooting backup and restore
          • Troubleshooting Code Manager
          • Troubleshooting Windows
          • Troubleshooting backup and restore

        Maintenance

        • Backing up and restoring Puppet Enterprise
          Keep regular backups of your PE infrastructure. Backups allow you to more easily migrate to a new primary server, troubleshoot, and quickly recover in the case of system failures.
        • Database maintenance
          You can optimize the Puppet Enterprise (PE) databases to improve performance.
        • Rotating the inventory service secret key
          The inventory service uses a randomly-generated secret key to encrypt a connection entry's sensitive parameters.
        Please enter your feedback and contact email

        If you leave us your email, we may contact you regarding your feedback. For more information on how Puppet uses your personal information, see our privacy policy.

        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