doc/xml/AdminReference/sect8/uss_bulk.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <refentry id="uss_bulk8">
   3   <refmeta>
   4     <refentrytitle>uss bulk</refentrytitle>
   5     <manvolnum>8</manvolnum>
   6   </refmeta>
   7   <refnamediv>
   8     <refname>uss bulk</refname>
   9     <refpurpose>Executes multiple uss commands listed in a file</refpurpose>
  10   </refnamediv>
  11   <refsect1>
  12     <title>Synopsis</title>
  13     <para><emphasis role="bold">uss bulk</emphasis> <emphasis role="bold">-file</emphasis> &lt;<emphasis>bulk input file</emphasis>&gt;
  14         [<emphasis role="bold">-template</emphasis> &lt;<emphasis>pathname of template file</emphasis>&gt;] [<emphasis role="bold">-verbose</emphasis>]
  15         [<emphasis role="bold">-cell</emphasis> &lt;<emphasis>cell name</emphasis>&gt;]
  16         [<emphasis role="bold">-admin</emphasis> &lt;<emphasis>administrator to authenticate</emphasis>&gt;] [<emphasis role="bold">-dryrun</emphasis>]
  17         [<emphasis role="bold">-skipauth</emphasis>] [<emphasis role="bold">-overwrite</emphasis>]
  18         [<emphasis role="bold">-pwexpires</emphasis> &lt;<emphasis>password expires in [0..254] days (0 =</emphasis> never)&gt;&gt;]
  19         [<emphasis role="bold">-pipe</emphasis>] [<emphasis role="bold">-help</emphasis>]</para>
  20
  21     <para><emphasis role="bold">uss b</emphasis> <emphasis role="bold">-f</emphasis> &lt;<emphasis>bulk input file</emphasis>&gt; [<emphasis role="bold">-t</emphasis> &lt;<emphasis>pathname of template file</emphasis>&gt;]
  22         [<emphasis role="bold">-v</emphasis>] [<emphasis role="bold">-c</emphasis> &lt;<emphasis>cell name</emphasis>&gt;]
  23         [<emphasis role="bold">-a</emphasis> &lt;<emphasis>administrator to authenticate</emphasis>&gt;] [<emphasis role="bold">-d</emphasis>] [<emphasis role="bold">-s</emphasis>]
  24         [<emphasis role="bold">-o</emphasis>] [<emphasis role="bold">-pw</emphasis> &lt;<emphasis>password expires in [0..254] days (0 =</emphasis> never)&gt;&gt;]
  25         [<emphasis role="bold">-pi</emphasis>] [<emphasis role="bold">-h</emphasis>]</para>
  26
  27   </refsect1>
  28   <refsect1>
  29     <title>Description</title>
  30     <para>The <emphasis role="bold">uss bulk</emphasis> command executes the uss commands listed in the <emphasis>bulk
  31     input file</emphasis> specified with the <emphasis role="bold">-file</emphasis> argument. If the bulk input file
  32     includes <emphasis role="bold">add</emphasis> instructions that reference a template file, then the
  33     <emphasis role="bold">-template</emphasis> argument is required.</para>
  34
  35     <para>To create a single account, use the <emphasis role="bold">uss add</emphasis> command. To delete one or
  36     more accounts, use the <emphasis role="bold">uss delete</emphasis> command.</para>
  37
  38   </refsect1>
  39   <refsect1>
  40     <title>Options</title>
  41     <variablelist>
  42       <varlistentry>
  43         <term><emphasis role="bold">-file</emphasis> &lt;<emphasis>bulk input file</emphasis>&gt;</term>
  44         <listitem>
  45           <para>Specifies the pathname of the bulk input file. Partial pathnames are
  46           interpreted relative to the current working directory. For details on the
  47           file's format, see <link linkend="uss_bulk5">uss_bulk(5)</link>.</para>
  48
  49         </listitem>
  50       </varlistentry>
  51       <varlistentry>
  52         <term><emphasis role="bold">-template</emphasis> &lt;<emphasis>pathname of template file</emphasis>&gt;</term>
  53         <listitem>
  54           <para>Specifies the pathname of the template file for any uss add commands that
  55           appear in the bulk input file. Partial pathnames are interpreted relative
  56           to the current working directory. For details on the file's format, see
  57           <link linkend="uss5">uss(5)</link>.</para>
  58
  59         </listitem>
  60       </varlistentry>
  61       <varlistentry>
  62         <term><emphasis role="bold">-verbose</emphasis></term>
  63         <listitem>
  64           <para>Produces on the standard output stream a detailed trace of the command's
  65           execution. If this argument is omitted, only warnings and error messages
  66           appear.</para>
  67
  68         </listitem>
  69       </varlistentry>
  70       <varlistentry>
  71         <term><emphasis role="bold">-cell</emphasis> &lt;<emphasis>cell name</emphasis>&gt;</term>
  72         <listitem>
  73           <para>Specifies the cell in which to run the command. For more details, see
  74           <link linkend="uss8">uss(8)</link>.</para>
  75
  76         </listitem>
  77       </varlistentry>
  78       <varlistentry>
  79         <term><emphasis role="bold">-admin</emphasis> &lt;<emphasis>administrator to authenticate</emphasis>&gt;</term>
  80         <listitem>
  81           <para>Specifies the AFS user name under which to establish authenticated
  82           connections to the AFS server processes that maintain the various
  83           components of a user account. For more details, see <link linkend="uss8">uss(8)</link>.</para>
  84
  85         </listitem>
  86       </varlistentry>
  87       <varlistentry>
  88         <term><emphasis role="bold">-dryrun</emphasis></term>
  89         <listitem>
  90           <para>Reports actions that the command interpreter needs to perform while
  91           executing the command, without actually performing them. For more details,
  92           see <link linkend="uss8">uss(8)</link>.</para>
  93
  94         </listitem>
  95       </varlistentry>
  96       <varlistentry>
  97         <term><emphasis role="bold">-skipauth</emphasis></term>
  98         <listitem>
  99           <para>Prevents authentication with the AFS Authentication Server, allowing a
 100           site using Kerberos to substitute that form of authentication.</para>
 101
 102         </listitem>
 103       </varlistentry>
 104       <varlistentry>
 105         <term><emphasis role="bold">-overwrite</emphasis></term>
 106         <listitem>
 107           <para>Overwrites any directories, files and links that exist in the file system
 108           and for which there are also <computeroutput>D</computeroutput>, <computeroutput>E</computeroutput>, <computeroutput>F</computeroutput>, <computeroutput>L</computeroutput>, or <computeroutput>S</computeroutput> instructions
 109           in a template file referenced by an <computeroutput>add</computeroutput> instruction in the bulk input
 110           file. If this flag is omitted, the command interpreter prompts, once for
 111           each <computeroutput>add</computeroutput> instruction in the bulk input file, for confirmation that it
 112           should overwrite such elements. Do not include this flag if the bulk input
 113           file does not contain <computeroutput>add</computeroutput> instructions.</para>
 114
 115         </listitem>
 116       </varlistentry>
 117       <varlistentry>
 118         <term><emphasis role="bold">-pwexpires</emphasis> &lt;<emphasis>password expiration</emphasis>&gt;</term>
 119         <listitem>
 120           <para>Sets the number of days after a user's password is changed that it remains
 121           valid, for each user named by an <computeroutput>add</computeroutput> instruction in the bulk input
 122           file. Provide an integer from the range <computeroutput>1</computeroutput> through <computeroutput>254</computeroutput> to specify the
 123           number of days until expiration, or the value <computeroutput>0</computeroutput> to indicate that the
 124           password never expires (the default).</para>
 125
 126           <para>When the password becomes invalid (expires), the user is unable to
 127           authenticate, but has 30 more days in which to issue the <emphasis role="bold">kpasswd</emphasis>
 128           command to change the password (after that, only an administrator can
 129           change it).</para>
 130
 131         </listitem>
 132       </varlistentry>
 133       <varlistentry>
 134         <term><emphasis role="bold">-pipe</emphasis></term>
 135         <listitem>
 136           <para>Suppresses the Authentication Server's prompt for the password of the
 137           issuer or the user named by the <emphasis role="bold">-admin</emphasis> argument (the Authentication
 138           Server always separately authenticates the creator of an entry in the
 139           Authentication Database). Instead, the command interpreter accepts the
 140           password via the standard input stream, as piped in from another
 141           program. This enables the <emphasis role="bold">uss bulk</emphasis> command to run as part of unattended
 142           batch jobs.</para>
 143
 144         </listitem>
 145       </varlistentry>
 146       <varlistentry>
 147         <term><emphasis role="bold">-help</emphasis></term>
 148         <listitem>
 149           <para>Prints the online help for this command. All other valid options are
 150           ignored.</para>
 151
 152         </listitem>
 153       </varlistentry>
 154     </variablelist>
 155   </refsect1>
 156   <refsect1>
 157     <title>Examples</title>
 158     <para>The following example command executes the instructions in the bulk input
 159     file called <replaceable>new_students</replaceable>, which includes <computeroutput>add</computeroutput> instructions that refer
 160     to the template file <replaceable>student.template</replaceable>. Both files reside in the current
 161     working directory.</para>
 162
 163 <programlisting>
 164    % uss bulk new_students student.template
 165
 166 </programlisting>
 167     </refsect1>
 168     <refsect1>
 169       <title>Privilege Required</title>
 170       <para>The issuer (or the user named by the <emphasis role="bold">-admin</emphasis> argument) must have the
 171       privileges necessary to run the commands that correspond to instructions
 172       in the bulk input file.</para>
 173
 174     </refsect1>
 175     <refsect1>
 176       <title>See Also</title>
 177       <para><link linkend="uss5">uss(5)</link>,
 178       <link linkend="uss_bulk5">uss_bulk(5)</link>,
 179       <link linkend="uss8">uss(8)</link>,
 180       <link linkend="uss_add8">uss_add(8)</link>,
 181       <link linkend="uss_delete8">uss_delete(8)</link></para>
 182
 183     </refsect1>
 184     <refsect1>
 185       <title>Copyright</title>
 186       <para>IBM Corporation 2000. &lt;http://www.ibm.com/&gt; All Rights Reserved.</para>
 187
 188       <para>This documentation is covered by the IBM Public License Version 1.0.  It was
 189       converted from HTML to POD by software written by Chas Williams and Russ
 190       Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.</para>
 191
 192     </refsect1>
 193   </refentry>