Skip to content

Commit 575ebc8

Browse files
authored
update REFERENCE.md (#396)
1 parent 698dd67 commit 575ebc8

File tree

1 file changed

+83
-0
lines changed

1 file changed

+83
-0
lines changed

REFERENCE.md

Lines changed: 83 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@
2727
* [`ssh::client::config::user`](#ssh--client--config--user): This defined type manages a users ssh config
2828
* [`ssh::client::match_block`](#ssh--client--match_block): Add match_block to ssh client config (concat needed)
2929
* [`ssh::server::config::setting`](#ssh--server--config--setting): Internal define to managed ssh server param
30+
* [`ssh::server::config_file`](#ssh--server--config_file): Resource type for managing a config file in the include dir.
3031
* [`ssh::server::host_key`](#ssh--server--host_key): Manage a ssh host key
3132

3233
This module install a ssh host key in the server (basically, it is
@@ -541,6 +542,10 @@ The following parameters are available in the `ssh::server` class:
541542
* [`host_priv_key_group`](#-ssh--server--host_priv_key_group)
542543
* [`default_options`](#-ssh--server--default_options)
543544
* [`ensure`](#-ssh--server--ensure)
545+
* [`include_dir`](#-ssh--server--include_dir)
546+
* [`include_dir_mode`](#-ssh--server--include_dir_mode)
547+
* [`include_dir_purge`](#-ssh--server--include_dir_purge)
548+
* [`config_files`](#-ssh--server--config_files)
544549
* [`storeconfigs_enabled`](#-ssh--server--storeconfigs_enabled)
545550
* [`options`](#-ssh--server--options)
546551
* [`validate_sshd_file`](#-ssh--server--validate_sshd_file)
@@ -601,6 +606,38 @@ Ensurable param to ssh server
601606

602607
Default value: `present`
603608

609+
##### <a name="-ssh--server--include_dir"></a>`include_dir`
610+
611+
Data type: `Optional[Stdlib::Absolutepath]`
612+
613+
Path to sshd include directory.
614+
615+
Default value: `undef`
616+
617+
##### <a name="-ssh--server--include_dir_mode"></a>`include_dir_mode`
618+
619+
Data type: `Stdlib::Filemode`
620+
621+
Mode to set on the sshd include directory.
622+
623+
Default value: `'0700'`
624+
625+
##### <a name="-ssh--server--include_dir_purge"></a>`include_dir_purge`
626+
627+
Data type: `Boolean`
628+
629+
Purge the include directory if true.
630+
631+
Default value: `true`
632+
633+
##### <a name="-ssh--server--config_files"></a>`config_files`
634+
635+
Data type: `Hash[String, Hash]`
636+
637+
Hash of config files to add to the ssh include directory.
638+
639+
Default value: `{}`
640+
604641
##### <a name="-ssh--server--storeconfigs_enabled"></a>`storeconfigs_enabled`
605642

606643
Data type: `Boolean`
@@ -835,6 +872,52 @@ Orders your setting within the config file
835872

836873
Default value: `'10'`
837874

875+
### <a name="ssh--server--config_file"></a>`ssh::server::config_file`
876+
877+
Resource type for managing a config file in the include dir.
878+
879+
#### Parameters
880+
881+
The following parameters are available in the `ssh::server::config_file` defined type:
882+
883+
* [`mode`](#-ssh--server--config_file--mode)
884+
* [`include`](#-ssh--server--config_file--include)
885+
* [`options`](#-ssh--server--config_file--options)
886+
* [`path`](#-ssh--server--config_file--path)
887+
888+
##### <a name="-ssh--server--config_file--mode"></a>`mode`
889+
890+
Data type: `Stdlib::Filemode`
891+
892+
File mode for the config file.
893+
894+
Default value: `$ssh::server::sshd_config_mode`
895+
896+
##### <a name="-ssh--server--config_file--include"></a>`include`
897+
898+
Data type: `Optional[Stdlib::Absolutepath]`
899+
900+
Absolute path to config file to include at the top of the config file. This
901+
is intended for including files not managed by this module (crypto policies).
902+
903+
Default value: `undef`
904+
905+
##### <a name="-ssh--server--config_file--options"></a>`options`
906+
907+
Data type: `Hash`
908+
909+
Dynamic hash for openssh server option
910+
911+
Default value: `{}`
912+
913+
##### <a name="-ssh--server--config_file--path"></a>`path`
914+
915+
Data type: `Stdlib::Absolutepath`
916+
917+
918+
919+
Default value: `"${ssh::server::include_dir}/${name}.conf"`
920+
838921
### <a name="ssh--server--host_key"></a>`ssh::server::host_key`
839922

840923
Manage a ssh host key

0 commit comments

Comments
 (0)