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
— 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 / >
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 / >
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 >
2026-02-14 19:41:42 +01:00
< 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" >
2026-02-14 18:41:39 +01:00
< li >
2026-02-14 19:41:42 +01:00
< span class = 'name' > ng_nagios_server< / span >
2026-02-14 18:41:39 +01:00
< span class = 'type' > (< tt > String< / tt > )< / span >
2026-02-14 19:41:42 +01:00
< em class = "default" > (defaults to: < tt > ' nagios.example.net' < / tt > )< / em >
2026-02-14 18:41:39 +01:00
2026-02-14 19:41:42 +01:00
—
< 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 >
2026-02-14 18:41:39 +01:00
< / li >
< li >
2026-02-14 19:41:42 +01:00
< span class = 'name' > ng_reqpackages_server< / span >
2026-02-14 18:41:39 +01:00
2026-02-14 19:41:42 +01:00
< span class = 'type' > (< tt > Array< / tt > )< / span >
2026-02-14 18:41:39 +01:00
2026-02-14 19:41:42 +01:00
< em class = "default" > (defaults to: < tt > [' nagios' ,' nagios-devel' ]< / tt > )< / em >
2026-02-14 18:41:39 +01:00
2026-02-14 19:41:42 +01:00
—
< div class = 'inline' >
< p > An array of packages to be installed on the Nagios server.< / p >
< / div >
2026-02-14 18:41:39 +01:00
< / li >
< li >
2026-02-14 19:41:42 +01:00
< span class = 'name' > ng_reqpackages_client< / span >
2026-02-14 18:41:39 +01:00
2026-02-14 19:41:42 +01:00
< span class = 'type' > (< tt > Array< / tt > )< / span >
2026-02-14 18:41:39 +01:00
2026-02-14 19:41:42 +01:00
< em class = "default" > (defaults to: < tt > [' net-snmp-utils' ,' nagios-plugins' ,' nagios-plugins-all' ,' nagios-plugins-nrpe' ,' nagios-common' ]< / tt > )< / em >
2026-02-14 18:41:39 +01:00
2026-02-14 19:41:42 +01:00
—
< div class = 'inline' >
< p > An array of packages to be installed on the Nagios clients.< / p >
< / div >
2026-02-14 18:41:39 +01:00
< / li >
< li >
2026-02-14 19:41:42 +01:00
< span class = 'name' > ng_pkg_ensure< / span >
2026-02-14 18:41:39 +01:00
< span class = 'type' > (< tt > String< / tt > )< / span >
2026-02-14 19:41:42 +01:00
< em class = "default" > (defaults to: < tt > ' present' < / tt > )< / em >
2026-02-14 18:41:39 +01:00
2026-02-14 19:41:42 +01:00
—
< div class = 'inline' >
< p > The ensure value for all packages. Default is ‘ ’ < / p >
< / div >
2026-02-14 18:41:39 +01:00
< / li >
< li >
2026-02-14 19:41:42 +01:00
< span class = 'name' > ng_user< / span >
2026-02-14 18:41:39 +01:00
< span class = 'type' > (< tt > String< / tt > )< / span >
2026-02-14 19:41:42 +01:00
—
< div class = 'inline' >
< p > The name of the Nagios user to be created on the Nagios server. Default is ‘ ’ < / p >
< / div >
2026-02-14 18:41:39 +01:00
< / li >
< li >
2026-02-14 19:41:42 +01:00
< span class = 'name' > ng_u_comment< / span >
2026-02-14 18:41:39 +01:00
< span class = 'type' > (< tt > String< / tt > )< / span >
2026-02-14 19:41:42 +01:00
—
< div class = 'inline' >
< p > The comment field for the Nagios user. Default is ‘ ’ < / p >
< / div >
2026-02-14 18:41:39 +01:00
< / li >
< li >
2026-02-14 19:41:42 +01:00
< span class = 'name' > ng_u_groups< / span >
2026-02-14 18:41:39 +01:00
< span class = 'type' > (< tt > String< / tt > )< / span >
2026-02-14 19:41:42 +01:00
—
< div class = 'inline' >
< p > The group(s) to which the Nagios user should be added. Default is ‘ ’ < / p >
< / div >
2026-02-14 18:41:39 +01:00
< / li >
< li >
2026-02-14 19:41:42 +01:00
< span class = 'name' > ng_u_shell< / span >
2026-02-14 18:41:39 +01:00
< span class = 'type' > (< tt > String< / tt > )< / span >
2026-02-14 19:41:42 +01:00
—
< div class = 'inline' >
< p > The login shell for the Nagios user. Default is ‘ ’ < / p >
< / div >
2026-02-14 18:41:39 +01:00
< / li >
< li >
2026-02-14 19:41:42 +01:00
< span class = 'name' > ng_u_home< / span >
2026-02-14 18:41:39 +01:00
< span class = 'type' > (< tt > String< / tt > )< / span >
2026-02-14 19:41:42 +01:00
—
< div class = 'inline' >
< p > The home directory for the Nagios user. Default is ‘ ’ < / p >
< / div >
2026-02-14 18:41:39 +01:00
2026-02-14 18:58:00 +01:00
< / li >
2026-02-14 18:41:39 +01:00
< li >
2026-02-14 19:41:42 +01:00
< span class = 'name' > ng_include_nrpe< / span >
2026-02-14 18:41:39 +01:00
< span class = 'type' > (< tt > Boolean< / tt > )< / span >
2026-02-14 19:41:42 +01:00
< em class = "default" > (defaults to: < tt > true< / tt > )< / em >
2026-02-14 18:49:41 +01:00
2026-02-14 19:41:42 +01:00
—
< div class = 'inline' >
< p > Whether to include the NRPE client on the Nagios clients. Default is true.< / p >
< / div >
2026-02-14 18:49:41 +01:00
< / li >
2026-02-14 18:58:00 +01:00
< li >
< span class = 'name' > ng_use_https< / span >
< span class = 'type' > (< tt > Boolean< / tt > )< / span >
< em class = "default" > (defaults to: < tt > false< / tt > )< / em >
2026-02-14 19:41:42 +01:00
—
< 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 >
2026-02-14 18:58:00 +01:00
< / li >
2026-02-13 19:30:20 +01:00
< / ul >
< / div > < div class = "method_details_list" >
< table class = "source_code" >
< tr >
< td >
< pre class = "lines" >
2026-02-14 19:53:27 +01:00
32
33
2026-02-14 19:41:42 +01:00
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
135
136
2026-02-14 20:04:31 +01:00
137< / pre >
2026-02-13 19:30:20 +01:00
< / td >
< td >
2026-02-14 19:53:27 +01:00
< pre class = "code" > < span class = "info file" > # File 'manifests/params.pp', line 32< / span >
2026-02-13 19:30:20 +01:00
class confdroid_nagios::params (
# main
2026-02-14 15:55:55 +01:00
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,
2026-02-13 19:30:20 +01:00
2026-02-14 15:42:45 +01:00
# httpd
Boolean $ng_use_https = false,
2026-02-13 19:30:20 +01:00
) {
# Default facts
$fqdn = $facts[' networking' ][' fqdn' ]
$domain = $facts[' networking' ][' domain' ]
$os_name = $facts[' os' ][' name' ]
$os_release = $facts[' os' ][' release' ][' major' ]
# service
2026-02-13 19:45:53 +01:00
$ng_nagios_service = ' nagios'
2026-02-13 19:30:20 +01:00
# 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"
2026-02-14 15:42:45 +01:00
# 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'
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 >
