9ae68f2bb3e56074e0f0bc5a7aa8e0dd1d5a3c21
[openafs.git] / doc / man-pages / pod1 / pts_setmax.pod
1 =head1 NAME
2
3 pts setmax - Sets the value of the max group id or max user id counter
4
5 =head1 SYNOPSIS
6
7 B<pts setmax> [B<-group> <I<group max>>] [B<-user> <I<user max>>]
8     [B<-cell> <I<cell name>>] [B<-noauth>] [B<-force>] [B<-help>] 
9
10 B<pts setm> [B<-g> I<group max>>] [B<-u> <I<user max>>]
11     [B<-c> <I<cell name>>] [B<-n>] [B<-f>] [B<-h>]
12
13 =head1 DESCRIPTION
14
15 The B<pts setmax> command sets the value of one or both counters that
16 track the IDs the Protection Server allocates to new users, machines, or
17 groups: the C<max user id> counter for the AFS user IDs (AFS UIDs)
18 assigned to users and machines, and the C<max group id> counter for the
19 AFS group IDs (AFS GIDs) assigned to groups.
20
21 Use the B<pts listmax> command to display the current value of both
22 counters.
23
24 =head1 OPTIONS
25
26 =over 4
27
28 =item B<-group> <I<group max>>
29
30 Sets the C<max group id> counter. Precede the value with a hyphen to
31 indicate that it is negative. When an administrator next uses the B<pts
32 creategroup> command to create a group entry and does not include that
33 command's B<-id> argument, the Protection Server assigns the group an AFS
34 GID one less (more negative) than this value.
35
36 =item B<-user> <I<user max>>
37
38 Sets the C<max user id> counter. When an administrator next uses the B<pts
39 createuser> command to create a user or machine entry and does not include
40 that command's B<-id> argument, the Protection Server assigns the group an
41 AFS UID one greater than this value.
42
43 =item B<-cell> <I<cell name>>
44
45 Names the cell in which to run the command. For more details, see
46 L<pts(1)>.
47
48 =item B<-noauth>
49
50 Assigns the unprivileged identity anonymous to the issuer. For more
51 details, see L<pts(1)>.
52
53 =item B<-force>
54
55 Enables the command to continue executing as far as possible when errors
56 or other problems occur, rather than halting execution at the first error.
57
58 =item B<-help>
59
60 Prints the online help for this command. All other valid options are
61 ignored.
62
63 =back
64
65 =head1 EXAMPLES
66
67 The following command sets the C<max group id> counter to -500 and the
68 C<max user id> counter to 1000.
69
70    % pts setmax -group -500 -user 1000
71
72 =head1 PRIVILEGE REQUIRED
73
74 The issuer must belong to the system:administrators group.
75
76 =head1 SEE ALSO
77
78 L<pts(1)>,
79 L<pts_creategroup(1)>,
80 L<pts_createuser(1)>,
81 L<pts_listmax(1)>
82
83 =head1 COPYRIGHT
84
85 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
86
87 This documentation is covered by the IBM Public License Version 1.0.  It was
88 converted from HTML to POD by software written by Chas Williams and Russ
89 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.