Skip to content

Latest commit

 

History

History
168 lines (79 loc) · 3.41 KB

REFERENCE.md

File metadata and controls

168 lines (79 loc) · 3.41 KB

Reference

Table of Contents

Classes

Public Classes

  • ssh: This module manages the OpenSSH service, but doesn't provide a way to manage the configuration. Use puppet/augeas_ssh to manage the configuration

Private Classes

  • ssh::config: Ensure that the minimal config files are present. This class is called from ssh for service config.
  • ssh::install: Ensure that the necessary packages are installed
  • ssh::service: Ensure the necesary services are running.

Functions

Private Functions

  • ssh::params

Data types

Private Data types

  • Ssh::File_mode

Classes

ssh

Manage OpenSSH

Parameters

The following parameters are available in the ssh class:

package_adminfile

Data type: Optional[String]

adminfile parameter for the package resource

package_name

Data type: Variant[String,Array[String]]

package names to manage

package_ensure

Data type: String

ensure parameter for the package resource

package_source

Data type: Optional[String]

service_enable

Data type: Boolean

service_ensure

Data type: Enum['running','stopped']

service_hasrestart

Data type: Boolean

service_hasstatus

Data type: Boolean

service_name

Data type: String

ssh_config_group

Data type: String

ssh_config_mode

Data type: Ssh::File_mode

ssh_config_owner

Data type: String

ssh_config_path

Data type: Variant[Stdlib::Unixpath,Array[Stdlib::Unixpath]]

sshd_config_group

Data type: String

sshd_config_mode

Data type: Ssh::File_mode

sshd_config_owner

Data type: String

sshd_config_path

Data type: Variant[Stdlib::Unixpath,Array[Stdlib::Unixpath]]

sshd_hostkey

Data type: Variant[Stdlib::Unixpath,Array[Stdlib::Unixpath]]