doc/man-pages/pod8/uss_delete.pod

   1 =head1 NAME
   2
   3 uss_delete - Deletes a user account
   4
   5 =head1 SYNOPSIS
   6
   7 =for html
   8 <div class="synopsis">
   9
  10 B<uss delete> S<<< B<-user> <I<login name>> >>>
  11     S<<< [B<-mountpoint> <I<mountpoint for user's volume>>] >>>
  12     [B<-savevolume>] [B<-verbose>] S<<< [B<-cell> <I<cell name>>] >>>
  13     S<<< [B<-admin> <I<administrator to authenticate>>] >>> [B<-dryrun>]
  14     [B<-skipauth>] [B<-help>]
  15
  16 B<uss d> S<<< B<-u> <I<login name>> >>> S<<< [B<-m> <I<mountpoint for user's volume>>] >>>
  17     [B<-sa>] [B<-v>] S<<< [B<-c> <I<cell name>>] >>>
  18     S<<< [B<-a> <I<administrator to authenticate>>] >>> [B<-d>] [B<-sk>] [B<-h>]
  19
  20 =for html
  21 </div>
  22
  23 =head1 DESCRIPTION
  24
  25 The B<uss delete> command removes the Authentication Database and
  26 Protection Database entries for the user named by B<-user> argument. In
  27 addition, it can remove the user's home volume and associated VLDB entry,
  28 a mount point for the volume or both, depending on whether the
  29 B<-mountpoint> and B<-savevolume> options are provided.
  30
  31 =over 4
  32
  33 =item *
  34
  35 To remove both the volume and mount point, use the B<-mountpoint> argument
  36 to name the user's home directory. It is best to create a tape backup of a
  37 volume before deleting it. Note that other mount points for the volume are
  38 not removed, if they exist.
  39
  40 =item *
  41
  42 To remove the mount point only, provide both the B<-mountpoint> and
  43 B<-savevolume> options.
  44
  45 =item *
  46
  47 To preserve both the volume and mount point, omit the B<-mountpoint>
  48 argument (or both it and the B<-savevolume> flag).
  49
  50 =back
  51
  52 =head1 OPTIONS
  53
  54 =over 4
  55
  56 =item B<-user> <I<login name>>
  57
  58 Names the entry to delete from the Protection and Authentication
  59 Databases.
  60
  61 =item B<-mountpoint> <I<mountpoint for the user's volume>>
  62
  63 Specifies the pathname to the user's home directory, which is deleted from
  64 the filespace. By default, the volume referenced by the mount point is
  65 also removed from the file server machine that houses it, along with its
  66 Volume Location Database (VLDB) entry. To retain the volume and VLDB
  67 entry, include the B<-savevolume> flag. Partial pathnames are interpreted
  68 relative to the current working directory.
  69
  70 Specify the read/write path to the mount point, to avoid the failure that
  71 results from attempting to remove a mount point from a read-only
  72 volume. By convention, the read/write path is indicated by placing a
  73 period before the cell name at the pathname's second level (for example,
  74 F</afs/.abc.com>). For further discussion of the concept of read/write and
  75 read-only paths through the filespace, see the B<fs mkmount> reference
  76 page.
  77
  78 =item B<-savevolume>
  79
  80 Preserves the user's volume and VLDB entry.
  81
  82 =item B<-verbose>
  83
  84 Produces on the standard output stream a detailed trace of the command's
  85 execution. If this argument is omitted, only warnings and error messages
  86 appear.
  87
  88 =item B<-cell> <I<cell name>>
  89
  90 Specifies the cell in which to run the command. For more details, see
  91 L<uss(8)>.
  92
  93 =item B<-admin> <I<administrator to authenticate>>
  94
  95 Specifies the AFS user name under which to establish authenticated
  96 connections to the AFS server processes that maintain the various
  97 components of a user account. For more details, see L<uss(8)>.
  98
  99 =item B<-dryrun>
 100
 101 Reports actions that the command interpreter needs to perform while
 102 executing the command, without actually performing them. For more details,
 103 see L<uss(8)>.
 104
 105 =item B<-skipauth>
 106
 107 Prevents authentication with the AFS Authentication Server, allowing a
 108 site using Kerberos to substitute that form of authentication.
 109
 110 =item B<-help>
 111
 112 Prints the online help for this command. All other valid options are
 113 ignored.
 114
 115 =back
 116
 117 =head1 EXAMPLES
 118
 119 The following command removes smith's user account from the C<abc.com>
 120 cell. The B<-savevolume> argument retains the C<user.smith> volume on its
 121 file server machine.
 122
 123    % uss delete smith -mountpoint /afs/abc.com/usr/smith -savevolume
 124
 125 =head1 PRIVILEGE REQUIRED
 126
 127 The issuer (or the user named by B<-admin> argument) must belong to the
 128 system:administrators group in the Protection Database, must have the
 129 C<ADMIN> flag turned on in his or her Authentication Database entry, and
 130 must have at least C<a> (administer) and C<d> (delete) permissions on the
 131 access control list (ACL) of the mount point's parent directory. If the
 132 B<-savevolume> flag is not included, the issuer must also be listed in the
 133 F</usr/afs/etc/UserList> file.
 134
 135 =head1 SEE ALSO
 136
 137 L<UserList(5)>,
 138 L<fs_mkmount(1)>,
 139 L<uss(8)>
 140
 141 =head1 COPYRIGHT
 142
 143 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
 144
 145 This documentation is covered by the IBM Public License Version 1.0.  It was
 146 converted from HTML to POD by software written by Chas Williams and Russ
 147 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.