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

431 lines
11 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/>
<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>
</div>
</li>
</ul>
</div><div class="method_details_list">
<table class="source_code">
<tr>
<td>
<pre class="lines">
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
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 24
2026-02-13 19:45:53 +01:00
71</pre>
Recommit for updates in build 23
2026-02-13 19:30:20 +01:00
</td>
<td>
<pre class="code"><span class="info file"># File 'manifests/params.pp', line 26</span>
class confdroid_nagios::params (
# main
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,
# user
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,
) {
# 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;
# 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