503 lines
15 KiB
HTML
503 lines
15 KiB
HTML
<!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
|
||
|
||
— 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> »
|
||
<span class='title'><span class='object_link'>Puppet Classes</span></span>
|
||
»
|
||
<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_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_3Anagios.html" title="puppet_classes::confdroid_nagios::server::nagios (puppet_class)">confdroid_nagios::server::nagios</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/>
|
||
|
||
<span class='object_link'><a href="confdroid_nagios_3A_3Aserver_3A_3Aaccess_rules.html" title="puppet_classes::confdroid_nagios::server::access_rules (puppet_class)">confdroid_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 confdroid_nagios module and is
|
||
inherited by all classes except defines.
|
||
|
||
<h2>Overview</h2>
|
||
<div class="docstring">
|
||
<div class="discussion">
|
||
|
||
<p>confdroid_nagios::params 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>'nagios.example.net'</tt>)</em>
|
||
|
||
|
||
—
|
||
<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>['nagios','nagios-devel']</tt>)</em>
|
||
|
||
|
||
—
|
||
<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>['net-snmp-utils','nagios-plugins','nagios-plugins-all','nagios-plugins-nrpe','nagios-common']</tt>)</em>
|
||
|
||
|
||
—
|
||
<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>'present'</tt>)</em>
|
||
|
||
|
||
—
|
||
<div class='inline'>
|
||
<p>The ensure value for all packages. Default is ‘present’.</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>
|
||
|
||
|
||
—
|
||
<div class='inline'>
|
||
<p>Whether to include the NRPE client on the Nagios clients. Default is true.</p>
|
||
</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>
|
||
|
||
|
||
—
|
||
<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>
|
||
</div>
|
||
|
||
</li>
|
||
|
||
<li>
|
||
|
||
<span class='name'>ng_main_user</span>
|
||
|
||
|
||
<span class='type'>(<tt>String</tt>)</span>
|
||
|
||
|
||
<em class="default">(defaults to: <tt>'nagios'</tt>)</em>
|
||
|
||
|
||
—
|
||
<div class='inline'>
|
||
<p>The username for the Nagios web interface. Default is ‘nagios’.</p>
|
||
</div>
|
||
|
||
</li>
|
||
|
||
<li>
|
||
|
||
<span class='name'>ng_main_password</span>
|
||
|
||
|
||
<span class='type'>(<tt>String</tt>)</span>
|
||
|
||
|
||
<em class="default">(defaults to: <tt>'nagios'</tt>)</em>
|
||
|
||
|
||
—
|
||
<div class='inline'>
|
||
<p>The encrypted password for the Nagios web interface. Default is ‘nagios’. Must be properly encrypted using the htpasswd utility.</p>
|
||
</div>
|
||
|
||
</li>
|
||
|
||
</ul>
|
||
|
||
|
||
|
||
</div><div class="method_details_list">
|
||
<table class="source_code">
|
||
<tr>
|
||
<td>
|
||
<pre class="lines">
|
||
|
||
|
||
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
|
||
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</pre>
|
||
</td>
|
||
<td>
|
||
<pre class="code"><span class="info file"># File 'manifests/params.pp', line 27</span>
|
||
|
||
class confdroid_nagios::params (
|
||
|
||
# main
|
||
String $ng_nagios_server = 'nagios.example.net',
|
||
Array $ng_reqpackages_server = ['nagios','nagios-devel'],
|
||
Array $ng_reqpackages_client = ['net-snmp-utils','nagios-plugins','nagios-plugins-all','nagios-plugins-nrpe','nagios-common'],
|
||
String $ng_pkg_ensure = 'present',
|
||
Boolean $ng_include_nrpe = true,
|
||
String $ng_main_user = 'nagios',
|
||
String $ng_main_password = 'nagios',
|
||
|
||
# httpd
|
||
Boolean $ng_use_https = false,
|
||
|
||
) {
|
||
# Default facts
|
||
$fqdn = $facts['networking']['fqdn']
|
||
$domain = $facts['networking']['domain']
|
||
$os_name = $facts['os']['name']
|
||
$os_release = $facts['os']['release']['major']
|
||
|
||
# service
|
||
$ng_nagios_service = 'nagios'
|
||
|
||
# directories
|
||
$ng_main_dir = '/etc/nagios'
|
||
$ng_conf_d_dir = "${ng_main_dir}/conf.d"
|
||
$ng_objects_dir = "${ng_main_dir}/objects"
|
||
$ng_private_dir = "${ng_main_dir}/private"
|
||
$ng_usr_incl = '/usr/include/nagios'
|
||
$ng_lib_dir = '/usr/lib64/nagios'
|
||
$ng_log_dir = '/var/log/nagios'
|
||
$ng_log_archives = "${ng_log_dir}/archives"
|
||
$ng_spool_dir = '/var/spool/nagios'
|
||
$ng_usr_share = '/usr/share/nagios'
|
||
$ng_share_html = "${ng_usr_share}/html"
|
||
$ng_run_dir = '/var/run/nagios'
|
||
$ng_cmd_dir = "${ng_spool_dir}/cmd"
|
||
$ng_checkresults_dir = "${ng_spool_dir}/checkresults"
|
||
|
||
# files
|
||
$ng_nagios_cfg_file = "${ng_main_dir}/nagios.cfg"
|
||
$ng_nagios_cfg_erb = 'confdroid_nagios/nagios/nagios_cfg.erb'
|
||
|
||
## old
|
||
$ng_main_config = "${ng_main_dir}/nagios.cfg"
|
||
$ng_cgi_cfg_file = "${ng_main_dir}/cgi.cfg"
|
||
$ng_cgi_cfg_erb = 'confdroid_nagios/nagios/cgi_cfg.erb'
|
||
$ng_htpasswd_file = "${ng_main_dir}/passwd"
|
||
$ng_htpasswd_head = 'confdroid_nagios/nagios/htpasswd_head.erb'
|
||
$ng_htpasswd_rule = 'confdroid_nagios/nagios/htpasswd_rule.erb'
|
||
$ng_taccgi_erb = 'confdroid_nagios/selinux/taccgi.erb'
|
||
$ng_statcgi_erb = 'confdroid_nagios/selinux/statuscgi.erb'
|
||
$ng_statdat_erb = 'confdroid_nagios/selinux/statusdat.erb'
|
||
$ng_checknrpe_erb = 'confdroid_nagios/selinux/checknrpe.erb'
|
||
$ng_checknagios_erb = 'confdroid_nagios/selinux/checknagios.erb'
|
||
$ng_nagios_conf = '/etc/httpd/conf.d/nagios.conf'
|
||
$ng_nagios_conf_erb = 'confdroid_nagios/httpd/nagios_conf.erb'
|
||
$ng_welcome_conf = '/etc/httpd/conf.d/welcome.conf'
|
||
$ng_welcome_conf_erb = 'confdroid_nagios/httpd/welcome_conf.erb'
|
||
$ng_forward_conf = '/etc/httpd/conf.d/nagios_forward.conf'
|
||
$ng_forward_conf_erb = 'confdroid_nagios/httpd/forward_conf.erb'
|
||
$ng_get_cert_erb = 'confdroid_nagios/certbot/get_cert.erb'
|
||
$ng_unless_get_cert = 'confdroid_nagios/certbot/unless_get_cert.erb'
|
||
$ng_unless_renew_erb = 'confdroid_nagios/certbot/unless_renew_cert.erb'
|
||
$ng_index_html_file = '/var/www/html/index.html'
|
||
$ng_index_html_erb = 'confdroid_nagios/httpd/index_html.erb'
|
||
$ng_ssl_vhost_file = '/etc/httpd/conf.d/nagios_ssl.conf'
|
||
$ng_ssl_vhost_erb = 'confdroid_nagios/httpd/nagios_ssl_vhost.erb'
|
||
$ng_resource_erb = 'confdroid_nagios/nagios/resource_cfg.erb'
|
||
$ng_grep_erb = 'confdroid_nagios/selinux/grep.erb'
|
||
|
||
# nagios
|
||
$ng_target_templates = "${ng_conf_d_dir}/nagios_templates.cfg"
|
||
$ng_templates_head_erb = 'confdroid_nagios/nagios/templates_cfg_head.erb'
|
||
$ng_templates_rule_erb = 'confdroid_nagios/nagios/templates_cfg_rule.erb'
|
||
$ng_tgt_timeperiods_base = "${ng_conf_d_dir}/nagios_timeperiods.cfg"
|
||
$ng_tgt_timep_add = "${ng_conf_d_dir}/nagios_timeperiods_add.cfg"
|
||
$ng_tgt_timep_head_erb = 'confdroid_nagios/nagios/timeperiods_cfg_head.erb'
|
||
$ng_tgt_timep_rule_erb = 'confdroid_nagios/nagios/timeperiods_cfg_rule.erb'
|
||
$ng_target_localhost = "${ng_conf_d_dir}/nagios_localhost.cfg"
|
||
$ng_target_host = "${ng_conf_d_dir}/nagios_host.cfg"
|
||
$ng_target_hostgroup_base = "${ng_conf_d_dir}/nagios_hostgroups_base.cfg"
|
||
$ng_tgt_hostgroup_add = "${ng_conf_d_dir}/nagios_hostgroups_add.cfg"
|
||
$ng_tgt_hostgrp_head_erb = 'confdroid_nagios/nagios/hostgroups_cfg_head.erb'
|
||
$ng_tgt_hostgrp_rule_erb = 'confdroid_nagios/nagios/hostgroups_cfg_rule.erb'
|
||
$ng_target_hostdep = "${ng_conf_d_dir}/nagios_hostdependency.cfg"
|
||
$ng_target_hostesc = "${ng_conf_d_dir}/nagios_hostescalation.cfg"
|
||
$ng_target_hostext = "${ng_conf_d_dir}/nagios_hostextinfo.cfg"
|
||
$ng_target_service = "${ng_conf_d_dir}/nagios_service.cfg"
|
||
$ng_target_svcgrp_base = "${ng_conf_d_dir}/nagios_servicegroups_base.cfg"
|
||
$ng_tgt_servicegroup_add = "${ng_conf_d_dir}/nagios_servicegroups_add.cfg"
|
||
$ng_tgt_svcgrp_head_erb = 'confdroid_nagios/nagios/svcgroups_cfg_head.erb'
|
||
$ng_tgt_svcgrp_rule_erb = 'confdroid_nagios/nagios/svcgroups_cfg_rule.erb'
|
||
$ng_target_base_contact = "${ng_conf_d_dir}/nagios_contact_base.cfg"
|
||
$ng_target_add_contact = "${ng_conf_d_dir}/nagios_contact_add.cfg"
|
||
$ng_contacts_head_erb = 'confdroid_nagios/nagios/contacts_cfg_head.erb'
|
||
$ng_contacts_rule_erb = 'confdroid_nagios/nagios/contacts_cfg_rule.erb'
|
||
$ng_tgt_contactgroup_base = "${ng_conf_d_dir}/nagios_contactgroup_base.cfg"
|
||
$ng_tgt_contactgroup_add = "${ng_conf_d_dir}/nagios_contactgroup_add.cfg"
|
||
$ng_cntctgrps_head_erb = 'confdroid_nagios/nagios/contactgroups_cfg_head.erb'
|
||
$ng_cntctgrps_rule_erb = 'confdroid_nagios/nagios/contactgroups_cfg_rule.erb'
|
||
$ng_target_command = "${ng_conf_d_dir}/nagios_commands_base.cfg"
|
||
$ng_nagios_service_cmd = 'check_nagios!/var/log/nagios/status.dat!5!/usr/sbin/nagios'
|
||
|
||
# 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> |