initial-html-documentation-20010606
[openafs.git] / doc / html / AdminReference / auarf245.htm
diff --git a/doc/html/AdminReference/auarf245.htm b/doc/html/AdminReference/auarf245.htm
new file mode 100644 (file)
index 0000000..77f6d4a
--- /dev/null
@@ -0,0 +1,135 @@
+<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 4//EN">
+<HTML><HEAD>
+<TITLE>Administration Reference</TITLE>
+<!-- Begin Header Records  ========================================== -->
+<!-- /tmp/idwt3672/auarf000.scr converted by idb2h R4.2 (359) ID      -->
+<!-- Workbench Version (AIX) on 3 Oct 2000 at 16:18:30                -->
+<META HTTP-EQUIV="updated" CONTENT="Tue, 03 Oct 2000 16:18:29">
+<META HTTP-EQUIV="review" CONTENT="Wed, 03 Oct 2001 16:18:29">
+<META HTTP-EQUIV="expires" CONTENT="Thu, 03 Oct 2002 16:18:29">
+</HEAD><BODY>
+<!-- (C) IBM Corporation 2000. All Rights Reserved    --> 
+<BODY bgcolor="ffffff"> 
+<!-- End Header Records  ============================================ -->
+<A NAME="Top_Of_Page"></A>
+<H1>Administration Reference</H1>
+<HR><P ALIGN="center"> <A HREF="../index.htm"><IMG SRC="../books.gif" BORDER="0" ALT="[Return to Library]"></A> <A HREF="auarf002.htm#ToC"><IMG SRC="../toc.gif" BORDER="0" ALT="[Contents]"></A> <A HREF="auarf244.htm"><IMG SRC="../prev.gif" BORDER="0" ALT="[Previous Topic]"></A> <A HREF="#Bot_Of_Page"><IMG SRC="../bot.gif" BORDER="0" ALT="[Bottom of Topic]"></A> <A HREF="auarf246.htm"><IMG SRC="../next.gif" BORDER="0" ALT="[Next Topic]"></A> <A HREF="auarf284.htm#HDRINDEX"><IMG SRC="../index.gif" BORDER="0" ALT="[Index]"></A> <P> 
+<P>
+<H2><A NAME="HDRUSS_BULK" HREF="auarf002.htm#ToC_259">uss bulk</A></H2>
+<A NAME="IDX5539"></A>
+<A NAME="IDX5540"></A>
+<A NAME="IDX5541"></A>
+<A NAME="IDX5542"></A>
+<A NAME="IDX5543"></A>
+<P><STRONG>Purpose</STRONG>
+<P>Executes multiple <B>uss</B> commands listed in a file
+<P><STRONG>Synopsis</STRONG>
+<PRE><B>uss bulk -file</B> &lt;<VAR>bulk&nbsp;input&nbsp;file</VAR>>  [<B>-template</B> &lt;<VAR>pathname&nbsp;of&nbsp;template&nbsp;file</VAR>>]
+         [<B>-verbose</B>]  [<B>-cell</B> &lt;<VAR>cell&nbsp;name</VAR>>]  
+         [<B>-admin</B> &lt;<VAR>administrator&nbsp;to&nbsp;authenticate</VAR>>] [<B>-dryrun</B>]  
+         [<B>-skipauth</B>]  [<B>-overwrite</B>]
+         [<B>-pwexpires</B> &lt;<VAR>password&nbsp;expires&nbsp;in&nbsp;[0..254]&nbsp;days&nbsp;(0&nbsp;=>&nbsp;never)</VAR>>]  
+         [<B>-pipe</B>]  [<B>-help</B>]
+     
+<B>uss b -f</B> &lt;<VAR>bulk&nbsp;input&nbsp;file</VAR>>  [<B>-t</B> &lt;<VAR>pathname&nbsp;of&nbsp;template&nbsp;file</VAR>>]  [<B>-v</B>]  
+      [<B>-c</B> &lt;<VAR>cell&nbsp;name</VAR>>]  [<B>-a</B> &lt;<VAR>administrator&nbsp;to&nbsp;authenticate</VAR>>]  [<B>-d</B>]  [<B>-s</B>]  
+      [<B>-o</B>]  [<B>-pw</B> &lt;<VAR>password&nbsp;expires&nbsp;in&nbsp;[0..254]&nbsp;days&nbsp;(0&nbsp;=>&nbsp;never)</VAR>>]  
+      [<B>-pi</B>]  [<B>-h</B>]
+</PRE>
+<P><STRONG>Description</STRONG>
+<P>The <B>uss bulk</B> command executes the <B>uss</B> commands listed
+in the <B>bulk input file</B> specified with the <B>-file</B>
+argument. If the bulk input file includes <B>add</B> instructions
+that reference a template file, then the <B>-template</B> argument is
+required.
+<P>To create a single account, use the <B>uss add</B> command. To
+delete one or more accounts, use the <B>uss delete</B> command.
+<P><STRONG>Options</STRONG>
+<DL>
+<P><DT><B>-file
+</B><DD>Specifies the pathname of the bulk input file. Partial pathnames
+are interpreted relative to the current working directory. For details
+on the file's format, see <A HREF="auarf054.htm#HDRUSSBULKINPUT">uss Bulk Input File</A>.
+<P><DT><B>-template
+</B><DD>Specifies the pathname of the template file for any <B>uss add</B>
+commands that appear in the bulk input file. Partial pathnames are
+interpreted relative to the current working directory. For details on
+the file's format, see <A HREF="auarf055.htm#HDRUSSFILE">uss Template File</A>.
+<P><DT><B>-verbose
+</B><DD>Produces on the standard output stream a detailed trace of the
+command's execution. If this argument is omitted, only warnings
+and error messages appear.
+<P><DT><B>-cell
+</B><DD>Specifies the cell in which to run the command. For more details,
+see the introductory <B>uss</B> reference page.
+<P><DT><B>-admin
+</B><DD>Specifies the AFS user name under which to establish authenticated
+connections to the AFS server processes that maintain the various components
+of a user account. For more details, see the introductory
+<B>uss</B> reference page.
+<P><DT><B>-dryrun
+</B><DD>Reports actions that the command interpreter needs to perform while
+executing the command, without actually performing them. For more
+details, see the introductory <B>uss</B> reference page.
+<P><DT><B>-skipauth
+</B><DD>Prevents authentication with the AFS Authentication Server, allowing a
+site using Kerberos to substitute that form of authentication.
+<P><DT><B>-overwrite
+</B><DD>Overwrites any directories, files and links that exist in the file system
+and for which there are also <B>D</B>, <B>E</B>, <B>F</B>,
+<B>L</B>, or <B>S</B> instructions in a template file referenced by an
+<B>add</B> instruction in the bulk input file. If this flag is
+omitted, the command interpreter prompts, once for each <B>add</B>
+instruction in the bulk input file, for confirmation that it should overwrite
+such elements. Do not include this flag if the bulk input file does not
+contain <B>add</B> instructions.
+<P><DT><B>-pwexpires
+</B><DD>Sets the number of days after a user's password is changed that it
+remains valid, for each user named by an <B>add</B> instruction in the
+bulk input file. Provide an integer from the range <B>1</B> through
+<B>254</B> to specify the number of days until expiration, or the value
+<B>0</B> to indicate that the password never expires (the default).
+<P>When the password becomes invalid (expires), the user is unable to
+authenticate, but has 30 more days in which to issue the <B>kpasswd</B>
+command to change the password (after that, only an administrator can change
+it).
+<P><DT><B>-pipe
+</B><DD>Suppresses the Authentication Server's prompt for the password of the
+issuer or the user named by the <B>-admin</B> argument (the Authentication
+Server always separately authenticates the creator of an entry in the
+Authentication Database). Instead, the command interpreter accepts the
+password via the standard input stream, as piped in from another
+program. This enables the <B>uss bulk</B> command to run as part of
+unattended batch jobs.
+<P><DT><B>-help
+</B><DD>Prints the online help for this command. All other valid options
+are ignored.
+</DL>
+<P><STRONG>Examples</STRONG>
+<P>The following example command executes the instructions in the bulk input
+file called <B>new_students</B>, which includes <B>add</B>
+instructions that refer to the template file
+<B>student.template</B>. Both files reside in the current
+working directory.
+<PRE>   % <B>uss bulk new_students student.template</B>
+   
+</PRE>
+<P><STRONG>Privilege Required</STRONG>
+<P>The issuer (or the user named by the <B>-admin</B> argument) must have
+the privileges necessary to run the commands that correspond to instructions
+in the bulk input file.
+<P><STRONG>Related Information</STRONG>
+<P><A HREF="auarf054.htm#HDRUSSBULKINPUT">uss Bulk Input File</A>
+<P><A HREF="auarf055.htm#HDRUSSFILE">uss Template File</A>
+<P><A HREF="auarf242.htm#HDRUSS_INTRO">uss</A>
+<P><A HREF="auarf243.htm#HDRUSS_ADD">uss add</A>
+<P><A HREF="auarf246.htm#HDRUSS_DELETE">uss delete</A>
+<P>
+<HR><P ALIGN="center"> <A HREF="../index.htm"><IMG SRC="../books.gif" BORDER="0" ALT="[Return to Library]"></A> <A HREF="auarf002.htm#ToC"><IMG SRC="../toc.gif" BORDER="0" ALT="[Contents]"></A> <A HREF="auarf244.htm"><IMG SRC="../prev.gif" BORDER="0" ALT="[Previous Topic]"></A> <A HREF="#Top_Of_Page"><IMG SRC="../top.gif" BORDER="0" ALT="[Top of Topic]"></A> <A HREF="auarf246.htm"><IMG SRC="../next.gif" BORDER="0" ALT="[Next Topic]"></A> <A HREF="auarf284.htm#HDRINDEX"><IMG SRC="../index.gif" BORDER="0" ALT="[Index]"></A> <P> 
+<!-- Begin Footer Records  ========================================== -->
+<P><HR><B> 
+<br>&#169; <A HREF="http://www.ibm.com/">IBM Corporation 2000.</A>  All Rights Reserved 
+</B> 
+<!-- End Footer Records  ============================================ -->
+<A NAME="Bot_Of_Page"></A>
+</BODY></HTML>