userdel(1m) - delete a user's login from the system

[mountaing]

System Administration Commands                                     userdel(1M)



NAME
       userdel - delete a user's login from the system

SYNOPSIS
       userdel [-r] [-S repository] [-q qualifier] login


DESCRIPTION
       The  userdel  utility  deletes a user account from the system and makes
       the appropriate account-related changes to the  system  file  and  file
       system.


       An administrator must be granted the User Management Profile to be able
       to delete a user.

OPTIONS
       The following options are supported:

       -q qualfier      The name of a host or netgroup which  qualifies  which
                        attributes  to  delete.  The  prefix  @ is required to
                        indicate that the qualifier is a netgroup name. The -q
                        option is only valid if the user account is maintained
                        in the LDAP name service. Only the attributes  associ-
                        ated  with  the qualifier are deleted. The account and
                        other attributes are not affected unless  this  option
                        is omitted. In that case, all qualified attributes are
                        also deleted.


       -r               Remove the user's home directory from the system. This
                        directory  must exist. The files and directories under
                        the home directory will no longer be  accessible  fol-
                        lowing  successful  execution  of  the  command. A ZFS
                        dataset that was created for the user's home directory
                        will be removed. An auto_home entry that was added for
                        the user will be deleted.


       -S repository    The valid repositories are files, ldap. The repository
                        specifies  which  name  service  will  be updated. The
                        default repository is files.


OPERANDS
       The following operands are supported:

       login    An existing login name to be deleted.


EXIT STATUS
       The following exit values are returned:

       0     Successful completion.


       2     Invalid command syntax. A usage message for the  userdel  command
             is displayed.


       6     The account to be removed does not exist.


       8     The account to be removed is in use.


       10    Cannot update the /etc/group or /etc/user_attr file but the login
             is removed from the /etc/passwd file.


       12    Cannot remove or otherwise modify the home directory.


FILES
       /etc/passwd       system password file


       /etc/shadow       system file contain users'  encrypted  passwords  and
                         related information


       /etc/group        system file containing group definitions


       /etc/user_attr    system file containing additional user attributes


ATTRIBUTES
       See attributes(5) for descriptions of the following attributes:




       +-----------------------------+-----------------------------+
       |      ATTRIBUTE TYPE         |      ATTRIBUTE VALUE        |
       +-----------------------------+-----------------------------+
       |Availability                 |system/core-os               |
       +-----------------------------+-----------------------------+

SEE ALSO
       auths(1),  passwd(1),  profiles(1),  roles(1), users(1B), groupadd(1M),
       groupdel(1M), groupmod(1M), logins(1M), roleadd(1M), rolemod(1M), user-
       add(1M),    usermod(1M),    passwd(4),    prof_attr(4),   user_attr(4),
       attributes(5)

NOTES
       The userdel utility deletes an account definition that is in the group,
       passwd,  shadow,  and  user_attr databases in the files or ldap reposi-
       tory.



SunOS 5.11                        21 Dec 2010                      userdel(1M)