confdroid_ntp/doc/puppet_classes/confdroid_ntp_3A_3Aparams.html

<!DOCTYPE html>
<html>
  <head>
    <meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
  Puppet Class: confdroid_ntp::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_ntp::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_ntp::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_ntp::params</h1>
<div class="box_info">
  
  
  <dl>
    <dt>Inherited by:</dt>
    <dd>
      
      <span class='object_link'><a href="confdroid_ntp_3A_3Amain_3A_3Adirs.html" title="puppet_classes::confdroid_ntp::main::dirs (puppet_class)">confdroid_ntp::main::dirs</a></span><br/>
      
      <span class='object_link'><a href="confdroid_ntp_3A_3Amain_3A_3Afiles.html" title="puppet_classes::confdroid_ntp::main::files (puppet_class)">confdroid_ntp::main::files</a></span><br/>
      
      <span class='object_link'><a href="confdroid_ntp_3A_3Amain_3A_3Aconfig.html" title="puppet_classes::confdroid_ntp::main::config (puppet_class)">confdroid_ntp::main::config</a></span><br/>
      
      <span class='object_link'><a href="confdroid_ntp_3A_3Amain_3A_3Ainstall.html" title="puppet_classes::confdroid_ntp::main::install (puppet_class)">confdroid_ntp::main::install</a></span><br/>
      
      <span class='object_link'><a href="confdroid_ntp_3A_3Amain_3A_3Aservice.html" title="puppet_classes::confdroid_ntp::main::service (puppet_class)">confdroid_ntp::main::service</a></span><br/>
      
      <span class='object_link'><a href="confdroid_ntp_3A_3Amonitoring_3A_3Atarget.html" title="puppet_classes::confdroid_ntp::monitoring::target (puppet_class)">confdroid_ntp::monitoring::target</a></span><br/>
      
    </dd>
  </dl>
  
  <dl>
    <dt>Defined in:</dt>
    <dd>
      manifests/params.pp
    </dd>
  </dl>
</div>

  <h2>Summary</h2>
  Class contains all parameters for the confdroid_ntp module.

<h2>Overview</h2>
<div class="docstring">
  <div class="discussion">
    
<p>confdroid_ntp::params.pp Module name: confdroid_ntp Author: 12ww1160 (12ww1160@confdroid.com)</p>

  </div>
</div>



<div class="tags">
  <p class="tag_title">Parameters:</p>
