Difference between revisions of "usermod/archive/Red Hat 7"

from HTYP, the free directory anyone can edit if they can prove to me that they're not a spambot
Jump to: navigation, search
 
(post-move tidying)
 
(16 intermediate revisions by the same user not shown)
Line 1: Line 1:
[[Category:Linux
+
[[category:manpages]]
Shell Commands]]
+
[[category:Red Hat]]
[[Techniques]]: [[Linux]]: [[usermod]]
+
[[category:Red Hat 7]]
 
==Manpage Text==
 
==Manpage Text==
 
===Name===
 
===Name===
:'''usermod''' - Modify a user account
+
: [[usermod]] - Modify a [[Linux users|user]] account
 +
 
 
===Synopsis===
 
===Synopsis===
:usermod [-c <u>comment</u>] [-d
+
: [[usermod]] {{arg|-c <u>comment</u>}} {{arg|-d <u>home_dir</u> [ -m]}} {{arg|-e <u>expire_date</u>}} {{arg|-f <u>inactive_time</u>}} {{arg|-g <u>initial_group</u>}} {{arg|-G <u>group</u>[,...]}} {{arg|-l <u>login_name</u>}} {{arg|-p <u>passwd</u>}} {{arg|-s <u>shell</u>}} {{arg|-u <u>uid</u> [ -o]}} {{arg|-L<nowiki>|</nowiki>-U}} <u>login</u>
<u>home_dir</u> [ -m]] [-e <u>expire_date</u>]
 
[-f <u>inactive_time</u>] [-g
 
<u>initial_group</u>] [-G <u>group</u>[,...]]
 
[-l <u>login_name</u>] [-p <u>passwd</u>] [-s
 
<u>shell</u>] [-u <u>uid</u> [ -o]] [-L|-U]
 
<u>login</u>
 
 
===Description===
 
===Description===
The usermod command modifies the system account files to reflect the
+
The usermod command modifies the system account files to reflect the changes that are specified on the command line. The options which apply to the usermod command are
changes that are specified on the command line. The options which apply
+
 
to the usermod command are
 
 
*'''-c <u>comment</u>'''
 
*'''-c <u>comment</u>'''
*:The new value of the user's password file comment field. It is
+
*:The new value of the user's password file comment field. It is normally modified using the [[chfn]](1) utility.
normally modified using the [[chfn]](1) utility.
 
 
*'''-d <u>home_dir</u>'''
 
*'''-d <u>home_dir</u>'''
*:The user's new login directory. If the -m option is given the
+
*:The user's new login directory. 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.
contents of the current home directory will be moved to the new home
 
directory, which is created if it does not already exist.
 
 
*'''-e <u>expire_date</u>'''
 
*'''-e <u>expire_date</u>'''
*:The date on which the user account will be disabled. The date is
+
*:The date on which the user account will be disabled. The date is specified in the format YYYY-MM-DD.
specified in the format YYYY-MM-DD.
 
 
*'''-f <u>inactive_days</u>'''
 
*'''-f <u>inactive_days</u>'''
*:The number of days after a password expires until the account is
+
*:The number of days after a password expires until the account is permanently disabled. A value of 0 disables the account as soon as the password has expired, and a value of -1 disables the feature. The default value is -1.
permanently disabled. A value of 0 disables the account as soon as the
 
password has expired, and a value of -1 disables the feature. The
 
default value is -1.
 
 
*'''-g <u>initial_group</u>'''
 
*'''-g <u>initial_group</u>'''
*:The group name or number of the user's new initial login group. The
+
*:The [[Linux/groups|group]] name or number of the user's new initial login group. The group name must exist. A group number must refer to an already existing group. The default group number is 1.
group name must exist. A group number must refer to an already existing
 
group. The default group number is 1.
 
 
*'''-G <u>group</u>,[...]'''
 
*'''-G <u>group</u>,[...]'''
*:A list of supplementary groups which the user is also a member of.
+
*:A list of supplementary [[Linux/groups|group]]s 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 -g option. If the user is currently a member of a group which is not listed, the user will be removed from the group
Each group is separated from the next by a comma, with no intervening
+
**'''Addendum''': groups are separated by commas without spaces, e.g. "-G ''group1'',''group2'',''group3''". --[[User:Woozle|Woozle]]
whitespace. The groups are subject to the same restrictions as the
 
