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