doc/man-pages/pod1/pts_removeuser.pod

   1 =head1 NAME
   2
   3 pts_removeuser - Removes a user from a Protection Database group
   4
   5 =head1 SYNOPSIS
   6
   7 =for html
   8 <div class="synopsis">
   9
  10 B<pts removeuser> S<<< B<-user> <I<user name>>+ >>> S<<< B<-group> <I<group name>>+ >>>
  11     S<<< [B<-cell> <I<cell name>>] >>> [B<-noauth>] [B<-localauth>] [B<-force>]
  12     [B<-help>]
  13
  14 B<pts rem> S<<< B<-u> <I<user name>>+ >>> S<<< B<-g> <I<group name>>+ >>>
  15     S<<< [B<-c> <I<cell name>>] >>> [B<-n>] [B<-l>] [B<-f>] [B<-h>]
  16
  17 =for html
  18 </div>
  19
  20 =head1 DESCRIPTION
  21
  22 The B<pts removeuser> command removes each user or machine named by the
  23 B<-user> argument from each group named by the B<-group> argument.
  24
  25 To add users to a group, use the B<pts adduser> command. To list group
  26 membership, use the B<pts membership> command. To remove users from a
  27 group and delete the group's entry completely in a single step, use the
  28 B<pts delete> command.
  29
  30 =head1 CAUTIONS
  31
  32 AFS compiles each user's group membership as he or she authenticates. Any
  33 users who have valid tokens when they are removed from a group retain the
  34 privileges extended to that group's members until they discard their
  35 tokens or reauthenticate.
  36
  37 =head1 OPTIONS
  38
  39 =over 4
  40
  41 =item B<-name> <I<user name>>+
  42
  43 Specifies the name of each user entry or the IP address (complete or
  44 wildcard-style) of each machine entry to remove.
  45
  46 =item B<-group> <I<group name>>+
  47
  48 Names each group from which to remove members.
  49
  50 =item B<-cell> <I<cell name>>
  51
  52 Names the cell in which to run the command. For more details, see
  53 L<pts(1)>.
  54
  55 =item B<-noauth>
  56
  57 Assigns the unprivileged identity anonymous to the issuer. For more
  58 details, see L<pts(1)>.
  59
  60 =item B<-localauth>
  61
  62 Constructs a server ticket using a key from the local
  63 F</usr/afs/etc/KeyFile> file. Do not combine this flag with the
  64 B<-cell> or B<-noauth> options. For more details, see L<pts(1)>.
  65
  66 =item B<-force>
  67
  68 Enables the command to continue executing as far as possible when errors
  69 or other problems occur, rather than halting execution at the first error.
  70
  71 =item B<-help>
  72
  73 Prints the online help for this command. All other valid options are
  74 ignored.
  75
  76 =back
  77
  78 =head1 EXAMPLES
  79
  80 The following example removes user smith from the groups C<staff> and
  81 C<staff:finance>. Note that no switch names are necessary because only a
  82 single instance is provided for the first argument (the username).
  83
  84    % pts removeuser smith staff staff:finance
  85
  86 The following example removes three machine entries, which represent all
  87 machines in the ABC Corporation network, from the group C<bin-prot>:
  88
  89    % pts removeuser -user 138.255.0.0 192.12.105.0 192.12.106.0 -group bin-prot
  90
  91 =head1 PRIVILEGE REQUIRED
  92
  93 The required privilege depends on the setting of the fifth privacy flag in
  94 the Protection Database for the group named by the B<-group> argument (use
  95 the B<pts examine> command to display the flags):
  96
  97 =over 4
  98
  99 =item *
 100
 101 If it is the hyphen, only the group's owner and members of the
 102 system:administrators group can remove members.
 103
 104 =item *
 105
 106 If it is lowercase C<r>, members of the group can also remove other
 107 members.
 108
 109 =back
 110
 111 (It is not possible to set the fifth flag to uppercase C<R>.)
 112
 113 =head1 SEE ALSO
 114
 115 L<pts(1)>,
 116 L<pts_adduser(1)>,
 117 L<pts_examine(1)>,
 118 L<pts_membership(1)>,
 119 L<pts_setfields(1)>
 120
 121 =head1 COPYRIGHT
 122
 123 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
 124
 125 This documentation is covered by the IBM Public License Version 1.0.  It was
 126 converted from HTML to POD by software written by Chas Williams and Russ
 127 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.