[strings] Generated Documentation Update at Revision v3.62.0-33-g0966901

_index.html

@@ -4,7 +4,7 @@
     <meta charset="utf-8">
 <meta name="viewport" content="width=device-width, initial-scale=1.0">
 <title>
-  Documentation by YARD 0.9.28
+  Documentation by YARD 0.9.34
 
 </title>
 
@@ -52,7 +52,7 @@
         <div class="clear"></div>
       </div>
 
-      <div id="content"><h1 class="noborder title">Documentation by YARD 0.9.28</h1>
+      <div id="content"><h1 class="noborder title">Documentation by YARD 0.9.34</h1>
 <div id="listing">
   <h1 class="alphaindex">Alphabetic Index</h1>
 

file.README.html

@@ -6,7 +6,7 @@
 <title>
   File: README
 
-    &mdash; Documentation by YARD 0.9.28
+    &mdash; Documentation by YARD 0.9.34
 
 </title>
 
@@ -124,9 +124,9 @@ <h1 id="label-Parameters">Parameters</h1>
 
 <p>Please keep in mind that this module does not include any sanity checks. Depending on the set parameters or values and the running version of SSH the resulting configuration could stop SSH from working.</p>
 
-<p>See <a href="REFERENCE.md">REFERENCE.md</a> for a list of all parameters.</p>
+<p>See <a href="REFERENCE_md.html">REFERENCE.md</a> for a list of all parameters.</p>
 
-<h1 id="label-Manage+user-27s+ssh_authorized_keys">Manage user&#39;s ssh_authorized_keys</h1>
+<h1 id="label-Manage+user-27s+ssh_authorized_keys">Manage user’s ssh_authorized_keys</h1>
 
 <p>The hash ssh::keys is passed to ssh_authorized_key type. Because of this, you may specify any valid parameter for ssh_authorized_key. See the <a href="https://github.com/puppetlabs/puppetlabs-sshkeys_core/blob/main/REFERENCE.md#ssh_authorized_key">Type Reference</a> for a complete list.</p>
 
@@ -187,19 +187,72 @@ <h1 id="label-Manage+configurations+files+in+.d+directories">Manage configuratio
 
 <h2 id="label-Sample+usage-3A">Sample usage:</h2>
 
