table of contents
USERMOD(8) | System Management Commands | USERMOD(8) |
NAME¶
usermod - modify a user account
SYNOPSIS¶
usermod [options] LOGIN
DESCRIPTION¶
The usermod command modifies the system account files to reflect the changes that are specified on the command line.
OPTIONS¶
The options which apply to the usermod command are:
-a, --append
-c, --comment COMMENT
-d, --home HOME_DIR
If the -m 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. If the current home directory does not exist the new home directory will not be created.
-e, --expiredate EXPIRE_DATE
An empty EXPIRE_DATE argument will disable the expiration of the account.
This option requires a /etc/shadow file. A /etc/shadow entry will be created if there were none.
-f, --inactive INACTIVE
A value of 0 disables the account as soon as the password has expired, and a value of -1 disables the feature.
This option requires a /etc/shadow file. A /etc/shadow entry will be created if there were none.
-g, --gid GROUP
Any file from the user´s home directory owned by the previous primary group of the user will be owned by this new group.
The group ownership of files outside of the user´s home directory must be fixed manually.
-G, --groups GROUP1[,GROUP2,...[,GROUPN]]]
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 -a option, which appends the user to the current supplementary group list.
-l, --login NEW_LOGIN
-L, --lock
Note: if you wish to lock the account (not only access with a password), you should also set the EXPIRE_DATE to 1.
-m, --move-home
This option is only valid in combination with the -d (or --home) option.
usermod 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.
-o, --non-unique
-p, --password PASSWORD
Note: This option is not recommended because the password (or encrypted password) will be visible by users listing the processes.
You should make sure the password respects the system´s password policy.
-R, --root CHROOT_DIR
-s, --shell SHELL
-u, --uid UID
This value must be unique, unless the -o option is used. The value must be non-negative.
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.
The ownership of files outside of the user´s home directory must be fixed manually.
No checks will be performed with regard to the UID_MIN, UID_MAX, SYS_UID_MIN, or SYS_UID_MAX from /etc/login.defs.
-U, --unlock
Note: if you wish to unlock the account (not only access with a password), you should also set the EXPIRE_DATE (for example to 99999, or to the EXPIRE value from /etc/default/useradd).
-Z, --selinux-user SEUSER
A blank SEUSER will remove the SELinux user mapping for user LOGIN (if any).
CAVEATS¶
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. usermod checks this on Linux, but only check if the user is logged in according to utmp on other architectures.
You must change the owner of any crontab files or at jobs manually.
You must make any changes involving NIS on the NIS server.
CONFIGURATION¶
The following configuration variables in /etc/login.defs change the behavior of this tool:
MAIL_DIR (string)
MAIL_FILE (string)
The MAIL_DIR and MAIL_FILE variables are used by useradd, usermod, and userdel to create, move, or delete the user´s mail spool.
If MAIL_CHECK_ENAB is set to yes, they are also used to define the MAIL environment variable.
MAX_MEMBERS_PER_GROUP (number)
The default value is 0, meaning that there are no limits in the number of members in a group.
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.
If you need to enforce such limit, you can use 25.
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.
FILES¶
/etc/group
/etc/gshadow
/etc/login.defs
/etc/passwd
/etc/shadow
SEE ALSO¶
chfn(1), chsh(1), passwd(1), crypt(3), gpasswd(8), groupadd(8), groupdel(8), groupmod(8), login.defs(5), useradd(8), userdel(8).
05/11/2016 | shadow-utils 4.1.5.1 |