confdroid/confdroid_nagios
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
Files
c653713e8fb52f5f824cedec987f4957935d7064
confdroid_nagios/doc/puppet_classes/confdroid_nagios_3A_3Aparams.html

651 lines
18 KiB
HTML
Raw Normal View History

Recommit for updates in build 23
2026-02-13 19:30:20 +01:00
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Puppet Class: confdroid_nagios::params
&mdash; Documentation by YARD 0.9.36
</title>
<link rel="stylesheet" href="../css/style.css" type="text/css" />
<link rel="stylesheet" href="../css/common.css" type="text/css" />
<script type="text/javascript">
pathId = "puppet_classes::confdroid_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">confdroid_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: confdroid_nagios::params</h1>
<div class="box_info">
<dl>
<dt>Inherited by:</dt>
<dd>
<span class='object_link'><a href="confdroid_nagios_3A_3Amain_3A_3Adirs.html" title="puppet_classes::confdroid_nagios::main::dirs (puppet_class)">confdroid_nagios::main::dirs</a></span><br/>
<span class='object_link'><a href="confdroid_nagios_3A_3Amain_3A_3Auser.html" title="puppet_classes::confdroid_nagios::main::user (puppet_class)">confdroid_nagios::main::user</a></span><br/>
<span class='object_link'><a href="confdroid_nagios_3A_3Amain_3A_3Aconfig.html" title="puppet_classes::confdroid_nagios::main::config (puppet_class)">confdroid_nagios::main::config</a></span><br/>
<span class='object_link'><a href="confdroid_nagios_3A_3Amain_3A_3Ainstall.html" title="puppet_classes::confdroid_nagios::main::install (puppet_class)">confdroid_nagios::main::install</a></span><br/>
<span class='object_link'><a href="confdroid_nagios_3A_3Aserver_3A_3Afiles.html" title="puppet_classes::confdroid_nagios::server::files (puppet_class)">confdroid_nagios::server::files</a></span><br/>
<span class='object_link'><a href="confdroid_nagios_3A_3Aclient_3A_3Atarget.html" title="puppet_classes::confdroid_nagios::client::target (puppet_class)">confdroid_nagios::client::target</a></span><br/>
Recommit for updates in build 25
2026-02-14 15:42:45 +01:00
<span class='object_link'><a href="confdroid_nagios_3A_3Aserver_3A_3Anagios.html" title="puppet_classes::confdroid_nagios::server::nagios (puppet_class)">confdroid_nagios::server::nagios</a></span><br/>
Recommit for updates in build 23
2026-02-13 19:30:20 +01:00
<span class='object_link'><a href="confdroid_nagios_3A_3Aserver_3A_3Aservice.html" title="puppet_classes::confdroid_nagios::server::service (puppet_class)">confdroid_nagios::server::service</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 confdroid_nagios module and is
inherited by all classes except defines.
<h2>Overview</h2>
<div class="docstring">
<div class="discussion">
<p>confdroid_nagios::params.pp Module name: confdroid_nagios Author: 12ww1160 (12ww1160@confdroid.com)</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>ng_nagios_server</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>&#39;nagios.example.net&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>The hostname or IP address of the Nagios server. This will determine the installation selection and the of the clients to connect to the Nagios server.</p>
</div>
</li>
<li>
<span class='name'>ng_reqpackages_server</span>
<span class='type'>(<tt>Array</tt>)</span>
<em class="default">(defaults to: <tt>[&#39;nagios&#39;,&#39;nagios-devel&#39;]</tt>)</em>
&mdash;
<div class='inline'>
<p>An array of packages to be installed on the Nagios server.</p>
</div>
</li>
<li>
<span class='name'>ng_reqpackages_client</span>
<span class='type'>(<tt>Array</tt>)</span>
<em class="default">(defaults to: <tt>[&#39;net-snmp-utils&#39;,&#39;nagios-plugins&#39;,&#39;nagios-plugins-all&#39;,&#39;nagios-plugins-nrpe&#39;,&#39;nagios-common&#39;]</tt>)</em>
&mdash;
<div class='inline'>
<p>An array of packages to be installed on the Nagios clients.</p>
</div>
</li>
<li>
<span class='name'>ng_pkg_ensure</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>&#39;present&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>The ensure value for all packages. Default is ‘present’.</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 user to be created on the Nagios server. Default is ‘nagios’.</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 User&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>The comment field for the Nagios user. Default is ‘Nagios User’.</p>
</div>
</li>
<li>
<span class='name'>ng_u_groups</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 group(s) to which the Nagios user should be added. Default is ‘nagios’.</p>
</div>
</li>
<li>
<span class='name'>ng_u_shell</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>&#39;/sbin/nologin&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>The login shell for the Nagios user. Default is ‘/sbin/nologin’.</p>
</div>
</li>
<li>
<span class='name'>ng_u_home</span>
<span class='type'>(<tt>String</tt>)</span>
<em class="default">(defaults to: <tt>&#39;/home/nagios&#39;</tt>)</em>
&mdash;
<div class='inline'>
<p>The home directory for the Nagios user. Default is ‘/home/nagios’.</p>
</div>
</li>
<li>
<span class='name'>ng_u_uid</span>
<span class='type'>(<tt>Integer</tt>)</span>
<em class="default">(defaults to: <tt>1004</tt>)</em>
&mdash;
<div class='inline'>
<p>The user ID for the Nagios user. Default is 1004.</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 the NRPE client on the Nagios clients. Default is true.</p>
Recommit for updates in build 25
2026-02-14 15:42:45 +01:00
</div>
</li>
<li>
<span class='name'>ng_use_https</span>
<span class='type'>(<tt>Boolean</tt>)</span>
<em class="default">(defaults to: <tt>false</tt>)</em>
&mdash;
<div class='inline'>
<p>Whether to configure the Nagios web interface to use HTTPS. Default is false. We recommend using a reverse proxy with SSL termination in front of the Nagios web interface, so this is disabled by default.</p>
Recommit for updates in build 28
2026-02-14 15:55:55 +01:00
</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>The event broker module to be used in the Nagios configuration. Default is an empty string, which means no event broker module will be configured. You can specify a module like ‘mod_gearman’ to enable the Gearman event broker module, for example.</p>
Recommit for updates in build 29
2026-02-14 15:59:53 +01:00
</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>The global host event handler to be used in the Nagios configuration. Default is an empty string, which means no global host event handler will be configured. You can specify a command like ‘notify-host-by-email’ to set a global host event handler that sends email notifications for host events, for example.</p>
Recommit for updates in build 30
2026-02-14 16:02:26 +01:00
</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>The global service event handler to be used in the Nagios configuration. Default is an empty string, which means no global service event handler will be configured. You can specify a command like ‘notify-service-by-email’ to set a global service event handler that sends email notifications for service events, for example.</p>
Recommit for updates in build 23
2026-02-13 19:30:20 +01:00
</div>
</li>
</ul>
</div><div class="method_details_list">
<table class="source_code">
<tr>
<td>
<pre class="lines">
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
Recommit for updates in build 25
2026-02-14 15:42:45 +01:00
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
Recommit for updates in build 28
2026-02-14 15:55:55 +01:00
143
144
145
146
147
148
149
Recommit for updates in build 29
2026-02-14 15:59:53 +01:00
150
151
152
153
154
155
Recommit for updates in build 30
2026-02-14 16:02:26 +01:00
156
157
158
159
160
161
162</pre>
Recommit for updates in build 23
2026-02-13 19:30:20 +01:00
</td>
<td>
Recommit for updates in build 30
2026-02-14 16:02:26 +01:00
<pre class="code"><span class="info file"># File 'manifests/params.pp', line 44</span>
Recommit for updates in build 23
2026-02-13 19:30:20 +01:00
class confdroid_nagios::params (
# main
Recommit for updates in build 28
2026-02-14 15:55:55 +01:00
String $ng_nagios_server = &#39;nagios.example.net&#39;,
Array $ng_reqpackages_server = [&#39;nagios&#39;,&#39;nagios-devel&#39;],
Array $ng_reqpackages_client = [&#39;net-snmp-utils&#39;,&#39;nagios-plugins&#39;,&#39;nagios-plugins-all&#39;,&#39;nagios-plugins-nrpe&#39;,&#39;nagios-common&#39;],
String $ng_pkg_ensure = &#39;present&#39;,
Boolean $ng_include_nrpe = true,
Recommit for updates in build 23
2026-02-13 19:30:20 +01:00
# user
Recommit for updates in build 28
2026-02-14 15:55:55 +01:00
String $ng_user = &#39;nagios&#39;,
String $ng_u_comment = &#39;Nagios User&#39;,
String $ng_u_groups = &#39;nagios&#39;,
String $ng_u_shell = &#39;/sbin/nologin&#39;,
String $ng_u_home = &#39;/home/nagios&#39;,
Integer $ng_u_uid = 1004,
# nagios_cfg settings
String $ng_event_broker_module = &#39;&#39;,
Recommit for updates in build 29
2026-02-14 15:59:53 +01:00
String $ng_glob_host_evt_handler = &#39;&#39;,
Recommit for updates in build 30
2026-02-14 16:02:26 +01:00
String $ng_glob_svc_evt_handler = &#39;&#39;,
Recommit for updates in build 23
2026-02-13 19:30:20 +01:00
Recommit for updates in build 25
2026-02-14 15:42:45 +01:00
# httpd
Boolean $ng_use_https = false,
Recommit for updates in build 23
2026-02-13 19:30:20 +01:00
) {
# Default facts
$fqdn = $facts[&#39;networking&#39;][&#39;fqdn&#39;]
$domain = $facts[&#39;networking&#39;][&#39;domain&#39;]
$os_name = $facts[&#39;os&#39;][&#39;name&#39;]
$os_release = $facts[&#39;os&#39;][&#39;release&#39;][&#39;major&#39;]
# service
Recommit for updates in build 24
2026-02-13 19:45:53 +01:00
$ng_nagios_service = &#39;nagios&#39;
Recommit for updates in build 23
2026-02-13 19:30:20 +01:00
# 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;
$ng_run_dir = &#39;/var/run/nagios&#39;
$ng_cmd_dir = &quot;${ng_spool_dir}/cmd&quot;
$ng_checkresults_dir = &quot;${ng_spool_dir}/checkresults&quot;
Recommit for updates in build 25
2026-02-14 15:42:45 +01:00
# files
$ng_nagios_cfg_file = &quot;${ng_main_dir}/nagios.cfg&quot;
$ng_nagios_cfg_erb = &#39;confdroid_nagios/nagios/nagios_cfg.erb&#39;
## old
$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;confdroid_nagios/nagios/cgi_cfg.erb&#39;
$ng_htpasswd_file = &quot;${ng_main_dir}/passwd&quot;
$ng_htpasswd_head = &#39;confdroid_nagios/nagios/htpasswd_head.erb&#39;
$ng_htpasswd_rule = &#39;confdroid_nagios/nagios/htpasswd_rule.erb&#39;
$ng_taccgi_erb = &#39;confdroid_nagios/selinux/taccgi.erb&#39;
$ng_statcgi_erb = &#39;confdroid_nagios/selinux/statuscgi.erb&#39;
$ng_statdat_erb = &#39;confdroid_nagios/selinux/statusdat.erb&#39;
$ng_checknrpe_erb = &#39;confdroid_nagios/selinux/checknrpe.erb&#39;
$ng_checknagios_erb = &#39;confdroid_nagios/selinux/checknagios.erb&#39;
$ng_nagios_conf = &#39;/etc/httpd/conf.d/nagios.conf&#39;
$ng_nagios_conf_erb = &#39;confdroid_nagios/httpd/nagios_conf.erb&#39;
$ng_welcome_conf = &#39;/etc/httpd/conf.d/welcome.conf&#39;
$ng_welcome_conf_erb = &#39;confdroid_nagios/httpd/welcome_conf.erb&#39;
$ng_forward_conf = &#39;/etc/httpd/conf.d/nagios_forward.conf&#39;
$ng_forward_conf_erb = &#39;confdroid_nagios/httpd/forward_conf.erb&#39;
$ng_get_cert_erb = &#39;confdroid_nagios/certbot/get_cert.erb&#39;
$ng_unless_get_cert = &#39;confdroid_nagios/certbot/unless_get_cert.erb&#39;
$ng_unless_renew_erb = &#39;confdroid_nagios/certbot/unless_renew_cert.erb&#39;
$ng_index_html_file = &#39;/var/www/html/index.html&#39;
$ng_index_html_erb = &#39;confdroid_nagios/httpd/index_html.erb&#39;
$ng_ssl_vhost_file = &#39;/etc/httpd/conf.d/nagios_ssl.conf&#39;
$ng_ssl_vhost_erb = &#39;confdroid_nagios/httpd/nagios_ssl_vhost.erb&#39;
$ng_resource_erb = &#39;confdroid_nagios/nagios/resource_cfg.erb&#39;
$ng_grep_erb = &#39;confdroid_nagios/selinux/grep.erb&#39;
# nagios
$ng_target_templates = &quot;${ng_conf_d_dir}/nagios_templates.cfg&quot;
$ng_templates_head_erb = &#39;confdroid_nagios/nagios/templates_cfg_head.erb&#39;
$ng_templates_rule_erb = &#39;confdroid_nagios/nagios/templates_cfg_rule.erb&#39;
$ng_tgt_timeperiods_base = &quot;${ng_conf_d_dir}/nagios_timeperiods.cfg&quot;
$ng_tgt_timep_add = &quot;${ng_conf_d_dir}/nagios_timeperiods_add.cfg&quot;
$ng_tgt_timep_head_erb = &#39;confdroid_nagios/nagios/timeperiods_cfg_head.erb&#39;
$ng_tgt_timep_rule_erb = &#39;confdroid_nagios/nagios/timeperiods_cfg_rule.erb&#39;
$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_base = &quot;${ng_conf_d_dir}/nagios_hostgroups_base.cfg&quot;
$ng_tgt_hostgroup_add = &quot;${ng_conf_d_dir}/nagios_hostgroups_add.cfg&quot;
$ng_tgt_hostgrp_head_erb = &#39;confdroid_nagios/nagios/hostgroups_cfg_head.erb&#39;
$ng_tgt_hostgrp_rule_erb = &#39;confdroid_nagios/nagios/hostgroups_cfg_rule.erb&#39;
$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_svcgrp_base = &quot;${ng_conf_d_dir}/nagios_servicegroups_base.cfg&quot;
$ng_tgt_servicegroup_add = &quot;${ng_conf_d_dir}/nagios_servicegroups_add.cfg&quot;
$ng_tgt_svcgrp_head_erb = &#39;confdroid_nagios/nagios/svcgroups_cfg_head.erb&#39;
$ng_tgt_svcgrp_rule_erb = &#39;confdroid_nagios/nagios/svcgroups_cfg_rule.erb&#39;
$ng_target_base_contact = &quot;${ng_conf_d_dir}/nagios_contact_base.cfg&quot;
$ng_target_add_contact = &quot;${ng_conf_d_dir}/nagios_contact_add.cfg&quot;
$ng_contacts_head_erb = &#39;confdroid_nagios/nagios/contacts_cfg_head.erb&#39;
$ng_contacts_rule_erb = &#39;confdroid_nagios/nagios/contacts_cfg_rule.erb&#39;
$ng_tgt_contactgroup_base = &quot;${ng_conf_d_dir}/nagios_contactgroup_base.cfg&quot;
$ng_tgt_contactgroup_add = &quot;${ng_conf_d_dir}/nagios_contactgroup_add.cfg&quot;
$ng_cntctgrps_head_erb = &#39;confdroid_nagios/nagios/contactgroups_cfg_head.erb&#39;
$ng_cntctgrps_rule_erb = &#39;confdroid_nagios/nagios/contactgroups_cfg_rule.erb&#39;
$ng_target_command = &quot;${ng_conf_d_dir}/nagios_commands_base.cfg&quot;
$ng_nagios_service_cmd = &#39;check_nagios!/var/log/nagios/status.dat!5!/usr/sbin/nagios&#39;
Recommit for updates in build 23
2026-02-13 19:30:20 +01:00
# includes must be last
include confdroid_nagios::main::config
}</pre>
</td>
</tr>
</table>
</div>
</div>
<div id="footer">
Generated by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>.
</div>
</div>
</body>
</html>
Reference in New Issue Copy Permalink