Documentation by YARD 0.9.34
+Documentation by YARD 0.9.36
Alphabetic Index
diff --git a/file.README.html b/file.README.html index a3c21af7..799f071c 100644 --- a/file.README.html +++ b/file.README.html @@ -6,7 +6,7 @@Known to work
Debian 11
Debian 12
+EL 7
EL 8
@@ -105,6 +107,8 @@Known to work
Ubuntu 22.04 LTS
Ubuntu 24.04 LTS
+Solaris 10
Solaris 11
@@ -124,9 +128,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,72 +191,19 @@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).
- -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'
-
-
-Using directives that are not supported by this module:
+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'
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:
+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':
- ensure: 'absent'
-
+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'
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