4 \section*{Bacula Console}
5 \label{_ChapterStart23}
6 \index[general]{Console!Bacula }
7 \index[general]{Bacula Console }
8 \addcontentsline{toc}{section}{Bacula Console}
11 \index[general]{General }
12 \addcontentsline{toc}{subsection}{General}
14 The {\bf Bacula Console} (sometimes called the User Agent) is a program that
15 allows the user or the System Administrator, to interact with the Bacula
16 Director daemon while the daemon is running.
18 The current Bacula Console comes in two versions: a shell interface (TTY
19 style), and a GNOME GUI interface. Both permit the administrator or authorized
20 users to interact with Bacula. You can determine the status of a particular
21 job, examine the contents of the Catalog as well as perform certain tape
22 manipulations with the Console program.
24 In addition, there is a wx-console built with wxWidgets that allows a graphic
25 restore of files. As of version 1.34.1 it is in an early stage of development,
26 but it already is quite useful.
28 Since the Console program interacts with the Director through the network, your
29 Console and Director programs do not necessarily need to run on the same
32 In fact, a certain minimal knowledge of the Console program is needed in order
33 for Bacula to be able to write on more than one tape, because when Bacula
34 requests a new tape, it waits until the user, via the Console program,
35 indicates that the new tape is mounted.
37 \subsection*{Configuration}
38 \index[general]{Configuration }
39 \addcontentsline{toc}{subsection}{Configuration}
41 When the Console starts, it reads a standard Bacula configuration file named
42 {\bf bconsole.conf} or {\bf gnome-console.conf} in the case of the GNOME
43 Console version. This file allows default configuration of the Console, and at
44 the current time, the only Resource Record defined is the Director resource,
45 which gives the Console the name and address of the Director. For more
46 information on configuration of the Console program, please see the
47 \ilink{Console Configuration File}{_ChapterStart36} Chapter of
50 \subsection*{Running the Console Program}
51 \index[general]{Running the Console Program }
52 \index[general]{Program!Running the Console }
53 \addcontentsline{toc}{subsection}{Running the Console Program}
55 After launching the Console program (bconsole), it will prompt you for the
56 next command with an asterisk (*). (Note, in the GNOME version, the prompt is
57 not present; you simply enter the commands you want in the command text box at
58 the bottom of the screen.) Generally, for all commands, you can simply enter
59 the command name and the Console program will prompt you for the necessary
60 arguments. Alternatively, in most cases, you may enter the command followed by
61 arguments. The general format is:
65 <command> <keyword1>[=<argument1>] <keyword2>[=<argument2>] ...
69 where {\bf command} is one of the commands listed below; {\bf keyword} is one
70 of the keywords listed below (usually followed by an argument); and {\bf
71 argument} is the value. The command may be abbreviated to the shortest unique
72 form. If two commands have the same starting letters, the one that will be
73 selected is the one that appears first in the {\bf help} listing. If you want
74 the second command, simply spell out the full command. None of the keywords
75 following the command may be abbreviated.
85 will list all files saved for JobId 23. Or:
93 will display all the Pool resource records.
95 \subsection*{Stopping the Console Program}
96 \index[general]{Program!Stopping the Console }
97 \index[general]{Stopping the Console Program }
98 \addcontentsline{toc}{subsection}{Stopping the Console Program}
100 Normally, you simply enter {\bf quit} or {\bf exit} and the Console program
101 will terminate. However, it waits until the Director acknowledges the command.
102 If the Director is already doing a lengthy command (e.g. prune), it may take
103 some time. If you want to immediately terminate the Console program, enter the
106 There is currently no way to interrupt a Console command once issued (i.e.
107 Ctrl-C does not work). However, if you are at a prompt that is asking you to
108 select one of several possibilities and you would like to abort the command,
109 you can enter a period ({\bf .}), and in most cases, you will either be
110 returned to the main command prompt or if appropriate the previous prompt (in
111 the case of nested prompts). In a few places such as where it is asking for a
112 Volume name, the period will be taken to be the Volume name. In that case, you
113 will most likely be able to cancel at the next prompt.
116 \subsection*{Alphabetic List of Console Commands}
117 \index[general]{Commands!Alphabetic List of Console }
118 \index[general]{Alphabetic List of Console Commands }
119 \addcontentsline{toc}{subsection}{Alphabetic List of Console Commands}
121 The following commands are currently implemented:
124 \item [{add [pool=\lt{}pool-name\gt{} storage=\lt{}storage\gt{}
125 jobid=\lt{}JobId\gt{}]} ]
126 \index[console]{add [pool }
127 This command is used to add Volumes to an existing Pool. The Volume names
128 entered are placed in the Catalog and thus become available for backup
129 operations. Normally, the {\bf label} command is used rather than this
130 command because the {\bf label} command labels the physical media (tape) and
131 does the equivalent of the {\bf add} command. This command affects only the
132 Catalog and not the physical media (data on Volumes). The physical media must
133 exist and be labeled before use (usually with the {\bf label} command). This
134 command can, however, be useful if you wish to add a number of Volumes to the
135 Pool that will be physically labeled at a later time. It can also be useful
136 if you are importing a tape from another site. Please see the {\bf label}
137 command below for the list of legal characters in a Volume name.
139 \item [autodisplay on/off]
140 \index[console]{autodisplay on/off }
141 This command accepts {\bf on} or {\bf off} as an argument, and turns
142 auto-display of messages on or off respectively. The default for the console
143 program is {\bf off}, which means that you will be notified when there are
144 console messages pending, but they will not automatically be displayed. The
145 default for the gnome-console program is {\bf on}, which means that messages
146 will be displayed when they are received (usually within 5 seconds of them
149 When autodisplay is turned off, you must explicitly retrieve the messages
150 with the {\bf messages} command. When autodisplay is turned on, the messages
151 will be displayed on the console as they are received.
153 \item [automount on/off]
154 \index[console]{automount on/off }
155 This command accepts {\bf on} or {\bf off} as the argument, and turns
156 auto-mounting of the tape after a {\bf label} command on or off respectively.
157 The default is {\bf on}. If {\bf automount} is turned off, you must
158 explicitly {\bf mount} the tape after a label command to use it.
160 \item [{cancel [jobid=\lt{}number\gt{} job=\lt{}job-name\gt{}]}]
161 \index[console]{cancel [jobid }
162 This command is used to cancel a job and accepts {\bf jobid=nnn} or {\bf
163 job=xxx} as an argument where nnn is replaced by the JobId and xxx is
164 replaced by the job name. If you do not specify a keyword, the Console
165 program will prompt you with the names of all the active jobs allowing you to
168 Once a Job is marked to be canceled, it may take a bit of time (generally
169 within a minute) before it actually terminates, depending on what operations
172 \item [{ create [pool=\lt{}pool-name\gt{}]}]
173 \index[console]{create [pool }
174 This command is used to create a Pool record in the database using the Pool
175 resource record defined in the Director's configuration file. So in a sense,
176 this command simply transfers the information from the Pool resource in the
177 configuration file into the Catalog. Normally this command is done
178 automatically for you when the Director starts providing the Pool is
179 referenced within a Job resource. If you use this command on an existing
180 Pool, it will automatically update the Catalog to have the same information
181 as the Pool resource. After creating a Pool, you will most likely use the
182 {\bf label} command to label one or more volumes and add their names to the
185 When starting a Job, if Bacula determines that there is no Pool record in the
186 database, but there is a Pool resource of the appropriate name, it will
187 create it for you. If you want the Pool record to appear in the database
188 immediately, simply use this command to force it to be created.
190 \item [{ delete [volume=\lt{}vol-name\gt{} pool=\lt{}pool-name\gt{} job
191 jobid=\lt{}id\gt{}] }]
192 \index[console]{delete }
193 The delete command is used to delete a Volume, Pool or Job record from the
194 Catalog as well as all associated Volume records that were created. This
195 command operates only on the Catalog database and has no effect on the actual
196 data written to a Volume. This command can be dangerous and we strongly
197 recommend that you do not use it unless you know what you are doing.
199 If the keyword {\bf Volume} appears on the command line, the named Volume
200 will be deleted from the catalog, if the keyword {\bf Pool} appears on the
201 command line, a Pool will be deleted, and if the keyword {\bf Job} appears on
202 the command line, a Job and all its associated records (File and JobMedia)
203 will be deleted from the catalog. The full form of this command is:
205 delete pool=\lt{}pool-name\gt{}
209 delete volume=\lt{}volume-name\gt{} pool=\lt{}pool-name\gt{} or
211 delete JobId=\lt{}job-id\gt{} JobId=\lt{}job-id2\gt{} ... or
213 delete Job JobId=n,m,o-r,t ...
215 The first form deletes a Pool record from the catalog database. The second
216 form deletes a Volume record from the specified pool in the catalog database.
217 The third form deletes the specified Job record from the catalog database.
218 The last form deletes JobId records for JobIds n,m,o,p, q,r, and t. Where each
219 one of the n,m,... is, of course, a number.
223 \index[console]{estimate }
224 Using this command, you can get an idea how many files will be backed up, or
225 if you are unsure about your Include statements in your FileSet, you can test
226 them without doing an actual backup. The default is to assume a Full backup.
227 However, you can override this by specifying a {\bf level=Incremental} or
228 {\bf level=Differential} on the command line. A Job name must be specified
229 or you will be prompted for one, and optionally a Client and FileSet may be
230 specified on the command line. It then contacts the client which computes
231 the number of files and bytes that would be backed up. Please note that this
232 is an estimate calculated from the number of blocks in the file rather than
233 by reading the actual bytes. As such, the estimated backup size will
234 generally be larger than an actual backup.
236 Optionally you may specify the keyword {\bf listing} in which case, all the
237 files to be backed up will be listed. Note, it could take quite some time to
238 display them if the backup is large. The full form is:
240 estimate job=\lt{}job-name\gt{} listing client=\lt{}client-name\gt{}
241 fileset=\lt{}fileset-name\gt{} level=\lt{}level-name\gt{}
243 Specification of the {\bf job} is sufficient, but you can also override the
244 client, fileset and/or level by specifying them on the estimate command line.
247 As an example, you might do:
252 estimate job=NightlySave listing level=Incremental
258 which will do a full listing of all files to be backed up for the Job {\bf
259 NightlySave} during an Incremental save and put it in the file {\bf
263 \index[console]{help }
264 This command displays the list of commands available.
267 \index[console]{label }
268 This command is used to label physical volumes. The full form of this command
271 label storage=\lt{}storage-name\gt{} volume=\lt{}volume-name\gt{}
274 If you leave out any part, you will be prompted for it. The media type is
275 automatically taken from the Storage resource definition that you supply.
276 Once the necessary information is obtained, the Console program contacts the
277 specified Storage daemon and requests that the tape be labeled. If the tape
278 labeling is successful, the Console program will create a Volume record in
279 the appropriate Pool.
281 The Volume name is restricted to letters, numbers, and the special characters
282 hyphen ({\bf -}), underscore ({\bf \_}), colon ({\bf :}), and period ({\bf
283 .}). All other characters including a space are illegal. This restriction is
284 to ensure good readability of Volume names to reduce operator errors.
286 Please note, when labeling a blank tape, Bacula will get {\bf read I/O error} when
287 it attempts to ensure that the tape is already labeled. If you wish to avoid
288 getting these messages, please write and EOF mark on your tape before
289 attempting to label it:
299 The label command can fail for a number of reasons:
302 \item The Volume name you specify is already in the Volume database.
303 \item The Storage daemon has a tape already mounted on the device, in which
304 case you must {\bf unmount} the device, insert a blank tape, then do the
306 \item The tape in the device is already a Bacula labeled tape. (Bacula will
307 never relabel a Bacula labeled tape unless it is recycled and you use the
308 {\bf relabel} command).
309 \item There is no tape in the drive.
312 There are two ways to relabel a volume that already has a Bacula label. The
313 brute force method is to write an end of file mark on the tape using the
314 system {\bf mt} program, something like the following:
318 mt -f /dev/st0 rewind
324 Then you use the {\bf label} command to add a new label. However, this could
325 leave traces of the old volume in the catalog.
327 The preferable method to relabel a tape is to first {\bf purge} the volume,
328 either automatically, or explicitly with the {\bf purge} command, then use
329 the {\bf relabel} command described below.
331 If your autochanger has barcode labels, you can label all the Volumes in your
332 autochanger one after another by using the {\bf label barcodes} command. For
333 each tape in the changer containing a barcode, Bacula will mount the tape and
334 then label it with the same name as the barcode. An appropriate Media record
335 will also be created in the catalog. Any barcode that begins with the same
336 characters as specified on the ``CleaningPrefix=xxx'' command, will be
337 treated as a cleaning tape, and will not be labeled. For example with:
343 Cleaning Prefix = "CLN"
349 Any slot containing a barcode of CLNxxxx will be treated as a cleaning tape
350 and will not be mounted. Note, the full form of the command is:
355 update storage=xxx pool=yyy slots=1-5,10 barcodes
360 \index[console]{list }
361 The list command lists the requested contents of the Catalog. The various
362 fields of each record are listed on a single line. The various forms
363 of the list command are:
368 list jobid=\lt{}id\gt{}
370 list job=\lt{}job-name\gt{}
374 list jobmedia jobid=\lt{}id\gt{}
376 list jobmedia job=\lt{}job-name\gt{}
378 list files jobid=\lt{}id\gt{}
380 list files job=\lt{}job-name\gt{}
390 list volumes jobid=\lt{}id\gt{}
392 list volumes pool=\lt{}pool-name\gt{}
394 list volumes job=\lt{}job-name\gt{}
396 list volume=\lt{}volume-name\gt{} list nextvolume job=\lt{}job-name\gt{}
398 list nextvol job=\lt{}job-name\gt{}
401 What most of the above commands do should be more or less obvious. In general
402 if you do not specify all the command line arguments, the command will prompt
403 you for what is needed.
405 The {\bf list nextvol} command will print the Volume name to be used by the
406 specified job. You should be aware that exactly what Volume will be used
407 depends on a lot of factors including the time and what a prior job will do.
408 It may fill a tape that is not full when you issue this command. As a
409 consequence, this command will give you a good estimate of what Volume will
410 be used but not a definitive answer. In addition, this command may have
411 certain side effect because it runs through the same algorithm as a job,
412 which means it may automatically purge or recycle a Volume.
414 If you wish to add specialized commands that list the contents of the
415 catalog, you can do so by adding them to the {\bf query.sql} file. However,
416 this takes some knowledge of programming SQL. Please see the {\bf query}
417 command below for additional information. See below for listing the full
418 contents of a catalog record with the {\bf llist} command.
420 As an example, the command {\bf list pools} might produce the following
425 +------+---------+---------+---------+----------+-------------+
426 | PoId | Name | NumVols | MaxVols | PoolType | LabelFormat |
427 +------+---------+---------+---------+----------+-------------+
428 | 1 | Default | 0 | 0 | Backup | * |
429 | 2 | Recycle | 0 | 8 | Backup | File |
430 +------+---------+---------+---------+----------+-------------+
434 As mentioned above, the {\bf list} command lists what is in the database.
435 Some things are put into the database immediately when Bacula starts up, but
436 in general, most things are put in only when they are first used, which is
437 the case for a Client as with Job records, etc.
439 Bacula should create a client record in the database the first time you run a
440 job for that client. Doing a {\bf status} will not cause a database record to
441 be created. The client database record will be created whether or not the job
442 fails, but it must at least start. When the Client is actually contacted,
443 additional info from the client will be added to the client record (a ``uname
446 If you want to see what Client resources you have available in your conf
447 file, you use the Console command {\bf show clients}.
450 \index[console]{llist }
451 The llist or ``long list'' command takes all the same arguments that the list
452 command described above does. The difference is that the llist command list
453 the full contents of each database record selected. It does so by listing the
454 various fields of the record vertically, with one field per line. It is
455 possible to produce a very large number of output lines with this command.
457 If instead of the {\bf list pools} as in the example above, you enter {\bf
458 llist pools} you might get the following output:
469 VolRetention: 1,296,000
470 VolUseDuration: 86,400
485 VolUseDuration: 3,600
497 \index[console]{messages }
498 This command causes any pending console messages to be immediately displayed.
502 \index[console]{mount }
503 The mount command is used to get Bacula to read a volume on a physical
504 device. It is a way to tell Bacula that you have mounted a tape and that
505 Bacula should examine the tape. This command is used only after there was no
506 Volume in a drive and Bacula requests you to mount a new Volume or when you
507 have specifically unmounted a Volume with the {\bf unmount} console command,
508 which causes Bacula to close the drive. If you have an autoloader, the mount
509 command will not cause Bacula to operate the autoloader. The various forms of
510 the mount command are:
512 mount storage=\lt{}storage-name\gt{}
514 mount [ jobid=\lt{}id\gt{} | job=\lt{}job-name\gt{} ]
516 If you have specified {\bf Automatic Mount = yes} in the Storage daemon's
517 Device resource, under most circumstances, Bacula will automatically access
518 the Volume unless you have explicitly {\bf unmount}ed it in the Console
520 \label{ManualPruning}
523 \index[console]{prune }
524 The Prune command allows you to safely remove expired database records from
525 Jobs and Volumes. This command works only on the Catalog database and does
526 not affect data written to Volumes. In all cases, the Prune command applies
527 a retention period to the specified records. You can Prune expired File
528 entries from Job records; you can Prune expired Job records from the
529 database, and you can Prune both expired Job and File records from specified
532 prune files|jobs|volume client=\lt{}client-name\gt{}
533 volume=\lt{}volume-name\gt{}
535 For a Volume to be pruned, the {\bf VolStatus} must be Full, Used, or Append,
536 otherwise the pruning will not take place.
539 \index[console]{purge }
540 The Purge command will delete associated Catalog database records from Jobs
541 and Volumes without considering the retention period. {\bf Purge} works only
542 on the Catalog database and does not affect data written to Volumes. This
543 command can be dangerous because you can delete catalog records associated
544 with current backups of files, and we recommend that you do not use it
545 unless you know what you are doing. The permitted forms of {\bf purge} are:
547 jobid=\lt{}jobid\gt{}|job=\lt{}job-name\gt{}|client=\lt{}client-name\gt{}
549 purge jobs client=\lt{}client-name\gt{} (of all jobs)
551 purge volume|volume=\lt{}vol-name\gt{} (of all jobs)
553 For the {\bf purge} command to work on Volume Catalog database records the
554 {\bf VolStatus} must be Append, Full, Used, or Error.
556 The actual data written to the Volume will be unaffected by this command.
559 \index[console]{relabel }
560 This command is used to label physical volumes. The full form of this command
563 relabel storage=\lt{}storage-name\gt{} volume=\lt{}newvolume-name\gt{}
564 name=\lt{}old-volume-name\gt{}
566 If you leave out any part, you will be prompted for it. In order for the
567 Volume (old-volume-name) to be relabeled, it must be in the catalog, and the
568 volume status must be marked {\bf Purged} or {\bf Recycle}. This happens
569 automatically as a result of applying retention periods, or you may
570 explicitly purge the volume using the {\bf purge} command.
572 Once the volume is physically relabeled, the old data written on the Volume
573 is lost and cannot be recovered.
576 \index[console]{release }
577 This command is used to cause the Storage daemon to rewind (release) the
578 current tape in the drive, and to re-read the Volume label the next time the
581 release storage=\lt{}storage-name\gt{}
583 After a release command, the device is still kept open by Bacula (unless
584 Always Open is set to No in the Storage Daemon's configuration) so it cannot
585 be used by another program. However, with some tape drives, the operator can
586 remove the current tape and to insert a different one, and when the next Job
587 starts, Bacula will know to re-read the tape label to find out what tape is
588 mounted. If you want to be able to use the drive with another program (e.g.
589 {\bf mt}), you must use the {\bf unmount} command to cause Bacula to
590 completely release (close) the device.
593 \index[console]{restore }
594 The restore command allows you to select one or more Jobs (JobIds) to be
595 restored using various methods. Once the JobIds are selected, the File
596 records for those Jobs are placed in an internal Bacula directory tree, and
597 the restore enters a file selection mode that allows you to interactively
598 walk up and down the file tree selecting individual files to be restored.
599 This mode is somewhat similar to the standard Unix {\bf restore} program's
600 interactive file selection mode.
602 restore storage=\lt{}storage-name\gt{} client=\lt{}client-name\gt{}
603 where=\lt{}path\gt{} pool=\lt{}pool-name\gt{} fileset=\lt{}fileset-name\gt{}
604 select current all done
606 Where {\bf current}, if specified, tells the restore command to automatically
607 select a restore to the most current backup. If not specified, you will be
608 prompted. The {\bf all} specification tells the restore command to restore
609 all files. If it is not specified, you will be prompted for the files to
610 restore. For details of the {\bf restore} command, please see the
611 \ilink{Restore Chapter}{_ChapterStart13} of this manual.
614 \index[console]{run }
615 This command allows you to schedule jobs to be run immediately. The full form
618 run job=\lt{}job-name\gt{} client=\lt{}client-name\gt{}
619 fileset=\lt{}FileSet-name\gt{} level=\lt{}level-keyword\gt{}
620 storage=\lt{}storage-name\gt{} where=\lt{}directory-prefix\gt{}
621 when=\lt{}universal-time-specification\gt{} yes
623 Any information that is needed but not specified will be listed for
624 selection, and before starting the job, you will be prompted to accept,
625 reject, or modify the parameters of the job to be run, unless you have
626 specified {\bf yes}, in which case the job will be immediately sent to the
629 On my system, when I enter a run command, I get the following prompt:
633 A job name must be specified.
634 The defined Job resources are:
644 Select Job resource (1-9):
649 If I then select number 5, I am prompted with:
655 FileSet: Minou Full Set
660 When: 2003-04-23 17:08:18
661 OK to run? (yes/mod/no):
666 If I now enter {\bf yes}, the Job will be run. If I enter {\bf mod}, I will
667 be presented with the following prompt.
671 Parameters to modify:
679 Select parameter to modify (1-7):
684 If you wish to start a job at a later time, you can do so by setting the When
685 time. Use the {\bf mod} option and select {\bf When} (no. 6). Then enter the
686 desired start time in YYYY-MM-DD HH:MM:SS format.
689 \index[dir]{setdebug }
690 This command is used to set the debug level in each daemon. The form of this
693 setdebug level=nn [trace=0/1 client=\lt{}client-name\gt{} | dir | director |
694 storage=\lt{}storage-name\gt{} | all]
696 If trace=1 is set, then the tracing will be enabled, and the daemon where the
697 setdebug applies will be placed in trace mode, and all debug output will go
698 to the file {\bf bacula.trace} in the current directory of the daemon.
699 Normally, tracing is used only for Win32 clients where the debug output
700 cannot be written to a terminal or redirected to a file. When tracing, each
701 debug output message is appended to the trace file. You must explicitly
702 delete the file when you are done.
705 \index[console]{show }
706 The show command will list the Director's resource records as defined in the
707 Director's configuration file (normally {\bf bacula-dir.conf}). This command
708 is used mainly for debugging purposes by developers. The following keywords
709 are accepted on the show command line: directors, clients, counters, jobs,
710 storages, catalogs, schedules, filesets, groups, pools, messages, all, help.
711 Please don't confuse this command with the {\bf list}, which displays the
712 contents of the catalog.
715 \index[dir]{sqlquery }
716 The sqlquery command puts the Console program into SQL query mode where each
717 line you enter is concatenated to the previous line until a semicolon (;) is
718 seen. The semicolon terminates the command, which is then passed directly to
719 the SQL database engine. When the output from the SQL engine is displayed,
720 the formation of a new SQL command begins. To terminate SQL query mode and
721 return to the Console command prompt, you enter a period (.) in column 1.
723 Using this command, you can query the SQL catalog database directly. Note you
724 should really know what you are doing otherwise you could damage the catalog
725 database. See the {\bf query} command below for simpler and safer way of
726 entering SQL queries.
728 Depending on what database engine you are using (MySQL, PostgreSQL or SQLite), you will
729 have somewhat different SQL commands available. For more detailed
730 information, please refer to the MySQL, PostgreSQL or SQLite documentation.
734 This command will display the status of the next jobs that are scheduled
735 during the next twenty-four hours as well as the status of currently running
736 jobs. The full form of this command is:
738 status [all | dir=\lt{}dir-name\gt{} | director |
739 client=\lt{}client-name\gt{} | storage=\lt{}storage-name\gt{}]
741 If you do a {\bf status dir}, the console will list any currently running
742 jobs, a summary of all jobs scheduled to be run in the next 24 hours, and a
743 listing of the last 10 terminated jobs with their statuses. The scheduled
744 jobs summary will include the Volume name to be used. You should be aware of
745 two things: 1. to obtain the volume name, the code goes through the same code
746 that will be used when the job runs, which means that it may prune or recycle
747 a Volume; 2. The Volume listed is only a best guess. The Volume actually
748 used may be different because of the time difference (more durations may
749 expire when the job runs) and another job could completely fill the Volume
752 In the Running Jobs listing, you may find the following types of information:
757 2507 Catalog MatouVerify.2004-03-13_05.05.02 is waiting execution
758 5349 Full CatalogBackup.2004-03-13_01.10.00 is waiting for higher
759 priority jobs to finish
760 5348 Differe Minou.2004-03-13_01.05.09 is waiting on max Storage jobs
761 5343 Full Rufus.2004-03-13_01.05.04 is running
765 Looking at the above listing from bottom to top, obviously JobId 5343 (Rufus)
766 is running. JobId 5348 (Minou) is waiting for JobId 5343 to finish because it
767 is using the Storage resource, hence the ``waiting on max Storage jobs''.
768 JobId 5349 has a lower priority than all the other jobs so it is waiting for
769 higher priority jobs to finish, and finally, JobId 2508 (MatouVerify) is
770 waiting because only one job can run at a time, hence it is simply ``waiting
771 execution\".</dd>
774 \index[console]{unmount }
775 This command causes the indicated Bacula Storage daemon to unmount the
776 specified device. The forms of the command are the same as the mount command:
779 unmount storage=\lt{}storage-name\gt{}
781 unmount [ jobid=\lt{}id\gt{} | job=\lt{}job-name\gt{} ]
785 \label{UpdateCommand}
787 \index[console]{update }
788 This command will update the catalog for either a specific Pool record, a Volume
789 record, or the Slots in an autochanger with barcode capability. In the case
790 of updating a Pool record, the new information will be automatically taken
791 from the corresponding Director's configuration resource record. It can be
792 used to increase the maximum number of volumes permitted or to set a maximum
793 number of volumes. The following main keywords may be specified:
796 media, volume, pool, slots
800 In the case of updating a Volume, you will be prompted for which value you
801 wish to change. The following Volume parameters may be changed:
807 Volume Retention Period
818 All Volumes from Pool
823 For slots {\bf update slots}, Bacula will obtain a list of slots and their
824 barcodes from the Storage daemon, and for each barcode found, it will
825 automatically update the slot in the catalog Media record to correspond to
826 the new value. This is very useful if you have moved cassettes in the
827 magazine, or if you have removed the magazine and inserted a different one.
828 As the slot of each Volume is updated, the InChanger flag for that Volume
829 will also be set, and any other Volumes in the Pool will have their InChanger
830 flag turned off. This permits Bacula to know what magazine (tape holder) is
831 currently in the autochanger.
833 If you do not have barcodes, you can accomplish the same thing in version
834 1.33 and later by using the {\bf update slots scan} command. The {\bf scan}
835 keyword tells Bacula to physically mount each tape and to read its
838 For Pool {\bf update pool}, Bacula will move the Volume record from its
839 existing pool to the pool specified.
841 For {\bf Volume from Pool} and {\bf All Volumes from Pool}, the following
842 values are updated from the Pool record: Recycle, VolRetention,
843 VolUseDuration, MaxVolJobs, MaxVolFiles, and MaxVolBytes.
845 The full form of the update command with all command line arguments is:
849 update volume=xxx pool=yyy slots volstatus=xxx VolRetention=ddd
850 VolUse=ddd MaxVolJobs=nnn MaxVolBytes=nnn Recycle=yes|no
857 \index[console]{use }
858 This command allows you to specify which Catalog database to use. Normally,
859 you will be using only one database so this will be done automatically. In
860 the case that you are using more than one database, you can use this command
861 to switch from one to another.
863 use \lt{}database-name\gt{}
867 \index[console]{var name }
868 This command takes a string or quoted string and does variable expansion on
869 it the same way variable expansion is done on the {\bf LabelFormat} string.
870 Thus, for the most part, you can test your LabelFormat strings. The
871 difference between the {\bf var} command and the actual LabelFormat process
872 is that during the var command, no job is running so ''dummy`` values are
873 used in place of Job specific variables. Generally, however, you will get a
874 good idea of what is going to happen in the real case.
877 \index[console]{version }
878 The command prints the Director's version.
881 \index[console]{quit }
882 This command terminates the console program. The console program sends the
883 {\bf quit} request to the Director and waits for acknowledgment. If the
884 Director is busy doing a previous command for you that has not terminated, it
885 may take some time. You may quit immediately by issuing the {\bf .quit}
886 command (i.e. quit preceded by a period).
889 \index[console]{query }
890 This command reads a predefined SQL query from the query file (the name and
891 location of the query file is defined with the QueryFile resource record in
892 the Director's configuration file). You are prompted to select a query from
893 the file, and possibly enter one or more parameters, then the command is
894 submitted to the Catalog database SQL engine.
896 The following queries are currently available (version 1.24):
902 2: List where a file is saved:
903 3: List where the most recent copies of a file are saved:
904 4: List total files/bytes by Job:
905 5: List total files/bytes by Volume:
906 6: List last 20 Full Backups for a Client:
907 7: List Volumes used by selected JobId:
908 8: List Volumes to Restore All Files:
909 9: List where a File is saved:
910 Choose a query (1-9):
916 \index[console]{exit }
917 This command terminates the console program.
920 \index[console]{wait }
921 The wait command causes the Director to pause until there are no jobs
922 running. This command is useful in a batch situation such as regression
923 testing where you wish to start a job and wait until that job completes
929 \subsection*{Special dot Commands}
930 \index[general]{Commands!Special dot }
931 \index[general]{Special dot Commands }
932 \addcontentsline{toc}{subsection}{Special dot Commands}
934 There is a list of commands that are prefixed with a period (.). These
935 commands are intended to be used either by batch programs or graphical user
936 interface front-ends. They are not normally used by interactive users. Once
937 GUI development begins, this list will be considerably expanded. The following
938 is the list of dot commands:
942 .die cause the Director to segment fault (for debugging)
943 .jobs list all job names
944 .filesets list all fileset names
945 .clients list all client names
946 .msgs return any queued messages
954 \subsection*{Special At (@) Commands}
955 \index[general]{Commands!Special At @ }
956 \index[general]{Special At (@) Commands }
957 \addcontentsline{toc}{subsection}{Special At (@) Commands}
959 Normally, all commands entered to the Console program are immediately
960 forwarded to the Director, which may be on another machine, to be executed.
961 However, there is a small list of {\bf at} commands, all beginning with an at
962 character (@), that will not be sent to the Director, but rather interpreted
963 by the Console program directly. Note, these commands are implemented only in
964 the tty console program and not in the GNOME Console. These commands are:
968 \item [@input \lt{}filename\gt{}]
969 \index[console]{@input \lt{}filename\gt{} }
970 Read and execute the commands contained in the file specified.
972 \item [@output \lt{}filename\gt{} w/a]
973 \index[console]{@output \lt{}filename\gt{} w/a }
974 Send all following output to the filename specified either overwriting the
975 file (w) or appending to the file (a). To redirect the output to the
976 terminal, simply enter {\bf @output} without a filename specification.
977 WARNING: be careful not to overwrite a valid file. A typical example during a
978 regression test might be:
989 \item [@tee \lt{}filename\gt{} w/a]
990 \index[console]{@tee \lt{}filename\gt{} w/a }
991 Send all subsequent output to both the specified file and the terminal. It is
992 turned off by specifying {\bf @tee} or {\bf @output} without a filename.
994 \item [@sleep \lt{}seconds\gt{}]
995 \index[console]{@sleep \lt{}seconds\gt{} }
996 Sleep the specified number of seconds.
999 \index[console]{@time }
1000 Print the current time and date.
1003 \index[console]{@version }
1004 Print the console's version.
1007 \index[console]{@quit }
1011 \index[console]{@exit }
1014 \item [@\# anything]
1015 \index[console]{anything }
1021 \subsection*{Running the Console Program from a Shell Script}
1022 \index[general]{Script!Running the Console Program from a Shell }
1023 \index[general]{Running the Console Program from a Shell Script }
1024 \addcontentsline{toc}{subsection}{Running the Console Program from a Shell
1027 You can automate many Console tasks by running the console program from a
1028 shell script. For example, if you have created a file containing the following
1033 ./bconsole -c ./bconsole.conf <<END_OF_DATA
1034 unmount storage=DDS-4
1040 when that file is executed, it will unmount the current DDS-4 storage device.
1041 You might want to run this command during a Job by using the {\bf
1042 RunBeforeJob} or {\bf RunAfterJob} records.
1044 It is also possible to run the Console program from file input where the file
1045 contains the commands as follows:
1049 ./bconsole -c ./bconsole.conf <filename
1053 where the file named {\bf filename} contains any set of console commands.
1055 As a real example, the following script is part of the Bacula regression
1056 tests. It labels a volume (a disk volume), runs a backup, then does a restore
1061 bin/bconsole -c bin/bconsole.conf <<END_OF_DATA
1064 @output /tmp/log1.out
1065 label volume=TestVolume001
1072 @output /tmp/log2.out
1083 The output from the backup is directed to /tmp/log1.out and the output from
1084 the restore is directed to /tmp/log2.out. To ensure that the backup and
1085 restore ran correctly, the output files are checked with:
1089 grep "^Termination: *Backup OK" /tmp/log1.out
1091 grep "^Termination: *Restore OK" /tmp/log2.out
1096 \subsection*{Adding Volumes to a Pool}
1097 \index[general]{Adding Volumes to a Pool }
1098 \index[general]{Pool!Adding Volumes to a }
1099 \addcontentsline{toc}{subsection}{Adding Volumes to a Pool}
1101 If you have used the {\bf label} command to label a Volume, it will be
1102 automatically added to the Pool, and you will not need to add any media to the
1105 Alternatively, you may choose to add a number of Volumes to the pool without
1106 labeling them. At a later time when the Volume is requested by {\bf Bacula}
1107 you will need to label it.
1109 Before adding a volume, you must know the following information:
1112 \item The name of the Pool (normally ''Default``)
1113 \item The Media Type as specified in the Storage Resource in the Director's
1114 configuration file (e.g. ''DLT8000``)
1115 \item The number and names of the Volumes you wish to create.
1118 For example, to add media to a Pool, you would issue the following commands to
1119 the console program:
1124 Enter name of Pool to add Volumes to: Default
1125 Enter the Media Type: DLT8000
1126 Enter number of Media volumes to create. Max=1000: 10
1127 Enter base volume name: Save
1128 Enter the starting number: 1
1129 10 Volumes created in pool Default
1134 To see what you have added, enter:
1138 *list media pool=Default
1139 +-------+----------+---------+---------+-------+------------------+
1140 | MedId | VolumeNa | MediaTyp| VolStat | Bytes | LastWritten |
1141 +-------+----------+---------+---------+-------+------------------+
1142 | 11 | Save0001 | DLT8000 | Append | 0 | 0000-00-00 00:00 |
1143 | 12 | Save0002 | DLT8000 | Append | 0 | 0000-00-00 00:00 |
1144 | 13 | Save0003 | DLT8000 | Append | 0 | 0000-00-00 00:00 |
1145 | 14 | Save0004 | DLT8000 | Append | 0 | 0000-00-00 00:00 |
1146 | 15 | Save0005 | DLT8000 | Append | 0 | 0000-00-00 00:00 |
1147 | 16 | Save0006 | DLT8000 | Append | 0 | 0000-00-00 00:00 |
1148 | 17 | Save0007 | DLT8000 | Append | 0 | 0000-00-00 00:00 |
1149 | 18 | Save0008 | DLT8000 | Append | 0 | 0000-00-00 00:00 |
1150 | 19 | Save0009 | DLT8000 | Append | 0 | 0000-00-00 00:00 |
1151 | 20 | Save0010 | DLT8000 | Append | 0 | 0000-00-00 00:00 |
1152 +-------+----------+---------+---------+-------+------------------+
1157 Notice that the console program automatically appended a number to the base
1158 Volume name that you specify (Save in this case). If you don't want it to
1159 append a number, you can simply answer 0 (zero) to the question ''Enter number
1160 of Media volumes to create. Max=1000:``, and in this case, it will create a
1161 single Volume with the exact name you specify.