Forge Home

pe_status_check

A Puppet Enterprise Module to Promote Preventative Maintenance and Self Service

4,872 downloads

291 latest version

5.0 quality score

Version information

  • 2.0.2 (latest)
  • 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 Jun 17th 2022
This version is compatible with:
  • Puppet Enterprise 2021.6.x, 2021.5.x, 2021.4.x, 2021.3.x, 2021.2.x, 2021.1.x, 2021.0.x, 2019.8.x
  • Puppet >= 6.16.0 < 8.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', '2.0.2'
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 2.0.2

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 2.0.2 Jun 17th 2022

Reference

Table of Contents

Classes

  • pe_status_check: This class should be enabled if you wish Puppet to notify when pe_status_check indicators are not at optimal values

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: []

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

Default value: []

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

Default value: []