Import Upstream version 1.8.5
[hcoop/debian/openafs.git] / doc / man-pages / pod1 / pts_setmax.pod.in
CommitLineData
805e021f
CE
1=head1 NAME
2
3pts_setmax - Sets the value of the max group id or max user id counter
4
5=head1 SYNOPSIS
6
7=for html
8<div class="synopsis">
9
10B<pts setmax> S<<< [B<-group> <I<group max>>] >>> S<<< [B<-user> <I<user max>>] >>>
11 S<<< [B<-cell> <I<cell name>>] >>> [B<-noauth>] [B<-localauth>] [B<-force>] [B<-help>]
12 [B<-auth>] [B<-encrypt>] S<<< [B<-config> <I<config directory>>] >>>
13
14B<pts setm> [B<-g> I<group max>>] S<<< [B<-u> <I<user max>>] >>>
15 S<<< [B<-c> <I<cell name>>] >>> [B<-n>] [B<-l>] [B<-f>] [B<-h>]
16 [B<-a>] [B<-e>] S<<< [B<-co> <I<config directory>>] >>>
17
18=for html
19</div>
20
21=head1 DESCRIPTION
22
23The B<pts setmax> command sets the value of one or both counters that
24track the IDs the Protection Server allocates to new users, machines, or
25groups: the C<max user id> counter for the AFS user IDs (AFS UIDs)
26assigned to users and machines, and the C<max group id> counter for the
27AFS group IDs (AFS GIDs) assigned to groups.
28
29Use the B<pts listmax> command to display the current value of both
30counters.
31
32=head1 OPTIONS
33
34=over 4
35
36=item B<-group> <I<group max>>
37
38Sets the C<max group id> counter. Precede the value with a hyphen to
39indicate that it is negative. When an administrator next uses the B<pts
40creategroup> command to create a group entry and does not include that
41command's B<-id> argument, the Protection Server assigns the group an AFS
42GID one less (more negative) than this value.
43
44=item B<-user> <I<user max>>
45
46Sets the C<max user id> counter. When an administrator next uses the B<pts
47createuser> command to create a user or machine entry and does not include
48that command's B<-id> argument, the Protection Server assigns the group an
49AFS UID one greater than this value.
50
51=include fragments/pts-common.pod
52
53=back
54
55=head1 EXAMPLES
56
57The following command sets the C<max group id> counter to -500 and the
58C<max user id> counter to 1000.
59
60 % pts setmax -group -500 -user 1000
61
62=head1 PRIVILEGE REQUIRED
63
64The issuer must belong to the system:administrators group.
65
66=head1 SEE ALSO
67
68L<pts(1)>,
69L<pts_creategroup(1)>,
70L<pts_createuser(1)>,
71L<pts_listmax(1)>
72
73=head1 COPYRIGHT
74
75IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
76
77This documentation is covered by the IBM Public License Version 1.0. It was
78converted from HTML to POD by software written by Chas Williams and Russ
79Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.