Skip to content

Commit

Permalink
[strings] Generated Documentation Update at Revision v3.62.0-44-gb0eaa74
Browse files Browse the repository at this point in the history
  • Loading branch information
ghoneycutt committed Dec 10, 2024
1 parent 9e93193 commit 2e5d9ae
Show file tree
Hide file tree
Showing 17 changed files with 52 additions and 145 deletions.
4 changes: 2 additions & 2 deletions _index.html
Original file line number Diff line number Diff line change
Expand Up @@ -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.34
Documentation by YARD 0.9.36

</title>

Expand Down Expand Up @@ -52,7 +52,7 @@
<div class="clear"></div>
</div>

<div id="content"><h1 class="noborder title">Documentation by YARD 0.9.34</h1>
<div id="content"><h1 class="noborder title">Documentation by YARD 0.9.36</h1>
<div id="listing">
<h1 class="alphaindex">Alphabetic Index</h1>

Expand Down
73 changes: 12 additions & 61 deletions file.README.html
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<title>
File: README

&mdash; Documentation by YARD 0.9.34
&mdash; Documentation by YARD 0.9.36

</title>

Expand Down Expand Up @@ -93,6 +93,8 @@ <h3 id="label-Known+to+work">Known to work</h3>
</li><li>
<p>Debian 11</p>
</li><li>
<p>Debian 12</p>
</li><li>
<p>EL 7</p>
</li><li>
<p>EL 8</p>
Expand All @@ -105,6 +107,8 @@ <h3 id="label-Known+to+work">Known to work</h3>
</li><li>
<p>Ubuntu 22.04 LTS</p>
</li><li>
<p>Ubuntu 24.04 LTS</p>
</li><li>
<p>Solaris 10</p>
</li><li>
<p>Solaris 11</p>
Expand All @@ -124,9 +128,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.html">REFERENCE.md</a> for a list of all parameters.</p>
<p>See <a href="REFERENCE.md">REFERENCE.md</a> for a list of all parameters.</p>

<h1 id="label-Manage+user-27s+ssh_authorized_keys">Manage users ssh_authorized_keys</h1>
<h1 id="label-Manage+user-27s+ssh_authorized_keys">Manage user&#39;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>

Expand Down Expand Up @@ -187,72 +191,19 @@ <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).</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>Using directives that are not supported by this module:</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). <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>

<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>
<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;:
ensure: &#39;absent&#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>

<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.html">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">UPGRADING.md</a></p>

<h2 id="label-Contributing">Contributing</h2>

<p>Please check <a href="CONTRIBUTING_md.html">CONTRIBUTING.md</a></p>
<p>Please check <a href="CONTRIBUTING.md">CONTRIBUTING.md</a></p>
</div></div>

