3 butc - Initializes the Tape Coordinator process
10 B<butc> S<<< [B<-port> <I<port offset>>] >>> S<<< [B<-debuglevel> (0 | 1 | 2)] >>>
11 S<<< [B<-cell> <I<cell name>>] >>> [B<-noautoquery>] [B<-rxbind>] [B<-localauth>]
12 [B<-auditlog> <I<file | sysvmq>> [B<-audit-interface> <I<interface>>]]
13 [B<-allow_unauthenticated>] [B<-help>]
15 B<butc> S<<< [B<-p> <I<port offset>>] >>> S<<< [B<-d> (0 | 1 | 2)] >>>
16 S<<< [B<-c> <I<cell name>>] >>> [B<-n>] [B<-r>] [B<-l>]
17 [B<-auditl> <I<file | sysvmq>> [-B<-audit-i> <I<interface>>]]
25 The B<butc> command initializes a Tape Coordinator process on a Tape
26 Coordinator machine, enabling an operator to direct Backup System requests
27 to the associated tape device or backup data file. (The Tape Coordinator
28 controls a backup data file if the C<FILE YES> instruction appears in the
29 F</usr/afs/backup/CFG_I<device_name>> file that corresponds to the Tape
30 Coordinator's entry in the F</usr/afs/backup/tapeconfig> file. For the
31 sake of simplicity, the following discusses tape devices only.)
33 It is conventional to start and run the Tape Coordinator in the
34 foreground. In this case, it runs on its own connection, which is
35 unavailable for any other use and must remain open the entire time the
36 Tape Coordinator is to accept backup requests and while it is executing
37 them. (When using a window manager, the connection corresponds to a
38 separate command shell window.) The Tape Coordinator can run in the
39 background if the F<CFG_I<device_name>> file is configured to eliminate
40 any need for the Tape Coordinator to prompt the operator. In both the
41 foreground and background, the Tape Coordinator writes operation traces
42 and other output to the standard output stream on the connection over
43 which it was started. Use the B<-debuglevel> argument to control the
44 amount of information that appears. The Tape Coordinator also writes
45 traces and error messages to two files in the local F</usr/afs/backup>
52 The F<TE_I<device_name>> file records problems that the Tape Coordinator
53 encounters as it executes backup operations.
57 The F<TL_I<device_name>> file records a trace of operations as well as the
58 same errors written to the F<TE_I<device_name>> file.
62 The Tape Coordinator creates the files automatically as it initializes. If
63 there are existing files, the Tape Coordinator renames them with a C<.old>
64 extension, overwriting the existing C<.old> files if they exist. It
65 derives the I<device_name> part of the file names by stripping off the
66 device name's F</dev/> prefix and replacing any other slashes with
67 underscores. For example, the files are called F<TE_rmt_4m> and
68 F<TL_rmt_4m> for a device called F</dev/rmt/4m>.
70 By default, at the beginning of each operation the Tape Coordinator
71 prompts for the operator to insert the first tape into the drive and press
72 Return. To suppress this prompt, include the B<-noautoquery> flag on the
73 command line or the instruction C<AUTOQUERY NO> in the
74 F</usr/afs/backup/CFG_I<device_name>> file. When the prompt is suppressed,
75 the first required tape must be in the drive before a B<backup> command is
76 issued. For subsequent tapes, the Tape Coordinator uses its normal tape
77 acquisition routine: if the F</usr/afs/backup/CFG_I<device_name>> file
78 includes a C<MOUNT> instruction, the Tape Coordinator invokes the
79 indicated command; otherwise, it prompts the operator for the next tape.
81 To stop the Tape Coordinator process, enter an interrupt signal such as
82 Ctrl-C over the dedicated connection (in the command shell window).
84 To cancel a backup operation that involves a tape before it begins
85 (assuming the initial tape prompt has not been suppressed), enter the
86 letter C<a> (for C<abort>) and press Return at the Tape Coordinator's
87 prompt for the first tape.
89 Tape Coordinator operation depends on the correct configuration of certain
90 files, as described in the following list:
96 The local F</usr/afs/backup/tapeconfig> file must include an entry for the
97 Tape Coordinator that specifies its device name and port offset number,
98 among other information; for details, L<tapeconfig(5)>.
102 The port offset number recorded in the Tape Coordinator's entry in the
103 Backup Database must match the one in the F<tapeconfig> file. Create the
104 Backup Database entry by using the B<backup addhost> command.
108 The optional F</usr/afs/backup/CFG_I<device_name>> file can contain
109 instructions for mounting and unmounting tapes automatically (when using a
110 tape stacker or jukebox, for instance) or automating other aspects of the
111 backup process. The I<device_name> part of the name is derived as
112 described previously for the F<TE_I<device_name>> and F<TL_I<device_name>>
119 If the Tape Coordinator machine is an AIX machine, use the SMIT utility to
120 set the device's block size to 0 (zero), indicating variable block
121 size. Otherwise, tape devices attached to machines running other operating
122 systems sometimes cannot read tapes written on AIX machines. For
123 instructions, see the I<OpenAFS Administration Guide> chapter about
124 configuring the Backup System.
130 =item B<-port> <I<port offset>>
132 Specifies the port offset number of the Tape Coordinator to initialize.
136 Controls the amount and type of messages the Tape Coordinator displays on
137 the standard output stream. Provide one of three acceptable values:
143 C<0> to display the minimum level of detail required to describe Tape
144 Coordinator operations, including prompts for tapes, messages that
145 indicate the beginning and end of operations, and error messages. This is
150 C<1> to display the names of the volumes being dumped or restored as well
151 as the information displayed at level C<0>.
155 C<2> to display all messages also being written to the
156 F<TL_I<device_name>> log file.
160 =item B<-cell> <I<cell name>>
162 Names the cell in which the Tape Coordinator operates (the cell to which
163 the file server machines that house affected volumes belong). If this
164 argument is omitted, the Tape Coordinator runs in the local cell as
165 defined in the local F</usr/vice/etc/ThisCell> file. Do not combine this
166 flag with the B<-localauth> argument.
168 =item B<-noautoquery>
170 Suppresses the Tape Coordinator's prompt for insertion of the first tape
171 needed for an operation. The operator must insert the tape into the drive
172 before issuing the B<backup> command that initializes the operation.
176 Bind the Rx socket to the primary interface only. If not specified, the Rx
177 socket will listen on all interfaces.
181 Constructs a server ticket using the server encryption key with the
182 highest key version number in the local F</usr/afs/etc/KeyFile> or
183 F</usr/afs/etc/KeyFileExt>. The
184 B<butc> command interpreter presents the ticket, which never expires, to
185 the Volume Server and Volume Location Server to use in mutual
188 Do not combine this argument with the B<-cell> flag, and use it only when
189 logged on to a server machine as the local superuser C<root>; client
190 machines do not have F</usr/afs/etc/KeyFile> or F</usr/afs/etc/KeyFileExt>
193 =item B<-auditlog> <I<log path>>
195 Turns on audit logging, and sets the path for the audit log. The audit
196 log records information about RPC calls, including the name of the RPC
197 call, the host that submitted the call, the authenticated entity (user)
198 that issued the call, the parameters for the call, and if the call
201 =item B<-audit-interface> <(file | sysvmq)>
203 Specifies what audit interface to use. Defaults to C<file>. See
204 L<fileserver(8)> for an explanation of each interface.
206 =item B<-allow_unauthenticated>
208 By default the B<butc> requires clients performing TC_ RPCs to authenticate
209 themselves, behavior introduced in the fix for OPENAFS-SA-2018-001.
210 This option reverts to the historical behavior of only using the rxnull
211 security class for incoming connections. Use of this option is strongly
212 disrecommended; it is provided only for backwards compatibility with older
213 clients in environments where B<backup> and B<butc> communicate over a secure
214 network that denies access to untrusted parties.
218 Prints the online help for this command. All other valid options are
225 The following command starts the Tape Coordinator with port offset C<7> at
226 debug level C<1>, meaning the Tape Coordinator reports the names of
227 volumes it is dumping or restoring.
229 % butc -port 7 -debuglevel 1
231 =head1 PRIVILEGE REQUIRED
233 The issuer must be listed in the F</usr/afs/etc/UserList> file on every
234 machine where the Backup Server or Volume Location (VL) Server is running,
235 and on every file server machine that houses a volume to be backed up. If
236 the B<-localauth> flag is included, the issuer must instead be logged on
237 to the Tape Coordinator machine as the local superuser C<root>. In
238 addition, the issuer must be able to read and write to the log and
239 configuration files in the local F</usr/afs/backup> directory.
254 IBM Corporation 2000. <http://www.ibm.com/> All Rights Reserved.
256 This documentation is covered by the IBM Public License Version 1.0. It was
257 converted from HTML to POD by software written by Chas Williams and Russ
258 Allbery, based on work by Alf Wachsmann and Elizabeth Cassell.