1 <?xml version="1.0" encoding="UTF-8"?>
2 <refentry id="vos_create1">
4 <refentrytitle>vos create</refentrytitle>
5 <manvolnum>1</manvolnum>
8 <refname>vos create</refname>
9 <refpurpose>Creates a read/write volume and associated VLDB entry</refpurpose>
12 <title>Synopsis</title>
13 <para><emphasis role="bold">vos create</emphasis> <emphasis role="bold">-server</emphasis> <<emphasis>machine name</emphasis>> <emphasis role="bold">-partition</emphasis> <<emphasis>partition name</emphasis>>
14 <emphasis role="bold">-name</emphasis> <<emphasis>volume name</emphasis>> [<emphasis role="bold">-maxquota</emphasis> <<emphasis>initial quota (KB)</emphasis>>]
15 [<emphasis role="bold">-cell</emphasis> <<emphasis>cell name</emphasis>>] [<emphasis role="bold">-noauth</emphasis>] [<emphasis role="bold">-localauth</emphasis>] [<emphasis role="bold">-verbose</emphasis>]
16 [<emphasis role="bold">-help</emphasis>]</para>
18 <para><emphasis role="bold">vos cr</emphasis> <emphasis role="bold">-s</emphasis> <<emphasis>machine name</emphasis>> <emphasis role="bold">-p</emphasis> <<emphasis>partition name</emphasis>>
19 <emphasis role="bold">-na</emphasis> <<emphasis>volume name</emphasis>> [<emphasis role="bold">-m</emphasis> <<emphasis>initial quota (KB)</emphasis>>]
20 [<emphasis role="bold">-c</emphasis> <<emphasis>cell name</emphasis>>] [<emphasis role="bold">-no</emphasis>] [<emphasis role="bold">-l</emphasis>] [<emphasis role="bold">-v</emphasis>] [<emphasis role="bold">-h</emphasis>]</para>
24 <title>Description</title>
25 <para>The <emphasis role="bold">vos create</emphasis> command creates a read/write volume with the name
26 specified by the <emphasis role="bold">-name</emphasis> argument at the site specified by the <emphasis role="bold">-server</emphasis>
27 and <emphasis role="bold">-partition</emphasis> arguments. In addition, the command allocates or sets
32 <para>Volume ID numbers for the read/write volume and its associated read-only
33 and backup volumes (this command does not actually create the latter two
34 types of volume). A volume ID number is an identification number
35 guaranteed to be unique within a cell.</para>
39 <para>An access control list (ACL) associated with the volume's root directory,
40 which takes the same name as volume's mount point when the volume is
41 mounted with the <emphasis role="bold">fs mkmount</emphasis> command. An entry that grants all seven
42 permissions to the members of the system:administrators group is
43 automatically placed on the ACL. (In addition, the File Server by default
44 always implicitly grants the <computeroutput>l</computeroutput> (lookup) and <computeroutput>a</computeroutput> (administer)
45 permissions on every ACL to members of the system:administrators group,
46 even when the group does not appear on an ACL; use the <emphasis role="bold">-implicit</emphasis>
47 argument to the <emphasis role="bold">fileserver</emphasis> initialization command to alter the set of
48 rights on a server-by-server basis if desired.)</para>
52 <para>The volume's space quota, set to 5000 kilobyte blocks by default. Use the
53 <emphasis role="bold">-maxquota</emphasis> argument to specify a different quota, or use the <emphasis role="bold">fs
54 setquota</emphasis> command to change the volume's quota after mounting the volume
55 with the <emphasis role="bold">fs mkmount</emphasis> command.</para>
59 <para>The volume is empty when created. To access it via the Cache Manager,
60 mount it in the file space by using the <emphasis role="bold">fs mkmount</emphasis> command.</para>
64 <title>Options</title>
67 <term><emphasis role="bold">-server</emphasis> <<emphasis>server name</emphasis>></term>
69 <para>Identifies the file server machine on which to create the read/write
70 volume. Provide the machine's IP address or its host name (either fully
71 qualified or using an unambiguous abbreviation). For details, see
72 <link linkend="vos1">vos(1)</link>.</para>
77 <term><emphasis role="bold">-partition</emphasis> <<emphasis>partition name</emphasis>></term>
79 <para>Identifies the partition on which to create the read/write volume, on the
80 file server machine specified by the <emphasis role="bold">-server</emphasis> argument. Provide the
81 partition's complete name with preceding slash (for example, <computeroutput>/vicepa</computeroutput>)
82 or use one of the three acceptable abbreviated forms. For details, see
83 <link linkend="vos1">vos(1)</link>.</para>
88 <term><emphasis role="bold">-name</emphasis> <<emphasis>volume name</emphasis>></term>
90 <para>Specifies a name for the read/write volume. The maximum length is 22
91 characters, which can include any alphanumeric or punctuation
92 character. By convention, periods separate the fields in a name. Do not
93 apply the <computeroutput>.backup</computeroutput> or <computeroutput>.readonly</computeroutput> extension to a read/write volume
94 name; they are reserved for the Volume Server to add to the read/write
95 name when creating those backup and read-only volumes respectively.</para>
100 <term><emphasis role="bold">-maxquota</emphasis> <<emphasis>volume quota</emphasis>></term>
102 <para>Specifies the maximum amount of disk space the volume can use, as a number
103 of kilobyte blocks (a value of <computeroutput>1024</computeroutput> is one megabyte). The value <computeroutput>0</computeroutput>
104 (zero) grants an unlimited quota, but the size of the disk partition that
105 houses the volume places an absolute limit on its size. If this argument
106 is omitted, the default value is <computeroutput>5000</computeroutput>.</para>
111 <term><emphasis role="bold">-cell</emphasis> <<emphasis>cell name</emphasis>></term>
113 <para>Names the cell in which to run the command. Do not combine this argument
114 with the <emphasis role="bold">-localauth</emphasis> flag. For more details, see <link linkend="vos1">vos(1)</link>.</para>
119 <term><emphasis role="bold">-noauth</emphasis></term>
121 <para>Assigns the unprivileged identity <computeroutput>anonymous</computeroutput> to the issuer. Do not
122 combine this flag with the <emphasis role="bold">-localauth</emphasis> flag. For more details, see
123 <link linkend="vos1">vos(1)</link>.</para>
128 <term><emphasis role="bold">-localauth</emphasis></term>
130 <para>Constructs a server ticket using a key from the local
131 <replaceable>/usr/afs/etc/KeyFile</replaceable> file. The <emphasis role="bold">vos</emphasis> command interpreter presents it
132 to the Volume Server and Volume Location Server during mutual
133 authentication. Do not combine this flag with the <emphasis role="bold">-cell</emphasis> argument or
134 <emphasis role="bold">-noauth</emphasis> flag. For more details, see <link linkend="vos1">vos(1)</link>.</para>
139 <term><emphasis role="bold">-verbose</emphasis></term>
141 <para>Produces on the standard output stream a detailed trace of the command's
142 execution. If this argument is omitted, only warnings and error messages
148 <term><emphasis role="bold">-help</emphasis></term>
150 <para>Prints the online help for this command. All other valid options are
158 <title>Output</title>
159 <para>The Volume Server produces the following message to confirm that it
160 created the volume:</para>
163 Volume &lt;volume_ID&gt; created on partition &lt;partition_name&gt; of &lt;machine_name&gt;
168 <title>Examples</title>
169 <para>The following command creates the read/write volume <computeroutput>user.pat</computeroutput> on the
170 <replaceable>/vicepf</replaceable> partition of the file server machine <computeroutput>fs4.abc.com</computeroutput>.</para>
173 % vos create -server fs4.abc.com -partition /vicepf -name user.pat
174 Volume user.pat created on partition /vicepf of fs4.abc.com
179 <title>Privilege Required</title>
180 <para>The issuer must be listed in the <replaceable>/usr/afs/etc/UserList</replaceable> file on the
181 machine specified with the <emphasis role="bold">-server</emphasis> argument and on each database server
182 machine. If the <emphasis role="bold">-localauth</emphasis> flag is included, the issuer must instead be
183 logged on to a server machine as the local superuser <computeroutput>root</computeroutput>.</para>
187 <title>See Also</title>
188 <para><link linkend="vos1">vos(1)</link></para>
192 <title>Copyright</title>
193 <para>IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.</para>
195 <para>This documentation is covered by the IBM Public License Version 1.0. It was
196 converted from HTML to POD by software written by Chas Williams and Russ
197 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.</para>