About the pe_status_check module

The pe_status_check module can alert you when your Puppet Enterprise (PE) installation is not in an ideal state, based on preset indicators, and describe how you can resolve or improve the detected issue.

If you have previously specified a version of this module, from the Forge or other sources, in your code, we recommend removing this version to allow the version bundled with PE to be asserted.

By default, the pe_status_check module uses the pe_status_check fact to compare your installation to a predetermined ideal state. This fact collects information about your PE infrastructure components. You can optionally enable the agent_status_check fact to collect information about agent nodes that are not infrastructure nodes. To enable this fact, classify pe_status_check::agent_status_enable to your nodes.

The pe_status_check module produces reports based on the information collected by the pe_status_check fact (and the agent_status_check fact, if it is enabled). The module recommends remedial actions you can take to either resolve a deficiency or improve your installation's tuning.

To get reports from the module, you can:

Run the pe_status_check::infra_summary and pe_status_check::agent_summary plans. These are setup requirements and various parameters and commands you can use for running the plans.
Use a Puppet Query Language (PQL) query.

To enable notifications in reports, you must declare the pe_status_check class.

These sections of the module's Forge page explain how to interpret the module's reports and the information that the facts collect: