---
name: "cdist-type__user"
section: "7"
platform: "linux"
package: "cdist"
version: "7.0.0-5"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/cdist-type__user"
---

# cdist-type\_\_user(7)

Manage users

## NAME

cdist-type\_\_user - Manage users

## DESCRIPTION

This cdist type allows you to create or modify users on the target.

## REQUIRED PARAMETERS

None.

## OPTIONAL PARAMETERS

- **state**

  absent or present, defaults to present

- **comment**

  see [usermod(8)](/usermod/8.md)

- **home**

  see above

- **gid**

  see above

- **password**

  see above

- **shell**

  see above

- **uid**

  see above

## BOOLEAN PARAMETERS

- **system**

  see [useradd(8)](/useradd/8.md), apply only on user create

- **create-home**

  see [useradd(8)](/useradd/8.md), apply only on user create

- **remove-home**

  see [userdel(8)](/userdel/8.md), apply only on user delete

## MESSAGES

- **mod**

  User is modified

- **add**

  New user added

- **userdel -r**

  If user was deleted with homedir

- **userdel**

  If user was deleted (keeping homedir)

## EXAMPLES

```
# Create user account for foobar with operating system default settings
__user foobar
# Same but with a different shell
__user foobar --shell /bin/zsh
# Same but for a system account
__user foobar --system
# Set explicit uid and home
__user foobar --uid 1001 --shell /bin/zsh --home /home/foobar
# Drop user if exists
__user foobar --state absent
```

## SEE ALSO

[**pw**(8)](/pw/8.md), [**usermod**(8)](/usermod/8.md)

## AUTHORS

Steven Armstrong \<*steven-cdist--@--armstrong.cc*\>

## COPYING

Copyright (C) 2011 Steven Armstrong. You can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

## COPYRIGHT

ungleich GmbH 2021