1 <?xml version="1.0" encoding="UTF-8"?>
2 <refentry id="volserver8">
4 <refentrytitle>volserver</refentrytitle>
5 <manvolnum>8</manvolnum>
8 <refname>volserver</refname>
9 <refpurpose>Initializes the Volume Server component of the fs process</refpurpose>
12 <title>Synopsis</title>
13 <para><emphasis role="bold">volserver</emphasis> [<emphasis role="bold">-log</emphasis>] [<emphasis role="bold">-p</emphasis> <<emphasis>number of processes</emphasis>>]
14 [<emphasis role="bold">-udpsize</emphasis> <<emphasis>size of socket buffer in bytes</emphasis>>]
15 [<emphasis role="bold">-enable_peer_stats</emphasis>] [<emphasis role="bold">-enable_process_stats</emphasis>] [<emphasis role="bold">-help</emphasis>]</para>
19 <title>Description</title>
20 <para>The <emphasis role="bold">volserver</emphasis> command initializes the Volume Server component of the
21 <computeroutput>fs</computeroutput> process. In the conventional configuration, its binary file is
22 located in the <replaceable>/usr/afs/bin</replaceable> directory on a file server machine.</para>
24 <para>The <emphasis role="bold">volserver</emphasis> command is not normally issued at the command shell
25 prompt but rather placed into a file server machine's
26 <replaceable>/usr/afs/local/BosConfig</replaceable> file with the <emphasis role="bold">bos create</emphasis> command. If it is
27 ever issued at the command shell prompt, the issuer must be logged onto a
28 database server machine as the local superuser <computeroutput>root</computeroutput>.</para>
30 <para>The Volume Server records a trace of its activity in the
31 <replaceable>/usr/afs/logs/VolserLog</replaceable> file. Use the <emphasis role="bold">bos getlog</emphasis> command to display
32 the contents of the file.</para>
34 <para>The Volume Server processes the <emphasis role="bold">vos</emphasis> commands that administrators use to
35 create, delete, move, and replicate volumes, as well as prepare them for
36 archiving to tape or other media.</para>
38 <para>By default, the VL Server runs nine lightweight processes (LWPs). To
39 change the number, use the <emphasis role="bold">-p</emphasis> argument.</para>
41 <para>This command does not use the syntax conventions of the AFS command
42 suites. Provide the command name and all option names in full.</para>
46 <title>Options</title>
49 <term><emphasis role="bold">-log</emphasis></term>
51 <para>Records in the /usr/afs/logs/VolserLog file the names of all users who
52 successfully initiate a <emphasis role="bold">vos</emphasis> command. The Volume Server also records any
53 file removals that result from issuing the <emphasis role="bold">vos release</emphasis> command with the
54 <emphasis role="bold">-f</emphasis> flag.</para>
59 <term><emphasis role="bold">-p</emphasis> <<emphasis>number of processes</emphasis>></term>
61 <para>Sets the number of server lightweight processes (LWPs) to run. Provide an
62 integer between <computeroutput>4</computeroutput> and <computeroutput>16</computeroutput>. The default is <computeroutput>9</computeroutput>.</para>
67 <term><emphasis role="bold">-udpsize</emphasis> <<emphasis>size of socket buffer</emphasis>></term>
69 <para>Sets the size of the UDP buffer in bytes, which is 64 KB by
70 default. Provide a positive integer, preferably larger than the default.</para>
75 <term><emphasis role="bold">-enable_peer_stats</emphasis></term>
77 <para>Activates the collection of Rx statistics and allocates memory for their
78 storage. For each connection with a specific UDP port on another machine,
79 a separate record is kept for each type of RPC (FetchFile, GetStatus, and
80 so on) sent or received. To display or otherwise access the records, use
81 the Rx Monitoring API.</para>
86 <term><emphasis role="bold">-enable_process_stats</emphasis></term>
88 <para>Activates the collection of Rx statistics and allocates memory for their
89 storage. A separate record is kept for each type of RPC (FetchFile,
90 GetStatus, and so on) sent or received, aggregated over all connections to
91 other machines. To display or otherwise access the records, use the Rx
92 Monitoring API.</para>
97 <term><emphasis role="bold">-help</emphasis></term>
99 <para>Prints the online help for this command. All other valid options are
107 <title>Examples</title>
108 <para>The following <emphasis role="bold">bos create</emphasis> command creates a <computeroutput>volserver</computeroutput> process on the
109 machine <computeroutput>fs2.abc.com</computeroutput>:</para>
112 % bos create -server fs2.abc.com -instance volserver -type simple \
113 -cmd /usr/afs/bin/volserver
118 <title>Privilege Required</title>
119 <para>The issuer must be logged in as the superuser <computeroutput>root</computeroutput> on a file server
120 machine to issue the command at a command shell prompt. It is conventional
121 instead to create and start the process by issuing the <emphasis role="bold">bos create</emphasis>
126 <title>See Also</title>
127 <para><link linkend="BosConfig5">BosConfig(5)</link>,
128 <link linkend="VolserLog5">VolserLog(5)</link>,
129 <link linkend="bos_create8">bos_create(8)</link>,
130 <link linkend="bos_getlog8">bos_getlog(8)</link>,
131 <link linkend="vos1">vos(1)</link></para>
135 <title>Copyright</title>
136 <para>IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.</para>
138 <para>This documentation is covered by the IBM Public License Version 1.0. It was
139 converted from HTML to POD by software written by Chas Williams and Russ
140 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.</para>