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