<ul class="param">
  
    <li>
      
        <span class='name'>cy_reqpackages</span>
      
      
        <span class='type'>(<tt>Array</tt>)</span>
      
      
        <em class="default">(defaults to: <tt>[&#39;chrony&#39;]</tt>)</em>
      
      
        &mdash;
        <div class='inline'>
<p>List of required packages to install for the confdroid_ntp module.</p>
</div>
      
    </li>
  
    <li>
      
        <span class='name'>cy_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>Ensure state of the required packages.</p>
</div>
      
    </li>
  
    <li>
      
        <span class='name'>cy_server_fqdn</span>
      
      
        <span class='type'>(<tt>String</tt>)</span>
      
      
        <em class="default">(defaults to: <tt>&#39;ntp.example.local&#39;</tt>)</em>
      
      
        &mdash;
        <div class='inline'>
<p>FQDN of the NTP server to configure. If the fqdn of the host matches this value, a time server will be configured, else a client.</p>
</div>
      
    </li>
  
    <li>
      
        <span class='name'>cy_conf_servers</span>
      
      
        <span class='type'>(<tt>Array</tt>)</span>
      
      
        <em class="default">(defaults to: <tt>[&#39;0.pool.ntp.org&#39;, &#39;1.pool.ntp.org&#39;, &#39;2.pool.ntp.org&#39;, &#39;3.pool.ntp.org&#39;]</tt>)</em>
      
      
        &mdash;
        <div class='inline'>
<p>List of NTP servers to point to as time source</p>
</div>
      
    </li>
  
    <li>
      
        <span class='name'>cy_min_sources</span>
      
      
        <span class='type'>(<tt>String</tt>)</span>
      
      
        <em class="default">(defaults to: <tt>&#39;3&#39;</tt>)</em>
      
      
        &mdash;
        <div class='inline'>
<p>Minimum number of selectable sources required to adjust the system clock. Primarily used for servers.</p>
</div>
      
    </li>
  
    <li>
      
        <span class='name'>cy_client_allow</span>
      
      
        <span class='type'>(<tt>String</tt>)</span>
      
      
        <em class="default">(defaults to: <tt>&#39;192.168.1.0/24&#39;</tt>)</em>
      
      
        &mdash;
        <div class='inline'>
<p>CIDR notation for allowed client networks</p>
</div>
      
    </li>
  
    <li>
      
        <span class='name'>cy_leapsec_mode</span>
      
      
        <span class='type'>(<tt>String</tt>)</span>
      
      
        <em class="default">(defaults to: <tt>&#39;slew&#39;</tt>)</em>
      
      
        &mdash;
        <div class='inline'>
<p>Leap second handling mode. Valid values are ‘slew’ or ‘step’.</p>
</div>
      
    </li>
  
    <li>
      
        <span class='name'>cy_leapsectz</span>
      
      
        <span class='type'>(<tt>String</tt>)</span>
      
      
        <em class="default">(defaults to: <tt>&#39;right/UTC&#39;</tt>)</em>
      
      
        &mdash;
        <div class='inline'>
<p>Leap second timezone file to use.</p>
</div>
      
    </li>
  
    <li>
      
        <span class='name'>cy_loginfo</span>
      
      
        <span class='type'>(<tt>String</tt>)</span>
      
      
        <em class="default">(defaults to: <tt>&#39;measurements statistics tracking&#39;</tt>)</em>
      
      
        &mdash;
        <div class='inline'>
<p>Log information to record. Valid values are ‘measurements’, ‘statistics’, and ‘tracking’.</p>
</div>
      
    </li>
  
    <li>
      
        <span class='name'>cy_use_lan_server</span>
      
      
        <span class='type'>(<tt>Boolean</tt>)</span>
      
      
        <em class="default">(defaults to: <tt>false</tt>)</em>
      
      
        &mdash;
        <div class='inline'>
<p>Whether to use a local LAN server or external pool.</p>
</div>
      
    </li>
  
    <li>
      
        <span class='name'>cy_manage_nagios</span>
      
      
        <span class='type'>(<tt>Boolean</tt>)</span>
      
      
        <em class="default">(defaults to: <tt>false</tt>)</em>
      
      
        &mdash;
        <div class='inline'>
<p>Whether to manage Nagios monitoring for the module.</p>
</div>
      
    </li>
  
    <li>
      
        <span class='name'>cy_procs_allowed</span>
      
      
        <span class='type'>(<tt>String</tt>)</span>
      
      
        <em class="default">(defaults to: <tt>&#39;1&#39;</tt>)</em>
      
      
        &mdash;
        <div class='inline'>
<p>Number of allowed processes for the Nagios check.</p>
</div>
      
    </li>
  
    <li>
      
        <span class='name'>cy_target_service</span>
      
      
        <span class='type'>(<tt>String</tt>)</span>
      
      
        <em class="default">(defaults to: <tt>&#39;/etc/nagios/conf.d/chronyd_service.cfg&#39;</tt>)</em>
      
      
        &mdash;
        <div class='inline'>
<p>Path to the Nagios service configuration file.</p>
</div>
      
    </li>
  
    <li>
      
        <span class='name'>cy_target_contacts</span>
      
      
        <span class='type'>(<tt>Array</tt>)</span>
      
      
        <em class="default">(defaults to: <tt>[&#39;admin&#39;]</tt>)</em>
      
      
        &mdash;
        <div class='inline'>
<p>List of Nagios contacts for notifications.</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</pre>
      </td>
      <td>
        <pre class="code"><span class="info file"># File 'manifests/params.pp', line 26</span>

class confdroid_ntp::params (

# installation
  Array $cy_reqpackages       = [&#39;chrony&#39;],
  String $cy_pkg_ensure       = &#39;present&#39;,

# configuration
  Boolean $cy_use_lan_server  = false,
  String $cy_server_fqdn      = &#39;ntp.example.local&#39;,
  Array $cy_conf_servers      = [&#39;0.pool.ntp.org&#39;, &#39;1.pool.ntp.org&#39;, &#39;2.pool.ntp.org&#39;, &#39;3.pool.ntp.org&#39;],
  String $cy_min_sources      = &#39;3&#39;,
  String $cy_client_allow     = &#39;192.168.1.0/24&#39;,
  String $cy_leapsec_mode     = &#39;slew&#39;,
  String $cy_leapsectz        = &#39;right/UTC&#39;,
  String $cy_loginfo          = &#39;measurements statistics tracking&#39;,

# monitoring
  Boolean $cy_manage_nagios   = false,
  String $cy_procs_allowed    = &#39;1&#39;,
  String $cy_target_service   = &#39;/etc/nagios/conf.d/chronyd_service.cfg&#39;,
  Array $cy_target_contacts   = [&#39;admin&#39;],

) {
# 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;]

# dirs

# files
  $cy_conf_file               = &#39;/etc/chrony.conf&#39;
  $cy_conf_erb                = &#39;confdroid_ntp/chrony.conf.erb&#39;
  $cy_drift_file              = &#39;/var/lib/chrony/drift&#39;
  $cy_logrotate_file          = &#39;/etc/logrotate.d/chrony&#39;
  $cy_logrotate_erb           = &#39;confdroid_ntp/logrotate.chrony.erb&#39;

# service
  $cy_service                 = &#39;chronyd&#39;

# includes must be last
  include confdroid_ntp::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>