Files
confdroid_nagios/doc/puppet_classes/cd_nagios_3A_3Aparams.html

3543 lines
76 KiB
HTML

<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Puppet Class: cd_nagios::params
&mdash; Documentation by YARD 0.9.9
</title>
<link rel="stylesheet" href="../css/style.css" type="text/css" charset="utf-8" />
<link rel="stylesheet" href="../css/common.css" type="text/css" charset="utf-8" />
<script type="text/javascript" charset="utf-8">
pathId = "puppet_classes::cd_nagios::params";
relpath = '../';
</script>
<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
</head>
<body>
<div class="nav_wrap">
<iframe id="nav" src="../puppet_class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../_index.html">Index (c)</a> &raquo;
<span class='title'><span class='object_link'>Puppet Classes</span></span>
&raquo;
<span class="title">cd_nagios::params</span>
</div>
<div id="search">
<a class="full_list_link" id="puppet_class_list_link"
href="../puppet_class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Puppet Class: cd_nagios::params</h1>
<div class="box_info">
<dl>
<dt>Inherited by:</dt>
<dd>
<span class='object_link'><a href="cd_nagios_3A_3Amain_3A_3Adirs.html" title="puppet_classes::cd_nagios::main::dirs (puppet_class)">cd_nagios::main::dirs</a></span><br/>
<span class='object_link'><a href="cd_nagios_3A_3Amain_3A_3Auser.html" title="puppet_classes::cd_nagios::main::user (puppet_class)">cd_nagios::main::user</a></span><br/>
<span class='object_link'><a href="cd_nagios_3A_3Amain_3A_3Aconfig.html" title="puppet_classes::cd_nagios::main::config (puppet_class)">cd_nagios::main::config</a></span><br/>
<span class='object_link'><a href="cd_nagios_3A_3Amain_3A_3Ainstall.html" title="puppet_classes::cd_nagios::main::install (puppet_class)">cd_nagios::main::install</a></span><br/>
<span class='object_link'><a href="cd_nagios_3A_3Aserver_3A_3Afiles.html" title="puppet_classes::cd_nagios::server::files (puppet_class)">cd_nagios::server::files</a></span><br/>
<span class='object_link'><a href="cd_nagios_3A_3Acertbot_3A_3Acerts.html" title="puppet_classes::cd_nagios::certbot::certs (puppet_class)">cd_nagios::certbot::certs</a></span><br/>
<span class='object_link'><a href="cd_nagios_3A_3Aclient_3A_3Atarget.html" title="puppet_classes::cd_nagios::client::target (puppet_class)">cd_nagios::client::target</a></span><br/>
<span class='object_link'><a href="cd_nagios_3A_3Aselinux_3A_3Aconfig.html" title="puppet_classes::cd_nagios::selinux::config (puppet_class)">cd_nagios::selinux::config</a></span><br/>
<span class='object_link'><a href="cd_nagios_3A_3Aserver_3A_3Aservice.html" title="puppet_classes::cd_nagios::server::service (puppet_class)">cd_nagios::server::service</a></span><br/>
<span class='object_link'><a href="cd_nagios_3A_3Afirewall_3A_3Aiptables.html" title="puppet_classes::cd_nagios::firewall::iptables (puppet_class)">cd_nagios::firewall::iptables</a></span><br/>
<span class='object_link'><a href="cd_nagios_3A_3Aserver_3A_3Aaccess_rules.html" title="puppet_classes::cd_nagios::server::access_rules (puppet_class)">cd_nagios::server::access_rules</a></span><br/>
</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>
manifests/params.pp
</dd>
</dl>
</div>
<h2>Summary</h2>
Class holds all parameters for the cd_nagios module and is
inherited by all classes except defines.
<h2>Overview</h2>
<div class="docstring">
<div class="discussion">
<p>cd_nagios::params.pp
Module name: cd_nagios
Author: Arne Teuke
(arne_teuke@ConfDroid.com)</p>
<h1 id="label-License%3A">License:</h1>
<p>This file is part of cd_nagios.</p>
<p>cd_nagios is used for providing automatic configuration of Nagios.
Copyright (C) 2016 ConfDroid (copyright@ConfDroid.com)
This program is
free software: you can redistribute it and/or modify
it under the terms of
the GNU General Public License as published by
the Free Software
Foundation, either version 3 of the License, or
(at your option) any later
version.</p>
<p>This program is distributed in the hope that it will be useful,
but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY
or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License
for more details.</p>
<p>You should have received a copy of the GNU General Public License
along
with this program. If not, see <a
href="http://www.gnu.org/licenses">www.gnu.org/licenses</a>/.
to connect
to NRPE, which as of now does not trust DNS names. Must be the
public
interface in case of NAT environments.
can issue host related commands.
can
issue service related commands.</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>pkg_ensure</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>&#39;latest&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>which <a href="https://confdroid.com/2017/05/puppet-type-package/">package
type</a>
to choose, i.e. <code>latest</code> or <code>present</code>.</p>
</div>
</li>
<li>
<span class='name'>ng_nagios_server</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>&quot;nagios.${::domain}&quot;</tt>)</em>
&mdash;
<div class='inline'>
<p>Specify the FQDN of the nagios server host.
Must be a proper A-name, no
CNAME i.e. on Loadbalancers. When the FQDN
matches the configured value,
Nagios server components will be installed
and the clients will allow to be
connected by that host. Impacts also
firewall ports (optional).</p>
</div>
</li>
<li>
<span class='name'>ng_nagios_ext_ip</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>undef</tt>)</em>
&mdash;
<div class='inline'>
<p>Specify the IP address of the
nagios server. Required for NRPE
configuration to allow the Nagios server</p>
</div>
</li>
<li>
<span class='name'>ng_include_nrpe</span>
<span class='type'>(<tt>boolean</tt>)</span>
<em class="default">(defaults to: <tt>true</tt>)</em>
&mdash;
<div class='inline'>
<p>Whether to include NRPE to allow
Nagios to connect to clients</p>
</div>
</li>
<li>
<span class='name'>ng_ping_warn</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>&#39;100.0,20%&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>Default value for ping warning check. Can be
overridden on host level.</p>
</div>
</li>
<li>
<span class='name'>ng_ping_crit</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>&#39;500.0,60%&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>Default value for ping critical check. Can be
overridden on host level.</p>
</div>
</li>
<li>
<span class='name'>ng_ping_ensure</span>
<span class='type'>(<tt>boolean</tt>)</span>
<em class="default">(defaults to: <tt>&#39;present&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>Wheter to include or exclude the check.
Can be overridden on host level.</p>
</div>
</li>
<li>
<span class='name'>ng_disk_warn</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>&#39;20%&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>Default value for disk space warning check.
Can be overridden on host
level.</p>
</div>
</li>
<li>
<span class='name'>ng_disk_crit</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>&#39;10%&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>Default value for disk space critical check
Can be overridden on host
level.</p>
</div>
</li>
<li>
<span class='name'>ng_disk_ensure</span>
<span class='type'>(<tt>boolean</tt>)</span>
<em class="default">(defaults to: <tt>&#39;present&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>Whether to include or exclude the check.
Can be overridden on host level.</p>
</div>
</li>
<li>
<span class='name'>ng_swap_warn</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>&#39;20&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>Default value for swap space warning check.
Can be overridden on host
level.</p>
</div>
</li>
<li>
<span class='name'>ng_swap_crit</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>&#39;10&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>Default value for swap space critical check.
Can be overridden on host
level.</p>
</div>
</li>
<li>
<span class='name'>ng_swap_ensure</span>
<span class='type'>(<tt>boolean</tt>)</span>
<em class="default">(defaults to: <tt>&#39;present&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>Whether to include or exclude the check.
Can be overridden on host level.</p>
</div>
</li>
<li>
<span class='name'>ng_users_warn</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>&#39;20&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>Default value for user logins warning check.
Can be overridden on host
level.</p>
</div>
</li>
<li>
<span class='name'>ng_users_crit</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>&#39;50&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>Default value for user logins critical check
Can be overridden on host
level.</p>
</div>
</li>
<li>
<span class='name'>ng_users_ensure</span>
<span class='type'>(<tt>boolean</tt>)</span>
<em class="default">(defaults to: <tt>&#39;present&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>Whether to include or exclude the check.
Can be overridden on host level.</p>
</div>
</li>
<li>
<span class='name'>ng_procs_tot_warn</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>&#39;330&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>Default warning for the total processes
warning check. Can be overridden on
host level.</p>
</div>
</li>
<li>
<span class='name'>ng_procs_tot_crit</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>&#39;400&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>Default warning for the total processes
critical check. Can be overridden
on host level.</p>
</div>
</li>
<li>
<span class='name'>ng_procs_tot_param</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>&#39;RDST&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>Default value for the process flags to be
checked. Can be overridden on
host level.</p>
</div>
</li>
<li>
<span class='name'>ng_procs_tot_ens</span>
<span class='type'>(<tt>boolean</tt>)</span>
<em class="default">(defaults to: <tt>&#39;present&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>Whether to include or exclude the check.
Can be overridden on host level.</p>
</div>
</li>
<li>
<span class='name'>ng_procs_z_warn</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>&#39;10&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>Default value for the zombie processes
warning check. Can be overridden on
host level.</p>
</div>
</li>
<li>
<span class='name'>ng_procs_z_crit</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>&#39;30&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>Default value for the zombie processess
critical check. Can be overridden
on host level.</p>
</div>
</li>
<li>
<span class='name'>ng_procs_z_param</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>&#39;Z&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>Default value for the zombie processes flag.
Can be overridden on host
level.</p>
</div>
</li>
<li>
<span class='name'>ng_procs_z_ensure</span>
<span class='type'>(<tt>boolean</tt>)</span>
<em class="default">(defaults to: <tt>&#39;present&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>Whether to include or exclude the check.
Can be overridden on host level.</p>
</div>
</li>
<li>
<span class='name'>ng_load_warn</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>&#39;5.00,4.00,3.00&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>Default value for the load warning check.
Can be overridden on host level.</p>
</div>
</li>
<li>
<span class='name'>ng_load_crit</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>&#39;10.00,6.00,4.00&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>Default value for the load critical check.
Can be overridden on host level.</p>
</div>
</li>
<li>
<span class='name'>ng_load_ensure</span>
<span class='type'>(<tt>boolean</tt>)</span>
<em class="default">(defaults to: <tt>&#39;present&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>Whether to include or exclude the load check.
Can be overridden on host
level.</p>
</div>
</li>
<li>
<span class='name'>ng_include_fw</span>
<span class='type'>(<tt>boolean</tt>)</span>
<em class="default">(defaults to: <tt>true</tt>)</em>
&mdash;
<div class='inline'>
<p>Whether to include firewall management.
requires cd_firewall or
puppetlabs-firewall module.</p>
</div>
</li>
<li>
<span class='name'>ng_fw_order</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>&#39;50&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>Prefix for the port number to establish proper
firewall rule ordering.</p>
</div>
</li>
<li>
<span class='name'>ng_use_https</span>
<span class='type'>(<tt>boolean</tt>)</span>
<em class="default">(defaults to: <tt>true</tt>)</em>
&mdash;
<div class='inline'>
<p>Whether to use https.</p>
</div>
</li>
<li>
<span class='name'>ng_http_https_fw</span>
<span class='type'>(<tt>boolean</tt>)</span>
<em class="default">(defaults to: <tt>true</tt>)</em>
&mdash;
<div class='inline'>
<p>Whether we want to forward http to https.
only active if
<code>ng_use_https</code> is set to <code>true</code>.</p>
</div>
</li>
<li>
<span class='name'>ng_http_port</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>&#39;80&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>Specify the port to use for httpd. Used in
templates and for firewall
(Optional)</p>
</div>
</li>
<li>
<span class='name'>ng_https_port</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>&#39;443&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>Specify the port to use for httpd. Used in
templates and for firewall
(Optional)</p>
</div>
</li>
<li>
<span class='name'>ng_user</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>&#39;nagios&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>The name of the Nagios service user.</p>
</div>
</li>
<li>
<span class='name'>ng_user_home</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>&#39;/var/spool/nagios&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>The home directory for the Nagios service user</p>
</div>
</li>
<li>
<span class='name'>ng_user_shell</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>&#39;/bin/bash&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>The shell for the Nagios service user, which
never should be allowed to
login.</p>
</div>
</li>
<li>
<span class='name'>ng_u_comment</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>&#39;Nagios service user&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>The comment for the Nagios service user for
/etc/passwd. Shows up in email
notifocations from the Nagios daemon.</p>
</div>
</li>
<li>
<span class='name'>ng_u_uid</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>&#39;1004&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>The UID for the Nagios service user. Important when
using shared
environments like NFS.</p>
</div>
</li>
<li>
<span class='name'>ng_u_groups</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>undef</tt>)</em>
&mdash;
<div class='inline'>
<p>The secondary groups for the Nagios service user.
Must not contain the
primary group.</p>
</div>
</li>
<li>
<span class='name'>ng_context_help</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>&#39;1&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>whether or not a context-sensitive
help icon will be displayed for most of
the CGIs.</p>
</div>
</li>
<li>
<span class='name'>ng_pending_state</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>&#39;1&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>what states should be displayed in the web
interface for hosts/services
that have not yet been checked</p>
</div>
</li>
<li>
<span class='name'>ng_use_auth</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>&#39;1&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>whether or not the CGIs will use any
authentication when displaying host
and service information, as
well as committing commands to Nagios for
processing. This should <strong>not</strong>
be set to 0.</p>
</div>
</li>
<li>
<span class='name'>ng_use_ssl_auth</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>&#39;0&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>allows you to use x509 cert (SSL)
authentication in the CGIs. This is an
advanced option and should
not be enabled unless you know what you&#39;re
doing.</p>
</div>
</li>
<li>
<span class='name'>ng_enable_def_user</span>
<span class='type'>(<tt>boolean</tt>)</span>
<em class="default">(defaults to: <tt>false</tt>)</em>
&mdash;
<div class='inline'>
<p>Whether to enable a default user
(<strong>not recommended</strong>).</p>
</div>
</li>
<li>
<span class='name'>ng_def_user_name</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>&#39;nagios_insecure&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>default user name that can
access pages without authentication. This allows
people within a
secure domain (i.e., behind a firewall) to see the current
status
without authenticating. Only actuve if
<code>ng_enable_def_user</code> is set to <code>true</code></p>
</div>
</li>
<li>
<span class='name'>ng_nagios_admin</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>&#39;nagios_sec_adm&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>Specify the name of a nagios administration
user here. Value will be used
in cgi.cfg for all authorized commands and info,
i.e. nagiosadmin. however,
its stronlgly suggested to use a different name.
Can be overridden per host
/ hostgroups, so allows flexibility and increased
security. You can also
add a comma-separated list of people in here instead,
which then would
function like a group instead a single user.</p>
</div>
</li>
<li>
<span class='name'>ng_sysinfo_auth</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>&#39;&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>comma-delimited list of all usernames that
have access to viewing the
Nagios process information as
provided by the Extended Information CGI
(extinfo.cgi).</p>
</div>
</li>
<li>
<span class='name'>ng_confinfo_auth</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>&#39;&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>comma-delimited list of all usernames that
can view ALL configuration
information (hosts, commands, etc).</p>
</div>
</li>
<li>
<span class='name'>ng_command_auth</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>&#39;&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>comma-delimited list of all usernames that
can issue shutdown and restart
commands to Nagios via the
command CGI (cmd.cgi).</p>
</div>
</li>
<li>
<span class='name'>ng_hostview_auth</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>&#39;&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>comma-delimited lists of all usernames that
can view information for all
hosts</p>
</div>
</li>
<li>
<span class='name'>ng_serviceview_auth</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>&#39;&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>comma-delimited lists of all usernames
that can view information for all
services.</p>
</div>
</li>
<li>
<span class='name'>ng_host_cmd_auth</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>&#39;&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>comma-delimited lists of all usernames that</p>
</div>
</li>
<li>
<span class='name'>ng_svc_cmd_auth</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>&#39;&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>comma-delimited lists of all usernames that</p>
</div>
</li>
<li>
<span class='name'>ng_readonly_auth</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>&#39;&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>comma-delimited list of usernames that have
read-only rights in the CGIs.</p>
</div>
</li>
<li>
<span class='name'>ng_statusmap_img</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>&#39;smbackground.gd2&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>specify an image to be used as a
background in the statusmap CGI.</p>
</div>
</li>
<li>
<span class='name'>ng_use_colormap</span>
<span class='type'>(<tt>boolean</tt>)</span>
<em class="default">(defaults to: <tt>false</tt>)</em>
&mdash;
<div class='inline'>
<p>Whether to set values of background colors.</p>
</div>
</li>
<li>
<span class='name'>ng_colormap_red</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>&#39;255&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>value for the <code>red</code> area of the color map.</p>
</div>
</li>
<li>
<span class='name'>ng_colormap_green</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>&#39;255&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>value for the <code>green</code> area of the color map</p>
</div>
</li>
<li>
<span class='name'>ng_colormap_blue</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>&#39;255&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>value for the <code>blue</code> area of the color map.</p>
</div>
</li>
<li>
<span class='name'>ng_statusmap_layout</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>&#39;6&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>Value for the default statusmap layout.</p>
</div>
</li>
<li>
<span class='name'>ng_wrl_layout</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>&#39;4&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>Value for the default statuswrl layout.</p>
</div>
</li>
<li>
<span class='name'>ng_incl_own_wrl</span>
<span class='type'>(<tt>boolean</tt>)</span>
<em class="default">(defaults to: <tt>false</tt>)</em>
&mdash;
<div class='inline'>
<p>Whether to include your own objects in the
generated VRML world.</p>
</div>
</li>
<li>
<span class='name'>ng_statuswrl_include</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>&#39;&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>Specify your own wrl object to be
included in the generated VRML world.
Only active if <code>ng_incl_own_wrl</code>
is set to <code>true</code>.</p>
</div>
</li>
<li>
<span class='name'>ng_ping_syntax</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>&#39;/bin/ping -n -U -c 5 $HOSTADDRESS$&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>what syntax should be used when
attempting to ping a host from the WAP
interface</p>
</div>
</li>
<li>
<span class='name'>ng_refresh_rate</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>&#39;90&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>specify the refresh rate in seconds
of various CGIs</p>
</div>
</li>
<li>
<span class='name'>ng_result_limit</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>&#39;100&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>specify the default number of results
displayed on the status.cgi.</p>
</div>
</li>
<li>
<span class='name'>ng_escape_html</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>&#39;1&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>whether HTML tags in host and service
status output is escaped in the web
interface. If enabled,
your plugin output will not be able to contain
clickable links.</p>
</div>
</li>
<li>
<span class='name'>ng_use_sound</span>
<span class='type'>(<tt>boolean</tt>)</span>
<em class="default">(defaults to: <tt>false</tt>)</em>
&mdash;
<div class='inline'>
<p>whether to enable sound usage.</p>
</div>
</li>
<li>
<span class='name'>ng_host_unreachable</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>&#39;hostdown.wav&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>soundfile for <code>host unreachable</code>
Only active if
<code>ng_use_sound</code> is set to <code>true</code>.</p>
</div>
</li>
<li>
<span class='name'>ng_host_down</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>&#39;hostdown.wav&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>soundfile for <code>host down</code>
Only active if
<code>ng_use_sound</code> is set to <code>true</code>.</p>
</div>
</li>
<li>
<span class='name'>ng_svc_critical</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>&#39;critical.wav&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>soundfile for <code>service critical</code>.
Only active if
<code>ng_use_sound</code> is set to <code>true</code>.</p>
</div>
</li>
<li>
<span class='name'>ng_svc_warn</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>&#39;warning.wav&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>soundfile for <code>service warning</code>
Only active if
<code>ng_use_sound</code> is set to <code>true</code>.</p>
</div>
</li>
<li>
<span class='name'>ng_svc_unknown</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>&#39;warning.wav&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>soundfile for <code>service unknown</code>
Only active if
<code>ng_use_sound</code> is set to <code>true</code>.</p>
</div>
</li>
<li>
<span class='name'>ng_normal_sound</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>&#39;noproblem.wav&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>soundfile for <code>normal</code>
Only active if <code>ng_use_sound</code>
is set to <code>true</code>.</p>
</div>
</li>
<li>
<span class='name'>ng_action_url_target</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>&#39;_blank&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>Specify target frames in which
action URLs will open</p>
</div>
</li>
<li>
<span class='name'>ng_notes_url_target</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>&#39;_blank&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>Specify target frames in which
notes URLs will open</p>
</div>
</li>
<li>
<span class='name'>ng_lock_author_names</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>&#39;1&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>whether users can change the author
name when submitting comments,
scheduling downtime.</p>
</div>
</li>
<li>
<span class='name'>ng_enable_splunk</span>
<span class='type'>(<tt>boolean</tt>)</span>
<em class="default">(defaults to: <tt>false</tt>)</em>
&mdash;
<div class='inline'>
<p>Whether to enable splunk integration.</p>
</div>
</li>
<li>
<span class='name'>ng_splunk_url</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>&#39;http://127.0.0.1:8000/&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>the URL for your Splunk URL</p>
</div>
</li>
<li>
<span class='name'>ng_navbar_addresses</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>&#39;1&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>allow navbar search queries IP addresses</p>
</div>
</li>
<li>
<span class='name'>ng_navbar_aliases</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>&#39;1&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>allow navbar search for aliases</p>
</div>
</li>
<li>
<span class='name'>ng_ack_no_sticky</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>&#39;0&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>Enabling ack_no_sticky will default the
&quot;Sticky Acknowledgement&quot;
to be unchecked.</p>
</div>
</li>
<li>
<span class='name'>ng_ack_no_send</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>&#39;0&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>Enabling ack_no_send will default the
&quot;Send Notification&quot; to be
unchecked.</p>
</div>
</li>
<li>
<span class='name'>ng_use_selinux_tools</span>
<span class='type'>(<tt>boolean</tt>)</span>
<em class="default">(defaults to: <tt>true</tt>)</em>
&mdash;
<div class='inline'>
<p>Whether to enable selinux tools and
policies. only effective if selinux is
enabled.</p>
</div>
</li>
<li>
<span class='name'>ng_required_hosts</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>&#39;&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>String of <strong>FQDNs</strong> for hosts which
should be
allowed/required. Requires format
&#39;host1.example.com
host2.example.com&#39;. If you want no restriction, chose &#39;all&#39;.</p>
</div>
</li>
<li>
<span class='name'>ng_required_ips</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>&#39;127.0.0.0/8&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>string of &lt;b&gt;_&lt;em&gt;Ip addresses __** for hosts which
should be
allowed/reqired. Requires format &#39;ipaddress ip address range&#39;.
If
you want no restriction, choose &#39;0.0.0.0/0&#39;Ip addresses
_&lt;/em&gt;&lt;/b&gt; for hosts which
should be allowed/reqired. Requires
format &#39;ipaddress ip address range&#39;.
If you want no restriction,
choose &#39;0.0.0.0/0&#39;</p>
</div>
</li>
<li>
<span class='name'>ng_enable_certbot</span>
<span class='type'>(<tt>boolean</tt>)</span>
<em class="default">(defaults to: <tt>true</tt>)</em>
&mdash;
<div class='inline'>
<p>Whether to use certbot for automated TLS
certificate management</p>
</div>
</li>
<li>
<span class='name'>ng_certbot_webroot</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>&#39;/var/www/html&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>the path for certbot to place
challenges for the certification process.</p>
</div>
</li>
<li>
<span class='name'>ng_mail_user</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>&quot;admin@${::domain}&quot;</tt>)</em>
&mdash;
<div class='inline'>
<p>email address to receive administrative mail.
used for nagios itself as
well as for certbot.</p>
</div>
</li>
<li>
<span class='name'>ng_enable_index</span>
<span class='type'>(<tt>boolean</tt>)</span>
<em class="default">(defaults to: <tt>true</tt>)</em>
&mdash;
<div class='inline'>
<p>Whether to create an index file to allow
httpd checks with nagios on the
nagios server.</p>
</div>
</li>
<li>
<span class='name'>ng_webserver_name</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>&quot;nagios.${::domain}&quot;</tt>)</em>
&mdash;
<div class='inline'>
<p>the name of the web server nagios should
listen to, i.e.
&#39;nagios.example.net&#39;. Unlike <code>ng_nagios_server</code>,
this
should not be the FQDN of the nagios host, but a web server domain
name.
required for certbot and used in the web templates.</p>
</div>
</li>
<li>
<span class='name'>ng_log_file</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>&#39;/var/log/nagios/nagios.log&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>main log file where service- and host events
are logged.</p>
</div>
</li>
<li>
<span class='name'>ng_max_check_attempts</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>&#39;10&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>maximum amount of checks done by nagios</p>
</div>
</li>
<li>
<span class='name'>ng_object_cache_file</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>&#39;/var/spool/nagios/objects.cache&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>determines where object definitions are
cached when # Nagios
starts/restarts.</p>
</div>
</li>
<li>
<span class='name'>ng_precached_obj_file</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>&#39;/var/spool/nagios/objects.precache&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>determines the location of the
precached object file.</p>
</div>
</li>
<li>
<span class='name'>ng_resource_file</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>&#39;/etc/nagios/private/resource.cfg&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>resource file that contains $USERx$ macro
definitions.</p>
</div>
</li>
<li>
<span class='name'>ng_status_file</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>&#39;/var/log/nagios/status.dat&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>where the current status of all monitored
services and hosts is stored.</p>
</div>
</li>
<li>
<span class='name'>ng_status_upd_interval</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>&#39;10&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>status file update interval.
determines the frequency (in seconds) that #
Nagios will periodically dump
program, host, and # service status data.</p>
</div>
</li>
<li>
<span class='name'>ng_check_ext_commands</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>&#39;1&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>allows you to specify whether or not
Nagios should check # for external
commands in the command file specified
by <code>ng_command_file</code>.</p>
</div>
</li>
<li>
<span class='name'>ng_command_file</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>&#39;/var/spool/nagios/cmd/nagios.cmd&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>file that Nagios checks for external command
requests. It is also where the
command CGI will write commands that are
submitted # by users, so it must
be writeable by the user that the web server
is running as.</p>
</div>
</li>
<li>
<span class='name'>ng_enable_query_handler</span>
<span class='type'>(<tt>boolean</tt>)</span>
<em class="default">(defaults to: <tt>false</tt>)</em>
&mdash;
<div class='inline'>
<p>Whether to enable the query handler
for running nagios in cluster mode.</p>
</div>
</li>
<li>
<span class='name'>ng_query_socket</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>&#39;/var/spool/nagios/cmd/nagios.qh&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>the socket for the query handler</p>
</div>
</li>
<li>
<span class='name'>ng_lock_file</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>&#39;/var/run/nagios/nagios.pid&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>lockfile that Nagios will use to store its PID
number in when it is running
in daemon mode.</p>
</div>
</li>
<li>
<span class='name'>ng_temp_file</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>&#39;/var/spool/nagios/nagios.tmp&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>temporary file that is used as scratch space
when Nagios # updates the
status log, cleans the comment file, etc.</p>
</div>
</li>
<li>
<span class='name'>ng_temp_path</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>&#39;/tmp&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>path where Nagios can create temp files for
service and # host check
results, etc.</p>
</div>
</li>
<li>
<span class='name'>ng_event_broker_options</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>&#39;-1&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>Controls what (if any) data gets sent
to the event broker.</p>
</div>
</li>
<li>
<span class='name'>ng_event_broker_module</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>&#39;&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>specify an event broker
(including full path) module that should # by
loaded by Nagios at startup.
Specify multiple modules as array
[&#39;path/to/module1&#39;,&#39;/path/to/module2&#39;]</p>
</div>
</li>
<li>
<span class='name'>ng_log_rotation_method</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>&#39;h&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>Valid options:
n = None - don&#39;t rotate the log
h = Hourly rotation (top
of the hour)
d = Daily rotation (midnight every day)
w = Weekly rotation
(midnight on Saturday evening)
m = Monthly rotation (midnight last day of
month)</p>
</div>
</li>
<li>
<span class='name'>ng_log_archive_path</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>&#39;/var/log/nagios/archives&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>directory where archived (rotated)
log files should be # placed (assuming
you&#39;ve chosen to do log rotation).</p>
</div>
</li>
<li>
<span class='name'>ng_use_syslog</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>&#39;1&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>whether to log messages to the syslog
facility, as well as the Nagios log
file. Valid options are <code>0</code> and <code>1</code>.</p>
</div>
</li>
<li>
<span class='name'>ng_log_notifications</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>&#39;1&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>Whether to log notifications in addition
to regular messages. Valid options
are <code>0</code> and <code>1</code>.</p>
</div>
</li>
<li>
<span class='name'>ng_log_service_retries</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>&#39;1&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>Whether to log service retries.
Valid options are <code>0</code> and
<code>1</code>.</p>
</div>
</li>
<li>
<span class='name'>ng_log_host_retries</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>&#39;1&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>Whether to log host retries.
Valid options are <code>0</code> and
<code>1</code>.</p>
</div>
</li>
<li>
<span class='name'>ng_log_event_handlers</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>&#39;1&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>Whether to log host and service event
handlers. Valid options are
<code>0</code> and <code>1</code>.</p>
</div>
</li>
<li>
<span class='name'>ng_log_initial_states</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>&#39;0&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>Whether to log initial states.
Valid options are <code>0</code> and
<code>1</code>.</p>
</div>
</li>
<li>
<span class='name'>ng_log_current_states</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>&#39;1&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>Whether to log all current host and
service states to the main log file
after log has been rotated.
Valid options are <code>0</code> and
<code>1</code>.</p>
</div>
</li>
<li>
<span class='name'>ng_log_external_commands</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>&#39;1&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>Whether to log external commands.
Valid options are <code>0</code> and
<code>1</code>.</p>
</div>
</li>
<li>
<span class='name'>ng_log_passive_checks</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>&#39;1&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>Whether to log passive checks.
Valid options are <code>0</code> and
<code>1</code>.</p>
</div>
</li>
<li>
<span class='name'>ng_glob_host_evt_handler</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>&#39;&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>Specify a global host event
handler # command that is to be run for every
host or service state change.
The global event handler is executed
immediately prior to the event
handler that you have optionally specified
in each host or # service
definition. The command argument is the short
name of a # command definition
that you define in your host configuration
file.</p>
</div>
</li>
<li>
<span class='name'>ng_glob_svc_evt_handler</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>&#39;&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>Specify a global service event
handler # command that is to be run for
every host or service state change.
The global event handler is executed
immediately prior to the event
handler that you have optionally specified
in each host or # service
definition. The command argument is the short
name of a # command definition
that you define in your host configuration
file.</p>
</div>
</li>
<li>
<span class='name'>ng_svc_int_check_delay</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>&#39;s&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>method that Nagios should use when
initially &quot;spreading out&quot;
service checks when it starts monitoring.
Valid options:
n = None -
don&#39;t use any delay between checks
d = Use a &quot;dumb&quot; delay of
1 second between checks
s = Use &quot;smart&quot; inter-check delay
calculation
x.xx = Use an inter-check delay of x.xx seconds</p>
</div>
</li>
<li>
<span class='name'>ng_max_svc_check_spread</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>&#39;30&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>timeframe (in minutes) from the
program start time that an initial check of
all services should be completed</p>
</div>
</li>
<li>
<span class='name'>ng_svc_interleave_factor</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>&#39;s&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>determines how service checks are
interleaved. Valid options: s = Use
&quot;smart&quot; interleave factor calculation
x = Use an interleave
factor of x, where x is greater than or equal to 1.</p>
</div>
</li>
<li>
<span class='name'>ng_host_int_check_delay</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>&#39;s&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>method that Nagios should use when
initially &quot;spreading out&quot; host
checks when it starts monitoring.
Valid options:
n = None - don&#39;t use
any delay between checks
d = Use a &quot;dumb&quot; delay of 1 second
between checks
s = Use &quot;smart&quot; inter-check delay calculation
x.xx
= Use an inter-check delay of x.xx seconds</p>
</div>
</li>
<li>
<span class='name'>ng_max_host_check_spread</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>&#39;30&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>timeframe (in minutes) from the
program start time that an initial check of
all hosts should # be completed.</p>
</div>
</li>
<li>
<span class='name'>ng_max_concurrent_checks</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>&#39;0&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>specify the maximum number of
service checks that can be run in parallel at
any given time. A value of 0
will not restrict the number of concurrent
checks that are being executed.</p>
</div>
</li>
<li>
<span class='name'>ng_check_res_reaper_freq</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>&#39;10&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>frequency (in seconds!) in which
Nagios will process the results of host
and service checks.</p>
</div>
</li>
<li>
<span class='name'>ng_max_check_res_reap_time</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>&#39;30&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>max amount of time (in seconds)
that a single # check result reaper event
will be allowed to run before
returning control back to Nagios so it can
perform other duties.</p>
</div>
</li>
<li>
<span class='name'>ng_check_result_path</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>&#39;/var/spool/nagios/checkresults&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>directory where Nagios stores the
results of host and service checks that
have not yet been processed.</p>
</div>
</li>
<li>
<span class='name'>ng_max_check_res_file_age</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>&#39;3600&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>maximum age (in seconds) which
check result files are considered to be
valid.</p>
</div>
</li>
<li>
<span class='name'>ng_cached_h_check_horizon</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>&#39;15&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>maximum amount of time (in seconds)
that the state of a previous host check
is considered current.
Cached host states (from host checks that were
performed more recently
that the timeframe specified by this value) can
immensely improve
performance in regards to the host check logic. Too high
of a value for
this option may result in inaccurate host states being used
by Nagios,
while a lower value may result in a performance hit for host
checks.
Use a value of 0 to disable host check caching.</p>
</div>
</li>
<li>
<span class='name'>ng_cached_s_check_horizon</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>&#39;15&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>maximum amount of time (in seconds)
that the state of a previous service
check is considered current.
Cached service states (from service checks
that were performed more recently
that the timeframe specified by this
value) can immensely improve
performance in regards to the service check
logic. Too high of a value for
this option may result in inaccurate service
states being used by Nagios,
while a lower value may result in a
performance hit for service checks.
Use a value of 0 to disable service
check caching.</p>
</div>
</li>
<li>
<span class='name'>ng_pred_host_dep_checks</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>&#39;1&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>Whether Nagios will attempt to execute
checks of hosts when it predicts
that future dependency logic test may be
needed. Valid options are
<code>0</code> and <code>1</code>.</p>
</div>
</li>
<li>
<span class='name'>ng_pred_svc_dep_checks</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>&#39;1&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>Whether Nagios will attempt to execute
checks of services when it predicts
that future dependency logic test may be
needed. Valid options are
<code>0</code> and <code>1</code>.</p>
</div>
</li>
<li>
<span class='name'>ng_soft_state_dependencies</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>&#39;0&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>Whether or not Nagios will use
soft state information when checking host
and service dependencies.
Valid options are <code>0</code> and
<code>1</code>.</p>
</div>
</li>
<li>
<span class='name'>ng_time_change_threshold</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>&#39;900&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>when Nagios will react to detected
changes in system time (either forward
or backwards).</p>
</div>
</li>
<li>
<span class='name'>ng_auto_reschedule_checks</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>&#39;0&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>Whether Nagios will attempt to
automatically reschedule active host and
service checks to
&quot;smooth&quot; them out over time. Experimental
feature.
Valid options are <code>0</code> and <code>1</code>.</p>
</div>
</li>
<li>
<span class='name'>ng_auto_reschedule_intval</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>&#39;30&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>how often (in seconds) Nagios will
attempt to automatically reschedule
checks. only has an effect if
<code>ng_auto_reschedule_checks</code> is set
to <code>1</code>.</p>
</div>
</li>
<li>
<span class='name'>ng_auto_reschedule_window</span>
<span class='type'>(<tt>string</tt>)</span>
<em class="default">(defaults to: <tt>&#39;180&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>determines the “window” of time
(in seconds) that # Nagios will look at
when automatically rescheduling
checks. Only host and service checks that
occur in the next X seconds
(determined by this variable) will be
rescheduled.</p>
</div>
</li>
</ul>
<p class="tag_title">See Also:</p>
<ul class="see">
<li><a href="https://confdroid.com/2017/07/nagios-cgi-cfg/" target="_parent" title="https://confdroid.com/2017/07/nagios-cgi-cfg/">https://confdroid.com/2017/07/nagios-cgi-cfg/</a></li>
</ul>
</div><div class="method_details_list">
<table class="source_code">
<tr>
<td>
<pre class="lines">
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'manifests/params.pp', line 361</span>
class cd_nagios::params (
$pkg_ensure = &#39;latest&#39;,
$ng_nagios_server = &quot;nagios.${::domain}&quot;,
$ng_nagios_ext_ip = undef,
$ng_mail_user = &quot;admin@${::domain}&quot;,
$ng_include_nrpe = true,
# firewall
$ng_include_fw = true,
$ng_use_https = true,
$ng_http_https_fw = true,
$ng_fw_order = &#39;50&#39;,
$ng_http_port = &#39;80&#39;,
$ng_https_port = &#39;443&#39;,
# check command parameters
## ping
$ng_ping_warn = &#39;100.0,20%&#39;,
$ng_ping_crit = &#39;500.0,60%&#39;,
$ng_ping_ensure = &#39;present&#39;,
## disk
$ng_disk_warn = &#39;20%&#39;,
$ng_disk_crit = &#39;10%&#39; ,
$ng_disk_ensure = &#39;present&#39;,
# swap
$ng_swap_warn = &#39;20&#39;,
$ng_swap_crit = &#39;10&#39;,
$ng_swap_ensure = &#39;present&#39;,
# users
$ng_users_warn = &#39;20&#39;,
$ng_users_crit = &#39;50&#39;,
$ng_users_ensure = &#39;present&#39;,
#total procs
$ng_procs_tot_warn = &#39;330&#39;,
$ng_procs_tot_crit = &#39;400&#39;,
$ng_procs_tot_param = &#39;RDST&#39;,
$ng_procs_tot_ens = &#39;present&#39;,
# zombie procs
$ng_procs_z_warn = &#39;10&#39;,
$ng_procs_z_crit = &#39;30&#39;,
$ng_procs_z_param = &#39;Z&#39;,
$ng_procs_z_ensure = &#39;present&#39;,
# load
$ng_load_warn = &#39;5.00,4.00,3.00&#39;,
$ng_load_crit = &#39;10.00,6.00,4.00&#39;,
$ng_load_ensure = &#39;present&#39;,
# user settings
$ng_user = &#39;nagios&#39;,
$ng_u_comment = &#39;Nagios service user&#39;,
$ng_u_uid = &#39;1004&#39;,
$ng_user_home = &#39;/var/spool/nagios&#39;,
$ng_u_groups = undef,
$ng_user_shell = &#39;/bin/bash&#39;,
# cgi settings
$ng_context_help = &#39;1&#39;,
$ng_pending_state = &#39;1&#39;,
$ng_use_auth = &#39;1&#39;,
$ng_use_ssl_auth = &#39;0&#39;,
$ng_enable_def_user = false,
$ng_def_user_name = &#39;nagios_insecure&#39;,
$ng_nagios_admin = &#39;nagios_sec_adm&#39;,
$ng_sysinfo_auth = &#39;&#39;,
$ng_confinfo_auth = &#39;&#39;,
$ng_command_auth = &#39;&#39;,
$ng_hostview_auth = &#39;&#39;,
$ng_serviceview_auth = &#39;&#39;,
$ng_host_cmd_auth = &#39;&#39;,
$ng_svc_cmd_auth = &#39;&#39;,
$ng_readonly_auth = &#39;&#39; ,
$ng_statusmap_img = &#39;smbackground.gd2&#39;,
$ng_use_colormap = false,
$ng_colormap_red = &#39;255&#39;,
$ng_colormap_green = &#39;255&#39;,
$ng_colormap_blue = &#39;255&#39;,
$ng_statusmap_layout = &#39;6&#39;,
$ng_wrl_layout = &#39;4&#39;,
$ng_incl_own_wrl = false,
$ng_statuswrl_include = &#39;&#39;,
$ng_ping_syntax = &#39;/bin/ping -n -U -c 5 $HOSTADDRESS$&#39;,
$ng_refresh_rate = &#39;90&#39;,
$ng_result_limit = &#39;100&#39;,
$ng_escape_html = &#39;1&#39;,
$ng_use_sound = false,
$ng_host_unreachable = &#39;hostdown.wav&#39;,
$ng_host_down = &#39;hostdown.wav&#39;,
$ng_svc_critical = &#39;critical.wav&#39;,
$ng_svc_warn = &#39;warning.wav&#39;,
$ng_svc_unknown = &#39;warning.wav&#39;,
$ng_normal_sound = &#39;noproblem.wav&#39;,
$ng_action_url_target = &#39;_blank&#39;,
$ng_notes_url_target = &#39;_blank&#39;,
$ng_lock_author_names = &#39;1&#39;,
$ng_enable_splunk = false,
$ng_splunk_url = &#39;http://127.0.0.1:8000/&#39;,
$ng_navbar_addresses = &#39;1&#39;,
$ng_navbar_aliases = &#39;1&#39;,
$ng_ack_no_sticky = &#39;0&#39;,
$ng_ack_no_send = &#39;0&#39;,
# selinux
$ng_use_selinux_tools = true,
# httpd
$ng_required_hosts = &#39;&#39;,
$ng_required_ips = &#39;127.0.0.0/8&#39;,
$ng_enable_index = true,
# certbot
$ng_enable_certbot = true,
$ng_certbot_webroot = &#39;/var/www/html&#39;,
$ng_webserver_name = &quot;nagios.${::domain}&quot;,
# main settings
$ng_log_file = &#39;/var/log/nagios/nagios.log&#39;,
$ng_max_check_attempts = &#39;10&#39;,
$ng_object_cache_file = &#39;/var/spool/nagios/objects.cache&#39;,
$ng_precached_obj_file = &#39;/var/spool/nagios/objects.precache&#39;,
$ng_resource_file = &#39;/etc/nagios/private/resource.cfg&#39;,
$ng_status_file = &#39;/var/log/nagios/status.dat&#39;,
$ng_status_upd_interval = &#39;10&#39;,
$ng_check_ext_commands = &#39;1&#39;,
$ng_command_file = &#39;/var/spool/nagios/cmd/nagios.cmd&#39;,
$ng_enable_query_handler = false,
$ng_query_socket = &#39;/var/spool/nagios/cmd/nagios.qh&#39;,
$ng_lock_file = &#39;/var/run/nagios/nagios.pid&#39;,
$ng_temp_file = &#39;/var/spool/nagios/nagios.tmp&#39;,
$ng_temp_path = &#39;/tmp&#39;,
$ng_event_broker_options = &#39;-1&#39;,
$ng_event_broker_module = &#39;&#39;,
$ng_log_rotation_method = &#39;h&#39;,
$ng_log_archive_path = &#39;/var/log/nagios/archives&#39;,
$ng_use_syslog = &#39;1&#39;,
$ng_log_notifications = &#39;1&#39;,
$ng_log_service_retries = &#39;1&#39;,
$ng_log_host_retries = &#39;1&#39;,
$ng_log_event_handlers = &#39;1&#39;,
$ng_log_initial_states = &#39;0&#39;,
$ng_log_current_states = &#39;1&#39;,
$ng_log_external_commands = &#39;1&#39;,
$ng_log_passive_checks = &#39;1&#39;,
$ng_glob_host_evt_handler = &#39;&#39;,
$ng_glob_svc_evt_handler = &#39;&#39;,
$ng_svc_int_check_delay = &#39;s&#39;,
$ng_max_svc_check_spread = &#39;30&#39;,
$ng_svc_interleave_factor = &#39;s&#39;,
$ng_host_int_check_delay = &#39;s&#39;,
$ng_max_host_check_spread = &#39;30&#39;,
$ng_max_concurrent_checks = &#39;0&#39;,
$ng_check_res_reaper_freq = &#39;10&#39;,
$ng_max_check_res_reap_time = &#39;30&#39;,
$ng_check_result_path = &#39;/var/spool/nagios/checkresults&#39;,
$ng_max_check_res_file_age = &#39;3600&#39;,
$ng_cached_h_check_horizon = &#39;15&#39;,
$ng_cached_s_check_horizon = &#39;15&#39;,
$ng_pred_host_dep_checks = &#39;1&#39;,
$ng_pred_svc_dep_checks = &#39;1&#39;,
$ng_soft_state_dependencies = &#39;0&#39;,
$ng_time_change_threshold = &#39;900&#39;,
$ng_auto_reschedule_checks = &#39;0&#39;,
$ng_auto_reschedule_intval = &#39;30&#39;,
$ng_auto_reschedule_window = &#39;180&#39;,
) {
# installation section
$reqpackages_server = $::operatingsystem ? {
/(?i-mx:centos|fedora|redhat)/ =&gt; [&#39;nagios&#39;,&#39;nagios-devel&#39;]
}
$reqpackages_client = $::operatingsystem ? {
/(?i-mx:centos|fedora|redhat)/ =&gt; [&#39;net-snmp-utils&#39;,&#39;nagios-plugins&#39;,&#39;nagios-plugins-all&#39;, &#39;nagios-plugins-nrpe&#39;, &#39;nagios-common&#39;]
}
$reqpackages_nrpe = $::operatingsystem ? {
/(?i-mx:centos|fedora|redhat)/ =&gt; [&#39;nrpe&#39;]
}
# service
$ng_service = &#39;nagios&#39;
$ae_service = &#39;httpd&#39;
# directories
$ng_main_dir = &#39;/etc/nagios&#39;
$ng_conf_d_dir = &quot;${ng_main_dir}/conf.d&quot;
$ng_objects_dir = &quot;${ng_main_dir}/objects&quot;
$ng_private_dir = &quot;${ng_main_dir}/private&quot;
$ng_usr_incl = &#39;/usr/include/nagios&#39;
$ng_lib_dir = &#39;/usr/lib64/nagios&#39;
$ng_log_dir = &#39;/var/log/nagios&#39;
$ng_log_archives = &quot;${ng_log_dir}/archives&quot;
$ng_spool_dir = &#39;/var/spool/nagios&#39;
$ng_usr_share = &#39;/usr/share/nagios&#39;
$ng_share_html = &quot;${ng_usr_share}/html&quot;
# files
$ng_main_config = &quot;${ng_main_dir}/nagios.cfg&quot;
$ng_cgi_cfg_file = &quot;${ng_main_dir}/cgi.cfg&quot;
$ng_cgi_cfg_erb = &#39;cd_nagios/nagios/cgi_cfg.erb&#39;
$ng_htpasswd_file = &quot;${ng_main_dir}/passwd&quot;
$ng_htpasswd_head = &#39;cd_nagios/nagios/htpasswd_head.erb&#39;
$ng_htpasswd_rule = &#39;cd_nagios/nagios/htpasswd_rule.erb&#39;
$ng_taccgi_erb = &#39;cd_nagios/selinux/taccgi.erb&#39;
$ng_statcgi_erb = &#39;cd_nagios/selinux/statuscgi.erb&#39;
$ng_nagios_conf = &#39;/etc/httpd/conf.d/nagios.conf&#39;
$ng_nagios_conf_erb = &#39;cd_nagios/httpd/nagios_conf.erb&#39;
$ng_welcome_conf = &#39;/etc/httpd/conf.d/welcome.conf&#39;
$ng_welcome_conf_erb = &#39;cd_nagios/httpd/welcome_conf.erb&#39;
$ng_forward_conf = &#39;/etc/httpd/conf.d/nagios_forward.conf&#39;
$ng_forward_conf_erb = &#39;cd_nagios/httpd/forward_conf.erb&#39;
$ng_get_cert_erb = &#39;cd_nagios/certbot/get_cert.erb&#39;
$ng_unless_get_cert = &#39;cd_nagios/certbot/unless_get_cert.erb&#39;
$ng_unless_renew_erb = &#39;cd_nagios/certbot/unless_renew_cert.erb&#39;
$ng_index_html_file = &#39;/var/www/html/index.html&#39;
$ng_index_html_erb = &#39;cd_nagios/httpd/index_html.erb&#39;
$ng_ssl_vhost_file = &#39;/etc/httpd/conf.d/nagios_ssl.conf&#39;
$ng_ssl_vhost_erb = &#39;cd_nagios/httpd/nagios_ssl_vhost.erb&#39;
$ng_nagios_cfg_file = &quot;${ng_main_dir}/nagios.cfg&quot;
$ng_nagios_cfg_erb = &#39;cd_nagios/nagios/nagios_cfg.erb&#39;
# certbot
$ng_certbot_main_dir = &#39;/etc/letsencrypt&#39;
$ng_certbot_archive = &quot;${ng_certbot_main_dir}/archive&quot;
$ng_certbot_check = &quot;${ng_certbot_archive}/${ng_webserver_name}/cert1.pem&quot;
$ng_certbot_live = &quot;${ng_certbot_main_dir}/live&quot;
# nagios
$ng_target_templates = &quot;${ng_conf_d_dir}/templates.cfg&quot;
$ng_target_timeperiods = &quot;${ng_conf_d_dir}/timeperiods.cfg&quot;
$ng_target_localhost = &quot;${ng_conf_d_dir}/nagios_localhost.cfg&quot;
$ng_target_host = &quot;${ng_conf_d_dir}/nagios_host.cfg&quot;
$ng_target_hostgroup = &quot;${ng_conf_d_dir}/nagios_hostgroup.cfg&quot;
$ng_target_hostdep = &quot;${ng_conf_d_dir}/nagios_hostdependency.cfg&quot;
$ng_target_hostesc = &quot;${ng_conf_d_dir}/nagios_hostescalation.cfg&quot;
$ng_target_hostext = &quot;${ng_conf_d_dir}/nagios_hostextinfo.cfg&quot;
$ng_target_service = &quot;${ng_conf_d_dir}/nagios_service.cfg&quot;
$ng_target_servicegroup = &quot;${ng_conf_d_dir}/nagios_servicegroup.cfg&quot;
$ng_target_contact = &quot;${ng_conf_d_dir}/nagios_contact.cfg&quot;
$ng_target_contactgroup = &quot;${ng_conf_d_dir}/nagios_contactgroup.cfg&quot;
$ng_target_command = &quot;${ng_conf_d_dir}/nagios_command.cfg&quot;
# includes must be last
include cd_nagios::main::config
}</pre>
</td>
</tr>
</table>
</div>
</div>
<div id="footer">
Generated on Mon Jul 24 17:25:34 2017 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.9 (ruby-2.0.0).
</div>
</div>
</body>
</html>