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