587 lines
14 KiB
HTML
587 lines
14 KiB
HTML
|
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
<HTML><HEAD><TITLE>Man page of USERMOD</TITLE>
|
|
</HEAD><BODY>
|
|
<H1>USERMOD</H1>
|
|
Section: System Management Commands (8)<BR>Updated: 05/28/2020<BR><A HREF="#index">Index</A>
|
|
<A HREF="/cgi-bin/man/man2html">Return to Main Contents</A><HR>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<A NAME="lbAB"> </A>
|
|
<H2>NAME</H2>
|
|
|
|
usermod - modify a user account
|
|
<A NAME="lbAC"> </A>
|
|
<H2>SYNOPSIS</H2>
|
|
|
|
<DL COMPACT>
|
|
<DT id="1">
|
|
<B>usermod</B> [<I>options</I>] <I>LOGIN</I>
|
|
</DL>
|
|
<A NAME="lbAD"> </A>
|
|
<H2>DESCRIPTION</H2>
|
|
|
|
<P>
|
|
|
|
<DD>The
|
|
<B>usermod</B>
|
|
command modifies the system account files to reflect the changes that are specified on the command line.
|
|
<A NAME="lbAE"> </A>
|
|
<H2>OPTIONS</H2>
|
|
|
|
<P>
|
|
|
|
The options which apply to the
|
|
<B>usermod</B>
|
|
command are:
|
|
<P>
|
|
|
|
<B>-a</B>, <B>--append</B>
|
|
<DL COMPACT><DT id="2"><DD>
|
|
Add the user to the supplementary group(s). Use only with the
|
|
<B>-G</B>
|
|
option.
|
|
</DL>
|
|
|
|
<P>
|
|
|
|
<B>-b</B>, <B>--badnames</B>
|
|
<DL COMPACT><DT id="3"><DD>
|
|
Allow names that do not conform to standards.
|
|
</DL>
|
|
|
|
<P>
|
|
|
|
<B>-c</B>, <B>--comment</B> <I>COMMENT</I>
|
|
<DL COMPACT><DT id="4"><DD>
|
|
The new value of the user's password file comment field. It is normally modified using the
|
|
<B><A HREF="/cgi-bin/man/man2html?1+chfn">chfn</A></B>(1)
|
|
utility.
|
|
</DL>
|
|
|
|
<P>
|
|
|
|
<B>-d</B>, <B>--home</B> <I>HOME_DIR</I>
|
|
<DL COMPACT><DT id="5"><DD>
|
|
The user's new login directory.
|
|
<P>
|
|
If the
|
|
<B>-m</B>
|
|
option is given, the contents of the current home directory will be moved to the new home directory, which is created if it does not already exist.
|
|
</DL>
|
|
|
|
<P>
|
|
|
|
<B>-e</B>, <B>--expiredate</B> <I>EXPIRE_DATE</I>
|
|
<DL COMPACT><DT id="6"><DD>
|
|
The date on which the user account will be disabled. The date is specified in the format
|
|
<I>YYYY-MM-DD</I>.
|
|
<P>
|
|
An empty
|
|
<I>EXPIRE_DATE</I>
|
|
argument will disable the expiration of the account.
|
|
<P>
|
|
This option requires a
|
|
/etc/shadow
|
|
file. A
|
|
/etc/shadow
|
|
entry will be created if there were none.
|
|
</DL>
|
|
|
|
<P>
|
|
|
|
<B>-f</B>, <B>--inactive</B> <I>INACTIVE</I>
|
|
<DL COMPACT><DT id="7"><DD>
|
|
The number of days after a password expires until the account is permanently disabled.
|
|
<P>
|
|
A value of 0 disables the account as soon as the password has expired, and a value of -1 disables the feature.
|
|
<P>
|
|
This option requires a
|
|
/etc/shadow
|
|
file. A
|
|
/etc/shadow
|
|
entry will be created if there were none.
|
|
</DL>
|
|
|
|
<P>
|
|
|
|
<B>-g</B>, <B>--gid</B> <I>GROUP</I>
|
|
<DL COMPACT><DT id="8"><DD>
|
|
The group name or number of the user's new initial login group. The group must exist.
|
|
<P>
|
|
Any file from the user's home directory owned by the previous primary group of the user will be owned by this new group.
|
|
<P>
|
|
The group ownership of files outside of the user's home directory must be fixed manually.
|
|
</DL>
|
|
|
|
<P>
|
|
|
|
<B>-G</B>, <B>--groups</B> <I>GROUP1</I>[<I>,GROUP2,...</I>[<I>,GROUPN</I>]]]
|
|
<DL COMPACT><DT id="9"><DD>
|
|
A list of supplementary groups which the user is also a member of. Each group is separated from the next by a comma, with no intervening whitespace. The groups are subject to the same restrictions as the group given with the
|
|
<B>-g</B>
|
|
option.
|
|
<P>
|
|
If the user is currently a member of a group which is not listed, the user will be removed from the group. This behaviour can be changed via the
|
|
<B>-a</B>
|
|
option, which appends the user to the current supplementary group list.
|
|
</DL>
|
|
|
|
<P>
|
|
|
|
<B>-l</B>, <B>--login</B> <I>NEW_LOGIN</I>
|
|
<DL COMPACT><DT id="10"><DD>
|
|
The name of the user will be changed from
|
|
<I>LOGIN</I>
|
|
to
|
|
<I>NEW_LOGIN</I>. Nothing else is changed. In particular, the user's home directory or mail spool should probably be renamed manually to reflect the new login name.
|
|
</DL>
|
|
|
|
<P>
|
|
|
|
<B>-L</B>, <B>--lock</B>
|
|
<DL COMPACT><DT id="11"><DD>
|
|
Lock a user's password. This puts a '!' in front of the encrypted password, effectively disabling the password. You can't use this option with
|
|
<B>-p</B>
|
|
or
|
|
<B>-U</B>.
|
|
<P>
|
|
Note: if you wish to lock the account (not only access with a password), you should also set the
|
|
<I>EXPIRE_DATE</I>
|
|
to
|
|
<I>1</I>.
|
|
</DL>
|
|
|
|
<P>
|
|
|
|
<B>-m</B>, <B>--move-home</B>
|
|
<DL COMPACT><DT id="12"><DD>
|
|
Move the content of the user's home directory to the new location.
|
|
<P>
|
|
This option is only valid in combination with the
|
|
<B>-d</B>
|
|
(or
|
|
<B>--home</B>) option.
|
|
<P>
|
|
<B>usermod</B>
|
|
will try to adapt the ownership of the files and to copy the modes, ACL and extended attributes, but manual changes might be needed afterwards.
|
|
</DL>
|
|
|
|
<P>
|
|
|
|
<B>-o</B>, <B>--non-unique</B>
|
|
<DL COMPACT><DT id="13"><DD>
|
|
When used with the
|
|
<B>-u</B>
|
|
option, this option allows to change the user ID to a non-unique value.
|
|
</DL>
|
|
|
|
<P>
|
|
|
|
<B>-p</B>, <B>--password</B> <I>PASSWORD</I>
|
|
<DL COMPACT><DT id="14"><DD>
|
|
The encrypted password, as returned by
|
|
<B><A HREF="/cgi-bin/man/man2html?3+crypt">crypt</A></B>(3).
|
|
<P>
|
|
<B>Note:</B>
|
|
This option is not recommended because the password (or encrypted password) will be visible by users listing the processes.
|
|
<P>
|
|
The password will be written in the local
|
|
/etc/passwd
|
|
or
|
|
/etc/shadow
|
|
file. This might differ from the password database configured in your PAM configuration.
|
|
<P>
|
|
You should make sure the password respects the system's password policy.
|
|
</DL>
|
|
|
|
<P>
|
|
|
|
<B>-R</B>, <B>--root</B> <I>CHROOT_DIR</I>
|
|
<DL COMPACT><DT id="15"><DD>
|
|
Apply changes in the
|
|
<I>CHROOT_DIR</I>
|
|
directory and use the configuration files from the
|
|
<I>CHROOT_DIR</I>
|
|
directory.
|
|
</DL>
|
|
|
|
<P>
|
|
|
|
<B>-P</B>, <B>--prefix</B> <I>PREFIX_DIR</I>
|
|
<DL COMPACT><DT id="16"><DD>
|
|
Apply changes in the
|
|
<I>PREFIX_DIR</I>
|
|
directory and use the configuration files from the
|
|
<I>PREFIX_DIR</I>
|
|
directory. This option does not chroot and is intended for preparing a cross-compilation target. Some limitations: NIS and LDAP users/groups are not verified. PAM authentication is using the host files. No SELINUX support.
|
|
</DL>
|
|
|
|
<P>
|
|
|
|
<B>-s</B>, <B>--shell</B> <I>SHELL</I>
|
|
<DL COMPACT><DT id="17"><DD>
|
|
The name of the user's new login shell. Setting this field to blank causes the system to select the default login shell.
|
|
</DL>
|
|
|
|
<P>
|
|
|
|
<B>-u</B>, <B>--uid</B> <I>UID</I>
|
|
<DL COMPACT><DT id="18"><DD>
|
|
The new numerical value of the user's ID.
|
|
<P>
|
|
This value must be unique, unless the
|
|
<B>-o</B>
|
|
option is used. The value must be non-negative.
|
|
<P>
|
|
The user's mailbox, and any files which the user owns and which are located in the user's home directory will have the file user ID changed automatically.
|
|
<P>
|
|
The ownership of files outside of the user's home directory must be fixed manually.
|
|
<P>
|
|
No checks will be performed with regard to the
|
|
<B>UID_MIN</B>,
|
|
<B>UID_MAX</B>,
|
|
<B>SYS_UID_MIN</B>, or
|
|
<B>SYS_UID_MAX</B>
|
|
from
|
|
/etc/login.defs.
|
|
</DL>
|
|
|
|
<P>
|
|
|
|
<B>-U</B>, <B>--unlock</B>
|
|
<DL COMPACT><DT id="19"><DD>
|
|
Unlock a user's password. This removes the '!' in front of the encrypted password. You can't use this option with
|
|
<B>-p</B>
|
|
or
|
|
<B>-L</B>.
|
|
<P>
|
|
Note: if you wish to unlock the account (not only access with a password), you should also set the
|
|
<I>EXPIRE_DATE</I>
|
|
(for example to
|
|
<I>99999</I>, or to the
|
|
<B>EXPIRE</B>
|
|
value from
|
|
/etc/default/useradd).
|
|
</DL>
|
|
|
|
<P>
|
|
|
|
<B>-v</B>, <B>--add-subuids</B> <I>FIRST</I>-<I>LAST</I>
|
|
<DL COMPACT><DT id="20"><DD>
|
|
Add a range of subordinate uids to the user's account.
|
|
<P>
|
|
This option may be specified multiple times to add multiple ranges to a users account.
|
|
<P>
|
|
No checks will be performed with regard to
|
|
<B>SUB_UID_MIN</B>,
|
|
<B>SUB_UID_MAX</B>, or
|
|
<B>SUB_UID_COUNT</B>
|
|
from /etc/login.defs.
|
|
</DL>
|
|
|
|
<P>
|
|
|
|
<B>-V</B>, <B>--del-subuids</B> <I>FIRST</I>-<I>LAST</I>
|
|
<DL COMPACT><DT id="21"><DD>
|
|
Remove a range of subordinate uids from the user's account.
|
|
<P>
|
|
This option may be specified multiple times to remove multiple ranges to a users account. When both
|
|
<B>--del-subuids</B>
|
|
and
|
|
<B>--add-subuids</B>
|
|
are specified, the removal of all subordinate uid ranges happens before any subordinate uid range is added.
|
|
<P>
|
|
No checks will be performed with regard to
|
|
<B>SUB_UID_MIN</B>,
|
|
<B>SUB_UID_MAX</B>, or
|
|
<B>SUB_UID_COUNT</B>
|
|
from /etc/login.defs.
|
|
</DL>
|
|
|
|
<P>
|
|
|
|
<B>-w</B>, <B>--add-subgids</B> <I>FIRST</I>-<I>LAST</I>
|
|
<DL COMPACT><DT id="22"><DD>
|
|
Add a range of subordinate gids to the user's account.
|
|
<P>
|
|
This option may be specified multiple times to add multiple ranges to a users account.
|
|
<P>
|
|
No checks will be performed with regard to
|
|
<B>SUB_GID_MIN</B>,
|
|
<B>SUB_GID_MAX</B>, or
|
|
<B>SUB_GID_COUNT</B>
|
|
from /etc/login.defs.
|
|
</DL>
|
|
|
|
<P>
|
|
|
|
<B>-W</B>, <B>--del-subgids</B> <I>FIRST</I>-<I>LAST</I>
|
|
<DL COMPACT><DT id="23"><DD>
|
|
Remove a range of subordinate gids from the user's account.
|
|
<P>
|
|
This option may be specified multiple times to remove multiple ranges to a users account. When both
|
|
<B>--del-subgids</B>
|
|
and
|
|
<B>--add-subgids</B>
|
|
are specified, the removal of all subordinate gid ranges happens before any subordinate gid range is added.
|
|
<P>
|
|
No checks will be performed with regard to
|
|
<B>SUB_GID_MIN</B>,
|
|
<B>SUB_GID_MAX</B>, or
|
|
<B>SUB_GID_COUNT</B>
|
|
from /etc/login.defs.
|
|
</DL>
|
|
|
|
<P>
|
|
|
|
<B>-Z</B>, <B>--selinux-user</B> <I>SEUSER</I>
|
|
<DL COMPACT><DT id="24"><DD>
|
|
The new SELinux user for the user's login.
|
|
<P>
|
|
A blank
|
|
<I>SEUSER</I>
|
|
will remove the SELinux user mapping for user
|
|
<I>LOGIN</I>
|
|
(if any).
|
|
</DL>
|
|
|
|
<A NAME="lbAF"> </A>
|
|
<H2>CAVEATS</H2>
|
|
|
|
<P>
|
|
|
|
You must make certain that the named user is not executing any processes when this command is being executed if the user's numerical user ID, the user's name, or the user's home directory is being changed.
|
|
<B>usermod</B>
|
|
checks this on Linux. On other platforms it only uses utmp to check if the user is logged in.
|
|
<P>
|
|
|
|
You must change the owner of any
|
|
<B>crontab</B>
|
|
files or
|
|
<B>at</B>
|
|
jobs manually.
|
|
<P>
|
|
|
|
You must make any changes involving NIS on the NIS server.
|
|
<A NAME="lbAG"> </A>
|
|
<H2>CONFIGURATION</H2>
|
|
|
|
<P>
|
|
|
|
The following configuration variables in
|
|
/etc/login.defs
|
|
change the behavior of this tool:
|
|
<P>
|
|
|
|
<B>LASTLOG_UID_MAX</B> (number)
|
|
<DL COMPACT><DT id="25"><DD>
|
|
Highest user ID number for which the lastlog entries should be updated. As higher user IDs are usually tracked by remote user identity and authentication services there is no need to create a huge sparse lastlog file for them.
|
|
<P>
|
|
No
|
|
<B>LASTLOG_UID_MAX</B>
|
|
option present in the configuration means that there is no user ID limit for writing lastlog entries.
|
|
</DL>
|
|
|
|
<P>
|
|
|
|
<B>MAIL_DIR</B> (string)
|
|
<DL COMPACT><DT id="26"><DD>
|
|
The mail spool directory. This is needed to manipulate the mailbox when its corresponding user account is modified or deleted. If not specified, a compile-time default is used.
|
|
</DL>
|
|
|
|
<P>
|
|
|
|
<B>MAIL_FILE</B> (string)
|
|
<DL COMPACT><DT id="27"><DD>
|
|
Defines the location of the users mail spool files relatively to their home directory.
|
|
</DL>
|
|
|
|
<P>
|
|
|
|
The
|
|
<B>MAIL_DIR</B>
|
|
and
|
|
<B>MAIL_FILE</B>
|
|
variables are used by
|
|
<B>useradd</B>,
|
|
<B>usermod</B>, and
|
|
<B>userdel</B>
|
|
to create, move, or delete the user's mail spool.
|
|
<P>
|
|
|
|
<B>MAX_MEMBERS_PER_GROUP</B> (number)
|
|
<DL COMPACT><DT id="28"><DD>
|
|
Maximum members per group entry. When the maximum is reached, a new group entry (line) is started in
|
|
/etc/group
|
|
(with the same name, same password, and same GID).
|
|
<P>
|
|
The default value is 0, meaning that there are no limits in the number of members in a group.
|
|
<P>
|
|
This feature (split group) permits to limit the length of lines in the group file. This is useful to make sure that lines for NIS groups are not larger than 1024 characters.
|
|
<P>
|
|
If you need to enforce such limit, you can use 25.
|
|
<P>
|
|
Note: split groups may not be supported by all tools (even in the Shadow toolsuite). You should not use this variable unless you really need it.
|
|
</DL>
|
|
|
|
<P>
|
|
|
|
<B>SUB_GID_MIN</B> (number), <B>SUB_GID_MAX</B> (number), <B>SUB_GID_COUNT</B> (number)
|
|
<DL COMPACT><DT id="29"><DD>
|
|
If
|
|
/etc/subuid
|
|
exists, the commands
|
|
<B>useradd</B>
|
|
and
|
|
<B>newusers</B>
|
|
(unless the user already have subordinate group IDs) allocate
|
|
<B>SUB_GID_COUNT</B>
|
|
unused group IDs from the range
|
|
<B>SUB_GID_MIN</B>
|
|
to
|
|
<B>SUB_GID_MAX</B>
|
|
for each new user.
|
|
<P>
|
|
The default values for
|
|
<B>SUB_GID_MIN</B>,
|
|
<B>SUB_GID_MAX</B>,
|
|
<B>SUB_GID_COUNT</B>
|
|
are respectively 100000, 600100000 and 65536.
|
|
</DL>
|
|
|
|
<P>
|
|
|
|
<B>SUB_UID_MIN</B> (number), <B>SUB_UID_MAX</B> (number), <B>SUB_UID_COUNT</B> (number)
|
|
<DL COMPACT><DT id="30"><DD>
|
|
If
|
|
/etc/subuid
|
|
exists, the commands
|
|
<B>useradd</B>
|
|
and
|
|
<B>newusers</B>
|
|
(unless the user already have subordinate user IDs) allocate
|
|
<B>SUB_UID_COUNT</B>
|
|
unused user IDs from the range
|
|
<B>SUB_UID_MIN</B>
|
|
to
|
|
<B>SUB_UID_MAX</B>
|
|
for each new user.
|
|
<P>
|
|
The default values for
|
|
<B>SUB_UID_MIN</B>,
|
|
<B>SUB_UID_MAX</B>,
|
|
<B>SUB_UID_COUNT</B>
|
|
are respectively 100000, 600100000 and 65536.
|
|
</DL>
|
|
|
|
<A NAME="lbAH"> </A>
|
|
<H2>FILES</H2>
|
|
|
|
<P>
|
|
|
|
/etc/group
|
|
<DL COMPACT><DT id="31"><DD>
|
|
Group account information.
|
|
</DL>
|
|
|
|
<P>
|
|
|
|
/etc/gshadow
|
|
<DL COMPACT><DT id="32"><DD>
|
|
Secure group account information.
|
|
</DL>
|
|
|
|
<P>
|
|
|
|
/etc/login.defs
|
|
<DL COMPACT><DT id="33"><DD>
|
|
Shadow password suite configuration.
|
|
</DL>
|
|
|
|
<P>
|
|
|
|
/etc/passwd
|
|
<DL COMPACT><DT id="34"><DD>
|
|
User account information.
|
|
</DL>
|
|
|
|
<P>
|
|
|
|
/etc/shadow
|
|
<DL COMPACT><DT id="35"><DD>
|
|
Secure user account information.
|
|
</DL>
|
|
|
|
<P>
|
|
|
|
/etc/subgid
|
|
<DL COMPACT><DT id="36"><DD>
|
|
Per user subordinate group IDs.
|
|
</DL>
|
|
|
|
<P>
|
|
|
|
/etc/subuid
|
|
<DL COMPACT><DT id="37"><DD>
|
|
Per user subordinate user IDs.
|
|
</DL>
|
|
|
|
<A NAME="lbAI"> </A>
|
|
<H2>SEE ALSO</H2>
|
|
|
|
<P>
|
|
|
|
<B><A HREF="/cgi-bin/man/man2html?1+chfn">chfn</A></B>(1),
|
|
<B><A HREF="/cgi-bin/man/man2html?1+chsh">chsh</A></B>(1),
|
|
<B><A HREF="/cgi-bin/man/man2html?1+passwd">passwd</A></B>(1),
|
|
<B><A HREF="/cgi-bin/man/man2html?3+crypt">crypt</A></B>(3),
|
|
<B><A HREF="/cgi-bin/man/man2html?8+gpasswd">gpasswd</A></B>(8),
|
|
<B><A HREF="/cgi-bin/man/man2html?8+groupadd">groupadd</A></B>(8),
|
|
<B><A HREF="/cgi-bin/man/man2html?8+groupdel">groupdel</A></B>(8),
|
|
<B><A HREF="/cgi-bin/man/man2html?8+groupmod">groupmod</A></B>(8),
|
|
<B><A HREF="/cgi-bin/man/man2html?5+login.defs">login.defs</A></B>(5),
|
|
<B><A HREF="/cgi-bin/man/man2html?5+subgid">subgid</A></B>(5), <B><A HREF="/cgi-bin/man/man2html?5+subuid">subuid</A></B>(5),
|
|
<B><A HREF="/cgi-bin/man/man2html?8+useradd">useradd</A></B>(8),
|
|
<B><A HREF="/cgi-bin/man/man2html?8+userdel">userdel</A></B>(8).
|
|
<P>
|
|
|
|
<HR>
|
|
<A NAME="index"> </A><H2>Index</H2>
|
|
<DL>
|
|
<DT id="38"><A HREF="#lbAB">NAME</A><DD>
|
|
<DT id="39"><A HREF="#lbAC">SYNOPSIS</A><DD>
|
|
<DT id="40"><A HREF="#lbAD">DESCRIPTION</A><DD>
|
|
<DT id="41"><A HREF="#lbAE">OPTIONS</A><DD>
|
|
<DT id="42"><A HREF="#lbAF">CAVEATS</A><DD>
|
|
<DT id="43"><A HREF="#lbAG">CONFIGURATION</A><DD>
|
|
<DT id="44"><A HREF="#lbAH">FILES</A><DD>
|
|
<DT id="45"><A HREF="#lbAI">SEE ALSO</A><DD>
|
|
</DL>
|
|
<HR>
|
|
This document was created by
|
|
<A HREF="/cgi-bin/man/man2html">man2html</A>,
|
|
using the manual pages.<BR>
|
|
Time: 00:06:18 GMT, March 31, 2021
|
|
</BODY>
|
|
</HTML>
|