doc/xml/AdminReference/sect8/uss.xml

   1 <?xml version="1.0" encoding="UTF-8"?>
   2 <refentry id="uss8">
   3   <refmeta>
   4     <refentrytitle>uss</refentrytitle>
   5     <manvolnum>8</manvolnum>
   6   </refmeta>
   7   <refnamediv>
   8     <refname>uss</refname>
   9     <refpurpose>Introduction to the uss command suite</refpurpose>
  10   </refnamediv>
  11   <refsect1>
  12     <title>Description</title>
  13     <para>The commands in the <emphasis role="bold">uss</emphasis> command suite help administrators to create AFS
  14     user accounts more easily and efficiently. If <emphasis role="bold">uss</emphasis> commands are not
  15     used, creating an account requires issuing at least six separate commands
  16     to five different AFS servers.</para>
  17
  18     <para>There are three main commands in the suite:</para>
  19
  20     <itemizedlist>
  21       <listitem>
  22         <para>The <emphasis role="bold">uss add</emphasis> command creates a single complete user account, based on
  23         command line arguments and instructions in a template file.</para>
  24
  25       </listitem>
  26       <listitem>
  27         <para>The <emphasis role="bold">uss bulk</emphasis> command creates multiple complete accounts at once, based
  28         on command line arguments, instructions in a template file and a bulk
  29         input file.</para>
  30
  31       </listitem>
  32       <listitem>
  33         <para>The <emphasis role="bold">uss delete</emphasis> command removes most parts of a user account.</para>
  34
  35       </listitem>
  36     </itemizedlist>
  37     <para>To obtain help, issue the <emphasis role="bold">uss apropos</emphasis> and <emphasis role="bold">uss help</emphasis> commands.</para>
  38
  39   </refsect1>
  40   <refsect1>
  41     <title>Options</title>
  42     <para>The following arguments and flags are available on many commands in the
  43     <emphasis role="bold">uss</emphasis> suite. The reference page for each command also lists them, but
  44     they are described here in greater detail.</para>
  45
  46     <variablelist>
  47       <varlistentry>
  48         <term><emphasis role="bold">-admin</emphasis> &lt;<emphasis>administrator to authenticate</emphasis>&gt;</term>
  49         <listitem>
  50           <para>Specifies the AFS user name under which to establish a connection to the
  51           AFS server processes that administer the various parts of a user
  52           account. If it is omitted, the connection is established under the
  53           issuer's effective user ID (his or her identity in the local file
  54           system). Even when this argument is included, UNIX commands that run
  55           during the <emphasis role="bold">uss</emphasis> operation (for instance, the UNIX <replaceable>/etc/chown</replaceable> command)
  56           run under the effective user ID.</para>
  57
  58         </listitem>
  59       </varlistentry>
  60       <varlistentry>
  61         <term><emphasis role="bold">-cell</emphasis> &lt;<emphasis>cell name</emphasis>&gt;</term>
  62         <listitem>
  63           <para>Names the cell in which to run the command. It is acceptable to abbreviate
  64           the cell name to the shortest form that distinguishes it from the other
  65           entries in the <replaceable>/usr/vice/etc/CellServDB</replaceable> file on the local machine. If
  66           the <emphasis role="bold">-cell</emphasis> argument is omitted, the command interpreter determines the
  67           name of the local cell by reading the following in order:</para>
  68
  69           <itemizedlist>
  70             <listitem>
  71               <para>The value of the AFSCELL environment variable.</para>
  72
  73             </listitem>
  74             <listitem>
  75               <para>The local <replaceable>/usr/vice/etc/ThisCell</replaceable> file.</para>
  76
  77             </listitem>
  78           </itemizedlist>
  79         </listitem>
  80       </varlistentry>
  81       <varlistentry>
  82         <term><emphasis role="bold">-dryrun</emphasis></term>
  83         <listitem>
  84           <para>Reports actions that the command interpreter needs to perform when
  85           executing the <emphasis role="bold">uss</emphasis> operation, without actually performing them. Include
  86           this flag to verify that the command produces the desired account
  87           configuration. Combine it with the <emphasis role="bold">-verbose</emphasis> flag to yield even more
  88           detailed information. Note that the output does not necessarily reveal all
  89           possible problems that can prevent successful execution of the command,
  90           especially those that result from transient server or network outages.</para>
  91
  92         </listitem>
  93       </varlistentry>
  94       <varlistentry>
  95         <term><emphasis role="bold">-help</emphasis></term>
  96         <listitem>
  97           <para>Prints a command's online help message on the standard output stream. Do
  98           not combine this flag with any of the command's other options; when it is
  99           provided, the command interpreter ignores all other options, and only
 100           prints the help message.</para>
 101
 102         </listitem>
 103       </varlistentry>
 104       <varlistentry>
 105         <term><emphasis role="bold">-skipauth</emphasis></term>
 106         <listitem>
 107           <para>Bypasses mutual authentication with the AFS Authentication Server,
 108           allowing a site that uses Kerberos instead of the AFS Authentication
 109           Server to substitute that form of authentication.</para>
 110
 111         </listitem>
 112       </varlistentry>
 113     </variablelist>
 114   </refsect1>
 115   <refsect1>
 116     <title>Privilege Required</title>
 117     <para>The issuer of a <emphasis role="bold">uss</emphasis> command must have all the rights required for
 118     performing the equivalent actions individually. See each <emphasis role="bold">uss</emphasis> command's
 119     reference page.</para>
 120
 121   </refsect1>
 122   <refsect1>
 123     <title>See Also</title>
 124     <para><link linkend="uss5">uss(5)</link>,
 125     <link linkend="uss_bulk5">uss_bulk(5)</link>,
 126     <link linkend="uss_add8">uss_add(8)</link>,
 127     <link linkend="uss_apropos8">uss_apropos(8)</link>,
 128     <link linkend="uss_bulk8">uss_bulk(8)</link>,
 129     <link linkend="uss_delete8">uss_delete(8)</link>,
 130     <link linkend="uss_help8">uss_help(8)</link></para>
 131
 132   </refsect1>
 133   <refsect1>
 134     <title>Copyright</title>
 135     <para>IBM Corporation 2000. &lt;http://www.ibm.com/&gt; All Rights Reserved.</para>
 136
 137     <para>This documentation is covered by the IBM Public License Version 1.0.  It was
 138     converted from HTML to POD by software written by Chas Williams and Russ
 139     Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.</para>
 140
 141   </refsect1>
 142 </refentry>