1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783
|
---
layout: default
built_from_commit: 942adce0b1b70f696b0f09d7109ded7559f0fa33
title: 'Resource Type: user'
canonical: "/puppet/latest/types/user.html"
---
# Resource Type: user
> **NOTE:** This page was generated from the Puppet source code on 2024-08-28 16:45:59 -0700
## user
* [Attributes](#user-attributes)
* [Providers](#user-providers)
* [Provider Features](#user-provider-features)
### Description {#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-attributes}
<pre><code>user { 'resource title':
<a href="#user-attribute-name">name</a> => <em># <strong>(namevar)</strong> The user name. While naming limitations vary by...</em>
<a href="#user-attribute-ensure">ensure</a> => <em># The basic state that the object should be in....</em>
<a href="#user-attribute-allowdupe">allowdupe</a> => <em># Whether to allow duplicate UIDs. Default...</em>
<a href="#user-attribute-attribute_membership">attribute_membership</a> => <em># Whether specified attribute value pairs should...</em>
<a href="#user-attribute-attributes">attributes</a> => <em># Specify AIX attributes for the user in an array...</em>
<a href="#user-attribute-auth_membership">auth_membership</a> => <em># Whether specified auths should be considered the </em>
<a href="#user-attribute-auths">auths</a> => <em># The auths the user has. Multiple auths should...</em>
<a href="#user-attribute-comment">comment</a> => <em># A description of the user. Generally the user's </em>
<a href="#user-attribute-expiry">expiry</a> => <em># The expiry date for this user. Provide as either </em>
<a href="#user-attribute-forcelocal">forcelocal</a> => <em># Forces the management of local accounts when...</em>
<a href="#user-attribute-gid">gid</a> => <em># The user's primary group. Can be specified...</em>
<a href="#user-attribute-groups">groups</a> => <em># The groups to which the user belongs. The...</em>
<a href="#user-attribute-home">home</a> => <em># The home directory of the user. The directory...</em>
<a href="#user-attribute-ia_load_module">ia_load_module</a> => <em># The name of the I&A module to use to manage this </em>
<a href="#user-attribute-iterations">iterations</a> => <em># This is the number of iterations of a chained...</em>
<a href="#user-attribute-key_membership">key_membership</a> => <em># Whether specified key/value pairs should be...</em>
<a href="#user-attribute-keys">keys</a> => <em># Specify user attributes in an array of key ...</em>
<a href="#user-attribute-loginclass">loginclass</a> => <em># The name of login class to which the user...</em>
<a href="#user-attribute-managehome">managehome</a> => <em># Whether to manage the home directory when Puppet </em>
<a href="#user-attribute-membership">membership</a> => <em># If `minimum` is specified, Puppet will ensure...</em>
<a href="#user-attribute-password">password</a> => <em># The user's password, in whatever encrypted...</em>
<a href="#user-attribute-password_max_age">password_max_age</a> => <em># The maximum number of days a password may be...</em>
<a href="#user-attribute-password_min_age">password_min_age</a> => <em># The minimum number of days a password must be...</em>
<a href="#user-attribute-password_warn_days">password_warn_days</a> => <em># The number of days before a password is going to </em>
<a href="#user-attribute-profile_membership">profile_membership</a> => <em># Whether specified roles should be treated as the </em>
<a href="#user-attribute-profiles">profiles</a> => <em># The profiles the user has. Multiple profiles...</em>
<a href="#user-attribute-project">project</a> => <em># The name of the project associated with a...</em>
<a href="#user-attribute-provider">provider</a> => <em># The specific backend to use for this `user...</em>
<a href="#user-attribute-purge_ssh_keys">purge_ssh_keys</a> => <em># Whether to purge authorized SSH keys for this...</em>
<a href="#user-attribute-role_membership">role_membership</a> => <em># Whether specified roles should be considered the </em>
<a href="#user-attribute-roles">roles</a> => <em># The roles the user has. Multiple roles should...</em>
<a href="#user-attribute-salt">salt</a> => <em># This is the 32-byte salt used to generate the...</em>
<a href="#user-attribute-shell">shell</a> => <em># The user's login shell. The shell must exist...</em>
<a href="#user-attribute-system">system</a> => <em># Whether the user is a system user, according to...</em>
<a href="#user-attribute-uid">uid</a> => <em># The user ID; must be specified numerically. If...</em>
# ...plus any applicable <a href="https://puppet.com/docs/puppet/latest/metaparameter.html">metaparameters</a>.
}</code></pre>
#### name {#user-attribute-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](#user-attributes))
#### ensure {#user-attribute-ensure}
_(**Property:** This attribute represents concrete state on the target system.)_
The basic state that the object should be in.
Allowed values:
* `present`
* `absent`
* `role`
([↑ Back to user attributes](#user-attributes))
#### allowdupe {#user-attribute-allowdupe}
Whether to allow duplicate UIDs.
Default: `false`
Allowed values:
* `true`
* `false`
* `yes`
* `no`
([↑ Back to user attributes](#user-attributes))
#### attribute_membership {#user-attribute-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.
Default: `minimum`
Allowed values:
* `inclusive`
* `minimum`
([↑ Back to user attributes](#user-attributes))
#### attributes {#user-attribute-attributes}
_(**Property:** This attribute represents concrete state on the target system.)_
Specify AIX attributes for the user in an array or hash of attribute = value pairs.
For example:
```
['minage=0', 'maxage=5', 'SYSTEM=compat']
```
or
```
attributes => { 'minage' => '0', 'maxage' => '5', 'SYSTEM' => 'compat' }
```
Requires features manages_aix_lam.
([↑ Back to user attributes](#user-attributes))
#### auth_membership {#user-attribute-auth_membership}
Whether specified auths should be considered the **complete list**
(`inclusive`) or the **minimum list** (`minimum`) of auths the user
has. This setting is specific to managing Solaris authorizations.
Default: `minimum`
Allowed values:
* `inclusive`
* `minimum`
([↑ Back to user attributes](#user-attributes))
#### auths {#user-attribute-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](#user-attributes))
#### comment {#user-attribute-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](#user-attributes))
#### expiry {#user-attribute-expiry}
_(**Property:** This attribute represents concrete state on the target system.)_
The expiry date for this user. Provide as either the special
value `absent` to ensure that the account never expires, or as
a zero-padded YYYY-MM-DD format -- for example, 2010-02-19.
Allowed values:
* `absent`
* `/^\d{4}-\d{2}-\d{2}$/`
Requires features manages_expiry.
([↑ Back to user attributes](#user-attributes))
#### forcelocal {#user-attribute-forcelocal}
Forces the management of local accounts when accounts are also
being managed by some other Name Service Switch (NSS). For AIX, refer to the `ia_load_module` parameter.
This option relies on your operating system's implementation of `luser*` commands, such as `luseradd` , and `lgroupadd`, `lusermod`. The `forcelocal` option could behave unpredictably in some circumstances. If the tools it depends on are not available, it might have no effect at all.
Default: `false`
Allowed values:
* `true`
* `false`
* `yes`
* `no`
Requires features manages_local_users_and_groups.
([↑ Back to user attributes](#user-attributes))
#### gid {#user-attribute-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](#user-attributes))
#### groups {#user-attribute-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](#user-attributes))
#### home {#user-attribute-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](#user-attributes))
#### ia_load_module {#user-attribute-ia_load_module}
The name of the I&A module to use to manage this user.
This should be set to `files` if managing local users.
Requires features manages_aix_lam.
([↑ Back to user attributes](#user-attributes))
#### iterations {#user-attribute-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](https://en.wikipedia.org/wiki/PBKDF2). 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](#user-attributes))
#### key_membership {#user-attribute-key_membership}
Whether specified key/value pairs should be considered the
**complete list** (`inclusive`) or the **minimum list** (`minimum`) of
the user's attributes.
Default: `minimum`
Allowed values:
* `inclusive`
* `minimum`
([↑ Back to user attributes](#user-attributes))
#### keys {#user-attribute-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](#user-attributes))
#### loginclass {#user-attribute-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](#user-attributes))
#### managehome {#user-attribute-managehome}
Whether to manage the home directory when Puppet creates or removes the user.
This creates the home directory if Puppet also creates the user account, and deletes the
home directory if Puppet also removes the user account.
This parameter has no effect unless Puppet is also creating or removing the user in the
resource at the same time. For instance, Puppet creates a home directory for a managed
user if `ensure => present` and the user does not exist at the time of the Puppet run.
If the home directory is then deleted manually, Puppet will not recreate it on the next
run.
Note that on Windows, this manages creation/deletion of the user profile instead of the
home directory. The user profile is stored in the `C:\\Users\\<username>` directory.
Default: `false`
Allowed values:
* `true`
* `false`
* `yes`
* `no`
([↑ Back to user attributes](#user-attributes))
#### membership {#user-attribute-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.
Default: `minimum`
Allowed values:
* `inclusive`
* `minimum`
([↑ Back to user attributes](#user-attributes))
#### password {#user-attribute-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.
* macOS 10.15 and later require the salt to be 32 bytes. Because Puppet's user
resource requires the value to be hex encoded, the length of the salt's
string must be 64.
* Windows passwords can be managed only in cleartext, because there is no Windows
API for setting the password hash.
[stdlib]: https://github.com/puppetlabs/puppetlabs-stdlib/
Enclose any value that includes a dollar sign ($) in single quotes (') to avoid
accidental variable interpolation.
To redact passwords from reports to PuppetDB, use the `Sensitive` data type. For
example, this resource protects the password:
```puppet
user { 'foo':
ensure => present,
password => Sensitive("my secret password")
}
```
This results in the password being redacted from the report, as in the
`previous_value`, `desired_value`, and `message` fields below.
```yaml
events:
- !ruby/object:Puppet::Transaction::Event
audited: false
property: password
previous_value: "[redacted]"
desired_value: "[redacted]"
historical_value:
message: changed [redacted] to [redacted]
name: :password_changed
status: success
time: 2017-05-17 16:06:02.934398293 -07:00
redacted: true
corrective_change: false
corrective_change: false
```
Requires features manages_passwords.
([↑ Back to user attributes](#user-attributes))
#### password_max_age {#user-attribute-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](#user-attributes))
#### password_min_age {#user-attribute-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](#user-attributes))
#### password_warn_days {#user-attribute-password_warn_days}
_(**Property:** This attribute represents concrete state on the target system.)_
The number of days before a password is going to expire (see the maximum password age) during which the user should be warned.
Requires features manages_password_age.
([↑ Back to user attributes](#user-attributes))
#### profile_membership {#user-attribute-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.
Default: `minimum`
Allowed values:
* `inclusive`
* `minimum`
([↑ Back to user attributes](#user-attributes))
#### profiles {#user-attribute-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](#user-attributes))
#### project {#user-attribute-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](#user-attributes))
#### provider {#user-attribute-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:
* [`aix`](#user-provider-aix)
* [`directoryservice`](#user-provider-directoryservice)
* [`hpuxuseradd`](#user-provider-hpuxuseradd)
* [`ldap`](#user-provider-ldap)
* [`openbsd`](#user-provider-openbsd)
* [`pw`](#user-provider-pw)
* [`user_role_add`](#user-provider-user_role_add)
* [`useradd`](#user-provider-useradd)
* [`windows_adsi`](#user-provider-windows_adsi)
([↑ Back to user attributes](#user-attributes))
#### purge_ssh_keys {#user-attribute-purge_ssh_keys}
Whether to purge authorized SSH keys for this user if they are not managed
with the `ssh_authorized_key` resource type. This parameter is a noop if the
ssh_authorized_key type is not available.
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.
Default: `false`
Allowed values:
* `true`
* `false`
([↑ Back to user attributes](#user-attributes))
#### role_membership {#user-attribute-role_membership}
Whether specified roles should be considered the **complete list**
(`inclusive`) or the **minimum list** (`minimum`) of roles the user
has.
Default: `minimum`
Allowed values:
* `inclusive`
* `minimum`
([↑ Back to user attributes](#user-attributes))
#### roles {#user-attribute-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_roles.
([↑ Back to user attributes](#user-attributes))
#### salt {#user-attribute-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](#user-attributes))
#### shell {#user-attribute-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](#user-attributes))
#### system {#user-attribute-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.
Default: `false`
Allowed values:
* `true`
* `false`
* `yes`
* `no`
([↑ Back to user attributes](#user-attributes))
#### uid {#user-attribute-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](#user-attributes))
### Providers {#user-providers}
#### aix {#user-provider-aix}
User management for AIX.
* Required binaries: `/bin/chpasswd`, `/usr/bin/chuser`, `/usr/bin/mkuser`, `/usr/sbin/lsuser`, `/usr/sbin/rmuser`
* Confined to: `os.name == aix`
* Default for: `["os.name", "aix"] == `
* Supported features: `manages_aix_lam`, `manages_expiry`, `manages_homedir`, `manages_local_users_and_groups`, `manages_password_age`, `manages_passwords`, `manages_shell`
#### directoryservice {#user-provider-directoryservice}
User management on OS X.
* Required binaries: `/usr/bin/dscacheutil`, `/usr/bin/dscl`, `/usr/bin/dsimport`, `/usr/bin/uuidgen`
* Confined to: `os.name == darwin`, `feature == cfpropertylist`
* Default for: `["os.name", "darwin"] == `
* Supported features: `manages_password_salt`, `manages_passwords`, `manages_shell`
#### hpuxuseradd {#user-provider-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`
* Confined to: `os.name == hp-ux`
* Default for: `["os.name", "hp-ux"] == `
* Supported features: `allows_duplicates`, `manages_homedir`, `manages_passwords`
#### ldap {#user-provider-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.
* Confined to: `feature == ldap`, `false == (Puppet[:ldapuser] == "")`
* Supported features: `manages_passwords`, `manages_shell`
#### openbsd {#user-provider-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`
* Confined to: `os.name == openbsd`
* Default for: `["os.name", "openbsd"] == `
* Supported features: `manages_expiry`, `manages_homedir`, `manages_shell`, `system_users`
#### pw {#user-provider-pw}
User management via `pw` on FreeBSD and DragonFly BSD.
* Required binaries: `pw`
* Confined to: `os.name == [:freebsd, :dragonfly]`
* Default for: `["os.name", "[:freebsd, :dragonfly]"] == `
* Supported features: `allows_duplicates`, `manages_expiry`, `manages_homedir`, `manages_passwords`, `manages_shell`
#### user_role_add {#user-provider-user_role_add}
User and role management on Solaris, via `useradd` and `roleadd`.
* Required binaries: `passwd`, `roleadd`, `roledel`, `rolemod`, `useradd`, `userdel`, `usermod`
* Default for: `["os.family", "solaris"] == `
* Supported features: `allows_duplicates`, `manages_homedir`, `manages_password_age`, `manages_passwords`, `manages_roles`, `manages_shell`, `manages_solaris_rbac`
#### useradd {#user-provider-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.
To use the `forcelocal` parameter, you need to install the `libuser` package (providing
`/usr/sbin/lgroupadd` and `/usr/sbin/luseradd`).
* Required binaries: `chage`, `chpasswd`, `useradd`, `userdel`, `usermod`
* Supported features: `allows_duplicates`, `manages_expiry`, `manages_homedir`, `manages_shell`
#### windows_adsi {#user-provider-windows_adsi}
Local user management for Windows.
* Confined to: `os.name == windows`
* Default for: `["os.name", "windows"] == `
* Supported features: `manages_homedir`, `manages_passwords`, `manages_roles`
### Provider Features {#user-provider-features}
Available features:
* `allows_duplicates` --- The provider supports duplicate users with the same UID.
* `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_local_users_and_groups` --- Allows local users to be managed on systems that also use some other remote Name Service Switch (NSS) method of managing accounts.
* `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_roles` --- The provider can manage roles
* `manages_shell` --- The provider allows for setting shell and validates if possible
* `manages_solaris_rbac` --- The provider can manage normal users
* `system_users` --- The provider allows you to create system users with lower UIDs.
Provider support:
* **aix** - _manages aix lam, manages homedir, manages passwords, manages shell, manages expiry, manages password age, manages local users and groups_
* **directoryservice** - _manages passwords, manages password salt, manages shell_
* **hpuxuseradd** - _manages homedir, allows duplicates, manages passwords_
* **ldap** - _manages passwords, manages shell_
* **openbsd** - _manages homedir, manages expiry, system users, manages shell_
* **pw** - _manages homedir, allows duplicates, manages passwords, manages expiry, manages shell_
* **user_role_add** - _manages homedir, allows duplicates, manages solaris rbac, manages roles, manages passwords, manages password age, manages shell_
* **useradd** - _manages homedir, allows duplicates, manages expiry, manages shell_
* **windows_adsi** - _manages homedir, manages passwords, manages roles_
|