This module provides a new type/provider for Puppet to read and modify ssh config files using the Augeas configuration library.
The advantage of using Augeas over the default Puppet parsedfile
implementations is that Augeas will go to great lengths to preserve file
formatting and comments, while also failing safely when needed.
This provider will hide all of the Augeas commands etc., you don't need to know anything about Augeas to make use of it.
Ensure both Augeas and ruby-augeas 0.3.0+ bindings are installed and working as normal. Both are usually bundled in the puppet agent AIO packages from Puppet Inc.
See Puppet/Augeas pre-requisites.
The module can be installed easily (documentation):
puppet module install puppet/augeasproviders_ssh
Ensure the module is present in your puppetmaster's own environment (it doesn't
have to use it) and that the master has pluginsync enabled. Run the agent on
the puppetmaster to cause the custom types to be synced to its local libdir
(puppet master --configprint libdir) and then restart the puppetmaster so it
loads them.
In theory. Puppet 2.7 is the minimal version. We currently (2022-08-29) we test against Puppet 6 and 7. Check the Puppet version range in metadata.json for supported versions.
| Augeas Versions | 0.10.0 | 1.0.0 | 1.1.0 | 1.2.0 |
|---|---|---|---|---|
| FEATURES | ||||
| case-insensitive keys | no | yes | yes | yes |
| PROVIDERS | ||||
| ssh_config | yes | yes | yes | yes |
| sshd_config | yes | yes | yes | yes |
| sshd_config_match | yes | yes | yes | yes |
| sshd_config_subsystem | yes | yes | yes | yes |
| sshkey | yes | yes | yes | yes |
Type documentation can be generated with puppet doc -r type or viewed on the
Puppet Forge page.
ssh_config { "ForwardAgent":
ensure => present,
value => "yes",
}
ssh_config { "SendEnv":
ensure => present,
value => ["LC_*", "LANG"],
}
ssh_config { "X11Forwarding":
ensure => present,
host => "example.net",
value => "yes",
}
ssh_config { "ForwardAgent global":
ensure => present,
key => "ForwardAgent",
value => "no",
}
ssh_config { "ForwardAgent on example.net":
ensure => present,
key => "ForwardAgent",
host => "example.net",
value => "yes",
}
ssh_config { "ForwardAgent":
ensure => present,
key => "ForwardAgent",
value => "no",
comment => "Do not forward",
}
ssh_config { "HashKnownHosts":
ensure => absent,
}
ssh_config { "BatchMode":
ensure => absent,
host => "example.net",
}
ssh_config { "CheckHostIP":
ensure => present,
value => "yes",
target => "/etc/ssh/another_sshd_config",
}
sshd_config { "PermitRootLogin":
ensure => present,
value => "yes",
}
sshd_config { "AllowGroups":
ensure => present,
value => ["sshgroups", "admins"],
}
sshd_config { "AllowGroups":
ensure => present,
value => ["sshgroups", "admins"],
array_append => true,
}
sshd_config { "X11Forwarding":
ensure => present,
condition => "Host foo User root",
value => "yes",
}
sshd_config { "AllowAgentForwarding":
ensure => present,
condition => "Host *.example.net",
value => "yes",
}
sshd_config { "X11Forwarding global":
ensure => present,
key => "X11Forwarding",
value => "no",
}
sshd_config { "X11Forwarding foo":
ensure => present,
key => "X11Forwarding",
condition => "User foo",
value => "yes",
}
sshd_config { "X11Forwarding root":
ensure => present,
key => "X11Forwarding",
condition => "User root",
value => "no",
}
sshd_config { "X11Forwarding":
ensure => present,
key => "X11Forwarding",
value => "no",
comment => "No X11",
}
sshd_config { "PermitRootLogin":
ensure => absent,
}
sshd_config { "AllowAgentForwarding":
ensure => absent,
condition => "Host *.example.net User *",
}
sshd_config { "PermitRootLogin":
ensure => present,
value => "yes",
target => "/etc/ssh/another_sshd_config",
}
sshd_config_match { "Host *.example.net":
ensure => present,
}
sshd_config_match { "Host *.example.net":
ensure => present,
position => "before first match",
}
sshd_config_match { "User foo":
ensure => present,
position => "after Host *.example.net",
}
sshd_config_match { "Host *.example.net":
ensure => present,
comment => "Example network",
}
sshd_config_match { "User foo Host *.example.net":
ensure => absent,
}
sshd_config_match { "Host *.example.net":
ensure => present,
target => "/etc/ssh/another_sshd_config",
}
sshd_config_subsystem { "sftp":
ensure => present,
command => "/usr/lib/openssh/sftp-server",
}
sshd_config_subsystem { "sftp":
ensure => present,
command => "/usr/lib/openssh/sftp-server",
comment => "SFTP sub",
}
sshd_config_subsystem { "sftp":
ensure => absent,
}
sshd_config_subsystem { "sftp":
ensure => present,
command => "/usr/lib/openssh/sftp-server",
target => "/etc/ssh/another_sshd_config",
}
sshkey { "foo.example.com":
ensure => present,
type => "ssh-rsa",
key => "AAADEADMEAT",
}
sshkey { "foo.example.com":
ensure => present,
type => "ssh-rsa",
key => "AAADEADMEAT",
host_aliases => [ 'foo', '192.168.0.1' ],
}
sshkey { "foo.example.com":
ensure => present,
type => "ssh-rsa",
key => "AAADEADMEAT",
hash_hostname => true,
}
sshkey { "foo.example.com":
ensure => hashed,
type => "ssh-rsa",
key => "AAADEADMEAT",
hash_hostname => true,
}
sshkey { "foo.example.com":
ensure => absent,
}
sshkey { "foo.example.com":
ensure => present,
type => "ssh-rsa",
key => "AAADEADMEAT",
target => "/root/.ssh/known_hosts",
}
Please file any issues or suggestions on GitHub.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent