Resource Type: user

Included in Puppet Enterprise 2016.5. A newer version is available; see the version menu above for details.

NOTE: This page was generated from the Puppet source code on 2016-11-01 14:17:00 -0500

user

Description

Manage users. This type is mostly built to manage system users, so it is lacking some features useful for managing normal users.

This resource type uses the prescribed native tools for creating groups and generally uses POSIX APIs for retrieving information about them. It does not directly modify /etc/passwd or anything.

Autorequires: If Puppet is managing the user’s primary group (as provided in the gid attribute) or any group listed in the groups attribute then the user resource will autorequire that group. If Puppet is managing any role accounts corresponding to the user’s roles, the user resource will autorequire those role accounts.

Attributes

user { 'resource title':
  name                 => # (namevar) The user name. While naming limitations vary by...
  ensure               => # The basic state that the object should be in....
  allowdupe            => # Whether to allow duplicate UIDs. Defaults to...
  attribute_membership => # Whether specified attribute value pairs should...
  attributes           => # Specify AIX attributes for the user in an array...
  auth_membership      => # Whether specified auths should be considered the 
  auths                => # The auths the user has.  Multiple auths should...
  comment              => # A description of the user.  Generally the user's 
  expiry               => # The expiry date for this user. Must be provided...
  forcelocal           => # Forces the management of local accounts when...
  gid                  => # The user's primary group.  Can be specified...
  groups               => # The groups to which the user belongs.  The...
  home                 => # The home directory of the user.  The directory...
  ia_load_module       => # The name of the I&A module to use to manage this 
  iterations           => # This is the number of iterations of a chained...
  key_membership       => # Whether specified key/value pairs should be...
  keys                 => # Specify user attributes in an array of key ...
  loginclass           => # The name of login class to which the user...
  managehome           => # Whether to manage the home directory when...
  membership           => # If `minimum` is specified, Puppet will ensure...
  password             => # The user's password, in whatever encrypted...
  password_max_age     => # The maximum number of days a password may be...
  password_min_age     => # The minimum number of days a password must be...
  profile_membership   => # Whether specified roles should be treated as the 
  profiles             => # The profiles the user has.  Multiple profiles...
  project              => # The name of the project associated with a user.  
  provider             => # The specific backend to use for this `user...
  purge_ssh_keys       => # Whether to purge authorized SSH keys for this...
  role_membership      => # Whether specified roles should be considered the 
  roles                => # The roles the user has.  Multiple roles should...
  salt                 => # This is the 32-byte salt used to generate the...
  shell                => # The user's login shell.  The shell must exist...
  system               => # Whether the user is a system user, according to...
  uid                  => # The user ID; must be specified numerically. If...
  # ...plus any applicable metaparameters.
}

name

(Namevar: If omitted, this attribute’s value defaults to the resource’s title.)

The user name. While naming limitations vary by operating system, it is advisable to restrict names to the lowest common denominator, which is a maximum of 8 characters beginning with a letter.

Note that Puppet considers user names to be case-sensitive, regardless of the platform’s own rules; be sure to always use the same case when referring to a given user.

(↑ Back to user attributes)

ensure

(Property: This attribute represents concrete state on the target system.)

The basic state that the object should be in.

Valid values are present, absent, role.

(↑ Back to user attributes)

allowdupe

Whether to allow duplicate UIDs. Defaults to false.

Valid values are true, false, yes, no.

(↑ Back to user attributes)

attribute_membership

Whether specified attribute value pairs should be treated as the complete list (inclusive) or the minimum list (minimum) of attribute/value pairs for the user. Defaults to minimum.

Valid values are inclusive, minimum.

(↑ Back to user attributes)

attributes

(Property: This attribute represents concrete state on the target system.)

Specify AIX attributes for the user in an array of attribute = value pairs.

Requires features manages_aix_lam.

(↑ Back to user attributes)

auth_membership

Whether specified auths should be considered the complete list (inclusive) or the minimum list (minimum) of auths the user has. Defaults to minimum.

