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