group given with the -g option. If the user is currently a member of a
 
group which is not listed, the user will be removed from the group
 
 
*'''-l <u>login_name</u>'''
 
*'''-l <u>login_name</u>'''
*:The name of the user will be changed from login to login_name.
+
*:The name of the user will be changed from login to login_name. Nothing else is changed. In particular, the user's home directory name should probably be changed to reflect the new login name.
Nothing else is changed. In particular, the user's home directory name
 
should probably be changed to reflect the new login name.
 
 
*'''-p <u>passwd</u>'''
 
*'''-p <u>passwd</u>'''
 
*:The encrypted password, as returned by [[crypt]](3).
 
*:The encrypted password, as returned by [[crypt]](3).
 
*'''-s <u>shell</u>'''
 
*'''-s <u>shell</u>'''
*:The name of the user's new login shell. Setting this field to blank
+
*:The name of the user's new login shell.   Setting this field to blank causes the system to select the default login shell.
causes the system to select the default login shell.
 
 
*'''-u <u>uid</u>'''
 
*'''-u <u>uid</u>'''
*:The numerical value of the user's ID. This value must be unique,
+
*:The numerical value of the user's ID. This value must be unique, unless the -o option is used. The value must be non-negative. Values between 0 and 99 are typically reserved for system accounts. Any files which the user owns and which are located in the directory tree rooted at the user's home directory will have the file user ID changed automatically. Files outside of the user's home directory must be altered manually.
unless the -o option is used. The value must be non-negative. Values
 
between 0 and 99 are typically reserved for system accounts. Any files
 
which the user owns and which are located in the directory tree rooted
 
at the user's home directory will have the file user ID changed
 
automatically. Files outside of the user's home directory must be
 
altered manually.
 
 
*'''-L'''
 
*'''-L'''
*:Lock a user's password. This puts a '!' in front of the encrypted
+
*: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 -p or -U.
password, effectively disabling the password. You can't use this option
 
with -p or -U.
 
 
*'''-U'''
 
*'''-U'''
*:Unlock a user's password. This removes the '!' in front of the
+
*:Unlock a user's password. This removes the '!' in front of the encrypted password.   You can't use this option with -p or -L.
encrypted password. You can't use this option with -p or -L.
+
*'''<u>login</u>''' is the username whose parameters are to be changed.
 +
 
 
===Caveats===
 
===Caveats===
[[usermod]] will not allow you to change the name of a user who is
+
[[usermod]] will not allow you to change the name of a user who is logged in. 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 is being changed.   You must change the owner of any crontab files manually. You must change the owner of any at jobs manually.   You must make any changes involving NIS on the NIS server.
logged in. 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 is being changed. You must change the owner of any
 
crontab files manually. You must change the owner of any at jobs
 
manually. You must make any changes involving NIS on the NIS server.
 
 
===Files===
 
===Files===
 
*'''/etc/passwd''' - user account information
 
*'''/etc/passwd''' - user account information
Line 78: Line 45:
 
*'''/etc/group''' - group information
 
*'''/etc/group''' - group information
 
===See Also===
 
===See Also===
[[chfn]](1), [[chsh]](1), [[crypt]](3), [[groupadd]](8),
+
[[chfn]](1), [[chsh]](1), [[crypt]](3), [[groupadd]](8), [[groupdel]](8), [[groupmod]](8), [[passwd]](1), [[useradd]](8), [[userdel]](8)
[[groupdel]](8), [[groupmod]](8), [[passwd]](1), [[useradd]](8),
+
 
[[userdel]](8)
 
 
===Author===
 
===Author===
Julianne Frances Haugh (jfh@austin.ibm.com)
+
Julianne Frances Haugh ({{email|jfh|austin.ibm|com}})
 +
==Examples==
 +
The "/usr/sbin/" prefix may or may not be necessary depending on how your [[Linux distro]] is set up.
 +
* /usr/sbin/usermod -G <u>group1</u>,<u>group2</u>,<u>group3</u> <u>username</u>
 +