-<p>Manage the client configuration file /etc/ssh/ssh_config.d/50-redhat.conf with some directives and default file permissions (0644 root:root). <code>yaml ssh::include: /etc/ssh/ssh_config.d/*.conf ssh::config_files:   &#39;50-redhat&#39;:     lines:       Match: &#39;final all&#39;       Include: &#39;/etc/crypto-policies/back-ends/openssh.config&#39;       GSSAPIAuthentication: &#39;yes&#39;       ForwardX11Trusted: &#39;yes&#39; </code></p>
+<p>Manage the client configuration file /etc/ssh/ssh_config.d/50-redhat.conf with some directives and default file permissions (0644 root:root).</p>
 
-<p>Manage the server configuration file /etc/ssh/sshd_config.d/50-redhat.conf with some directives and default file permissions (0600 root:root). <code>yaml ssh::server::include: /etc/ssh/sshd_config.d/*.conf ssh::server::config_files:   &#39;50-redhat&#39;:     lines:       Include: &#39;/etc/crypto-policies/back-ends/opensshserver.config&#39;       SyslogFacility: &#39;AUTHPRIV&#39;       ChallengeResponseAuthentication: &#39;no&#39;       GSSAPIAuthentication: &#39;yes&#39;       GSSAPICleanupCredentials: &#39;no&#39;       UsePAM: &#39;yes&#39;       X11Forwarding: &#39;yes&#39;       PrintMotd: &#39;no&#39; </code> You can also specify different file permissions by setting $owner, $group, or $mode accordingly: <code>yaml ssh::include: /etc/ssh/ssh_config.d/*.conf ssh::config_files:   &#39;50-redhat&#39;:     owner: &#39;name&#39;     group: &#39;group&#39;     mode:  &#39;0664&#39;     lines:       Match: &#39;final all&#39;       GSSAPIAuthentication: &#39;yes&#39; </code> Using directives that are not supported by this module: <code>yaml ssh::include: /etc/ssh/ssh_config.d/*.conf ssh::config_files:   &#39;50-redhat&#39;:     custom:       - &#39;Directive1 Value1&#39;       - &#39;Directive2 Value2&#39; </code></p>
+<pre class="code ruby"><code class="ruby">ssh::include: /etc/ssh/ssh_config.d/*.conf
+ssh::config_files:
+  &#39;50-redhat&#39;:
+    lines:
+      Match: &#39;final all&#39;
+      Include: &#39;/etc/crypto-policies/back-ends/openssh.config&#39;
+      GSSAPIAuthentication: &#39;yes&#39;
+      ForwardX11Trusted: &#39;yes&#39;
+</code></pre>
+
+<p>Manage the server configuration file /etc/ssh/sshd_config.d/50-redhat.conf with some directives and default file permissions (0600 root:root).</p>
+
+<pre class="code ruby"><code class="ruby">ssh::server::include: /etc/ssh/sshd_config.d/*.conf
+ssh::server::config_files:
+  &#39;50-redhat&#39;:
+    lines:
+      Include: &#39;/etc/crypto-policies/back-ends/opensshserver.config&#39;
+      SyslogFacility: &#39;AUTHPRIV&#39;
+      ChallengeResponseAuthentication: &#39;no&#39;
+      GSSAPIAuthentication: &#39;yes&#39;
+      GSSAPICleanupCredentials: &#39;no&#39;
+      UsePAM: &#39;yes&#39;
+      X11Forwarding: &#39;yes&#39;
+      PrintMotd: &#39;no&#39;
+</code></pre>
+
+<p>You can also specify different file permissions by setting $owner, $group, or $mode accordingly:</p>
+
+<pre class="code ruby"><code class="ruby">ssh::include: /etc/ssh/ssh_config.d/*.conf
+ssh::config_files:
+  &#39;50-redhat&#39;:
+    owner: &#39;name&#39;
+    group: &#39;group&#39;
+    mode:  &#39;0664&#39;
+    lines:
+      Match: &#39;final all&#39;
+      GSSAPIAuthentication: &#39;yes&#39;
+</code></pre>
 
-<p>Remove the file /etc/ssh/ssh_config.d/50-redhat.conf: <code>yaml ssh::include: /etc/ssh/ssh_config.d/*.conf ssh::config_files:   &#39;50-redhat&#39;:     ensure: &#39;absent&#39; </code></p>
+<p>Using directives that are not supported by this module:</p>
+
+<pre class="code ruby"><code class="ruby">ssh::include: /etc/ssh/ssh_config.d/*.conf
+ssh::config_files:
+  &#39;50-redhat&#39;:
+    custom:
+      - &#39;Directive1 Value1&#39;
+      - &#39;Directive2 Value2&#39;
+</code></pre>
+
+<p>Remove the file /etc/ssh/ssh_config.d/50-redhat.conf:</p>
+
+<pre class="code ruby"><code class="ruby">ssh::include: /etc/ssh/ssh_config.d/*.conf
+ssh::config_files:
+  &#39;50-redhat&#39;:
+    ensure: &#39;absent&#39;
+</code></pre>
 
 <h2 id="label-Upgrading">Upgrading</h2>
 
-<p>The SSH module v4 was completely rewritten. In this process all parameters for the SSH configuration files have been renamed. Users that want to upgrade need to change their running configuration. To make your upgrade easier there is a list of old and new parameter names. Consult <a href="UPGRADING.md">UPGRADING.md</a></p>
+<p>The SSH module v4 was completely rewritten. In this process all parameters for the SSH configuration files have been renamed. Users that want to upgrade need to change their running configuration. To make your upgrade easier there is a list of old and new parameter names. Consult <a href="UPGRADING_md.html">UPGRADING.md</a></p>
 
 <h2 id="label-Contributing">Contributing</h2>
 
-<p>Please check <a href="CONTRIBUTING.md">CONTRIBUTING.md</a></p>
+<p>Please check <a href="CONTRIBUTING_md.html">CONTRIBUTING.md</a></p>
 </div></div>
 
       <div id="footer">

frames.html

@@ -2,7 +2,7 @@
 <html>
 <head>
   <meta charset="utf-8">
-	<title>Documentation by YARD 0.9.28</title>
+	<title>Documentation by YARD 0.9.34</title>
 </head>
 <script type="text/javascript">
   var match = unescape(window.location.hash).match(/^#!(.+)/);

index.html

@@ -6,7 +6,7 @@
 <title>
   File: README
 
-    &mdash; Documentation by YARD 0.9.28
+    &mdash; Documentation by YARD 0.9.34
 
 </title>
 
@@ -124,9 +124,9 @@ <h1 id="label-Parameters">Parameters</h1>
 
 <p>Please keep in mind that this module does not include any sanity checks. Depending on the set parameters or values and the running version of SSH the resulting configuration could stop SSH from working.</p>
 
-<p>See <a href="REFERENCE.md">REFERENCE.md</a> for a list of all parameters.</p>
+<p>See <a href="REFERENCE_md.html">REFERENCE.md</a> for a list of all parameters.</p>
 
-<h1 id="label-Manage+user-27s+ssh_authorized_keys">Manage user&#39;s ssh_authorized_keys</h1>
+<h1 id="label-Manage+user-27s+ssh_authorized_keys">Manage user’s ssh_authorized_keys</h1>
 
 <p>The hash ssh::keys is passed to ssh_authorized_key type. Because of this, you may specify any valid parameter for ssh_authorized_key. See the <a href="https://github.com/puppetlabs/puppetlabs-sshkeys_core/blob/main/REFERENCE.md#ssh_authorized_key">Type Reference</a> for a complete list.</p>
 
@@ -187,19 +187,72 @@ <h1 id="label-Manage+configurations+files+in+.d+directories">Manage configuratio
 
 <h2 id="label-Sample+usage-3A">Sample usage:</h2>
 
-<p>Manage the client configuration file /etc/ssh/ssh_config.d/50-redhat.conf with some directives and default file permissions (0644 root:root). <code>yaml ssh::include: /etc/ssh/ssh_config.d/*.conf ssh::config_files:   &#39;50-redhat&#39;:     lines:       Match: &#39;final all&#39;       Include: &#39;/etc/crypto-policies/back-ends/openssh.config&#39;       GSSAPIAuthentication: &#39;yes&#39;       ForwardX11Trusted: &#39;yes&#39; </code></p>
+<p>Manage the client configuration file /etc/ssh/ssh_config.d/50-redhat.conf with some directives and default file permissions (0644 root:root).</p>
 
-<p>Manage the server configuration file /etc/ssh/sshd_config.d/50-redhat.conf with some directives and default file permissions (0600 root:root). <code>yaml ssh::server::include: /etc/ssh/sshd_config.d/*.conf ssh::server::config_files:   &#39;50-redhat&#39;:     lines:       Include: &#39;/etc/crypto-policies/back-ends/opensshserver.config&#39;       SyslogFacility: &#39;AUTHPRIV&#39;       ChallengeResponseAuthentication: &#39;no&#39;       GSSAPIAuthentication: &#39;yes&#39;       GSSAPICleanupCredentials: &#39;no&#39;       UsePAM: &#39;yes&#39;       X11Forwarding: &#39;yes&#39;       PrintMotd: &#39;no&#39; </code> You can also specify different file permissions by setting $owner, $group, or $mode accordingly: <code>yaml ssh::include: /etc/ssh/ssh_config.d/*.conf ssh::config_files:   &#39;50-redhat&#39;:     owner: &#39;name&#39;     group: &#39;group&#39;     mode:  &#39;0664&#39;     lines:       Match: &#39;final all&#39;       GSSAPIAuthentication: &#39;yes&#39; </code> Using directives that are not supported by this module: <code>yaml ssh::include: /etc/ssh/ssh_config.d/*.conf ssh::config_files:   &#39;50-redhat&#39;:     custom:       - &#39;Directive1 Value1&#39;       - &#39;Directive2 Value2&#39; </code></p>
+<pre class="code ruby"><code class="ruby">ssh::include: /etc/ssh/ssh_config.d/*.conf
+ssh::config_files:
+  &#39;50-redhat&#39;:
+    lines:
+      Match: &#39;final all&#39;
+      Include: &#39;/etc/crypto-policies/back-ends/openssh.config&#39;
+      GSSAPIAuthentication: &#39;yes&#39;
+      ForwardX11Trusted: &#39;yes&#39;
+</code></pre>
+
+<p>Manage the server configuration file /etc/ssh/sshd_config.d/50-redhat.conf with some directives and default file permissions (0600 root:root).</p>
+
+<pre class="code ruby"><code class="ruby">ssh::server::include: /etc/ssh/sshd_config.d/*.conf
+ssh::server::config_files:
+  &#39;50-redhat&#39;:
+    lines:
+      Include: &#39;/etc/crypto-policies/back-ends/opensshserver.config&#39;
+      SyslogFacility: &#39;AUTHPRIV&#39;
+      ChallengeResponseAuthentication: &#39;no&#39;
+      GSSAPIAuthentication: &#39;yes&#39;
+      GSSAPICleanupCredentials: &#39;no&#39;
+      UsePAM: &#39;yes&#39;
+      X11Forwarding: &#39;yes&#39;
+      PrintMotd: &#39;no&#39;
+</code></pre>
+
+<p>You can also specify different file permissions by setting $owner, $group, or $mode accordingly:</p>
+
+<pre class="code ruby"><code class="ruby">ssh::include: /etc/ssh/ssh_config.d/*.conf
+ssh::config_files:
+  &#39;50-redhat&#39;:
+    owner: &#39;name&#39;
+    group: &#39;group&#39;
+    mode:  &#39;0664&#39;
+    lines:
+      Match: &#39;final all&#39;
+      GSSAPIAuthentication: &#39;yes&#39;
+</code></pre>
 
-<p>Remove the file /etc/ssh/ssh_config.d/50-redhat.conf: <code>yaml ssh::include: /etc/ssh/ssh_config.d/*.conf ssh::config_files:   &#39;50-redhat&#39;:     ensure: &#39;absent&#39; </code></p>
+<p>Using directives that are not supported by this module:</p>
+
+<pre class="code ruby"><code class="ruby">ssh::include: /etc/ssh/ssh_config.d/*.conf
+ssh::config_files:
+  &#39;50-redhat&#39;:
+    custom:
+      - &#39;Directive1 Value1&#39;
+      - &#39;Directive2 Value2&#39;
+</code></pre>
+
+<p>Remove the file /etc/ssh/ssh_config.d/50-redhat.conf:</p>
+
+<pre class="code ruby"><code class="ruby">ssh::include: /etc/ssh/ssh_config.d/*.conf
+ssh::config_files:
+  &#39;50-redhat&#39;:
+    ensure: &#39;absent&#39;
+</code></pre>
 
 <h2 id="label-Upgrading">Upgrading</h2>
 
-<p>The SSH module v4 was completely rewritten. In this process all parameters for the SSH configuration files have been renamed. Users that want to upgrade need to change their running configuration. To make your upgrade easier there is a list of old and new parameter names. Consult <a href="UPGRADING.md">UPGRADING.md</a></p>
+<p>The SSH module v4 was completely rewritten. In this process all parameters for the SSH configuration files have been renamed. Users that want to upgrade need to change their running configuration. To make your upgrade easier there is a list of old and new parameter names. Consult <a href="UPGRADING_md.html">UPGRADING.md</a></p>
 
 <h2 id="label-Contributing">Contributing</h2>
 
-<p>Please check <a href="CONTRIBUTING.md">CONTRIBUTING.md</a></p>
+<p>Please check <a href="CONTRIBUTING_md.html">CONTRIBUTING.md</a></p>
 </div></div>
 
       <div id="footer">

puppet_classes/ssh.html

@@ -6,7 +6,7 @@
 <title>
   Puppet Class: ssh
 
-    &mdash; Documentation by YARD 0.9.28
+    &mdash; Documentation by YARD 0.9.34
 
 </title>
 
@@ -84,6 +84,7 @@ <h2>Overview</h2>
 </div>
 
 
+
 <div class="tags">
   <p class="tag_title">Parameters:</p>
 <ul class="param">
@@ -340,6 +341,24 @@ <h2>Overview</h2>
 
     </li>
 
+    <li>
+
+        <span class='name'>manage_packages</span>
+
+
+        <span class='type'>(<tt>Boolean</tt>)</span>
+
+
+        <em class="default">(defaults to: <tt>true</tt>)</em>
+
+
+        &mdash;
+        <div class='inline'>
+<p>Boolean to choose if SSH client packages should be managed.</p>
+</div>
+
+    </li>
+
     <li>
 
         <span class='name'>packages</span>
@@ -358,6 +377,24 @@ <h2>Overview</h2>
 
     </li>
 
+    <li>
+
+        <span class='name'>packages_ensure</span>
+
+
+        <span class='type'>(<tt>Variant[Enum['present', 'absent', 'purged', 'disabled', 'installed', 'latest'], String[1]]</tt>)</span>
+
+
+        <em class="default">(defaults to: <tt>&#39;installed&#39;</tt>)</em>
+
+
+        &mdash;
+        <div class='inline'>
+<p>Ensure parameter to SSH client package(s).</p>
+</div>
+
+    </li>
+
     <li>
 
         <span class='name'>packages_adminfile</span>
@@ -2277,12 +2314,6 @@ <h2>Overview</h2>
         <pre class="lines">
 
 
-469
-470
-471
-472
-473
-474
 475
 476
 477
@@ -2504,10 +2535,22 @@ <h2>Overview</h2>
 693
 694
 695
-696</pre>
+696
+697
+698
+699
+700
+701
+702
+703
+704
+705
+706
+707
+708</pre>
       </td>
       <td>
-        <pre class="code"><span class="info file"># File 'manifests/init.pp', line 469</span>
+        <pre class="code"><span class="info file"># File 'manifests/init.pp', line 475</span>
 
 class ssh (
   Hash $config_entries = {},
@@ -2524,7 +2567,9 @@ <h2>Overview</h2>
   Boolean $manage_root_ssh_config = false,
   Boolean $manage_server = true,
   Boolean $manage_sshkey = true,
+  Boolean $manage_packages = true,
   Array[String[1]] $packages = [],
+  Variant[Enum[&#39;present&#39;, &#39;absent&#39;, &#39;purged&#39;, &#39;disabled&#39;, &#39;installed&#39;, &#39;latest&#39;], String[1]] $packages_ensure = &#39;installed&#39;,
   Optional[Stdlib::Absolutepath] $packages_adminfile = undef,
   Optional[Stdlib::Absolutepath] $packages_source = undef,
   Boolean $purge_keys = true,
@@ -2635,12 +2680,16 @@ <h2>Overview</h2>
   # the ssh_config file.
   Optional[Array[String[1]]] $custom = undef
 ) {
-
-  package { $packages:
-    ensure    =&gt; installed,
-    source    =&gt; $packages_source,
-    adminfile =&gt; $packages_adminfile,
-    before    =&gt; &#39;File[ssh_config]&#39;,
+  if $manage_packages {
+    package { $packages:
+      ensure    =&gt; $packages_ensure,
+      source    =&gt; $packages_source,
+      adminfile =&gt; $packages_adminfile,
+      before    =&gt; &#39;File[ssh_config]&#39;,
+    }
+    $packages_require = Package[$packages]
+  } else {
+    $packages_require = undef
   }
 
   file { &#39;ssh_config&#39; :
@@ -2663,7 +2712,7 @@ <h2>Overview</h2>
       purge   =&gt; $include_dir_purge,
       recurse =&gt; $include_dir_purge,
       force   =&gt; $include_dir_purge,
-      require =&gt; Package[$packages],
+      require =&gt; $packages_require,
     }
   } else {
     $include_dir = undef