cdist/cdist/conf/type/__user/man.rst

106 lines
1.6 KiB
ReStructuredText
Raw Normal View History

cdist-type__user(7)
===================
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
-------------------
2016-05-20 06:50:56 +00:00
state
absent or present, defaults to present
2016-05-20 06:50:56 +00:00
comment
see usermod(8)
2016-05-20 06:50:56 +00:00
home
see above
2016-05-20 06:50:56 +00:00
gid
see above
2016-05-20 06:50:56 +00:00
password
see above
2016-05-20 06:50:56 +00:00
shell
see above
2016-05-20 06:50:56 +00:00
uid
see above
2016-05-20 06:50:56 +00:00
BOOLEAN PARAMETERS
------------------
2016-05-20 06:50:56 +00:00
system
see useradd(8), apply only on user create
2016-05-20 06:50:56 +00:00
create-home
see useradd(8), apply only on user create
2016-05-20 06:50:56 +00:00
remove-home
see userdel(8), apply only on user delete
MESSAGES
--------
2016-05-20 06:50:56 +00:00
mod
User is modified
2016-05-20 06:50:56 +00:00
add
New user added
2018-10-11 14:05:57 +00:00
userdel -r
If user was deleted with homedir
userdel
If user was deleted (keeping homedir)
EXAMPLES
--------
2016-05-20 06:50:56 +00:00
.. code-block:: sh
# Create user account for foobar with operating system default settings
__user foobar
2016-05-20 06:50:56 +00:00
# Same but with a different shell
__user foobar --shell /bin/zsh
2016-05-20 06:50:56 +00:00
# Same but for a system account
__user foobar --system
2016-05-20 06:50:56 +00:00
# Set explicit uid and home
__user foobar --uid 1001 --shell /bin/zsh --home /home/foobar
2016-05-20 06:50:56 +00:00
# Drop user if exists
__user foobar --state absent
SEE ALSO
--------
2016-06-30 13:12:32 +00:00
:strong:`pw`\ (8), :strong:`usermod`\ (8)
AUTHORS
-------
Steven Armstrong <steven-cdist--@--armstrong.cc>
COPYING
-------
2016-08-10 16:15:54 +00:00
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.