Forge Home

shadow

manages useradd and login.defs defaults

4,703 downloads

4,593 latest version

4.3 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

  • 0.1.3 (latest)
  • 0.1.2
released Apr 17th 2019
This version is compatible with:
  • Puppet Enterprise 2023.8.x, 2023.7.x, 2023.6.x, 2023.5.x, 2023.4.x, 2023.3.x, 2023.2.x, 2023.1.x, 2023.0.x, 2021.7.x, 2021.6.x, 2021.5.x, 2021.4.x, 2021.3.x, 2021.2.x, 2021.1.x, 2021.0.x, 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, 2017.3.x, 2017.2.x, 2017.1.x, 2016.5.x, 2016.4.x
  • Puppet >= 3.8.0
  • , , , , , ,

Start using this module

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

Add this module to your Puppetfile:

mod 'eyp-shadow', '0.1.3'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add eyp-shadow
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install eyp-shadow --version 0.1.3

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

eyp/shadow — version 0.1.3 Apr 17th 2019

shadow

Table of Contents

  1. Overview
  2. Module Description
  3. Setup
  4. Usage
  5. Reference
  6. Limitations
  7. Development

Overview

A one-maybe-two sentence summary of what the module does/what problem it solves. This is your 30 second elevator pitch for your module. Consider including OS/Puppet version it works with.

Module Description

/etc/default/useradd and login.defs management

Setup

What shadow affects

  • manages package containing /etc/default/useradd
  • /etc/default/useradd itself

Setup Requirements

This module requires pluginsync enabled

Beginning with shadow

The very basic steps needed for a user to get the module up and running.

If your most recent release breaks compatibility or requires particular steps for upgrading, you may wish to include an additional section here: Upgrading (For an example, see http://forge.puppetlabs.com/puppetlabs/firewall).

Usage

Put the classes, types, and resources for customizing, configuring, and doing the fancy stuff with your module here.

Reference

classes

shadow::logindefs

  • maildir: = $shadow::params::maildir_default,
  • pass_max_days: = $shadow::params::pass_max_days_default,
  • pass_min_days: = $shadow::params::pass_min_days_default,
  • pass_min_len: = $shadow::params::pass_min_len_default,
  • pass_warn_age: = $shadow::params::pass_warn_age_default,
  • uid_min: = '1000',
  • uid_max: = '60000',
  • gid_min: = '1000',
  • gid_max: = '60000',
  • sys_uid_min: = $shadow::params::sys_uid_min_default,
  • sys_uid_max: = $shadow::params::sys_uid_max_default,
  • sys_gid_min: = $shadow::params::sys_gid_min_default,
  • sys_gid_max: = $shadow::params::sys_gid_max_default,
  • encrypt_method: = $encrypt_method_default,

shadow::useradd

  • group: The group name or ID for a new user's initial group (when the -N/--no-user-group is used or when the USERGROUPS_ENAB variable is set to no in /etc/login.defs). The named group must exist, and a numerical group ID must have an existing entry (default: 100)
  • home: The default base directory for the system if no homedir (-d) is specified. home is concatenated with the account name to define the home directory. (default: /home)
  • inactive: The number of days after a password expires until the account is permanently disabled. A value of 0 disables the account as soon as the password has expired, and a value of -1 disables the feature (default: -1)
  • expire: The date on which the user account will be disabled. The date is specified in the format YYYY-MM-DD (default: undef)
  • shell: The name of the user's login shell (default: /sbin/nologin)
  • skel: The skeleton directory, which contains files and directories to be copied in the user's home directory, when the home directory is created by useradd. (default: /etc/skel)

Limitations

This is where you list OS compatibility, version compatibility, etc.

Development

We are pushing to have acceptance testing in place, so any new feature should have some test to check both presence and absence of any feature

TODO

TODO list

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Added some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request