.\" Automatically generated by Pod::Man 4.10 (Pod::Simple 3.35) .\" .\" 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 "DAFILESERVER 8" .TH DAFILESERVER 8 "2021-01-27" "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" dafileserver \- Initializes the File Server component of the dafs process .SH "SYNOPSIS" .IX Header "SYNOPSIS" \&\fBdafileserver\fR [\fB\-auditlog\fR\ <\fIpath\ to\ log\ file\fR>] [\fB\-audit\-interface\fR\ (file\ |\ sysvmq)] [\fB\-d\fR\ <\fIdebug\ level\fR>] [\fB\-p\fR\ <\fInumber\ of\ processes\fR>] [\fB\-spare\fR\ <\fInumber\ of\ spare\ blocks\fR>] [\fB\-pctspare\fR\ <\fIpercentage\ spare\fR>] [\fB\-b\fR\ <\fIbuffers\fR>] [\fB\-l\fR\ <\fIlarge\ vnodes\fR>] [\fB\-s\fR\ <\fIsmall\ vnodes\fR>] [\fB\-vc\fR\ <\fIvolume\ cachesize\fR>] [\fB\-w\fR\ <\fIcall\ back\ wait\ interval\fR>] [\fB\-cb\fR\ <\fInumber\ of\ call\ backs\fR>] [\fB\-banner\fR] [\fB\-novbc\fR] [\fB\-implicit\fR\ <\fIadmin\ mode\ bits:\ rlidwka\fR>] [\fB\-readonly\fR] [\fB\-hr\fR\ <\fInumber\ of\ hours\ between\ refreshing\ the\ host\ cps\fR>] [\fB\-busyat\fR\ <\fIredirect\ clients\ when\ queue\ >\ n\fR>] [\fB\-nobusy\fR] [\fB\-rxpck\fR\ <\fInumber\ of\ rx\ extra\ packets\fR>] [\fB\-rxdbg\fR] [\fB\-rxdbge\fR] [\fB\-rxmaxmtu\fR\ <\fIbytes\fR>] [\fB\-nojumbo\fR] [\fB\-jumbo\fR] [\fB\-rxbind\fR] [\fB\-allow\-dotted\-principals\fR] [\fB\-L\fR] [\fB\-S\fR] [\fB\-k\fR\ <\fIstack\ size\fR>] [\fB\-realm\fR\ <\fIKerberos\ realm\ name\fR>] [\fB\-udpsize\fR\ <\fIsize\ of\ socket\ buffer\ in\ bytes\fR>] [\fB\-sendsize\fR\ <\fIsize\ of\ send\ buffer\ in\ bytes\fR>] [\fB\-abortthreshold\fR\ <\fIabort\ threshold\fR>] [\fB\-enable_peer_stats\fR] [\fB\-enable_process_stats\fR] [\fB\-syslog\fR\ [<\fI\ loglevel\ \fR>]] [\fB\-mrafslogs\fR] [\fB\-transarc\-logs\fR] [\fB\-saneacls\fR] [\fB\-help\fR] [\fB\-vhandle\-setaside\fR\ <\fIfds\ reserved\ for\ non-cache\ io\fR>] [\fB\-vhandle\-max\-cachesize\fR\ <\fImax\ open\ files\fR>] [\fB\-vhandle\-initial\-cachesize\fR\ <\fIfds\ reserved\ for\ non-cache\ io\fR>] [\fB\-vattachpar\fR\ <\fInumber\ of\ volume\ attach\ threads\fR>] [\fB\-m\fR\ <\fImin\ percentage\ spare\ in\ partition\fR>] [\fB\-lock\fR] [\fB\-fs\-state\-dont\-save\fR] [\fB\-fs\-state\-dont\-restore\fR] [\fB\-fs\-state\-verify\fR]\ (none\ |\ save\ |\ restore\ |\ both)] [\fB\-vhashsize\fR\ <\fI\f(BIlog\fI\|(2)\ of\ number\ of\ volume\ hash\ buckets\fR>] [\fB\-vlrudisable\fR] [\fB\-vlruthresh\fR\ <\fIminutes\ before\ eligibility\ for\ soft\ detach\fR>] [\fB\-vlruinterval\fR\ <\fIseconds\ between\ \s-1VLRU\s0\ scans\fR>] [\fB\-vlrumax\fR\ <\fImax\ volumes\ to\ soft\ detach\ in\ one\ \s-1VLRU\s0\ scan\fR>] [\fB\-unsafe\-nosalvage\fR] [\fB\-offline\-timeout\fR\ <\fItimeout\ in\ seconds\fR>] [\fB\-offline\-shutdown\-timeout\fR\ <\fItimeout\ in\ seconds\fR>] [\fB\-sync\fR\ <\fIsync\ behavior\fR>] [\fB\-logfile\ <\f(BIlog\ file\fB\fR] [\fB\-config\ <\f(BIconfiguration\ path\fB\fR] .SH "DESCRIPTION" .IX Header "DESCRIPTION" The \fBdafileserver\fR command initializes the File Server component of the \&\f(CW\*(C`dafs\*(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 \fBdafileserver\fR command is not normally issued at the command shell prompt, but rather placed into a database 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 file server machine as the local superuser \f(CW\*(C`root\*(C'\fR. .PP The File Server creates the \fI/var/log/openafs/FileLog\fR log file as it initializes, if the file does not already exist. It does not write a detailed trace by default, but the \fB\-d\fR option may be used to increase the amount of detail. Use the \fBbos getlog\fR command to display the contents of the log file. .PP The command's arguments enable the administrator to control many aspects of the File Server's performance, as detailed in \*(L"\s-1OPTIONS\*(R"\s0. By default the File Server sets values for many arguments that are suitable for a medium-sized file server machine. To set values suitable for a small or large file server machine, use the \fB\-S\fR or \fB\-L\fR flag respectively. The following list describes the parameters and corresponding argument for which the File Server sets default values, and the table below summarizes the setting for each of the three machine sizes. .IP "\(bu" 4 The maximum number of threads the File Server uses to handle requests for data; corresponds to the \&\fB\-p\fR argument. The File Server always uses a minimum of 32 \s-1KB\s0 of memory for these processes. .IP "\(bu" 4 The maximum number of directory blocks the File Server caches in memory; corresponds to the \fB\-b\fR argument. Each cached directory block (buffer) consumes 2,092 bytes of memory. .IP "\(bu" 4 The maximum number of large vnodes the File Server caches in memory for tracking directory elements; corresponds to the \fB\-l\fR argument. Each large vnode consumes 292 bytes of memory. .IP "\(bu" 4 The maximum number of small vnodes the File Server caches in memory for tracking file elements; corresponds to the \fB\-s\fR argument. Each small vnode consumes 100 bytes of memory. .IP "\(bu" 4 The maximum volume cache size, which determines how many volumes the File Server can cache in memory before having to retrieve data from disk; corresponds to the \fB\-vc\fR argument. .IP "\(bu" 4 The maximum number of callback structures the File Server caches in memory; corresponds to the \fB\-cb\fR argument. Each callback structure consumes 16 bytes of memory. .IP "\(bu" 4 The maximum number of Rx packets the File Server uses; corresponds to the \&\fB\-rxpck\fR argument. Each packet consumes 1544 bytes of memory. .PP The default values are: .PP .Vb 9 \& Parameter (Argument) Small (\-S) Medium Large (\-L) \& \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\- \& Number of threads (\-p) 6 9 128 \& Number of cached dir blocks (\-b) 70 90 120 \& Number of cached large vnodes (\-l) 200 400 600 \& Number of cached small vnodes (\-s) 200 400 600 \& Maximum volume cache size (\-vc) 200 400 600 \& Number of callbacks (\-cb) 20,000 60,000 64,000 \& Number of Rx packets (\-rxpck) 100 150 200 .Ve .PP To override any of the values, provide the indicated argument (which can be combined with the \fB\-S\fR or \fB\-L\fR flag). .PP The amount of memory required for the File Server varies. The approximate default memory usage is 751 \s-1KB\s0 when the \fB\-S\fR flag is used (small configuration), 1.1 \s-1MB\s0 when all defaults are used (medium configuration), and 1.4 \s-1MB\s0 when the \fB\-L\fR flag is used (large configuration). If additional memory is available, increasing the value of the \fB\-cb\fR and \&\fB\-vc\fR arguments can improve File Server performance most directly. .PP By default, the File Server allows a volume to exceed its quota by 1 \s-1MB\s0 when an application is writing data to an existing file in a volume that is full. The File Server still does not allow users to create new files in a full volume. To change the default, use one of the following arguments: .IP "\(bu" 4 Set the \fB\-spare\fR argument to the number of extra kilobytes that the File Server allows as overage. A value of \f(CW0\fR allows no overage. .IP "\(bu" 4 Set the \fB\-pctspare\fR argument to the percentage of the volume's quota the File Server allows as overage. .PP By default, the File Server implicitly grants the \f(CW\*(C`a\*(C'\fR (administer) and \&\f(CW\*(C`l\*(C'\fR (lookup) permissions to system:administrators on the access control list (\s-1ACL\s0) of every directory in the volumes stored on its file server machine. In other words, the group's members can exercise those two permissions even when an entry for the group does not appear on an \s-1ACL.\s0 To change the set of default permissions, use the \fB\-implicit\fR argument. .PP The File Server maintains a \fIhost current protection subgroup\fR (\fIhost \&\s-1CPS\s0\fR) for each client machine from which it has received a data access request. Like the \s-1CPS\s0 for a user, a host \s-1CPS\s0 lists all of the Protection Database groups to which the machine belongs, and the File Server compares the host \s-1CPS\s0 to a directory's \s-1ACL\s0 to determine in what manner users on the machine are authorized to access the directory's contents. When the \fBpts adduser\fR or \fBpts removeuser\fR command is used to change the groups to which a machine belongs, the File Server must recompute the machine's host \&\s-1CPS\s0 in order to notice the change. By default, the File Server contacts the Protection Server every two hours to recompute host CPSs, implying that it can take that long for changed group memberships to become effective. To change this frequency, use the \fB\-hr\fR argument. .PP The File Server stores volumes in partitions. A partition is a filesystem or directory on the server machine that is named \f(CW\*(C`/vicepX\*(C'\fR or \f(CW\*(C`/vicepXX\*(C'\fR where \s-1XX\s0 is \*(L"a\*(R" through \*(L"z\*(R" or \*(L"aa\*(R" though \*(L"iv\*(R". Up to 255 partitions are allowed. The File Server expects that the /vicepXX directories are each on a dedicated filesystem. The File Server will only use a /vicepXX if it's a mountpoint for another filesystem, unless the file \f(CW\*(C`/vicepXX/AlwaysAttach\*(C'\fR exists. A partition will not be mounted if the file \f(CW\*(C`/vicepXX/NeverAttach\*(C'\fR exists. If both \&\f(CW\*(C`/vicepXX/AlwaysAttach\*(C'\fR and \f(CW\*(C`/vicepXX/NeverAttach\*(C'\fR are present, then \&\f(CW\*(C`/vicepXX/AlwaysAttach\*(C'\fR wins. The data in the partition is a special format that can only be access using OpenAFS commands or an OpenAFS client. .PP The File Server generates the following message when a partition is nearly full: .PP .Vb 1 \& No space left on device .Ve .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 "CAUTIONS" .IX Header "CAUTIONS" There are two strategies the File Server can use for attaching \s-1AFS\s0 volumes at startup and handling volume salvages. The traditional method assumes all volumes are salvaged before the File Server starts and attaches all volumes at start before serving files. The newer demand-attach method attaches volumes only on demand, salvaging them at that time as needed, and detaches volumes that are not in use. A demand-attach File Server can also save state to disk for faster restarts. The \fBdafileserver\fR implements the demand-attach method, while \fBfileserver\fR uses the traditional method. .PP The choice of traditional or demand-attach File Server changes the required setup in \fIBosConfig\fR. When changing from a traditional File Server to demand-attach or vice versa, you will need to stop and remove the \f(CW\*(C`fs\*(C'\fR or \f(CW\*(C`dafs\*(C'\fR node in \fIBosConfig\fR and create a new node of the appropriate type. See \fBbos_create\fR\|(8) for more information. .PP Do not use the \fB\-w\fR argument, which is intended for use by the OpenAFS developers only. Changing it from its default values can result in unpredictable File Server behavior. .PP Do not specify both the \fB\-spare\fR and \fB\-pctspare\fR arguments. Doing so causes the File Server to exit, leaving an error message in the \&\fI/var/log/openafs/FileLog\fR file. .PP Options that are available only on some system types, such as the \fB\-m\fR and \fB\-lock\fR options, appear in the output generated by the \fB\-help\fR option only on the relevant system type. .PP Currently, the maximum size of a volume quota is 2 terabytes (2^41 bytes) and the maximum size of a /vicepX partition on a fileserver is 2^64 kilobytes. The maximum partition size in releases 1.4.7 and earlier is 2 terabytes (2^31 bytes). The maximum partition size for 1.5.x releases 1.5.34 and earlier is 2 terabytes as well. .PP The maximum number of directory entries is 64,000 if all of the entries have names that are 15 octets or less in length. A name that is 15 octets long requires the use of only one block in the directory. Additional sequential blocks are required to store entries with names that are longer than 15 octets. Each additional block provides an additional length of 32 octets for the name of the entry. Note that if file names use an encoding like \s-1UTF\-8,\s0 a single character may be encoded into multiple octets. .PP In real world use, the maximum number of objects in an \s-1AFS\s0 directory is usually between 16,000 and 25,000, depending on the average name length. .SH "OPTIONS" .IX Header "OPTIONS" .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. The \f(CW\*(C`file\*(C'\fR interface writes audit messages to the file passed to \fB\-auditlog\fR. The \f(CW\*(C`sysvmq\*(C'\fR interface writes audit messages to a \s-1SYSV\s0 message (see \fBmsgget\fR\|(2) and \&\fBmsgrcv\fR\|(2)). The message queue the \f(CW\*(C`sysvmq\*(C'\fR interface writes to has the key \f(CW\*(C`ftok(path, 1)\*(C'\fR, where \f(CW\*(C`path\*(C'\fR is the path specified in the \&\fB\-auditlog\fR option. .Sp Defaults to \f(CW\*(C`file\*(C'\fR. .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/FileLog\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. The default value of \f(CW0\fR produces only a few messages. .IP "\fB\-p\fR <\fInumber of processes\fR>" 4 .IX Item "-p " Sets the number of threads to run. Provide a positive integer. The File Server creates and uses five threads for special purposes, in addition to the number specified (but if this argument specifies the maximum possible number, the File Server automatically uses five of the threads for its own purposes). .Sp The maximum number of threads can differ in each release of OpenAFS. Consult the \fIOpenAFS Release Notes\fR for the current release. .IP "\fB\-spare\fR <\fInumber of spare blocks\fR>" 4 .IX Item "-spare " Specifies the number of additional kilobytes an application can store in a volume after the quota is exceeded. Provide a positive integer; a value of \&\f(CW0\fR prevents the volume from ever exceeding its quota. Do not combine this argument with the \fB\-pctspare\fR argument. .IP "\fB\-pctspare\fR <\fIpercentage spare\fR>" 4 .IX Item "-pctspare " Specifies the amount by which the File Server allows a volume to exceed its quota, as a percentage of the quota. Provide an integer between \f(CW0\fR and \f(CW99\fR. A value of \f(CW0\fR prevents the volume from ever exceeding its quota. Do not combine this argument with the \fB\-spare\fR argument. .IP "\fB\-b\fR <\fIbuffers\fR>" 4 .IX Item "-b " Sets the number of directory buffers. Provide a positive integer. .IP "\fB\-l\fR <\fIlarge vnodes\fR>" 4 .IX Item "-l " Sets the number of large vnodes available in memory for caching directory elements. Provide a positive integer. .IP "\fB\-s\fR <\fIsmall nodes\fR>" 4 .IX Item "-s " Sets the number of small vnodes available in memory for caching file elements. Provide a positive integer. .IP "\fB\-vc\fR <\fIvolume cachesize\fR>" 4 .IX Item "-vc " Sets the number of volumes the File Server can cache in memory. Provide a positive integer. .IP "\fB\-w\fR <\fIcall back wait interval\fR>" 4 .IX Item "-w " Sets the interval at which the daemon spawned by the File Server performs its maintenance tasks. Do not use this argument; changing the default value can cause unpredictable behavior. .IP "\fB\-cb\fR <\fInumber of callbacks\fR>" 4 .IX Item "-cb " Sets the number of callbacks the File Server can track. Provide a positive integer. .IP "\fB\-banner\fR" 4 .IX Item "-banner" Prints the following banner to \fI/dev/console\fR about every 10 minutes. .Sp .Vb 1 \& File Server is running at I