Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
VOLSERVER(8)		     AFS Command Reference		  VOLSERVER(8)

NAME
       volserver - Initializes the Volume Server component of the fs process

SYNOPSIS
       volserver
	   [-log] [-p <number of processes>]
	   [-auditlog <log path>] [-audit-interface (file | sysvmq)]
	   [-udpsize <size of socket buffer in bytes>]
	   [-d <debug level>]
	   [-nojumbo] [-jumbo]
	   [-enable_peer_stats]	[-enable_process_stats]
	   [-allow-dotted-principals] [-preserve-vol-stats] [-help]
	   [-sync <sync	behavior>]

DESCRIPTION
       The volserver command initializes the Volume Server component of	the
       "fs" process. In	the conventional configuration,	its binary file	is
       located in the /usr/local/libexec/openafs directory on a	file server
       machine.

       The volserver command is	not normally issued at the command shell
       prompt but rather placed	into a file server machine's
       /usr/local/etc/openafs/BosConfig	file with the bos create command. If
       it is ever issued at the	command	shell prompt, the issuer must be
       logged onto a database server machine as	the local superuser "root".

       The Volume Server records a trace of its	activity in the
       /var/openafs/logs/VolserLog file. Use the bos getlog command to display
       the contents of the file.

       The Volume Server processes the vos commands that administrators	use to
       create, delete, move, and replicate volumes, as well as prepare them
       for archiving to	tape or	other media.

       By default, the VL Server runs nine lightweight processes (LWPs). To
       change the number, use the -p argument.

       This command does not use the syntax conventions	of the AFS command
       suites. Provide the command name	and all	option names in	full.

OPTIONS
       -d <debug level>
	   Sets	the detail level for the debugging trace written to the
	   /var/openafs/logs/VolserLog file. Provide one of the	following
	   values, each	of which produces an increasingly detailed trace: 0,
	   1, 5, 25, and 125.

       -log
	   Records in the /var/openafs/logs/VolserLog file the names of	all
	   users who successfully initiate a vos command. The Volume Server
	   also	records	any file removals that result from issuing the vos
	   release command with	the -f flag.

       -p <number of processes>
	   Sets	the number of server lightweight processes (LWPs) to run.
	   Provide an integer between 4	and 16.	The default is 9.

       -auditlog <log path>
	   Turns on audit logging, and sets the	path for the audit log.	 The
	   audit log records information about RPC calls, including the	name
	   of the RPC call, the	host that submitted the	call, the
	   authenticated entity	(user) that issued the call, the parameters
	   for the call, and if	the call succeeded or failed.

       -audit-interface	(file |	sysvmq)
	   Specifies what audit	interface to use. Defaults to "file". See
	   fileserver(8) for an	explanation of each interface.

       -udpsize	<size of socket	buffer>
	   Sets	the size of the	UDP buffer in bytes, which is 64 KB by
	   default. Provide a positive integer,	preferably larger than the
	   default.

       -jumbo
	   Allows the server to	send and receive jumbograms. A jumbogram is a
	   large-size packet composed of 2 to 4	normal Rx data packets that
	   share the same header. The volserver	does not use jumbograms	by
	   default, as some routers are	not capable of properly	breaking the
	   jumbogram into smaller packets and reassembling them.

       -nojumbo
	   Deprecated; jumbograms are disabled by default.

       -enable_peer_stats
	   Activates the collection of Rx statistics and allocates memory for
	   their storage. For each connection with a specific UDP port on
	   another machine, a separate record is kept for each type of RPC
	   (FetchFile, GetStatus, and so on) sent or received. To display or
	   otherwise access the	records, use the Rx Monitoring API.

       -enable_process_stats
	   Activates the collection of Rx statistics and allocates memory for
	   their storage. A separate record is kept for	each type of RPC
	   (FetchFile, GetStatus, and so on) sent or received, aggregated over
	   all connections to other machines. To display or otherwise access
	   the records,	use the	Rx Monitoring API.

       -allow-dotted-principals
	   By default, the RXKAD security layer	will disallow access by
	   Kerberos principals with a dot in the first component of their
	   name. This is to avoid the confusion	where principals user/admin
	   and user.admin are both mapped to the user.admin PTS	entry. Sites
	   whose Kerberos realms don't have these collisions between principal
	   names may disable this check	by starting the	server with this
	   option.

       -preserve-vol-stats
	   Preserve volume access statistics over volume restore and reclone
	   operations.	By default, volume access statistics are reset during
	   volume restore and reclone operations.

       -sync <sync behavior>
	   This	is the same as the -sync option	in fileserver(8). See
	   fileserver(8).

       -help
	   Prints the online help for this command. All	other valid options
	   are ignored.

EXAMPLES
       The following bos create	command	creates	a "volserver" process on the
       machine "fs2.abc.com" as	part of	the fs process:

	  % bos	create -server fs2.abc.com -instance fs	-type fs \
		       -cmd "/usr/local/libexec/openafs/fileserver" \
		       /usr/local/libexec/openafs/volserver /usr/local/libexec/openafs/salvager

PRIVILEGE REQUIRED
       The issuer must be logged in as the superuser "root" on a file server
       machine to issue	the command at a command shell prompt. It is
       conventional instead to create and start	the process by issuing the bos
       create command.

SEE ALSO
       BosConfig(5), VolserLog(5), bos_create(8), bos_getlog(8), vos(1)

COPYRIGHT
       IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.

       This documentation is covered by	the IBM	Public License Version 1.0.
       It was converted	from HTML to POD by software written by	Chas Williams
       and Russ	Allbery, based on work by Alf Wachsmann	and Elizabeth Cassell.

OpenAFS				  2016-12-15			  VOLSERVER(8)

NAME | SYNOPSIS | DESCRIPTION | OPTIONS | EXAMPLES | PRIVILEGE REQUIRED | SEE ALSO | COPYRIGHT

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=volserver&sektion=8&manpath=FreeBSD+12.0-RELEASE+and+Ports>

home | help