<div id="footer">
Expand Down
15 changes: 10 additions & 5 deletions frames.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,18 @@
<html>
<head>
<meta charset="utf-8">
<title>Documentation by YARD 0.9.34</title>
<title>Documentation by YARD 0.9.36</title>
</head>
<script type="text/javascript">
var match = unescape(window.location.hash).match(/^#!(.+)/);
var name = match ? match[1] : 'index.html';
name = name.replace(/^(\w+):\/\//, '').replace(/^\/\//, '');
window.top.location = name;
var mainUrl = 'index.html';
try {
var match = decodeURIComponent(window.location.hash).match(/^#!(.+)/);
var name = match ? match[1] : mainUrl;
var url = new URL(name, location.href);
window.top.location.replace(url.origin === location.origin ? name : mainUrl);
} catch (e) {
window.top.location.replace(mainUrl);
}
</script>
<noscript>
<h1>Oops!</h1>
Expand Down
73 changes: 12 additions & 61 deletions index.html
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<title>
File: README

&mdash; Documentation by YARD 0.9.34
&mdash; Documentation by YARD 0.9.36

</title>

Expand Down Expand Up @@ -93,6 +93,8 @@ <h3 id="label-Known+to+work">Known to work</h3>
</li><li>
<p>Debian 11</p>
</li><li>
<p>Debian 12</p>
</li><li>
<p>EL 7</p>
</li><li>
<p>EL 8</p>
Expand All @@ -105,6 +107,8 @@ <h3 id="label-Known+to+work">Known to work</h3>
</li><li>
<p>Ubuntu 22.04 LTS</p>
</li><li>
<p>Ubuntu 24.04 LTS</p>
</li><li>
<p>Solaris 10</p>
</li><li>
<p>Solaris 11</p>
Expand All @@ -124,9 +128,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.html">REFERENCE.md</a> for a list of all parameters.</p>
<p>See <a href="REFERENCE.md">REFERENCE.md</a> for a list of all parameters.</p>

<h1 id="label-Manage+user-27s+ssh_authorized_keys">Manage users ssh_authorized_keys</h1>
<h1 id="label-Manage+user-27s+ssh_authorized_keys">Manage user&#39;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>

Expand Down Expand Up @@ -187,72 +191,19 @@ <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).</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>Using directives that are not supported by this module:</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). <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>

<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>
<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;:
ensure: &#39;absent&#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>

<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.html">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">UPGRADING.md</a></p>

<h2 id="label-Contributing">Contributing</h2>

<p>Please check <a href="CONTRIBUTING_md.html">CONTRIBUTING.md</a></p>
<p>Please check <a href="CONTRIBUTING.md">CONTRIBUTING.md</a></p>
</div></div>

<div id="footer">
Expand Down
2 changes: 1 addition & 1 deletion puppet_classes/ssh.html
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<title>
Puppet Class: ssh

&mdash; Documentation by YARD 0.9.34
&mdash; Documentation by YARD 0.9.36

</title>

Expand Down
4 changes: 2 additions & 2 deletions puppet_classes/ssh_3A_3Aserver.html
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<title>
Puppet Class: ssh::server

&mdash; Documentation by YARD 0.9.34
&mdash; Documentation by YARD 0.9.36

</title>

Expand Down Expand Up @@ -2154,7 +2154,7 @@ <h2>Overview</h2>

&mdash;
<div class='inline'>
<p>Value(s) passed to UsePAM parameter in sshd_config. Unused if empty. Possible values are yes and ‘no’. There is no mentioning of this parameter in the current man pages of OpenSSH v7. But it is mentioned in the release notes of OpenSSH v8. <a href="https://www.openssh.com/txt/release-8.0">www.openssh.com/txt/release-8.0</a></p>
<p>Value(s) passed to UsePAM parameter in sshd_config. Unused if empty. Possible values are &#39;yes&#39; and &#39;no&#39;. There is no mentioning of this parameter in the current man pages of OpenSSH v7. But it is mentioned in the release notes of OpenSSH v8. <a href="https://www.openssh.com/txt/release-8.0">www.openssh.com/txt/release-8.0</a></p>
</div>

</li>
Expand Down
2 changes: 1 addition & 1 deletion puppet_data_type_aliases/Ssh_3A_3AKey_3A_3AType.html
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<title>
Data Type: Ssh::Key::Type

&mdash; Documentation by YARD 0.9.34
&mdash; Documentation by YARD 0.9.36

</title>

Expand Down
2 changes: 1 addition & 1 deletion puppet_data_type_aliases/Ssh_3A_3ALog_level.html
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<title>
Data Type: Ssh::Log_level

&mdash; Documentation by YARD 0.9.34
&mdash; Documentation by YARD 0.9.36

</title>

Expand Down
4 changes: 2 additions & 2 deletions puppet_data_type_aliases/Ssh_3A_3APermit_root_login.html
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<title>
Data Type: Ssh::Permit_root_login

&mdash; Documentation by YARD 0.9.34
&mdash; Documentation by YARD 0.9.36

</title>

Expand Down Expand Up @@ -76,7 +76,7 @@ <h2>Overview</h2>
<div class="docstring">
<div class="discussion">

<p>without-password is a deprecated alias for prohibit-password</p>
<p>&#39;without-password&#39; is a deprecated alias for &#39;prohibit-password&#39;</p>

</div>
</div>
Expand Down
2 changes: 1 addition & 1 deletion puppet_data_type_aliases/Ssh_3A_3ASsh_Config.html
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<title>
Data Type: Ssh::Ssh_Config

&mdash; Documentation by YARD 0.9.34
&mdash; Documentation by YARD 0.9.36

</title>

Expand Down
4 changes: 2 additions & 2 deletions puppet_data_type_aliases/Ssh_3A_3ASshd_Config.html
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<title>
Data Type: Ssh::Sshd_Config

&mdash; Documentation by YARD 0.9.34
&mdash; Documentation by YARD 0.9.36

</title>

Expand Down Expand Up @@ -151,7 +151,7 @@ <h2>Overview</h2>
Optional['PermitRootLogin'] => Ssh::Permit_root_login,
Optional['PermitTTY'] => Ssh::Yes_no,
Optional['PermitTunnel'] => Enum['yes', 'point-to-point', 'ethernet', 'no'],
Optional['PermitUserEnvironmen'] => String[1],
Optional['PermitUserEnvironment'] => String[1],
Optional['PermitUserRC'] => Ssh::Yes_no,
Optional['PerSourceMaxStartups'] => String[1],
Optional['PerSourceNetBlockSize'] => String[1],
Expand Down
2 changes: 1 addition & 1 deletion puppet_data_type_aliases/Ssh_3A_3ASyslog_facility.html
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<title>
Data Type: Ssh::Syslog_facility

&mdash; Documentation by YARD 0.9.34
&mdash; Documentation by YARD 0.9.36

</title>

Expand Down
2 changes: 1 addition & 1 deletion puppet_data_type_aliases/Ssh_3A_3AYes_no.html
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<title>
Data Type: Ssh::Yes_no

&mdash; Documentation by YARD 0.9.34
&mdash; Documentation by YARD 0.9.36

</title>

Expand Down
2 changes: 1 addition & 1 deletion puppet_defined_types/ssh_3A_3Aconfig_entry.html
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
<title>
Defined Type: ssh::config_entry

&mdash; Documentation by YARD 0.9.34
&mdash; Documentation by YARD 0.9.36

</title>

Expand Down
Loading

0 comments on commit 2e5d9ae

Please sign in to comment.