sssd

Install and configure SSSD

792,719 downloads

75,634 latest version

5.0 quality score

We run a couple of automated
scans to help you access a
module's quality. Each module is
given a score based on how well
the author has formatted their
code and documentation and
modules are also checked for
malware using VirusTotal.

Please note, the information below
is for guidance only and neither of
these methods should be considered
an endorsement by Puppet.

Support the Puppet Community by contributing to this module

You are welcome to contribute to this module by suggesting new features, currency updates, or fixes. Every contribution is valuable to help ensure that the module remains compatible with the latest Puppet versions and continues to meet community needs. Complete the following steps:

  1. Review the module’s contribution guidelines and any licenses. Ensure that your planned contribution aligns with the author’s standards and any legal requirements.
  2. Fork the repository on GitHub, make changes on a branch of your fork, and submit a pull request. The pull request must clearly document your proposed change.

For questions about updating the module, contact the module’s author.

Version information

  • 3.1.0 (latest)
  • 3.0.0
  • 2.13.1
  • 2.13.0
  • 2.12.0
  • 2.11.0
  • 2.10.1
  • 2.10.0
  • 2.9.0
  • 2.8.0
  • 2.7.0
  • 2.6.0
  • 2.5.0
  • 2.4.1
  • 2.4.0
  • 2.3.0
  • 2.2.2
  • 2.2.1
  • 2.2.0
  • 2.1.0
  • 2.0.0
  • 1.0.1
  • 1.0.0
  • 0.4.1
  • 0.4.0
  • 0.3.1
  • 0.3.0
  • 0.2.1
  • 0.2.0
  • 0.1.4
  • 0.1.3
  • 0.1.2
  • 0.1.1
  • 0.1.0 (deleted)
released Jan 28th 2020
This version is compatible with:
  • Puppet Enterprise 2019.8.x, 2019.7.x, 2019.5.x, 2019.4.x, 2019.3.x, 2019.2.x, 2019.1.x, 2019.0.x, 2018.1.x
  • Puppet >= 5.5.10 < 7.0.0
  • , , , , , , , ,

Start using this module

  • r10k or Code Manager
  • Bolt
  • Manual installation
  • Direct download

Add this module to your Puppetfile:

mod 'sgnl05-sssd', '3.1.0'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add sgnl05-sssd
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install sgnl05-sssd --version 3.1.0

Direct download is not typically how you would use a Puppet module to manage your infrastructure, but you may want to download the module in order to inspect the code.

Download

Documentation

sgnl05/sssd — version 3.1.0 Jan 28th 2020

Reference

Table of Contents

Classes

  • sssd: Base sssd class

Classes

sssd

Installs and configures SSSD

Examples

Declaring the class
include ::sssd

Parameters

The following parameters are available in the sssd class.

ensure

Data type: Enum['present', 'absent']

Ensure if the sssd config file is to be present or absent.

Default value: 'present'

config

Data type: Hash

Hash containing entire SSSD config.

Default value: { 'sssd' => { 'domains' => $::domain, 'config_file_version' => 2, 'services' => ['nss', 'pam'], }, "domain/${::domain}" => { 'access_provider' => 'simple', 'simple_allow_users' => ['root'], }, }

sssd_package

Data type: String

Name of the sssd package. Only set this if your platform is not supported or you know what you're doing.

Default value: 'sssd'

sssd_package_ensure

Data type: String

Sets the ensure parameter of the sssd package.

Default value: 'present'

sssd_service

Data type: String

Name of the sssd service.

Default value: 'sssd'

extra_packages

Data type: Array

Array of extra packages.

Default value: []

extra_packages_ensure

Data type: String

Value of ensure parameter for extra packages.

Default value: 'present'

config_file

Data type: Stdlib::Absolutepath

Path to the sssd config file.

Default value: '/etc/sssd/sssd.conf'

config_template

Data type: String

Defines the template used for the sssd config.

Default value: 'sssd/sssd.conf.erb'

mkhomedir

Data type: Boolean

Whether or not to manage auto-creation of home directories on user login.

Default value: true

manage_oddjobd

Data type: Boolean

Whether or not to manage the oddjobd service.

Default value: false

service_ensure

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

Ensure if services should be running/stopped.

Default value: 'running'

service_dependencies

Data type: Array

Array of service resource names to manage before managing sssd related services. Intended to be used to manage messagebus service to prevent Error: Could not start Service[oddjobd].

Default value: []

enable_mkhomedir_flags

Data type: Array

Array of flags to use with authconfig or authselect to enable auto-creation of home directories.

Default value: [ '--enablesssd', '--enablesssdauth', '--enablemkhomedir', ]

disable_mkhomedir_flags

Data type: Array

Array of flags to use with authconfig or authselect to disable auto-creation of home directories.

Default value: [ '--enablesssd', '--enablesssdauth', '--disablemkhomedir', ]

pam_mkhomedir_umask

Data type: String

Umask to set for pam_mkhomedir (oddjobd-mkhomedir on RedHat uses UMASK from login.defs)

Default value: '0022'

ensure_absent_flags

Data type: Array

Array of flags to use with authconfig when service is disabled.

Default value: [ '--disablesssd', '--disablesssdauth', ]