.\" 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 "BUSERVER 8" .TH BUSERVER 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" buserver \- Initializes the Backup Server .SH "SYNOPSIS" .IX Header "SYNOPSIS" \&\fBbuserver\fR [\fB\-database\fR\ <\fIdatabase\ directory\fR>] [\fB\-auditlog\fR\ <\fIlog\ path\fR>] [\fB\-audit\-interface\fR\ (file\ |\ sysvmq)] [\fB\-cellservdb\fR\ <\fIcell\ configuration\ directory\fR>] [\fB\-resetdb\fR] [\fB\-noauth\fR] [\fB\-smallht\fR] [\fB\-servers\fR\ <\fIlist\ of\ ubik\ database\ servers\fR>+] [\fB\-rxbind\fR] [\fB\-p\fR <\fInumber of threads\fR>] [\fB\-ubikbuffers\fR <\fI# of buffers\fR>] [\fB\-help\fR] .SH "DESCRIPTION" .IX Header "DESCRIPTION" The \fBbuserver\fR command initializes the Backup Server, which runs on database server machines and maintains the Backup Database. In the conventional configuration, the binary file is located in the \&\fI/usr/lib/openafs\fR directory on a file server machine. .PP The \fBbuserver\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 As it initializes, the Backup Server process creates the two files that constitute the Backup Database, \fIbdb.DB0\fR and \fIbdb.DBSYS1\fR, in the \&\fI/var/lib/openafs/db\fR directory if they do not already exist. The Backup Database houses information about volume sets and entries, the dump hierarchy, Tape Coordinators, and previously performed dump sets. Use the commands in the \&\fBbackup\fR suite to administer the database. .PP The Backup Server records a trace of its activity in the \&\fI/var/log/openafs/BackupLog\fR file. Use the \fBbos getlog\fR command to display the contents of the file. .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" The \fBbuserver\fR process reserves port 7021 for its use. Unexpected behavior can occur if another process tries to reserve this port while the \&\fBbuserver\fR process is running. .SH "OPTIONS" .IX Header "OPTIONS" .IP "\fB\-database\fR <\fIdatabase directory\fR>" 4 .IX Item "-database " Specifies the pathname of an alternate directory for the Backup Database files, ending in a final slash (\f(CW\*(C`/\*(C'\fR). If this argument is not provided, the default is the \fI/var/lib/openafs/db\fR directory. .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\-cellservdb\fR <\fIcell configuration directory\fR>" 4 .IX Item "-cellservdb " Specifies the pathname of the directory from which the Backup Server reads in an alternate version of the \fICellServDB\fR file. This argument is mandatory for correct functioning when the Backup Server is running on a subset of the cell's database server machines that is not a majority of the machines listed in the standard \fI/etc/openafs/server/CellServDB\fR file (which the Backup Server consults if this argument is not provided). It is not appropriate in any other circumstances. .IP "\fB\-resetdb\fR" 4 .IX Item "-resetdb" Removes all of the information in the Backup Database files in the \&\fI/var/lib/openafs/db\fR directory, leaving zero-length versions of them. The backup operator must recreate the configuration entries in the database (for volume sets, the dump hierarchy and so on) before performing backup operations. .IP "\fB\-noauth\fR" 4 .IX Item "-noauth" Turns off all authorization checks, and allows all connecting users to act as administrators, even unauthenticated users. The use of this option is inherently insecure, and should only be used in controlled environments for experimental or debug purposes. See \fBNoAuth\fR\|(5). .IP "\fB\-smallht\fR" 4 .IX Item "-smallht" Directs the Backup Server to use smaller internal hash tables for the Backup Database, which reduces memory requirements but can make data access take longer. .IP "\fB\-servers\fR <\fIlist of ubik database servers\fR>+" 4 .IX Item "-servers +" Specifies the database server machines on which to start the Backup Server. Use this argument if running the Backup Server on a subset of the database server machines that is not a majority of the machines listed in the \fI/etc/openafs/server/CellServDB\fR file. .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\-p\fR <\fInumber of threads\fR>" 4 .IX Item "-p " Sets the number of server lightweight processes (LWPs or pthreads) to run. Provide a positive integer from the range 3 to 16. The default value is 3. .IP "\fB\-ubikbuffers\fR <\fI# of buffers\fR>" 4 .IX Item "-ubikbuffers <# of buffers>" Sets the number of internal buffers used for maintaining the ubik database. The default is 400. If the buserver runs out of free buffers, errors can occur while trying to modify ubik data. It is not recommended to change this setting. .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 example \fBbos create\fR command creates a \f(CW\*(C`buserver\*(C'\fR process on the file server machine \f(CW\*(C`fs3.example.com\*(C'\fR. It appears here on two lines only for legibility. .PP .Vb 2 \& % bos create \-server fs3.example.com \-instance buserver \e \& \-type simple \-cmd /usr/lib/openafs/buserver .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" \&\fBBackupLog\fR\|(5), \&\fBBosConfig\fR\|(5), \&\fBCellServDB\fR\|(5), \&\fBbdb.DB0\fR\|(5), \&\fBbackup\fR\|(8), \&\fBbos_create\fR\|(8), \&\fBbos_getlog\fR\|(8) .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.