Valid values are inclusive, minimum.

(↑ Back to user attributes)

auths

(Property: This attribute represents concrete state on the target system.)

The auths the user has. Multiple auths should be specified as an array.

Requires features manages_solaris_rbac.

(↑ Back to user attributes)

comment

(Property: This attribute represents concrete state on the target system.)

A description of the user. Generally the user’s full name.

(↑ Back to user attributes)

expiry

(Property: This attribute represents concrete state on the target system.)

The expiry date for this user. Must be provided in a zero-padded YYYY-MM-DD format — e.g. 2010-02-19. If you want to ensure the user account never expires, you can pass the special value absent.

Valid values are absent. Values can match /^\d{4}-\d{2}-\d{2}$/.

Requires features manages_expiry.

(↑ Back to user attributes)

forcelocal

Forces the management of local accounts when accounts are also being managed by some other NSS

Valid values are true, false, yes, no.

Requires features libuser.

(↑ Back to user attributes)

gid

(Property: This attribute represents concrete state on the target system.)

The user’s primary group. Can be specified numerically or by name.

This attribute is not supported on Windows systems; use the groups attribute instead. (On Windows, designating a primary group is only meaningful for domain accounts, which Puppet does not currently manage.)

(↑ Back to user attributes)

groups

(Property: This attribute represents concrete state on the target system.)

The groups to which the user belongs. The primary group should not be listed, and groups should be identified by name rather than by GID. Multiple groups should be specified as an array.

(↑ Back to user attributes)

home

(Property: This attribute represents concrete state on the target system.)

The home directory of the user. The directory must be created separately and is not currently checked for existence.

(↑ Back to user attributes)

ia_load_module

The name of the I&A module to use to manage this user.

Requires features manages_aix_lam.

(↑ Back to user attributes)

iterations

(Property: This attribute represents concrete state on the target system.)

This is the number of iterations of a chained computation of the PBKDF2 password hash. This parameter is used in OS X, and is required for managing passwords on OS X 10.8 and newer.

Requires features manages_password_salt.

(↑ Back to user attributes)

key_membership

Whether specified key/value pairs should be considered the complete list (inclusive) or the minimum list (minimum) of the user’s attributes. Defaults to minimum.

Valid values are inclusive, minimum.

(↑ Back to user attributes)

keys

(Property: This attribute represents concrete state on the target system.)

Specify user attributes in an array of key = value pairs.

Requires features manages_solaris_rbac.

(↑ Back to user attributes)

loginclass

(Property: This attribute represents concrete state on the target system.)

The name of login class to which the user belongs.

Requires features manages_loginclass.

(↑ Back to user attributes)

managehome

Whether to manage the home directory when managing the user. This will create the home directory when ensure => present, and delete the home directory when ensure => absent. Defaults to false.

Valid values are true, false, yes, no.

(↑ Back to user attributes)

membership

If minimum is specified, Puppet will ensure that the user is a member of all specified groups, but will not remove any other groups that the user is a part of.

If inclusive is specified, Puppet will ensure that the user is a member of only specified groups.

Defaults to minimum.

Valid values are inclusive, minimum.

(↑ Back to user attributes)

password

(Property: This attribute represents concrete state on the target system.)

The user’s password, in whatever encrypted format the local system requires. Consult your operating system’s documentation for acceptable password encryption formats and requirements.

  • Mac OS X 10.5 and 10.6, and some older Linux distributions, use salted SHA1 hashes. You can use Puppet’s built-in sha1 function to generate a salted SHA1 hash from a password.
  • Mac OS X 10.7 (Lion), and many recent Linux distributions, use salted SHA512 hashes. The Puppet Labs stdlib module contains a str2saltedsha512 function which can generate password hashes for these operating systems.
  • OS X 10.8 and higher use salted SHA512 PBKDF2 hashes. When managing passwords on these systems, the salt and iterations attributes need to be specified as well as the password.
  • Windows passwords can only be managed in cleartext, as there is no Windows API for setting the password hash.

