.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "VOLSERVER 8" .TH VOLSERVER 8 "2023-12-24" "OpenAFS" "AFS Command Reference" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" volserver \- Initializes the Volume Server component of the fs process .SH "SYNOPSIS" .IX Header "SYNOPSIS" \&\fBvolserver\fR [\fB\-log\fR] [\fB\-p\fR\ <\fInumber\ of\ processes\fR>] [\fB\-auditlog\fR\ <\fIlog\ path\fR>] [\fB\-audit\-interface\fR\ (file\ |\ sysvmq)] [\fB\-logfile\ <\f(BIlog\ file\fB\fR] [\fB\-config\fR\ <\fIconfiguration\ path\fR>] [\fB\-udpsize\fR\ <\fIsize\ of\ socket\ buffer\ in\ bytes\fR>] [\fB\-d\fR\ <\fIdebug\ level\fR>] [\fB\-nojumbo\fR] [\fB\-jumbo\fR] [\fB\-enable_peer_stats\fR] [\fB\-enable_process_stats\fR] [\fB\-allow\-dotted\-principals\fR] [\fB\-clear\-vol\-stats\fR] [\fB\-sync\fR <\fIsync behavior\fR>] [\fB\-rxmaxmtu\fR <\fIbytes\fR>] [\fB\-rxbind\fR] [\fB\-syslog\fR[=<\fI\s-1FACILITY\s0\fR]] [\fB\-transarc\-logs\fR] [\fB\-sleep\fR <\fIsleep time\fR/\fIrun time\fR>] [\fB\-restricted_query\fR (anyuser | admin)] [\fB\-s2scrypt\fR (never | always | inherit)] [\fB\-help\fR] .SH "DESCRIPTION" .IX Header "DESCRIPTION" The \fBvolserver\fR command initializes the Volume Server component of the \&\f(CW\*(C`fs\*(C'\fR process. In the conventional configuration, its binary file is located in the \fI/usr/lib/openafs\fR directory on a file server machine. .PP The \fBvolserver\fR command is not normally issued at the command shell prompt but rather placed into a file server machine's \&\fI/etc/openafs/BosConfig\fR file with the \fBbos create\fR 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 \f(CW\*(C`root\*(C'\fR. .PP The Volume Server records a trace of its activity in the \&\fI/var/log/openafs/VolserLog\fR file. Use the \fBbos getlog\fR command to display the contents of the file. .PP The Volume Server processes the \fBvos\fR commands that administrators use to create, delete, move, and replicate volumes, as well as prepare them for archiving to tape or other media. .PP By default, the \s-1VL\s0 Server runs nine lightweight processes (LWPs). To change the number, use the \fB\-p\fR argument. .PP This command does not use the syntax conventions of the \s-1AFS\s0 command suites. Provide the command name and all option names in full. .SH "OPTIONS" .IX Header "OPTIONS" .IP "\fB\-d\fR <\fIdebug level\fR>" 4 .IX Item "-d " Sets the detail level for the debugging trace written to the \&\fI/var/log/openafs/VolserLog\fR file. Provide one of the following values, each of which produces an increasingly detailed trace: \f(CW0\fR, \f(CW1\fR, \f(CW5\fR, \f(CW25\fR, and \f(CW125\fR. .IP "\fB\-log\fR" 4 .IX Item "-log" Records in the /var/log/openafs/VolserLog file the names of all users who successfully initiate a \fBvos\fR command. The Volume Server also records any file removals that result from issuing the \fBvos release\fR command with the \&\fB\-f\fR flag. .IP "\fB\-transarc\-logs\fR" 4 .IX Item "-transarc-logs" Use Transarc style logging features. Rename the log file \&\fI/var/log/openafs/VolserLog\fR to \fI/var/log/openafs/VolserLog.old\fR when the volume server is restarted. This option is provided for compatibility with older versions. .IP "\fB\-p\fR <\fInumber of processes\fR>" 4 .IX Item "-p " Sets the number of server lightweight processes (LWPs) to run. Provide an integer between \f(CW4\fR and \f(CW16\fR. The default is \f(CW9\fR. .IP "\fB\-auditlog\fR <\fIlog path\fR>" 4 .IX Item "-auditlog " Turns on audit logging, and sets the path for the audit log. The audit log records information about \s-1RPC\s0 calls, including the name of the \s-1RPC\s0 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. .IP "\fB\-audit\-interface\fR (file | sysvmq)" 4 .IX Item "-audit-interface (file | sysvmq)" Specifies what audit interface to use. Defaults to \f(CW\*(C`file\*(C'\fR. See \&\fBfileserver\fR\|(8) for an explanation of each interface. .IP "\fB\-udpsize\fR <\fIsize of socket buffer\fR>" 4 .IX Item "-udpsize " Sets the size of the \s-1UDP\s0 buffer in bytes, which is 64 \s-1KB\s0 by default. Provide a positive integer, preferably larger than the default. .IP "\fB\-jumbo\fR" 4 .IX Item "-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. .IP "\fB\-nojumbo\fR" 4 .IX Item "-nojumbo" Deprecated; jumbograms are disabled by default. .IP "\fB\-enable_peer_stats\fR" 4 .IX Item "-enable_peer_stats" Activates the collection of Rx statistics and allocates memory for their storage. For each connection with a specific \s-1UDP\s0 port on another machine, a separate record is kept for each type of \s-1RPC\s0 (FetchFile, GetStatus, and so on) sent or received. To display or otherwise access the records, use the Rx Monitoring \s-1API.\s0 .IP "\fB\-enable_process_stats\fR" 4 .IX Item "-enable_process_stats" Activates the collection of Rx statistics and allocates memory for their storage. A separate record is kept for each type of \s-1RPC\s0 (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 \s-1API.\s0 .IP "\fB\-allow\-dotted\-principals\fR" 4 .IX Item "-allow-dotted-principals" By default, the \s-1RXKAD\s0 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 \s-1PTS\s0 entry. Sites whose Kerberos realms don't have these collisions between principal names may disable this check by starting the server with this option. .IP "\fB\-clear\-vol\-stats\fR" 4 .IX Item "-clear-vol-stats" Clear volume access statistics during volume restore and reclone operations. This includes clearing the volume access statistics of read-only volumes during a volume release. By default, volume access statistics are preserved during volume restore and reclone operations. .Sp Volume access statistics were cleared by default in versions prior to OpenAFS 1.8.0. This flag is intended to provide compatible behaviour. .IP "\fB\-sync\fR <\fIsync behavior\fR>" 4 .IX Item "-sync " This is the same as the \fB\-sync\fR option in \fBfileserver\fR\|(8). See \&\fBfileserver\fR\|(8). .IP "\fB\-logfile\fR <\fIlog file\fR>" 4 .IX Item "-logfile " Sets the file to use for server logging. If logfile is not specified and no other logging options are supplied, this will be \fI/var/log/openafs/VolserLog\fR. 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 \fBbos\fR. .IP "\fB\-config\fR <\fIconfiguration directory\fR>" 4 .IX Item "-config " Set the location of the configuration directory used to configure this service. In a typical configuration this will be \fI/etc/openafs/server\fR \- this option allows the use of alternative configuration locations for testing purposes. .IP "\fB\-rxmaxmtu\fR <\fIbytes\fR>" 4 .IX Item "-rxmaxmtu " Defines the maximum size of an \s-1MTU.\s0 The value must be between the minimum and maximum packet data sizes for Rx. .IP "\fB\-rxbind\fR" 4 .IX Item "-rxbind" Bind the Rx socket to the primary interface only. (If not specified, the Rx socket will listen on all interfaces.) .IP "\fB\-syslog\fR[=<\fIsyslog facility\fR>]" 4 .IX Item "-syslog[=]" Specifies that logging output should go to syslog instead of the normal log file. \fB\-syslog\fR=\fI\s-1FACILITY\s0\fR can be used to specify to which facility the log message should be sent. .IP "\fB\-sleep\fR <\fIsleep_time\fR/\fIrun_time\fR>" 4 .IX Item "-sleep " 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. .IP "\fB\-restricted_query\fR (anyuser | admin)" 4 .IX Item "-restricted_query (anyuser | admin)" Restrict RPCs that query information about volumes to a specific group of users. You can use \f(CW\*(C`admin\*(C'\fR to restrict to \s-1AFS\s0 administrators. The \&\f(CW\*(C`anyuser\*(C'\fR option doesn't restrict the RPCs and leaves it open for all users including unauthenticated users, this is the default. .IP "\fB\-s2scrypt\fR (never | always | inherit)" 4 .IX Item "-s2scrypt (never | always | inherit)" Set the cryptographic disposition of inter-volserver traffic. .RS 4 .IP "\fBnever\fR" 4 .IX Item "never" All inter-volserver traffic is unencrypted. This is the default behavior. .IP "\fBalways\fR" 4 .IX Item "always" All inter-volserver traffic is encrypted (using rxkad). .IP "\fBinherit\fR" 4 .IX Item "inherit" Inter-volserver traffic will be encrypted if the client connection triggering the server-to-server traffic is encrypted. This has the effect of encrypting inter-server traffic if the \*(L"\-encrypt\*(R" option is provided to \&\fBvos release\fR, for example. .RE .RS 4 .RE .IP "\fB\-help\fR" 4 .IX Item "-help" Prints the online help for this command. All other valid options are ignored. .SH "EXAMPLES" .IX Header "EXAMPLES" The following \fBbos create\fR command creates a \f(CW\*(C`volserver\*(C'\fR process on the machine \f(CW\*(C`fs2.example.com\*(C'\fR as part of the fs process: .PP .Vb 3 \& % bos create \-server fs2.example.com \-instance fs \-type fs \e \& \-cmd "/usr/lib/openafs/fileserver" \e \& /usr/lib/openafs/volserver /usr/lib/openafs/salvager .Ve .SH "PRIVILEGE REQUIRED" .IX Header "PRIVILEGE REQUIRED" The issuer must be logged in as the superuser \f(CW\*(C`root\*(C'\fR 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 \fBbos create\fR command. .SH "SEE ALSO" .IX Header "SEE ALSO" \&\fBBosConfig\fR\|(5), \&\fBVolserLog\fR\|(5), \&\fBbos_create\fR\|(8), \&\fBbos_getlog\fR\|(8), \&\fBvos\fR\|(1) .SH "COPYRIGHT" .IX Header "COPYRIGHT" \&\s-1IBM\s0 Corporation 2000. All Rights Reserved. .PP This documentation is covered by the \s-1IBM\s0 Public License Version 1.0. It was converted from \s-1HTML\s0 to \s-1POD\s0 by software written by Chas Williams and Russ Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.