NAME

volserver - Initializes the Volume Server component of the dafs process

SYNOPSIS

volserver [-log] [-p <number of processes>] [-auditlog [<log path>] | yes | on] [-audit-interface (file | syslog | sysvmq)] [-restricted_query (anyuser | admin)] [-maxthreads <maximum number of worker threads>] [-threadidle <maximum idle lifetime for a worker thread in seconds>] [-udpsize <size of socket buffer in bytes>] [-debug <debug level>] [-enable_peer_stats] [-enable_process_stats] [-allow-dotted-principals] [-help]

DESCRIPTION

The volserver command initializes the Volume Server component of the dafs process. In the conventional configuration, its binary file is located in the /usr/libexec/yfs 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 /etc/yfs/server/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/log/yfs/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

-debug <debug level>

Sets the detail level for the debugging trace written to the /var/log/yfs/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/log/yfs/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.

-auditlog [<log path> | yes | on]

Turns on audit logging, and optionally 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. If no path is specified, /var/log/yfs/VolserAuditLog is used.

-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.

-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).

-logfile <log file>

Sets the file to use for server logging. If logfile is not specified and no other logging options are supplied, this will be /var/log/yfs/VolserLog. Note that this option is intended for debugging and testing purposes. Changing the location of the log file from the command line may result in undesirable interactions with tools such as bos.

-config <configuration file>

Sets an alternate location for the configuration file that will be parsed for configuration options for this service. If this option is not specified, /etc/yfs/server/yfs-server.conf will be used.

-rxmaxmtu <bytes>

Defines the maximum size of an MTU. The value must be between the minimum and maximum packet data sizes for Rx.

-rxbind

Bind the Rx socket to the primary interface only. (If not specified, the Rx socket will listen on all interfaces.)

-syslog[=<syslog facility>]

Specifies that logging output should go to syslog instead of the normal log file. -syslog=FACILITY can be used to specify to which facility the log message should be sent.

-sleep <sleep_time/run_time>

This option is obsolete, and is now only accepted for compatibility with older releases. All it does now is log a warning message about how the option is obsolete.

-restricted_query (anyuser | admin)

Restrict RPCs that query information about volumes to a specific group of users. You can use admin to restrict to AFS administrators and members of the ReaderList(5). The anyuser option doesn't restrict the RPCs and leaves it open for all users including unauthenticated users. The default is admin.

-maxthreads <maximum number of worker threads>

Specifies the maximum number of worker threads that can be started to service incoming remote procedure calls. The default is either 1024 or 32 less than the maximum number of file descriptors the volserver process is permitted to open, if that is smaller.

-threadidle <maximum idle lifetime for a worker thread in seconds>

Specifies the maximum number of seconds that a worker thread can remain idle before it will be terminated. The default is 20 minutes (1200 seconds). This value should be increased if the volserver workload is known to experience a spike in the number of serviced remote procedure calls on a periodic cycle longer than the default.

-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.example.com as part of the dafs process:

   % bos create -server fs2.example.com -instance dafs -type dafs \
                -cmd "/usr/libexec/yfs/fileserver" \
                /usr/libexec/yfs/volserver \
                /usr/libexec/yfs/salvageserver \
                /usr/libexec/yfs/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

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.

ACKNOWLEDGEMENTS

"AFS" is a registered mark of International Business Machines Corporation, used under license. (USPTO Registration 1598389)

"OpenAFS" is a registered mark of International Business Machines Corporation. (USPTO Registration 4577045)

The "AuriStor" name, log 'S' brand mark, and icon are registered marks of AuriStor, Inc. (USPTO Registrations 4849419, 4849421, and 4928460) (EUIPO Registration 015539653).

"Your File System" is a registered mark of AuriStor, Inc. (USPTO Registrations 4801402 and 4849418).

"YFS" and "AuriStor File System" are trademarks of AuriStor, Inc.