Enclose any value that includes a dollar sign ($) in single quotes (‘) to avoid accidental variable interpolation.

Requires features manages_passwords.

(↑ Back to user attributes)

password_max_age

(Property: This attribute represents concrete state on the target system.)

The maximum number of days a password may be used before it must be changed.

Requires features manages_password_age.

(↑ Back to user attributes)

password_min_age

(Property: This attribute represents concrete state on the target system.)

The minimum number of days a password must be used before it may be changed.

Requires features manages_password_age.

(↑ Back to user attributes)

profile_membership

Whether specified roles should be treated as the complete list (inclusive) or the minimum list (minimum) of roles of which the user is a member. Defaults to minimum.

Valid values are inclusive, minimum.

(↑ Back to user attributes)

profiles

(Property: This attribute represents concrete state on the target system.)

The profiles the user has. Multiple profiles should be specified as an array.

Requires features manages_solaris_rbac.

(↑ Back to user attributes)

project

(Property: This attribute represents concrete state on the target system.)

The name of the project associated with a user.

Requires features manages_solaris_rbac.

(↑ Back to user attributes)

provider

The specific backend to use for this user resource. You will seldom need to specify this — Puppet will usually discover the appropriate provider for your platform.

Available providers are:

(↑ Back to user attributes)

purge_ssh_keys

Whether to purge authorized SSH keys for this user if they are not managed with the ssh_authorized_key resource type. Allowed values are:

  • false (default) — don’t purge SSH keys for this user.
  • true — look for keys in the .ssh/authorized_keys file in the user’s home directory. Purge any keys that aren’t managed as ssh_authorized_key resources.
  • An array of file paths — look for keys in all of the files listed. Purge any keys that aren’t managed as ssh_authorized_key resources. If any of these paths starts with ~ or %h, that token will be replaced with the user’s home directory.

Valid values are true, false.

(↑ Back to user attributes)

role_membership

Whether specified roles should be considered the complete list (inclusive) or the minimum list (minimum) of roles the user has. Defaults to minimum.

Valid values are inclusive, minimum.

(↑ Back to user attributes)

roles

(Property: This attribute represents concrete state on the target system.)

The roles the user has. Multiple roles should be specified as an array.

Requires features manages_solaris_rbac.

(↑ Back to user attributes)

salt

(Property: This attribute represents concrete state on the target system.)

This is the 32-byte salt used to generate the PBKDF2 password used in OS X. This field is required for managing passwords on OS X >= 10.8.

Requires features manages_password_salt.

(↑ Back to user attributes)

shell

(Property: This attribute represents concrete state on the target system.)

The user’s login shell. The shell must exist and be executable.

This attribute cannot be managed on Windows systems.

Requires features manages_shell.

(↑ Back to user attributes)

system

Whether the user is a system user, according to the OS’s criteria; on most platforms, a UID less than or equal to 500 indicates a system user. This parameter is only used when the resource is created and will not affect the UID when the user is present. Defaults to false.

Valid values are true, false, yes, no.

(↑ Back to user attributes)

uid

(Property: This attribute represents concrete state on the target system.)

The user ID; must be specified numerically. If no user ID is specified when creating a new user, then one will be chosen automatically. This will likely result in the same user having different UIDs on different systems, which is not recommended. This is especially noteworthy when managing the same user on both Darwin and other platforms, since Puppet does UID generation on Darwin, but the underlying tools do so on other platforms.

On Windows, this property is read-only and will return the user’s security identifier (SID).

(↑ Back to user attributes)

Providers

aix

User management for AIX.

  • Required binaries: /bin/chpasswd, /usr/bin/chuser, /usr/bin/mkuser, /usr/sbin/lsgroup, /usr/sbin/lsuser, /usr/sbin/rmuser.
  • Default for operatingsystem == aix.
  • Supported features: manages_aix_lam, manages_expiry, manages_homedir, manages_password_age, manages_passwords, manages_shell.

directoryservice

