add-afs-man-pages-20010716
[openafs.git] / src / man / uss.1
1                            AFS Commands
2
3    1. The uss Commands and Template Lines
4
5    ------------------------------------------------------------
6
7    The uss commands help administrators create user accounts in
8    their system more easily and  efficiently.    Without  them,
9    administering  accounts can become time consuming.  Creating
10    an account "by hand" requires issuing at least six  separate
11    commands  to  five  different  AFS servers, whereas a single
12    uss add command can accomplish all  the  equivalent  actions
13    once  the  issuer  sets  up  the  necessary  template.  Even
14    better, a single issue  of  the  the  uss bulk  command  can
15    create  multiple  accounts  at  once,  after  the  necessary
16    preparations have been made.
17
18    Refer to chapter 11 in the Reference Manual for  a  complete
19    summary list of uss commands and their syntax.
20
21    1.1 Common Arguments and Flags
22    Most  uss  commands  accept the following optional arguments
23    and flags.  They are  listed  in  the  command  descriptions
24    where they apply, and are described here in detail:
25
26    [-cell <cell name>]
27
28    This  argument  specifies  that the command should be run in
29    the cell specified by cell name.  By default,  commands  are
30    executed    in    the    local    cell,    as   defined   in
31    /usr/vice/etc/ThisCell on the client machine  on  which  the
32    command  is  issued.  The issuer may abbreviate cell name to
33    the shortest form that distinguishes it from the other cells
34    listed  in /usr/vice/etc/CellServDB on the client machine on
35    which the command is issued.
36
37    [-admin <administrator to authenticate>]
38
39    This argument names the user name  whom  the  Authentication
40    Servers  should  authenticate  for  purposes  of creating an
41    Authentication Database entry.    If  the  issuer  does  not
42    provide   it,   the  authentication  is  attempted  for  the
43    effective user name (the  one  under  which  the  issuer  is
44    logged  into the local machine's UNIX file system).  With or
45    without this argument, UNIX commands invoked by this command
46    (for  instance, /etc/chown) are executed under the effective
47    user name.
48                               l
49    AFS Command Reference ManuaThe uss Commands and Template Li
50
51
52    [-dryrun]
53
54    This flag indicates that the command interpreter should  not
55    actually  execute  the  command,  but  should report all the
56    actions it would perform if executing  it.    This  flag  is
57    useful  for verifying that the account will be configured as
58    the issuer wishes.  It does not, however, necessarily reveal
59    failures  that  will  result  if the uss command interpreter
60    encounters any circumstances  that  make  it  impossible  to
61    carry  out  a  requested  action.  Combining  this flag with
62    -verbose yields more information.
63
64    [-help]
65
66    This flag has the same function as the bos help command:  it
67    prints  the command's online help message on the screen.  No
68    other arguments or flags should  be  provided  at  the  same
69    time.    Even if they are, this flag overrides them, and the
70    only effect of issuing the command is that the help  message
71    appears.
72
73
74
75    1.1.1 The Privilege Required for uss Commands
76    The  issuer  of  a  uss  command  must  have  all the rights
77    required for performing the equivalent actions individually.
78    See   the   PRIVILEGE   REQUIRED  section  of  each  command
79    description for details.