Class holds all parameters for the confdroid_nrpe module and is
inherited by all classes except defines.
<h2>Overview</h2>
<divclass="docstring">
<divclass="discussion">
<p>confdroid_nrpe::params.pp Module name: confdroid_nrpe Author: 12ww1160 (12ww1160@ConfDroid.com) be passed to the NRPE daemon.</p>
</div>
</div>
<divclass="tags">
<pclass="tag_title">Parameters:</p>
<ulclass="param">
<li>
<spanclass='name'>pkg_ensure</span>
<spanclass='type'>(<tt>String</tt>)</span>
<emclass="default">(defaults to: <tt>'present'</tt>)</em>
—
<divclass='inline'>
<p>which <ahref="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>
<spanclass='name'>ne_log_facility</span>
<spanclass='type'>(<tt>String</tt>)</span>
<emclass="default">(defaults to: <tt>'daemon'</tt>)</em>
—
<divclass='inline'>
<p>the log facility to use.</p>
</div>
</li>
<li>
<spanclass='name'>ne_log_file</span>
<spanclass='type'>(<tt>String</tt>)</span>
<emclass="default">(defaults to: <tt>''</tt>)</em>
—
<divclass='inline'>
<p>If a log file is specified in this option, nrpe will write to that file instead of using syslog. i.e. /var/run/nrpe.log</p>
</div>
</li>
<li>
<spanclass='name'>ne_debug</span>
<spanclass='type'>(<tt>String</tt>)</span>
<emclass="default">(defaults to: <tt>'0'</tt>)</em>
—
<divclass='inline'>
<p>Whether debugging messages are logged to the syslog facility.</p>
</div>
</li>
<li>
<spanclass='name'>ne_nrpe_port</span>
<spanclass='type'>(<tt>String</tt>)</span>
<emclass="default">(defaults to: <tt>'5666'</tt>)</em>
—
<divclass='inline'>
<p>the NRPE port. used in firewall ( optional) and configuration file.</p>
</div>
</li>
<li>
<spanclass='name'>ne_listen_queue_size</span>
<spanclass='type'>(<tt>String</tt>)</span>
<emclass="default">(defaults to: <tt>'5'</tt>)</em>
—
<divclass='inline'>
<p>Listen queue size (backlog) for serving incoming connections.</p>
</div>
</li>
<li>
<spanclass='name'>ne_dont_blame_nrpe</span>
<spanclass='type'>(<tt>String</tt>)</span>
<emclass="default">(defaults to: <tt>'1'</tt>)</em>
—
<divclass='inline'>
<p>whether or not the NRPE daemon will allow clients to specify arguments to commands that are executed.</p>
</div>
</li>
<li>
<spanclass='name'>ne_allow_bash_cmd_subst</span>
<spanclass='type'>(<tt>String</tt>)</span>
<emclass="default">(defaults to: <tt>'1'</tt>)</em>
—
<divclass='inline'>
<p>whether or not the NRPE daemon will allow clients to specify arguments that contain bash command substitutions of the form $(…).</p>
</div>
</li>
<li>
<spanclass='name'>ne_allow_sudo</span>
<spanclass='type'>(<tt>Boolean</tt>)</span>
<emclass="default">(defaults to: <tt>true</tt>)</em>
—
<divclass='inline'>
<p>Whether to allow sudo access. used in nrpe.cfg as well as for creating a sudo role.</p>
</div>
</li>
<li>
<spanclass='name'>ne_command_prefix</span>
<spanclass='type'>(<tt>String</tt>)</span>
<emclass="default">(defaults to: <tt>'/usr/bin/sudo'</tt>)</em>
—
<divclass='inline'>
<p>allows you to prefix all commands with a user-defined String.</p>
</div>
</li>
<li>
<spanclass='name'>ne_incl_fw</span>
<spanclass='type'>(<tt>Boolean</tt>)</span>
<emclass="default">(defaults to: <tt>true</tt>)</em>
—
<divclass='inline'>
<p>Whether to include firewall rules</p>
</div>
</li>
<li>
<spanclass='name'>ne_command_timeout</span>
<spanclass='type'>(<tt>String</tt>)</span>
<emclass="default">(defaults to: <tt>'60'</tt>)</em>
—
<divclass='inline'>
<p>maximum number of seconds that the NRPE daemon will allow plugins to finish executing before killing them off.</p>
</div>
</li>
<li>
<spanclass='name'>ne_connection_timeout</span>
<spanclass='type'>(<tt>String</tt>)</span>
<emclass="default">(defaults to: <tt>'300'</tt>)</em>
—
<divclass='inline'>
<p>maximum number of seconds that the NRPE daemon will wait for a connection to be established before exiting.</p>
</div>
</li>
<li>
<spanclass='name'>ne_ssl_version</span>
<spanclass='type'>(<tt>String</tt>)</span>
<emclass="default">(defaults to: <tt>'TLSv2+'</tt>)</em>
—
<divclass='inline'>
<p>These directives allow you to specify how to use SSL/TLS.</p>
</div>
</li>
<li>
<spanclass='name'>ne_ssl_use_adh</span>
<spanclass='type'>(<tt>String</tt>)</span>
<emclass="default">(defaults to: <tt>'1'</tt>)</em>
—
<divclass='inline'>
<p>This is for backward compatibility and is DEPRECATED. Set to 1 to enable ADH or 2 to require ADH. 1 is currently the default but will be changed in a later version.</p>
</div>
</li>
<li>
<spanclass='name'>ne_ssl_cipher_list</span>
<spanclass='type'>(<tt>String</tt>)</span>
<emclass="default">(defaults to: <tt>'ALL:!aNULL:!eNULL:!SSLv2:!LOW:!EXP:!RC4:!MD5:@STRENGTH'</tt>)</em>
—
<divclass='inline'>
<p>ciphers can be used. For backward compatibility, this defaults to ‘ssl_cipher_list=ALL:!MD5:@STRENGTH’ in this version but will be changed in a later version of NRPE.</p>
</div>
</li>
<li>
<spanclass='name'>ne_ssl_cacert_file</span>
<spanclass='type'>(<tt>String</tt>)</span>
<emclass="default">(defaults to: <tt>'/etc/pki/tls/certs/ca-chain.crt.pem'</tt>)</em>
—
<divclass='inline'>
<p>path and name of the ssl certificate authority (ca) file / chain. must be full path.</p>
</div>
</li>
<li>
<spanclass='name'>ne_ssl_client_certs</span>
<spanclass='type'>(<tt>String</tt>)</span>
<emclass="default">(defaults to: <tt>'2'</tt>)</em>
—
<divclass='inline'>
<p>determines client certificate usage. Values: 0 = Don’t ask for or require client certificates 1 = Ask for client certificates 2 = Require client certificates</p>
</div>
</li>
<li>
<spanclass='name'>ne_ssl_logging</span>
<spanclass='type'>(<tt>String</tt>)</span>
<emclass="default">(defaults to: <tt>'0x00'</tt>)</em>
—
<divclass='inline'>
<p>determines which SSL messages are send to syslog. OR values together to specify multiple options. Values: 0x00 (0) = No additional logging (default) 0x01 (1) = Log startup SSL/TLS parameters 0x02 (2) = Log remote IP address 0x04 (4) = Log SSL/TLS version of connections 0x08 (8) = Log which cipher is being used for the connection 0x10 (16) = Log if client has a certificate 0x20 (32) = Log details of client’s certificate if it has one -1 or 0xff or 0x2f = All of the above</p>
</div>
</li>
<li>
<spanclass='name'>ne_nasty_metachars</span>
<spanclass='type'>(<tt>Array</tt>)</span>
<emclass="default">(defaults to: <tt>["|`&><'\\[]{};\r\n"]</tt>)</em>
—
<divclass='inline'>
<p>list of characters that cannot</p>
</div>
</li>
<li>
<spanclass='name'>ne_include_file</span>
<spanclass='type'>(<tt>String</tt>)</span>
<emclass="default">(defaults to: <tt>''</tt>)</em>
—
<divclass='inline'>
<p>include definitions from an external config file.</p>
</div>
</li>
<li>
<spanclass='name'>ne_fw_order_no</span>
<spanclass='type'>(<tt>String</tt>)</span>
<emclass="default">(defaults to: <tt>'50'</tt>)</em>
—
<divclass='inline'>
<p>ordering prefix for he firewall rules. Adjust to your environment if needed.</p>
</div>
</li>
<li>
<spanclass='name'>ne_ssl_opts</span>
<spanclass='type'>(<tt>String</tt>)</span>
<emclass="default">(defaults to: <tt>''</tt>)</em>
—
<divclass='inline'>
<p>Specify additional SSL options.</p>
</div>
</li>
<li>
<spanclass='name'>ne_user</span>
<spanclass='type'>(<tt>String</tt>)</span>
<emclass="default">(defaults to: <tt>'nrpe'</tt>)</em>
—
<divclass='inline'>
<p>the NRPE service user</p>
</div>
</li>
<li>
<spanclass='name'>ne_user_comment</span>
<spanclass='type'>(<tt>String</tt>)</span>
<emclass="default">(defaults to: <tt>'NRPE service user'</tt>)</em>
—
<divclass='inline'>
<p>The comment for the service user /etc/passwd</p>
</div>
</li>
<li>
<spanclass='name'>ne_user_uid</span>
<spanclass='type'>(<tt>String</tt>)</span>
<emclass="default">(defaults to: <tt>'1005'</tt>)</em>
—
<divclass='inline'>
<p>the UID for the service user</p>
</div>
</li>
<li>
<spanclass='name'>ne_user_home</span>
<spanclass='type'>(<tt>String</tt>)</span>
<emclass="default">(defaults to: <tt>'/var/run/nrpe'</tt>)</em>
—
<divclass='inline'>
<p>the home for the service user</p>
</div>
</li>
<li>
<spanclass='name'>ne_user_shell</span>
<spanclass='type'>(<tt>String</tt>)</span>
<emclass="default">(defaults to: <tt>'/sbin/nologin'</tt>)</em>
<emclass="default">(defaults to: <tt>'0.0.0.0/0'</tt>)</em>
—
<divclass='inline'>
<p>the source address for the firewall rule. Adjust to your environment if needed. Default is ‘0.0.0.0/0’ to allow all sources, but it is recommended to specify the nagios server IP or subnet.</p>
