From 815973cc151b96c83e6967e3788fd3b3de2749ad Mon Sep 17 00:00:00 2001 From: Garrett Honeycutt Date: Thu, 16 Nov 2023 13:14:39 -0500 Subject: [PATCH] [strings] Generated Documentation Update at Revision v3.62.0-33-g0966901 --- _index.html | 4 +- file.README.html | 69 ++++++++++-- frames.html | 2 +- index.html | 69 ++++++++++-- puppet_classes/ssh.html | 81 +++++++++++--- puppet_classes/ssh_3A_3Aserver.html | 101 ++++++++++++++---- .../Ssh_3A_3AKey_3A_3AType.html | 3 +- .../Ssh_3A_3ALog_level.html | 3 +- .../Ssh_3A_3APermit_root_login.html | 5 +- .../Ssh_3A_3ASsh_Config.html | 3 +- .../Ssh_3A_3ASshd_Config.html | 3 +- .../Ssh_3A_3ASyslog_facility.html | 3 +- puppet_data_type_aliases/Ssh_3A_3AYes_no.html | 3 +- .../ssh_3A_3Aconfig_entry.html | 3 +- .../ssh_3A_3Aconfig_file_client.html | 3 +- .../ssh_3A_3Aconfig_file_server.html | 7 +- top-level-namespace.html | 2 +- 17 files changed, 296 insertions(+), 68 deletions(-) diff --git a/_index.html b/_index.html index 549e7a4d..d9c2b677 100644 --- a/_index.html +++ b/_index.html @@ -4,7 +4,7 @@ - Documentation by YARD 0.9.28 + Documentation by YARD 0.9.34 @@ -52,7 +52,7 @@
-

Documentation by YARD 0.9.28

+

Documentation by YARD 0.9.34

Alphabetic Index

diff --git a/file.README.html b/file.README.html index efec361a..a3c21af7 100644 --- a/file.README.html +++ b/file.README.html @@ -6,7 +6,7 @@ File: README - — Documentation by YARD 0.9.28 + — Documentation by YARD 0.9.34 @@ -124,9 +124,9 @@

Parameters

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.

-

See REFERENCE.md for a list of all parameters.

+

See REFERENCE.md for a list of all parameters.

-

Manage user's ssh_authorized_keys

+

Manage user’s ssh_authorized_keys

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 Type Reference for a complete list.

@@ -187,19 +187,72 @@

Manage configuratio

Sample usage:

-

Manage the client configuration file /etc/ssh/ssh_config.d/50-redhat.conf with some directives and default file permissions (0644 root:root). yaml ssh::include: /etc/ssh/ssh_config.d/*.conf ssh::config_files: '50-redhat': lines: Match: 'final all' Include: '/etc/crypto-policies/back-ends/openssh.config' GSSAPIAuthentication: 'yes' ForwardX11Trusted: 'yes'

+

Manage the client configuration file /etc/ssh/ssh_config.d/50-redhat.conf with some directives and default file permissions (0644 root:root).

-

Manage the server configuration file /etc/ssh/sshd_config.d/50-redhat.conf with some directives and default file permissions (0600 root:root). yaml ssh::server::include: /etc/ssh/sshd_config.d/*.conf ssh::server::config_files: '50-redhat': lines: Include: '/etc/crypto-policies/back-ends/opensshserver.config' SyslogFacility: 'AUTHPRIV' ChallengeResponseAuthentication: 'no' GSSAPIAuthentication: 'yes' GSSAPICleanupCredentials: 'no' UsePAM: 'yes' X11Forwarding: 'yes' PrintMotd: 'no' You can also specify different file permissions by setting $owner, $group, or $mode accordingly: yaml ssh::include: /etc/ssh/ssh_config.d/*.conf ssh::config_files: '50-redhat': owner: 'name' group: 'group' mode: '0664' lines: Match: 'final all' GSSAPIAuthentication: 'yes' Using directives that are not supported by this module: yaml ssh::include: /etc/ssh/ssh_config.d/*.conf ssh::config_files: '50-redhat': custom: - 'Directive1 Value1' - 'Directive2 Value2'

+
ssh::include: /etc/ssh/ssh_config.d/*.conf
+ssh::config_files:
+  '50-redhat':
+    lines:
+      Match: 'final all'
+      Include: '/etc/crypto-policies/back-ends/openssh.config'
+      GSSAPIAuthentication: 'yes'
+      ForwardX11Trusted: 'yes'
+
+ +

Manage the server configuration file /etc/ssh/sshd_config.d/50-redhat.conf with some directives and default file permissions (0600 root:root).

+ +
ssh::server::include: /etc/ssh/sshd_config.d/*.conf
+ssh::server::config_files:
+  '50-redhat':
+    lines:
+      Include: '/etc/crypto-policies/back-ends/opensshserver.config'
+      SyslogFacility: 'AUTHPRIV'
+      ChallengeResponseAuthentication: 'no'
+      GSSAPIAuthentication: 'yes'
+      GSSAPICleanupCredentials: 'no'
+      UsePAM: 'yes'
+      X11Forwarding: 'yes'
+      PrintMotd: 'no'
+
+ +

You can also specify different file permissions by setting $owner, $group, or $mode accordingly:

+ +
ssh::include: /etc/ssh/ssh_config.d/*.conf
+ssh::config_files:
+  '50-redhat':
+    owner: 'name'
+    group: 'group'
+    mode:  '0664'
+    lines:
+      Match: 'final all'
+      GSSAPIAuthentication: 'yes'
+
-

Remove the file /etc/ssh/ssh_config.d/50-redhat.conf: yaml ssh::include: /etc/ssh/ssh_config.d/*.conf ssh::config_files: '50-redhat': ensure: 'absent'

+

Using directives that are not supported by this module:

+ +
ssh::include: /etc/ssh/ssh_config.d/*.conf
+ssh::config_files:
+  '50-redhat':
+    custom:
+      - 'Directive1 Value1'
+      - 'Directive2 Value2'
+
+ +

Remove the file /etc/ssh/ssh_config.d/50-redhat.conf:

+ +
ssh::include: /etc/ssh/ssh_config.d/*.conf
+ssh::config_files:
+  '50-redhat':
+    ensure: 'absent'
+

Upgrading

-

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 UPGRADING.md

+

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 UPGRADING.md

Contributing

-

Please check CONTRIBUTING.md

+

Please check CONTRIBUTING.md