doc/man-pages/pod/pts_adduser.pod

   1 =head1 NAME
   2
   3 pts adduser - Add a user or machine to a Protection Database group
   4
   5 =head1 SYNOPSIS
   6
   7 pts adduser B<-user> I<user> [I<user> ...] B<-group> I<group> [I<group>
   8 ...] [B<-cell> I<cell>] [B<-noauth>] [B<-force>] [B<-help>]
   9
  10 pts ad B<-u> I<user> [I<user> ...] B<-g> I<group> [I<group> ...] [B<-c>
  11 I<cell>] [B<-n>] [B<-f>] [B<-h>]
  12
  13 =head1 DESCRIPTION
  14
  15 The C<pts adduser> command adds each user or machine entry named by the
  16 B<-user> argument as a member of each group named by the B<-group>
  17 argument.
  18
  19 To remove members of a group, use the C<pts removeuser> command.  To list
  20 the groups to which a user or machine belongs, or the members of a
  21 specified group, use the C<pts membership> command.
  22
  23 If no explicit B<-user> or B<-group> flags are given, the first argument
  24 to C<pts adduser> is taken to be the user and the second argument is taken
  25 to be the group to which to add that user.  For any more complex
  26 operation, the explicit flags must be provided.
  27
  28 =head1 OPTIONS
  29
  30 =over 4
  31
  32 =item B<-user> I<user> [I<user> ...]
  33
  34 Specifies the name of each user or machine entry to add to each group
  35 named by the B<-group> argument.  The name of a machine entry resembles an
  36 IP address and can use the wildcard notation described on the C<pts
  37 createuser> reference page.  The user or machine entry must already exist
  38 in the Protection Database.
  39
  40 =item B<-group> I<group> [I<group> ...]
  41
  42 Specifies the complete name (including the owner prefix if applicable) of
  43 each group to which to add members.  The group entry must already exist in
  44 the Protection Database.
  45
  46 =item B<-cell> I<cell>
  47
  48 Names the cell in which to run the command.  For more details, see the
  49 introductory L<pts(1)> reference page.
  50
  51 =item B<-noauth>
  52
  53 Assigns the unprivileged identity anonymous to the issuer.  For more
  54 details, see the introductory L<pts(1)> reference page.
  55
  56 =item B<-force>
  57
  58 Enables the command to continue executing as far as possible when errors
  59 or other problems occur, rather than halting execution at the first error.
  60
  61 =item B<-help>
  62
  63 Prints the online help for this command.  All other valid options are
  64 ignored.
  65
  66 =back
  67
  68 =head1 EXAMPLES
  69
  70 The following example adds user smith to the group system:administrators.
  71
  72     pts adduser -user smith -group system:administrators
  73
  74 The following example adds users jones, terry, and pat to the
  75 smith:colleagues group.
  76
  77     pts adduser -user jones terry pat -group smith:colleagues
  78
  79 The following example adds the machine entries in the ABC Corporation
  80 subnet to the group bin-prot.  Because of the IP address range of the ABC
  81 Corporation subnet, the system administrator was able to group the
  82 machines into three machine entries (using the wildcard notation discussed
  83 on the C<pts createuser> reference page).
  84
  85     pts adduser -user 138.255.0.0 192.12.105.0 -group bin-prot
  86
  87 =head1 PRIVILEGE REQUIRED
  88
  89 The required privilege depends on the setting of the fourth privacy flag
  90 in the Protection Database entry for each group named by the B<-group>
  91 argument (use the C<pts examine> command to display the flags):
  92
  93 =over 4
  94
  95 =item *
  96
  97 If it is the hyphen, only the group's owner and members of the
  98 system:administrators group can add members.
  99
 100 =item *
 101
 102 If it is lowercase a, current members of the group can add new members.
 103
 104 =item *
 105
 106 If it is uppercase A, anyone who can access the cell's database server
 107 machines can add new members.
 108
 109 =back
 110
 111 =head1 CAVEATS
 112
 113 After being added as a group member, a currently authenticated user must
 114 reauthenticate (for example, by issuing the B<klog> command) to obtain
 115 permissions granted to the group on an access control list (ACL).
 116
 117 =head1 SEE ALSO
 118
 119 L<pts(1)>,
 120 L<pts_createuser(1)>,
 121 L<pts_examine(1)>,
 122 L<pts_membership(1)>,
 123 L<pts_removeuser(1)>,
 124 L<pts_setfields(1)>
 125
 126 =cut