Forge Home

pe_status_check

A Puppet Enterprise Module to Promote Preventative Maintenance and Self Service

16,339 downloads

277 latest version

3.1 quality score

We run a couple of automated
scans to help you access a
module's quality. Each module is
given a score based on how well
the author has formatted their
code and documentation and
modules are also checked for
malware using VirusTotal.

Please note, the information below
is for guidance only and neither of
these methods should be considered
an endorsement by Puppet.

Version information

  • 4.1.0 (latest)
  • 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 Dec 11th 2023
This version is compatible with:
  • Puppet Enterprise 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
  • , , , , , , , ,
Plans:
  • agent_summary
  • infra_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.1.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.1.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.1.0 Dec 11th 2023

Reference

Table of Contents

Classes

Plans

  • pe_status_check::agent_summary: Summary report if 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
  • 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

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_summary

Summary report if 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_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, [])