initial-html-documentation-20010606
[openafs.git] / doc / html / AdminReference / auarf258.htm
diff --git a/doc/html/AdminReference/auarf258.htm b/doc/html/AdminReference/auarf258.htm
new file mode 100644 (file)
index 0000000..7a1e121
--- /dev/null
@@ -0,0 +1,165 @@
+<!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="auarf257.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="auarf259.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="HDRVOS_CREATE" HREF="auarf002.htm#ToC_272">vos create</A></H2>
+<A NAME="IDX5614"></A>
+<A NAME="IDX5615"></A>
+<A NAME="IDX5616"></A>
+<A NAME="IDX5617"></A>
+<A NAME="IDX5618"></A>
+<A NAME="IDX5619"></A>
+<A NAME="IDX5620"></A>
+<A NAME="IDX5621"></A>
+<A NAME="IDX5622"></A>
+<A NAME="IDX5623"></A>
+<A NAME="IDX5624"></A>
+<A NAME="IDX5625"></A>
+<A NAME="IDX5626"></A>
+<A NAME="IDX5627"></A>
+<A NAME="IDX5628"></A>
+<A NAME="IDX5629"></A>
+<A NAME="IDX5630"></A>
+<A NAME="IDX5631"></A>
+<P><STRONG>Purpose</STRONG>
+<P>Creates a read/write volume and associated VLDB entry
+<P><STRONG>Synopsis</STRONG>
+<PRE><B>vos create -server</B> &lt;<VAR>machine&nbsp;name</VAR>>  <B>-partition</B> &lt;<VAR>partition&nbsp;name</VAR>>
+           <B>-name</B> &lt;<VAR>volume&nbsp;name</VAR>>  [<B>-maxquota</B> &lt;<VAR>initial&nbsp;quota&nbsp;(KB)</VAR>>]  
+           [<B>-cell</B> &lt;<VAR>cell&nbsp;name</VAR>>]  [<B>-noauth</B>]  [<B>-localauth</B>]  [<B>-verbose</B>]  [<B>-help</B>]
+    
+<B>vos cr -s</B> &lt;<VAR>machine&nbsp;name</VAR>>  <B>-p</B> &lt;<VAR>partition&nbsp;name</VAR>>  <B>-na</B> &lt;<VAR>volume&nbsp;name</VAR>>
+       [<B>-m</B> &lt;<VAR>initial&nbsp;quota&nbsp;(KB)</VAR>>]  [<B>-c</B> &lt;<VAR>cell&nbsp;name</VAR>>]  [<B>-no</B>]  [<B>-l</B>]  [<B>-v</B>]  [<B>-h</B>]
+</PRE>
+<P><STRONG>Description</STRONG>
+<P>The <B>vos create</B> command creates a read/write volume with the name
+specified by the <B>-name</B> argument at the site specified by the
+<B>-server</B> and <B>-partition</B> arguments. In addition,
+the command allocates or sets the following:
+<UL>
+<P><LI>Volume ID numbers for the read/write volume and its associated read-only
+and backup volumes (this command does not actually create the latter two types
+of volume). A volume ID number is an identification number guaranteed
+to be unique within a cell. 
+<A NAME="IDX5632"></A>
+<A NAME="IDX5633"></A>
+<A NAME="IDX5634"></A>
+<A NAME="IDX5635"></A>
+<A NAME="IDX5636"></A>
+<A NAME="IDX5637"></A>
+<P><LI>An access control list (ACL) associated with the volume's root
+directory, which takes the same name as volume's mount point when the
+volume is mounted with the <B>fs mkmount</B> command. An entry that
+grants all seven permissions to the members of the
+<B>system:administrators</B> group is automatically placed on the
+ACL. (In addition, the File Server by default always implicitly grants
+the <B>l</B> (<B>lookup</B>) and <B>a</B> (<B>administer</B>)
+permissions on every ACL to members of the
+<B>system:administrators</B> group, even when the group does not
+appear on an ACL; use the <B>-implicit</B> argument to the
+<B>fileserver</B> initialization command to alter the set of rights on a
+server-by-server basis if desired.)
+<P><LI>The volume's space quota, set to 5000 kilobyte blocks by
+default. Use the <B>-maxquota</B> argument to specify a different
+quota, or use the <B>fs setquota</B> command to change the volume's
+quota after mounting the volume with the <B>fs mkmount</B> command.
+</UL>
+<P>The volume is empty when created. To access it via the Cache
+Manager, mount it in the file space by using the <B>fs mkmount</B>
+command.
+<P><STRONG>Options</STRONG>
+<DL>
+<P><DT><B>-server
+</B><DD>Identifies the file server machine on which to create the read/write
+volume. Provide the machine's IP address or its host name (either
+fully qualified or using an unambiguous abbreviation). For details, see
+the introductory reference page for the <B>vos</B> command suite.
+<P><DT><B>-partition
+</B><DD>Identifies the partition on which to create the read/write volume, on the
+file server machine specified by the <B>-server</B> argument.
+Provide the partition's complete name with preceding slash (for example,
+<B>/vicepa</B>) or use one of the three acceptable abbreviated
+forms. For details, see the introductory reference page for the
+<B>vos</B> command suite.
+<P><DT><B>-name
+</B><DD>Specifies a name for the read/write volume. The maximum length is
+22 characters, which can include any alphanumeric or punctuation
+character. By convention, periods separate the fields in a name.
+Do not apply the <B>.backup</B> or <B>.readonly</B>
+extension to a read/write volume name; they are reserved for the Volume
+Server to add to the read/write name when creating those backup and read-only
+volumes respectively.
+<P><DT><B>-maxquota
+</B><DD>Specifies the maximum amount of disk space the volume can use, as a number
+of kilobyte blocks (a value of <B>1024</B> is one megabyte). The
+value <B>0</B> (zero) grants an unlimited quota, but the size of the disk
+partition that houses the volume places an absolute limit on its size.
+If this argument is omitted, the default value is <B>5000</B>.
+<P><DT><B>-cell
+</B><DD>Names the cell in which to run the command. Do not combine this
+argument with the <B>-localauth</B> flag. For more details, see the
+introductory <B>vos</B> reference page.
+<P><DT><B>-noauth
+</B><DD>Assigns the unprivileged identity <B>anonymous</B> to the
+issuer. Do not combine this flag with the <B>-localauth</B>
+flag. For more details, see the introductory <B>vos</B> reference
+page.
+<P><DT><B>-localauth
+</B><DD>Constructs a server ticket using a key from the local
+<B>/usr/afs/etc/KeyFile</B> file. The <B>vos</B> command
+interpreter presents it to the Volume Server and Volume Location Server during
+mutual authentication. Do not combine this flag with the
+<B>-cell</B> argument or <B>-noauth</B> flag. For more details,
+see the introductory <B>vos</B> reference page.
+<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>-help
+</B><DD>Prints the online help for this command. All other valid options
+are ignored.
+</DL>
+<P><STRONG>Output</STRONG>
+<P>The Volume Server produces the following message to confirm that it created
+the volume:
+<PRE>   Volume <VAR>volume_ID</VAR> created on partition <VAR>partition_name</VAR> of <VAR>machine_name</VAR>
+   
+</PRE>
+<P><STRONG>Examples</STRONG>
+<P>The following command creates the read/write volume
+<B>user.pat</B> on the <B>/vicepf</B> partition of the file
+server machine <B>fs4.abc.com</B>.
+<PRE>   % <B>vos create -server fs4.abc.com -partition /vicepf -name user.pat</B>
+   Volume user.pat created on partition /vicepf of fs4.abc.com
+   
+</PRE>
+<P><STRONG>Privilege Required</STRONG>
+<P>The issuer must be listed in the <B>/usr/afs/etc/UserList</B> file on
+the machine specified with the <B>-server</B> argument and on each
+database server machine. If the <B>-localauth</B> flag is included,
+the issuer must instead be logged on to a server machine as the local
+superuser <B>root</B>.
+<P><STRONG>Related Information</STRONG>
+<P><A HREF="auarf252.htm#HDRVOS_INTRO">vos</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="auarf257.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="auarf259.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>