** Joins user <u>username</u> to groups <u>group1</u>, <u>group2</u>, and <u>group3</u>, and unjoins from any other groups (get list of existing groups with "groups <u>username</u>"). <u>Group</u>s may be identified by name or by ID; see {{l/sub|/etc/group|pfx=Linux/files}} for list of groups and IDs.
 +
** ''this doesn't seem to work -- usermod returns a quick guide to proper usage --[[User:Woozle|Woozle]] 01:16, 20 June 2010 (UTC)''
 +
* usermod -G <u>groupname</u> -a <u>username</u>
 +
** Adds user <u>username</u> to group <u>groupname</u> without removing user from any other groups.
 +
 
 
==Edit Log==
 
==Edit Log==
 
*2005-06-12 Transcribed from manpage in Red Hat 7
 
*2005-06-12 Transcribed from manpage in Red Hat 7

Latest revision as of 18:48, 23 April 2017

Manpage Text

Name

usermod - Modify a user account

Synopsis

usermod <-c comment> <-d home_dir [ -m]> <-e expire_date> <-f inactive_time> <-g initial_group> <-G group[,...]> <-l login_name> <-p passwd> <-s shell> <-u uid [ -o]> <-L|-U> login

Description

The usermod command modifies the system account files to reflect the changes that are specified on the command line. The options which apply to the usermod command are

  • -c comment
    The new value of the user's password file comment field. It is normally modified using the chfn(1) utility.
  • -d home_dir
    The user's new login directory. 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.
  • -e expire_date
    The date on which the user account will be disabled. The date is specified in the format YYYY-MM-DD.
  • -f inactive_days
    The number of days after a password expires until the account is permanently disabled. A value of 0 disables the account as soon as the password has expired, and a value of -1 disables the feature. The default value is -1.
  • -g initial_group
    The group name or number of the user's new initial login group. The group name must exist. A group number must refer to an already existing group. The default group number is 1.
  • -G group,[...]
    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 -g option. If the user is currently a member of a group which is not listed, the user will be removed from the group
    • Addendum: groups are separated by commas without spaces, e.g. "-G group1,group2,group3". --Woozle
  • -l login_name
    The name of the user will be changed from login to login_name. Nothing else is changed. In particular, the user's home directory name should probably be changed to reflect the new login name.
  • -p passwd
    The encrypted password, as returned by crypt(3).
  • -s shell
    The name of the user's new login shell. Setting this field to blank causes the system to select the default login shell.
  • -u uid
    The numerical value of the user's ID. This value must be unique, unless the -o option is used. The value must be non-negative. Values between 0 and 99 are typically reserved for system accounts. Any files which the user owns and which are located in the directory tree rooted at the user's home directory will have the file user ID changed automatically. Files outside of the user's home directory must be altered manually.
  • -L
    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 -p or -U.
  • -U
    Unlock a user's password. This removes the '!' in front of the encrypted password. You can't use this option with -p or -L.
  • login is the username whose parameters are to be changed.

Caveats

usermod will not allow you to change the name of a user who is logged in. 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 is being changed. You must change the owner of any crontab files manually. You must change the owner of any at jobs manually. You must make any changes involving NIS on the NIS server.

Files

  • /etc/passwd - user account information
  • /etc/shadow - secure user account information
  • /etc/group - group information

See Also

chfn(1), chsh(1), crypt(3), groupadd(8), groupdel(8), groupmod(8), passwd(1), useradd(8), userdel(8)

Author

Julianne Frances Haugh (jfhspam@spamaustin.ibmspam.spamcom)

Examples

The "/usr/sbin/" prefix may or may not be necessary depending on how your Linux distro is set up.

  • /usr/sbin/usermod -G group1,group2,group3 username
    • Joins user username to groups group1, group2, and group3, and unjoins from any other groups (get list of existing groups with "groups username"). Groups may be identified by name or by ID; see /etc/group for list of groups and IDs.
    • this doesn't seem to work -- usermod returns a quick guide to proper usage --Woozle 01:16, 20 June 2010 (UTC)
  • usermod -G groupname -a username
    • Adds user username to group groupname without removing user from any other groups.

Edit Log

  • 2005-06-12 Transcribed from manpage in Red Hat 7