doc/man-pages/pod8/uss_bulk.pod

   1 =head1 NAME
   2
   3 uss_bulk - Executes multiple uss commands listed in a file
   4
   5 =head1 SYNOPSIS
   6
   7 =for html
   8 <div class="synopsis">
   9
  10 B<uss bulk> S<<< B<-file> <I<bulk input file>> >>>
  11     S<<< [B<-template> <I<pathname of template file>>] >>> [B<-verbose>]
  12     S<<< [B<-cell> <I<cell name>>] >>>
  13     S<<< [B<-admin> <I<administrator to authenticate>>] >>> [B<-dryrun>]
  14     [B<-skipauth>] [B<-overwrite>]
  15     [B<-pwexpires> <I<password expires in [0..254] days (0 => never)>>]
  16     [B<-pipe>] [B<-help>]
  17
  18 B<uss b> S<<< B<-f> <I<bulk input file>> >>> S<<< [B<-t> <I<pathname of template file>>] >>>
  19     [B<-v>] S<<< [B<-c> <I<cell name>>] >>>
  20     S<<< [B<-a> <I<administrator to authenticate>>] >>> [B<-d>] [B<-s>]
  21     [B<-o>] [B<-pw> <I<password expires in [0..254] days (0 => never)>>]
  22     [B<-pi>] [B<-h>]
  23
  24 =for html
  25 </div>
  26
  27 =head1 DESCRIPTION
  28
  29 The B<uss bulk> command executes the uss commands listed in the I<bulk
  30 input file> specified with the B<-file> argument. If the bulk input file
  31 includes B<add> instructions that reference a template file, then the
  32 B<-template> argument is required.
  33
  34 To create a single account, use the B<uss add> command. To delete one or
  35 more accounts, use the B<uss delete> command.
  36
  37 =head1 OPTIONS
  38
  39 =over 4
  40
  41 =item B<-file> <I<bulk input file>>
  42
  43 Specifies the pathname of the bulk input file. Partial pathnames are
  44 interpreted relative to the current working directory. For details on the
  45 file's format, see L<uss_bulk(5)>.
  46
  47 =item B<-template> <I<pathname of template file>>
  48
  49 Specifies the pathname of the template file for any uss add commands that
  50 appear in the bulk input file. Partial pathnames are interpreted relative
  51 to the current working directory. For details on the file's format, see
  52 L<uss(5)>.
  53
  54 =item B<-verbose>
  55
  56 Produces on the standard output stream a detailed trace of the command's
  57 execution. If this argument is omitted, only warnings and error messages
  58 appear.
  59
  60 =item B<-cell> <I<cell name>>
  61
  62 Specifies the cell in which to run the command. For more details, see
  63 L<uss(8)>.
  64
  65 =item B<-admin> <I<administrator to authenticate>>
  66
  67 Specifies the AFS user name under which to establish authenticated
  68 connections to the AFS server processes that maintain the various
  69 components of a user account. For more details, see L<uss(8)>.
  70
  71 =item B<-dryrun>
  72
  73 Reports actions that the command interpreter needs to perform while
  74 executing the command, without actually performing them. For more details,
  75 see L<uss(8)>.
  76
  77 =item B<-skipauth>
  78
  79 Prevents authentication with the AFS Authentication Server, allowing a
  80 site using Kerberos to substitute that form of authentication.
  81
  82 =item B<-overwrite>
  83
  84 Overwrites any directories, files and links that exist in the file system
  85 and for which there are also C<D>, C<E>, C<F>, C<L>, or C<S> instructions
  86 in a template file referenced by an C<add> instruction in the bulk input
  87 file. If this flag is omitted, the command interpreter prompts, once for
  88 each C<add> instruction in the bulk input file, for confirmation that it
  89 should overwrite such elements. Do not include this flag if the bulk input
  90 file does not contain C<add> instructions.
  91
  92 =item B<-pwexpires> <I<password expiration>>
  93
  94 Sets the number of days after a user's password is changed that it remains
  95 valid, for each user named by an C<add> instruction in the bulk input
  96 file. Provide an integer from the range C<1> through C<254> to specify the
  97 number of days until expiration, or the value C<0> to indicate that the
  98 password never expires (the default).
  99
 100 When the password becomes invalid (expires), the user is unable to
 101 authenticate, but has 30 more days in which to issue the B<kpasswd>
 102 command to change the password (after that, only an administrator can
 103 change it).
 104
 105 =item B<-pipe>
 106
 107 Suppresses the Authentication Server's prompt for the password of the
 108 issuer or the user named by the B<-admin> argument (the Authentication
 109 Server always separately authenticates the creator of an entry in the
 110 Authentication Database). Instead, the command interpreter accepts the
 111 password via the standard input stream, as piped in from another
 112 program. This enables the B<uss bulk> command to run as part of unattended
 113 batch jobs.
 114
 115 =item B<-help>
 116
 117 Prints the online help for this command. All other valid options are
 118 ignored.
 119
 120 =back
 121
 122 =head1 EXAMPLES
 123
 124 The following example command executes the instructions in the bulk input
 125 file called F<new_students>, which includes C<add> instructions that refer
 126 to the template file F<student.template>. Both files reside in the current
 127 working directory.
 128
 129    % uss bulk new_students student.template
 130
 131 =head1 PRIVILEGE REQUIRED
 132
 133 The issuer (or the user named by the B<-admin> argument) must have the
 134 privileges necessary to run the commands that correspond to instructions
 135 in the bulk input file.
 136
 137 =head1 SEE ALSO
 138
 139 L<uss(5)>,
 140 L<uss_bulk(5)>,
 141 L<uss(8)>,
 142 L<uss_add(8)>,
 143 L<uss_delete(8)>
 144
 145 =head1 COPYRIGHT
 146
 147 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
 148
 149 This documentation is covered by the IBM Public License Version 1.0.  It was
 150 converted from HTML to POD by software written by Chas Williams and Russ
 151 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.