e309385ba660330ed0406545beb649901cd63fda
[openafs.git] / doc / man-pages / pod8 / uss.pod
1 =head1 NAME
2
3 uss - Introduction to the uss command suite
4
5 =head1 DESCRIPTION
6
7 The commands in the B<uss> command suite help administrators to create AFS
8 user accounts more easily and efficiently. If B<uss> commands are not
9 used, creating an account requires issuing at least six separate commands
10 to five different AFS servers.
11
12 There are three main commands in the suite:
13
14 =over 4
15
16 =item *
17
18 The B<uss add> command creates a single complete user account, based on
19 command line arguments and instructions in a template file.
20
21 =item *
22
23 The B<uss bulk> command creates multiple complete accounts at once, based
24 on command line arguments, instructions in a template file and a bulk
25 input file.
26
27 =item *
28
29 The B<uss delete> command removes most parts of a user account.
30
31 =back
32
33 To obtain help, issue the B<uss apropos> and B<uss help> commands.
34
35 =head1 OPTIONS
36
37 The following arguments and flags are available on many commands in the
38 B<uss> suite. The reference page for each command also lists them, but
39 they are described here in greater detail.
40
41 =over 4
42
43 =item B<-admin> <I<administrator to authenticate>>
44
45 Specifies the AFS user name under which to establish a connection to the
46 AFS server processes that administer the various parts of a user
47 account. If it is omitted, the connection is established under the
48 issuer's effective user ID (his or her identity in the local file
49 system). Even when this argument is included, UNIX commands that run
50 during the B<uss> operation (for instance, the UNIX F</etc/chown> command)
51 run under the effective user ID.
52
53 =item B<-cell> <I<cell name>>
54
55 Names the cell in which to run the command. It is acceptable to abbreviate
56 the cell name to the shortest form that distinguishes it from the other
57 entries in the F</usr/vice/etc/CellServDB> file on the local machine. If
58 the B<-cell> argument is omitted, the command interpreter determines the
59 name of the local cell by reading the following in order:
60
61 =over 4
62
63 =item *
64
65 The value of the AFSCELL environment variable.
66
67 =item *
68
69 The local F</usr/vice/etc/ThisCell> file.
70
71 =back
72
73 =item B<-dryrun>
74
75 Reports actions that the command interpreter needs to perform when
76 executing the B<uss> operation, without actually performing them. Include
77 this flag to verify that the command produces the desired account
78 configuration. Combine it with the B<-verbose> flag to yield even more
79 detailed information. Note that the output does not necessarily reveal all
80 possible problems that can prevent successful execution of the command,
81 especially those that result from transient server or network outages.
82
83 =item B<-help>
84
85 Prints a command's online help message on the standard output stream. Do
86 not combine this flag with any of the command's other options; when it is
87 provided, the command interpreter ignores all other options, and only
88 prints the help message.
89
90 =item B<-skipauth>
91
92 Bypasses mutual authentication with the AFS Authentication Server,
93 allowing a site that uses Kerberos instead of the AFS Authentication
94 Server to substitute that form of authentication.
95
96 =back
97
98 =head1 PRIVILEGE REQUIRED
99
100 The issuer of a B<uss> command must have all the rights required for
101 performing the equivalent actions individually. See each B<uss> command's
102 reference page.
103
104 =head1 SEE ALSO
105
106 L<uss(5)>,
107 L<uss_bulk(5)>,
108 L<uss_add(8)>,
109 L<uss_apropos(8)>,
110 L<uss_bulk(8)>,
111 L<uss_delete(8)>,
112 L<uss_help(8)>
113
114 =head1 COPYRIGHT
115
116 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
117
118 This documentation is covered by the IBM Public License Version 1.0.  It was
119 converted from HTML to POD by software written by Chas Williams and Russ
120 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.