pam-afs-new-features-20010907
[openafs.git] / doc / html / AdminReference / auarf245.htm
1 <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 4//EN">
2 <HTML><HEAD>
3 <TITLE>Administration Reference</TITLE>
4 <!-- Begin Header Records  ========================================== -->
5 <!-- /tmp/idwt3672/auarf000.scr converted by idb2h R4.2 (359) ID      -->
6 <!-- Workbench Version (AIX) on 3 Oct 2000 at 16:18:30                -->
7 <META HTTP-EQUIV="updated" CONTENT="Tue, 03 Oct 2000 16:18:29">
8 <META HTTP-EQUIV="review" CONTENT="Wed, 03 Oct 2001 16:18:29">
9 <META HTTP-EQUIV="expires" CONTENT="Thu, 03 Oct 2002 16:18:29">
10 </HEAD><BODY>
11 <!-- (C) IBM Corporation 2000. All Rights Reserved    --> 
12 <BODY bgcolor="ffffff"> 
13 <!-- End Header Records  ============================================ -->
14 <A NAME="Top_Of_Page"></A>
15 <H1>Administration Reference</H1>
16 <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> 
17 <P>
18 <H2><A NAME="HDRUSS_BULK" HREF="auarf002.htm#ToC_259">uss bulk</A></H2>
19 <A NAME="IDX5539"></A>
20 <A NAME="IDX5540"></A>
21 <A NAME="IDX5541"></A>
22 <A NAME="IDX5542"></A>
23 <A NAME="IDX5543"></A>
24 <P><STRONG>Purpose</STRONG>
25 <P>Executes multiple <B>uss</B> commands listed in a file
26 <P><STRONG>Synopsis</STRONG>
27 <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>>]
28          [<B>-verbose</B>]  [<B>-cell</B> &lt;<VAR>cell&nbsp;name</VAR>>]  
29          [<B>-admin</B> &lt;<VAR>administrator&nbsp;to&nbsp;authenticate</VAR>>] [<B>-dryrun</B>]  
30          [<B>-skipauth</B>]  [<B>-overwrite</B>]
31          [<B>-pwexpires</B> &lt;<VAR>password&nbsp;expires&nbsp;in&nbsp;[0..254]&nbsp;days&nbsp;(0&nbsp;=>&nbsp;never)</VAR>>]  
32          [<B>-pipe</B>]  [<B>-help</B>]
33      
34 <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>]  
35       [<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>]  
36       [<B>-o</B>]  [<B>-pw</B> &lt;<VAR>password&nbsp;expires&nbsp;in&nbsp;[0..254]&nbsp;days&nbsp;(0&nbsp;=>&nbsp;never)</VAR>>]  
37       [<B>-pi</B>]  [<B>-h</B>]
38 </PRE>
39 <P><STRONG>Description</STRONG>
40 <P>The <B>uss bulk</B> command executes the <B>uss</B> commands listed
41 in the <B>bulk input file</B> specified with the <B>-file</B>
42 argument. If the bulk input file includes <B>add</B> instructions
43 that reference a template file, then the <B>-template</B> argument is
44 required.
45 <P>To create a single account, use the <B>uss add</B> command. To
46 delete one or more accounts, use the <B>uss delete</B> command.
47 <P><STRONG>Options</STRONG>
48 <DL>
49 <P><DT><B>-file
50 </B><DD>Specifies the pathname of the bulk input file. Partial pathnames
51 are interpreted relative to the current working directory. For details
52 on the file's format, see <A HREF="auarf054.htm#HDRUSSBULKINPUT">uss Bulk Input File</A>.
53 <P><DT><B>-template
54 </B><DD>Specifies the pathname of the template file for any <B>uss add</B>
55 commands that appear in the bulk input file. Partial pathnames are
56 interpreted relative to the current working directory. For details on
57 the file's format, see <A HREF="auarf055.htm#HDRUSSFILE">uss Template File</A>.
58 <P><DT><B>-verbose
59 </B><DD>Produces on the standard output stream a detailed trace of the
60 command's execution. If this argument is omitted, only warnings
61 and error messages appear.
62 <P><DT><B>-cell
63 </B><DD>Specifies the cell in which to run the command. For more details,
64 see the introductory <B>uss</B> reference page.
65 <P><DT><B>-admin
66 </B><DD>Specifies the AFS user name under which to establish authenticated
67 connections to the AFS server processes that maintain the various components
68 of a user account. For more details, see the introductory
69 <B>uss</B> reference page.
70 <P><DT><B>-dryrun
71 </B><DD>Reports actions that the command interpreter needs to perform while
72 executing the command, without actually performing them. For more
73 details, see the introductory <B>uss</B> reference page.
74 <P><DT><B>-skipauth
75 </B><DD>Prevents authentication with the AFS Authentication Server, allowing a
76 site using Kerberos to substitute that form of authentication.
77 <P><DT><B>-overwrite
78 </B><DD>Overwrites any directories, files and links that exist in the file system
79 and for which there are also <B>D</B>, <B>E</B>, <B>F</B>,
80 <B>L</B>, or <B>S</B> instructions in a template file referenced by an
81 <B>add</B> instruction in the bulk input file. If this flag is
82 omitted, the command interpreter prompts, once for each <B>add</B>
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</B> instructions.
86 <P><DT><B>-pwexpires
87 </B><DD>Sets the number of days after a user's password is changed that it
88 remains valid, for each user named by an <B>add</B> instruction in the
89 bulk input file. Provide an integer from the range <B>1</B> through
90 <B>254</B> to specify the number of days until expiration, or the value
91 <B>0</B> to indicate that the password never expires (the default).
92 <P>When the password becomes invalid (expires), the user is unable to
93 authenticate, but has 30 more days in which to issue the <B>kpasswd</B>
94 command to change the password (after that, only an administrator can change
95 it).
96 <P><DT><B>-pipe
97 </B><DD>Suppresses the Authentication Server's prompt for the password of the
98 issuer or the user named by the <B>-admin</B> argument (the Authentication
99 Server always separately authenticates the creator of an entry in the
100 Authentication Database). Instead, the command interpreter accepts the
101 password via the standard input stream, as piped in from another
102 program. This enables the <B>uss bulk</B> command to run as part of
103 unattended batch jobs.
104 <P><DT><B>-help
105 </B><DD>Prints the online help for this command. All other valid options
106 are ignored.
107 </DL>
108 <P><STRONG>Examples</STRONG>
109 <P>The following example command executes the instructions in the bulk input
110 file called <B>new_students</B>, which includes <B>add</B>
111 instructions that refer to the template file
112 <B>student.template</B>. Both files reside in the current
113 working directory.
114 <PRE>   % <B>uss bulk new_students student.template</B>
115    
116 </PRE>
117 <P><STRONG>Privilege Required</STRONG>
118 <P>The issuer (or the user named by the <B>-admin</B> argument) must have
119 the privileges necessary to run the commands that correspond to instructions
120 in the bulk input file.
121 <P><STRONG>Related Information</STRONG>
122 <P><A HREF="auarf054.htm#HDRUSSBULKINPUT">uss Bulk Input File</A>
123 <P><A HREF="auarf055.htm#HDRUSSFILE">uss Template File</A>
124 <P><A HREF="auarf242.htm#HDRUSS_INTRO">uss</A>
125 <P><A HREF="auarf243.htm#HDRUSS_ADD">uss add</A>
126 <P><A HREF="auarf246.htm#HDRUSS_DELETE">uss delete</A>
127 <P>
128 <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> 
129 <!-- Begin Footer Records  ========================================== -->
130 <P><HR><B> 
131 <br>&#169; <A HREF="http://www.ibm.com/">IBM Corporation 2000.</A>  All Rights Reserved 
132 </B> 
133 <!-- End Footer Records  ============================================ -->
134 <A NAME="Bot_Of_Page"></A>
135 </BODY></HTML>