User management on OS X.

  • Required binaries: /usr/bin/dscacheutil, /usr/bin/dscl, /usr/bin/dsimport, /usr/bin/uuidgen.
  • Default for operatingsystem == darwin.
  • Supported features: manages_password_salt, manages_passwords, manages_shell.

hpuxuseradd

User management for HP-UX. This provider uses the undocumented -F switch to HP-UX’s special usermod binary to work around the fact that its standard usermod cannot make changes while the user is logged in. New functionality provides for changing trusted computing passwords and resetting password expirations under trusted computing.

  • Required binaries: /usr/sam/lbin/useradd.sam, /usr/sam/lbin/userdel.sam, /usr/sam/lbin/usermod.sam.
  • Default for operatingsystem == hp-ux.
  • Supported features: allows_duplicates, manages_homedir, manages_passwords.

ldap

User management via LDAP.

This provider requires that you have valid values for all of the LDAP-related settings in puppet.conf, including ldapbase. You will almost definitely need settings for ldapuser and ldappassword in order for your clients to write to LDAP.

Note that this provider will automatically generate a UID for you if you do not specify one, but it is a potentially expensive operation, as it iterates across all existing users to pick the appropriate next one.

  • Supported features: manages_passwords, manages_shell.

openbsd

User management via useradd and its ilk for OpenBSD. Note that you will need to install Ruby’s shadow password library (package known as ruby-shadow) if you wish to manage user passwords.

  • Required binaries: passwd, useradd, userdel, usermod.
  • Default for operatingsystem == openbsd.
  • Supported features: manages_expiry, manages_homedir, manages_shell, system_users.

pw

User management via pw on FreeBSD and DragonFly BSD.

  • Required binaries: pw.
  • Default for operatingsystem == freebsd, dragonfly.
  • Supported features: allows_duplicates, manages_expiry, manages_homedir, manages_passwords, manages_shell.

user_role_add

User and role management on Solaris, via useradd and roleadd.

  • Required binaries: passwd, roleadd, roledel, rolemod, useradd, userdel, usermod.
  • Default for osfamily == solaris.
  • Supported features: allows_duplicates, manages_homedir, manages_password_age, manages_passwords, manages_shell, manages_solaris_rbac.

useradd

User management via useradd and its ilk. Note that you will need to install Ruby’s shadow password library (often known as ruby-libshadow) if you wish to manage user passwords.

  • Required binaries: chage, luseradd, useradd, userdel, usermod.
  • Supported features: allows_duplicates, manages_expiry, manages_homedir, manages_shell, system_users.

windows_adsi

Local user management for Windows.

  • Default for operatingsystem == windows.
  • Supported features: manages_homedir, manages_passwords.

Provider Features

Available features:

  • allows_duplicates — The provider supports duplicate users with the same UID.
  • libuser — Allows local users to be managed on systems that also use some other remote NSS method of managing accounts.
  • manages_aix_lam — The provider can manage AIX Loadable Authentication Module (LAM) system.
  • manages_expiry — The provider can manage the expiry date for a user.
  • manages_homedir — The provider can create and remove home directories.
  • manages_loginclass — The provider can manage the login class for a user.
  • manages_password_age — The provider can set age requirements and restrictions for passwords.
  • manages_password_salt — The provider can set a password salt. This is for providers that implement PBKDF2 passwords with salt properties.
  • manages_passwords — The provider can modify user passwords, by accepting a password hash.
  • manages_shell — The provider allows for setting shell and validates if possible
  • manages_solaris_rbac — The provider can manage roles and normal users
  • system_users — The provider allows you to create system users with lower UIDs.

Provider support:

Provider allows duplicates libuser manages aix lam manages expiry manages homedir manages loginclass manages password age manages password salt manages passwords manages shell manages solaris rbac system users
aix X X X X X X
directoryservice X X X
hpuxuseradd X X X
ldap X X
openbsd X X X X X X
pw X X X X X
user_role_add X X X X X X
useradd X X X X X X X X
windows_adsi X X

NOTE: This page was generated from the Puppet source code on 2016-11-01 14:17:00 -0500

↑ Back to top