pe_status_check

pdk
supported
A Puppet Enterprise Module to Promote Preventative Maintenance and Self Service

26,756 downloads

847 latest version

3.1 quality score

Version information

  • 4.6.0 (latest)
  • 4.5.2
  • 4.5.1
  • 4.5.0
  • 4.4.0
  • 4.3.0
  • 4.2.0
  • 4.1.0
  • 4.0.1
  • 4.0.0
  • 3.0.0
  • 2.6.0
  • 2.5.1
  • 2.5.0
  • 2.4.1
  • 2.4.0
  • 2.3.1
  • 2.3.0
  • 2.2.0
  • 2.1.1
  • 2.1.0
  • 2.0.2
  • 2.0.1
  • 2.0.0
  • 1.5.0
  • 1.4.0
  • 1.3.0
  • 1.2.0
  • 1.1.0
  • 1.0.0
released Feb 20th 2025
This version is compatible with:
  • Puppet Enterprise 2025.5.x, 2025.4.x, 2025.3.x, 2025.2.x, 2025.1.x, 2023.8.x, 2023.7.x, 2023.6.x, 2023.5.x, 2023.4.x, 2023.3.x, 2023.2.x, 2023.1.x, 2023.0.x, 2021.7.x
  • Puppet >= 7.18.0 < 9.0.0
  • RedHat
    ,
    CentOS
    ,
    OracleLinux
    ,
    Scientific
    ,
    Ubuntu
    ,
    Windows
    ,
    SLES
    ,
    Rocky
    ,
    AlmaLinux
Plans:
  • infra_role_summary
  • infra_summary
  • agent_state_summary
  • agent_summary

Start using this module

  • r10k or Code Manager
  • Bolt
  • Manual installation
  • Direct download

Add this module to your Puppetfile:

mod 'puppetlabs-pe_status_check', '4.6.0'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add puppetlabs-pe_status_check
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install puppetlabs-pe_status_check --version 4.6.0

Direct download is not typically how you would use a Puppet module to manage your infrastructure, but you may want to download the module in order to inspect the code.

Download

Documentation

puppetlabs/pe_status_check — version 4.6.0 Feb 20th 2025

Reference

Table of Contents

Classes

Plans

Classes

pe_status_check

When this class is enabled, when any of the indicators in the pe_status_check fact are false puppet will notify of this, individual tests can be disabled by adding the ID to the indicator_exclusions parameter

Examples

include pe_status_check

Parameters

The following parameters are available in the pe_status_check class:

indicator_exclusions

Data type: Array[String[1]]

List of disabled indicators, place any indicator ids you do not wish to report on in this list

Default value: []

checks

Data type: Hash

Hash containing a descriptiong for each key indicator

pe_status_check::agent_status_enable

Adding this class will enable the execution of the agent_status_check fact, This allows the fact to be targeted to a specific agent or group of agents

Examples

include pe_status_check::agent_status_enable

Parameters

The following parameters are available in the pe_status_check::agent_status_enable class:

agent_status_enabled

Data type: Boolean

Flag to enable or disable agent_status_check fact

Default value: true

Plans

pe_status_check::agent_state_summary

provides an overview of all Puppet agents and their error states

Parameters

The following parameters are available in the pe_status_check::agent_state_summary plan:

runinterval

Data type: Integer[0]

the runinterval for the Puppet Agent in minutes. We consider latest reports that are older than runinterval as unresponsive

Default value: 30

log_healthy_nodes

Data type: Boolean

optionally return all healthy nodes, not only the unhealthy

Default value: false

log_unhealthy_nodes

Data type: Boolean

optionally hide unhealthy nodes

Default value: true

pe_status_check::agent_summary

Summary report of the state of agent_status_check on each node Uses the facts task to get the current status from each node and produces a summary report in JSON

Parameters

The following parameters are available in the pe_status_check::agent_summary plan:

targets

Data type: Optional[TargetSpec]

A comma seprated list of FQDN's of Puppet agent nodes Defaults to using a PuppetDB query to identify nodes

Default value: undef

indicator_exclusions

Data type: Array[String[1]]

List of disabled indicators, place any indicator ids you do not wish to report on in this list Static Hiera Data can be used to set indicator_exclusions in a plan - for more information see https://www.puppet.com/docs/pe/latest/writing_plans_in_puppet_language_pe.html#using_hiera_with_plans

Default value: lookup('pe_status_check::indicator_exclusions', undef, undef, [])

pe_status_check::infra_role_summary

provides an overview of all PE systems and their role

pe_status_check::infra_summary

Summary report if the state of pe_status check on each node Uses the facts task to get the current status from each node and produces a summary report in JSON

Parameters

The following parameters are available in the pe_status_check::infra_summary plan:

targets

Data type: Optional[TargetSpec]

A comma seprated list of FQDN's of Puppet infrastructure agent nodes Defaults to using a PuppetDB query to identify nodes

Default value: undef

indicator_exclusions

Data type: Array[String[1]]

List of disabled indicators, place any indicator ids you do not wish to report on in this list Static Hiera Data can be used to set indicator_exclusions in a plan - for more information see https://www.puppet.com/docs/pe/latest/writing_plans_in_puppet_language_pe.html#using_hiera_with_plans

Default value: lookup('pe_status_check::indicator_exclusions', undef, undef, [])