venus: Remove dedebug
[openafs.git] / AdminReference / auarf258.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="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> 
17 <P>
18 <H2><A NAME="HDRVOS_CREATE" HREF="auarf002.htm#ToC_272">vos create</A></H2>
19 <A NAME="IDX5614"></A>
20 <A NAME="IDX5615"></A>
21 <A NAME="IDX5616"></A>
22 <A NAME="IDX5617"></A>
23 <A NAME="IDX5618"></A>
24 <A NAME="IDX5619"></A>
25 <A NAME="IDX5620"></A>
26 <A NAME="IDX5621"></A>
27 <A NAME="IDX5622"></A>
28 <A NAME="IDX5623"></A>
29 <A NAME="IDX5624"></A>
30 <A NAME="IDX5625"></A>
31 <A NAME="IDX5626"></A>
32 <A NAME="IDX5627"></A>
33 <A NAME="IDX5628"></A>
34 <A NAME="IDX5629"></A>
35 <A NAME="IDX5630"></A>
36 <A NAME="IDX5631"></A>
37 <P><STRONG>Purpose</STRONG>
38 <P>Creates a read/write volume and associated VLDB entry
39 <P><STRONG>Synopsis</STRONG>
40 <PRE><B>vos create -server</B> &lt;<VAR>machine&nbsp;name</VAR>>  <B>-partition</B> &lt;<VAR>partition&nbsp;name</VAR>>
41            <B>-name</B> &lt;<VAR>volume&nbsp;name</VAR>>  [<B>-maxquota</B> &lt;<VAR>initial&nbsp;quota&nbsp;(KB)</VAR>>]  
42            [<B>-cell</B> &lt;<VAR>cell&nbsp;name</VAR>>]  [<B>-noauth</B>]  [<B>-localauth</B>]  [<B>-verbose</B>]  [<B>-help</B>]
43     
44 <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>>
45        [<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>]
46 </PRE>
47 <P><STRONG>Description</STRONG>
48 <P>The <B>vos create</B> command creates a read/write volume with the name
49 specified by the <B>-name</B> argument at the site specified by the
50 <B>-server</B> and <B>-partition</B> arguments. In addition,
51 the command allocates or sets the following:
52 <UL>
53 <P><LI>Volume ID numbers for the read/write volume and its associated read-only
54 and backup volumes (this command does not actually create the latter two types
55 of volume). A volume ID number is an identification number guaranteed
56 to be unique within a cell. 
57 <A NAME="IDX5632"></A>
58 <A NAME="IDX5633"></A>
59 <A NAME="IDX5634"></A>
60 <A NAME="IDX5635"></A>
61 <A NAME="IDX5636"></A>
62 <A NAME="IDX5637"></A>
63 <P><LI>An access control list (ACL) associated with the volume's root
64 directory, which takes the same name as volume's mount point when the
65 volume is mounted with the <B>fs mkmount</B> command. An entry that
66 grants all seven permissions to the members of the
67 <B>system:administrators</B> group is automatically placed on the
68 ACL. (In addition, the File Server by default always implicitly grants
69 the <B>l</B> (<B>lookup</B>) and <B>a</B> (<B>administer</B>)
70 permissions on every ACL to members of the
71 <B>system:administrators</B> group, even when the group does not
72 appear on an ACL; use the <B>-implicit</B> argument to the
73 <B>fileserver</B> initialization command to alter the set of rights on a
74 server-by-server basis if desired.)
75 <P><LI>The volume's space quota, set to 5000 kilobyte blocks by
76 default. Use the <B>-maxquota</B> argument to specify a different
77 quota, or use the <B>fs setquota</B> command to change the volume's
78 quota after mounting the volume with the <B>fs mkmount</B> command.
79 </UL>
80 <P>The volume is empty when created. To access it via the Cache
81 Manager, mount it in the file space by using the <B>fs mkmount</B>
82 command.
83 <P><STRONG>Options</STRONG>
84 <DL>
85 <P><DT><B>-server
86 </B><DD>Identifies the file server machine on which to create the read/write
87 volume. Provide the machine's IP address or its host name (either
88 fully qualified or using an unambiguous abbreviation). For details, see
89 the introductory reference page for the <B>vos</B> command suite.
90 <P><DT><B>-partition
91 </B><DD>Identifies the partition on which to create the read/write volume, on the
92 file server machine specified by the <B>-server</B> argument.
93 Provide the partition's complete name with preceding slash (for example,
94 <B>/vicepa</B>) or use one of the three acceptable abbreviated
95 forms. For details, see the introductory reference page for the
96 <B>vos</B> command suite.
97 <P><DT><B>-name
98 </B><DD>Specifies a name for the read/write volume. The maximum length is
99 22 characters, which can include any alphanumeric or punctuation
100 character. By convention, periods separate the fields in a name.
101 Do not apply the <B>.backup</B> or <B>.readonly</B>
102 extension to a read/write volume name; they are reserved for the Volume
103 Server to add to the read/write name when creating those backup and read-only
104 volumes respectively.
105 <P><DT><B>-maxquota
106 </B><DD>Specifies the maximum amount of disk space the volume can use, as a number
107 of kilobyte blocks (a value of <B>1024</B> is one megabyte). The
108 value <B>0</B> (zero) grants an unlimited quota, but the size of the disk
109 partition that houses the volume places an absolute limit on its size.
110 If this argument is omitted, the default value is <B>5000</B>.
111 <P><DT><B>-cell
112 </B><DD>Names the cell in which to run the command. Do not combine this
113 argument with the <B>-localauth</B> flag. For more details, see the
114 introductory <B>vos</B> reference page.
115 <P><DT><B>-noauth
116 </B><DD>Assigns the unprivileged identity <B>anonymous</B> to the
117 issuer. Do not combine this flag with the <B>-localauth</B>
118 flag. For more details, see the introductory <B>vos</B> reference
119 page.
120 <P><DT><B>-localauth
121 </B><DD>Constructs a server ticket using a key from the local
122 <B>/usr/afs/etc/KeyFile</B> file. The <B>vos</B> command
123 interpreter presents it to the Volume Server and Volume Location Server during
124 mutual authentication. Do not combine this flag with the
125 <B>-cell</B> argument or <B>-noauth</B> flag. For more details,
126 see the introductory <B>vos</B> reference page.
127 <P><DT><B>-verbose
128 </B><DD>Produces on the standard output stream a detailed trace of the
129 command's execution. If this argument is omitted, only warnings
130 and error messages appear.
131 <P><DT><B>-help
132 </B><DD>Prints the online help for this command. All other valid options
133 are ignored.
134 </DL>
135 <P><STRONG>Output</STRONG>
136 <P>The Volume Server produces the following message to confirm that it created
137 the volume:
138 <PRE>   Volume <VAR>volume_ID</VAR> created on partition <VAR>partition_name</VAR> of <VAR>machine_name</VAR>
139    
140 </PRE>
141 <P><STRONG>Examples</STRONG>
142 <P>The following command creates the read/write volume
143 <B>user.pat</B> on the <B>/vicepf</B> partition of the file
144 server machine <B>fs4.abc.com</B>.
145 <PRE>   % <B>vos create -server fs4.abc.com -partition /vicepf -name user.pat</B>
146    Volume user.pat created on partition /vicepf of fs4.abc.com
147    
148 </PRE>
149 <P><STRONG>Privilege Required</STRONG>
150 <P>The issuer must be listed in the <B>/usr/afs/etc/UserList</B> file on
151 the machine specified with the <B>-server</B> argument and on each
152 database server machine. If the <B>-localauth</B> flag is included,
153 the issuer must instead be logged on to a server machine as the local
154 superuser <B>root</B>.
155 <P><STRONG>Related Information</STRONG>
156 <P><A HREF="auarf252.htm#HDRVOS_INTRO">vos</A>
157 <P>
158 <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> 
159 <!-- Begin Footer Records  ========================================== -->
160 <P><HR><B> 
161 <br>&#169; <A HREF="http://www.ibm.com/">IBM Corporation 2000.</A>  All Rights Reserved 
162 </B> 
163 <!-- End Footer Records  ============================================ -->
164 <A NAME="Bot_Of_Page"></A>
165 </BODY></HTML>