4 \chapter{Bacula Console}
5 \label{_ConsoleChapter}
6 \index[general]{Console!Bacula}
7 \index[general]{Bacula Console}
8 \index[general]{Console!Bacula}
9 \index[general]{Bacula Console}
11 The {\bf Bacula Console} (sometimes called the User Agent) is a program that
12 allows the user or the System Administrator, to interact with the Bacula
13 Director daemon while the daemon is running.
15 The current Bacula Console comes in two versions: a shell interface (TTY
16 style), and a QT GUI interface (Bat). Both permit the administrator or
17 authorized users to interact with Bacula. You can determine the status of a
18 particular job, examine the contents of the Catalog as well as perform certain
19 tape manipulations with the Console program.
21 Since the Console program interacts with the Director through the network, your
22 Console and Director programs do not necessarily need to run on the same
25 In fact, a certain minimal knowledge of the Console program is needed in order
26 for Bacula to be able to write on more than one tape, because when Bacula
27 requests a new tape, it waits until the user, via the Console program,
28 indicates that the new tape is mounted.
30 \section{Console Configuration}
31 \index[general]{Console Configuration}
32 \index[general]{Configuration!Console}
33 \index[general]{Console Configuration}
34 \index[general]{Configuration!Console}
36 When the Console starts, it reads a standard Bacula configuration file
37 named {\bf bconsole.conf} or {\bf bat.conf} in the case of the Bat
38 QT Console version from the current directory unless you specify the {\bf {-}c}
39 command line option (see below). This file allows default configuration
40 of the Console, and at the current time, the only Resource Record defined
41 is the Director resource, which gives the Console the name and address of
42 the Director. For more information on configuration of the Console
43 program, please see the \ilink{Console Configuration
44 File}{ConsoleConfChapter} Chapter of this document.
46 \section{Running the Console Program}
47 \index[general]{Running the Console Program}
48 \index[general]{Program!Running the Console}
49 \index[general]{Running the Console Program}
50 \index[general]{Program!Running the Console}
52 The console program can be run with the following options:
55 Usage: bconsole [-s] [-c config_file] [-d debug_level]
56 -c <file> set configuration file to file
57 -dnn set debug level to nn
60 -u <nn> set command execution timeout to <nn> seconds
61 -t test - read configuration and exit
62 -? print this message.
67 After launching the Console program (bconsole), it will prompt you for the next
68 command with an asterisk (*). Generally, for all commands, you can simply
69 enter the command name and the Console program will prompt you for the
70 necessary arguments. Alternatively, in most cases, you may enter the command
71 followed by arguments. The general format is:
75 <command> <keyword1>[=<argument1>] <keyword2>[=<argument2>] ...
79 where {\bf command} is one of the commands listed below; {\bf keyword} is one
80 of the keywords listed below (usually followed by an argument); and {\bf
81 argument} is the value. The command may be abbreviated to the shortest unique
82 form. If two commands have the same starting letters, the one that will be
83 selected is the one that appears first in the {\bf help} listing. If you want
84 the second command, simply spell out the full command. None of the keywords
85 following the command may be abbreviated.
95 will list all files saved for JobId 23. Or:
103 will display all the Pool resource records.
105 The maximum command line length is limited to 511 characters, so if you
106 are scripting the console, you may need to take some care to limit the
109 \section{Stopping the Console Program}
110 \index[general]{Program!Stopping the Console}
111 \index[general]{Stopping the Console Program}
112 \index[general]{Program!Stopping the Console}
113 \index[general]{Stopping the Console Program}
115 Normally, you simply enter {\bf quit} or {\bf exit} and the Console program
116 will terminate. However, it waits until the Director acknowledges the command.
117 If the Director is already doing a lengthy command (e.g. prune), it may take
118 some time. If you want to immediately terminate the Console program, enter the
121 There is currently no way to interrupt a Console command once issued (i.e.
122 Ctrl-C does not work). However, if you are at a prompt that is asking you to
123 select one of several possibilities and you would like to abort the command,
124 you can enter a period ({\bf .}), and in most cases, you will either be
125 returned to the main command prompt or if appropriate the previous prompt (in
126 the case of nested prompts). In a few places such as where it is asking for a
127 Volume name, the period will be taken to be the Volume name. In that case, you
128 will most likely be able to cancel at the next prompt.
131 \section{Alphabetic List of Console Keywords}
132 \index[general]{Keywords!Alphabetic List of Console}
133 \index[general]{Alphabetic List of Console Keywords}
134 \index[general]{Keywords!Alphabetic List of Console}
135 \index[general]{Alphabetic List of Console Keywords}
136 Unless otherwise specified, each of the following keywords
137 takes an argument, which is specified after the keyword following
138 an equal sign. For example:
144 Please note, this list is incomplete as it is currently in
145 the process of being created and is not currently totally in
151 Permitted on the python command, and causes the Python
152 interpreter to be restarted. Takes no argument.
154 Permitted on the status and show commands to specify all components or
155 resources respectively.
157 Permitted on the update command to specify that all Volumes in the
158 pool (specified on the command line) should be updated.
160 Permitted on the update command to specify that all Volumes in all
161 pools should be updated.
163 Used in the restore command.
165 Used in the restore command.
167 Allowed in the use command to specify the catalog name
170 Used in the show command. Takes no arguments.
173 Used in the show, list, and llist commands. Takes no arguments.
175 Used in the show command. Takes no arguments.
177 Used in the restore command. Takes no argument.
179 Used to define the number of days the "list nextvol" command
180 should consider when looking for jobs to be run. The days keyword
181 can also be used on the "status dir" command so that it will display
182 jobs scheduled for the number of days you want.
184 Used in the show command. Takes no arguments.
185 \item [dir | director]
187 Used in the show command. Takes no arguments.
189 Used in the restore command. Its argument specifies the directory
192 This keyword can appear on the {\bf update volume} as well
193 as the {\bf update slots} commands, and can
194 allows one of the following arguments: yes, true, no, false, archived,
195 0, 1, 2. Where 0 corresponds to no or false, 1 corresponds to yes or true, and
196 2 corresponds to archived. Archived volumes will not be used, nor will
197 the Media record in the catalog be pruned. Volumes that are not enabled,
198 will not be used for backup or restore.
200 Used in the restore command. Takes no argument.
202 Used in the restore command.
204 Used in the list and llist commands. Takes no arguments.
207 Used in the show command. Takes no arguments.
209 Used in the show command. Takes no arguments.
211 Used in the show, list and llist commands. Takes no arguments.
213 Used in the list and llist commands. Takes no arguments.
215 Used in the list and llist commands. Takes no arguments.
217 The JobId is the numeric jobid that is printed in the Job
218 Report output. It is the index of the database record for the
219 given job. While it is unique for all the existing Job records
220 in the catalog database, the same JobId can be reused once a
221 Job is removed from the catalog. Probably you will refer
222 specific Jobs that ran using their numeric JobId.
223 \item [job | jobname]
224 The Job or Jobname keyword refers to the name you specified
225 in the Job resource, and hence it refers to any number of
226 Jobs that ran. It is typically useful if you want to list
227 all jobs of a particular name.
230 Permitted on the estimate command. Takes no argument.
233 Used in the show command. Takes no arguments.
235 Used in the list and llist commands. Takes no arguments.
236 \item [nextvol | nextvolume]
237 Used in the list and llist commands. Takes no arguments.
244 Used in the show, list, and llist commands. Takes no arguments.
246 Used in the restore command. Takes no argument.
248 Used in the setbandwidth command. Takes integer in KB/s unit.
250 Used in the show command. Takes no arguments.
252 Used in the show command. Takes no arguments.
253 \item [sd | store | storage]
255 The ujobid is a unique job identification that is printed
256 in the Job Report output. At the current time, it consists
257 of the Job name (from the Name directive for the job) appended
258 with the date and time the job was run. This keyword is useful
259 if you want to completely identify the Job instance run.
262 Used in the list and llist commands. Takes no arguments.
264 Used in the restore command.
266 Used in the restore command. Takes no argument.
270 \section{Alphabetic List of Console Commands}
271 \index[general]{Commands!Alphabetic List of Console}
272 \index[general]{Alphabetic List of Console Commands}
273 \index[general]{Commands!Alphabetic List of Console}
274 \index[general]{Alphabetic List of Console Commands}
276 The following commands are currently implemented:
279 \item [{add [pool=\lt{}pool-name\gt{} storage=\lt{}storage\gt{}
280 jobid=\lt{}JobId\gt{}]} ]
282 This command is used to add Volumes to an existing Pool. That is,
283 it creates the Volume name in the catalog and inserts into the Pool
284 in the catalog, but does not attempt to access the physical Volume.
286 added, Bacula expects that Volume to exist and to be labeled.
287 This command is not normally used since Bacula will
288 automatically do the equivalent when Volumes are labeled. However,
289 there may be times when you have removed a Volume from the catalog
290 and want to later add it back.
292 Normally, the {\bf label} command is used rather than this command
293 because the {\bf label} command labels the physical media (tape, disk,
294 DVD, ...) and does the equivalent of the {\bf add} command. The {\bf
295 add} command affects only the Catalog and not the physical media (data
296 on Volumes). The physical media must exist and be labeled before use
297 (usually with the {\bf label} command). This command can, however, be
298 useful if you wish to add a number of Volumes to the Pool that will be
299 physically labeled at a later time. It can also be useful if you are
300 importing a tape from another site. Please see the {\bf label} command
301 below for the list of legal characters in a Volume name.
303 \item [autodisplay on/off]
304 \index[general]{autodisplay on/off}
305 This command accepts {\bf on} or {\bf off} as an argument, and turns
306 auto-display of messages on or off respectively. The default for the
307 console program is {\bf off}, which means that you will be notified when
308 there are console messages pending, but they will not automatically be
311 When autodisplay is turned off, you must explicitly retrieve the
312 messages with the {\bf messages} command. When autodisplay is turned
313 on, the messages will be displayed on the console as they are received.
315 \item [automount on/off]
316 \index[general]{automount on/off}
317 This command accepts {\bf on} or {\bf off} as the argument, and turns
318 auto-mounting of the Volume after a {\bf label} command on or off
319 respectively. The default is {\bf on}. If {\bf automount} is turned
320 off, you must explicitly {\bf mount} tape Volumes after a label command to
323 \item [{cancel [jobid=\lt{}number\gt{} job=\lt{}job-name\gt{} ujobid=\lt{}unique-jobid\gt{}]}]
324 \index[general]{cancel jobid}
325 This command is used to cancel a job and accepts {\bf jobid=nnn} or {\bf
326 job=xxx} as an argument where nnn is replaced by the JobId and xxx is
327 replaced by the job name. If you do not specify a keyword, the Console
328 program will prompt you with the names of all the active jobs allowing
331 Once a Job is marked to be canceled, it may take a bit of time
332 (generally within a minute but up to two hours) before the Job actually
333 terminates, depending on what operations it is doing.
334 Don't be surprised that you receive a Job not found message. That just
335 means that one of the three daemons had already canceled the job.
336 Messages numbered in the 1000's are from the Director, 2000's are from
337 the File daemon and 3000's from the Storage daemon.
340 \item [{create [pool=\lt{}pool-name\gt{}]}]
341 \index[general]{create pool}
342 This command is not normally used as the Pool records are automatically
343 created by the Director when it starts based on what it finds in
344 the conf file. If needed, this command can be
345 to create a Pool record in the database using the
346 Pool resource record defined in the Director's configuration file. So
347 in a sense, this command simply transfers the information from the Pool
348 resource in the configuration file into the Catalog. Normally this
349 command is done automatically for you when the Director starts providing
350 the Pool is referenced within a Job resource. If you use this command
351 on an existing Pool, it will automatically update the Catalog to have
352 the same information as the Pool resource. After creating a Pool, you
353 will most likely use the {\bf label} command to label one or more
354 volumes and add their names to the Media database.
356 When starting a Job, if Bacula determines that there is no Pool record
357 in the database, but there is a Pool resource of the appropriate name,
358 it will create it for you. If you want the Pool record to appear in the
359 database immediately, simply use this command to force it to be created.
361 \item [{delete [volume=\lt{}vol-name\gt{} pool=\lt{}pool-name\gt{} job
362 jobid=\lt{}id\gt{}]}]
363 \index[general]{delete}
364 The delete command is used to delete a Volume, Pool or Job record from
365 the Catalog as well as all associated catalog Volume records that were
366 created. This command operates only on the Catalog database and has no
367 effect on the actual data written to a Volume. This command can be
368 dangerous and we strongly recommend that you do not use it unless you
369 know what you are doing.
371 If the keyword {\bf Volume} appears on the command line, the named
372 Volume will be deleted from the catalog, if the keyword {\bf Pool}
373 appears on the command line, a Pool will be deleted, and if the keyword
374 {\bf Job} appears on the command line, a Job and all its associated
375 records (File and JobMedia) will be deleted from the catalog. The full
376 form of this command is:
379 delete pool=<pool-name>
385 delete volume=<volume-name> pool=<pool-name> or
389 delete JobId=<job-id> JobId=<job-id2> ... or
393 delete Job JobId=n,m,o-r,t ...
396 The first form deletes a Pool record from the catalog database. The
397 second form deletes a Volume record from the specified pool in the
398 catalog database. The third form deletes the specified Job record from
399 the catalog database. The last form deletes JobId records for JobIds
400 n, m, o, p, q, r, and t. Where each one of the n,m,... is, of course, a
401 number. That is a "delete jobid" accepts lists and ranges of
404 \item [disable job\lt{}job-name\gt{}]
405 \index[general]{disable}
406 This command permits you to disable a Job for automatic scheduling.
407 The job may have been previously enabled with the Job resource
408 {\bf Enabled} directive or using the console {\bf enable} command.
409 The next time the Director is restarted or the conf file is reloaded,
410 the Enable/Disable state will be set to the value in the Job resource
411 (default enabled) as defined in the bacula-dir.conf file.
413 \item [enable job\lt{}job-name\gt{}]
414 \index[general]{enable}
415 This command permits you to enable a Job for automatic scheduling.
416 The job may have been previously disabled with the Job resource
417 {\bf Enabled} directive or using the console {\bf disable} command.
418 The next time the Director is restarted or the conf file is reloaded,
419 the Enable/Disable state will be set to the value in the Job resource
420 (default enabled) as defined in the bacula-dir.conf file.
424 \index[general]{estimate}
425 Using this command, you can get an idea how many files will be backed
426 up, or if you are unsure about your Include statements in your FileSet,
427 you can test them without doing an actual backup. The default is to
428 assume a Full backup. However, you can override this by specifying a
429 {\bf level=Incremental} or {\bf level=Differential} on the command line.
430 A Job name must be specified or you will be prompted for one, and
431 optionally a Client and FileSet may be specified on the command line.
432 It then contacts the client which computes the number of files and bytes
433 that would be backed up. Please note that this is an estimate
434 calculated from the number of blocks in the file rather than by reading
435 the actual bytes. As such, the estimated backup size will generally be
436 larger than an actual backup.
438 The \texttt{estimate} command can use the accurate code to detect changes
439 and give a better estimation. You can set the accurate behavior on command
440 line using \texttt{accurate=yes/no} or use the Job setting as default value.
442 Optionally you may specify the keyword {\bf listing} in which case, all the
443 files to be backed up will be listed. Note, it could take quite some time to
444 display them if the backup is large. The full form is:
447 estimate job=<job-name> listing client=<client-name> accurate=<yes/no>
448 fileset=<fileset-name> level=<level-name>
451 Specification of the {\bf job} is sufficient, but you can also override the
452 client, fileset, accurate and/or level by specifying them on the estimate
456 As an example, you might do:
461 estimate job=NightlySave listing level=Incremental
466 which will do a full listing of all files to be backed up for the Job {\bf
467 NightlySave} during an Incremental save and put it in the file {\bf
468 /tmp/listing}. Note, the byte estimate provided by this command is
469 based on the file size contained in the directory item. This can give
470 wildly incorrect estimates of the actual storage used if there are
471 sparse files on your systems. Sparse files are often found on 64 bit
472 systems for certain system files. The size that is returned is the size
473 Bacula will backup if the sparse option is not specified in the FileSet.
474 There is currently no way to get an estimate of the real file size that
475 would be found should the sparse option be enabled.
478 \index[general]{exit}
479 This command terminates the console program.
483 Invoke the non-interactive gui mode.
489 \index[general]{help}
490 This command displays the list of commands available.
493 \index[general]{label}
494 \index[general]{relabel}
495 \index[general]{label}
496 \index[general]{relabel}
497 This command is used to label physical volumes. The full form of this command
501 label storage=<storage-name> volume=<volume-name>
505 If you leave out any part, you will be prompted for it. The media type
506 is automatically taken from the Storage resource definition that you
507 supply. Once the necessary information is obtained, the Console program
508 contacts the specified Storage daemon and requests that the Volume be
509 labeled. If the Volume labeling is successful, the Console program will
510 create a Volume record in the appropriate Pool.
512 The Volume name is restricted to letters, numbers, and the special
513 characters hyphen ({\bf -}), underscore ({\bf \_}), colon ({\bf :}), and
514 period ({\bf .}). All other characters including a space are invalid.
515 This restriction is to ensure good readability of Volume names to reduce
518 Please note, when labeling a blank tape, Bacula will get {\bf read I/O
519 error} when it attempts to ensure that the tape is not already labeled. If
520 you wish to avoid getting these messages, please write an EOF mark on
521 your tape before attempting to label it:
531 The label command can fail for a number of reasons:
534 \item The Volume name you specify is already in the Volume database.
536 \item The Storage daemon has a tape or other Volume already mounted on the
537 device, in which case you must {\bf unmount} the device, insert a blank
538 tape, then do the {\bf label} command.
540 \item The Volume in the device is already a Bacula labeled Volume. (Bacula will
541 never relabel a Bacula labeled Volume unless it is recycled and you use the
542 {\bf relabel} command).
544 \item There is no Volume in the drive.
547 There are two ways to relabel a volume that already has a Bacula label. The
548 brute force method is to write an end of file mark on the tape using the
549 system {\bf mt} program, something like the following:
553 mt -f /dev/st0 rewind
558 For a disk volume, you would manually delete the Volume.
560 Then you use the {\bf label} command to add a new label. However, this could
561 leave traces of the old volume in the catalog.
563 The preferable method to relabel a Volume is to first {\bf purge} the volume,
564 either automatically, or explicitly with the {\bf purge} command, then use
565 the {\bf relabel} command described below.
567 If your autochanger has barcode labels, you can label all the Volumes in
568 your autochanger one after another by using the {\bf label barcodes}
569 command. For each tape in the changer containing a barcode, Bacula will
570 mount the tape and then label it with the same name as the barcode. An
571 appropriate Media record will also be created in the catalog. Any barcode
572 that begins with the same characters as specified on the
573 "CleaningPrefix=xxx" directive in the Director's Pool resource, will be
574 treated as a cleaning tape, and will not be labeled. However, an entry for
575 the cleaning tape will be created in the catalog. For example with:
581 Cleaning Prefix = "CLN"
587 Any slot containing a barcode of CLNxxxx will be treated as a cleaning tape
588 and will not be mounted. Note, the full form of the command is:
592 label storage=xxx pool=yyy slots=1-5,10 barcodes
597 \index[general]{list}
598 The list command lists the requested contents of the Catalog. The
599 various fields of each record are listed on a single line. The various
600 forms of the list command are:
605 list jobid=<id> (list jobid id)
607 list ujobid=<unique job name> (list job with unique name)
609 list job=<job-name> (list all jobs with "job-name")
611 list jobname=<job-name> (same as above)
613 In the above, you can add "limit=nn" to limit the output to
616 list joblog jobid=<id> (list job output if recorded in the catalog)
620 list jobmedia jobid=<id>
622 list jobmedia job=<job-name>
624 list files jobid=<id>
626 list files job=<job-name>
636 list volumes jobid=<id>
638 list volumes pool=<pool-name>
640 list volumes job=<job-name>
642 list volume=<volume-name>
644 list nextvolume job=<job-name>
646 list nextvol job=<job-name>
648 list nextvol job=<job-name> days=nnn
653 What most of the above commands do should be more or less obvious. In
654 general if you do not specify all the command line arguments, the
655 command will prompt you for what is needed.
657 The {\bf list nextvol} command will print the Volume name to be used by
658 the specified job. You should be aware that exactly what Volume will be
659 used depends on a lot of factors including the time and what a prior job
660 will do. It may fill a tape that is not full when you issue this
661 command. As a consequence, this command will give you a good estimate
662 of what Volume will be used but not a definitive answer. In addition,
663 this command may have certain side effect because it runs through the
664 same algorithm as a job, which means it may automatically purge or
665 recycle a Volume. By default, the job specified must run within the
666 next two days or no volume will be found. You can, however, use the
667 {\bf days=nnn} specification to specify up to 50 days. For example,
668 if on Friday, you want to see what Volume will be needed on Monday,
669 for job MyJob, you would use {\bf list nextvol job=MyJob days=3}.
671 If you wish to add specialized commands that list the contents of the
672 catalog, you can do so by adding them to the {\bf query.sql} file.
673 However, this takes some knowledge of programming SQL. Please see the
674 {\bf query} command below for additional information. See below for
675 listing the full contents of a catalog record with the {\bf llist}
678 As an example, the command {\bf list pools} might produce the following
683 +------+---------+---------+---------+----------+-------------+
684 | PoId | Name | NumVols | MaxVols | PoolType | LabelFormat |
685 +------+---------+---------+---------+----------+-------------+
686 | 1 | Default | 0 | 0 | Backup | * |
687 | 2 | Recycle | 0 | 8 | Backup | File |
688 +------+---------+---------+---------+----------+-------------+
692 As mentioned above, the {\bf list} command lists what is in the
693 database. Some things are put into the database immediately when Bacula
694 starts up, but in general, most things are put in only when they are
695 first used, which is the case for a Client as with Job records, etc.
697 Bacula should create a client record in the database the first time you
698 run a job for that client. Doing a {\bf status} will not cause a
699 database record to be created. The client database record will be
700 created whether or not the job fails, but it must at least start. When
701 the Client is actually contacted, additional info from the client will
702 be added to the client record (a "uname -a" output).
704 If you want to see what Client resources you have available in your conf
705 file, you use the Console command {\bf show clients}.
708 \index[general]{llist}
709 The llist or "long list" command takes all the same arguments that the
710 list command described above does. The difference is that the llist
711 command list the full contents of each database record selected. It
712 does so by listing the various fields of the record vertically, with one
713 field per line. It is possible to produce a very large number of output
714 lines with this command.
716 If instead of the {\bf list pools} as in the example above, you enter
717 {\bf llist pools} you might get the following output:
728 VolRetention: 1,296,000
729 VolUseDuration: 86,400
745 VolUseDuration: 3,600
757 \index[general]{messages}
758 This command causes any pending console messages to be immediately displayed.
761 \index[general]{memory}
762 Print current memory usage.
766 \index[general]{mount}
767 The mount command is used to get Bacula to read a volume on a physical
768 device. It is a way to tell Bacula that you have mounted a tape and
769 that Bacula should examine the tape. This command is normally
770 used only after there was no Volume in a drive and Bacula requests you to mount a new
771 Volume or when you have specifically unmounted a Volume with the {\bf
772 unmount} console command, which causes Bacula to close the drive. If
773 you have an autoloader, the mount command will not cause Bacula to
774 operate the autoloader unless you specify a {\bf slot} and possibly a
775 {\bf drive}. The various forms of the mount command are:
777 mount storage=\lt{}storage-name\gt{} [ slot=\lt{}num\gt{} ] [
778 drive=\lt{}num\gt{} ]
780 mount [ jobid=\lt{}id\gt{} | job=\lt{}job-name\gt{} ]
782 If you have specified {\bf Automatic Mount = yes} in the Storage daemon's
783 Device resource, under most circumstances, Bacula will automatically access
784 the Volume unless you have explicitly {\bf unmount}ed it in the Console
787 \label{ManualPruning}
789 \index[general]{prune}
790 The Prune command allows you to safely remove expired database records from
791 Jobs, Volumes and Statistics. This command works only on the Catalog
792 database and does not affect data written to Volumes. In all cases, the
793 Prune command applies a retention period to the specified records. You can
794 Prune expired File entries from Job records; you can Prune expired Job
795 records from the database, and you can Prune both expired Job and File
796 records from specified Volumes.
798 prune files|jobs|volume|stats client=\lt{}client-name\gt{}
799 volume=\lt{}volume-name\gt{}
801 For a Volume to be pruned, the {\bf VolStatus} must be Full, Used, or
802 Append, otherwise the pruning will not take place.
805 \index[general]{purge}
806 The Purge command will delete associated Catalog database records from
807 Jobs and Volumes without considering the retention period. {\bf Purge}
808 works only on the Catalog database and does not affect data written to
809 Volumes. This command can be dangerous because you can delete catalog
810 records associated with current backups of files, and we recommend that
811 you do not use it unless you know what you are doing. The permitted
812 forms of {\bf purge} are:
814 purge files jobid=\lt{}jobid\gt{}|job=\lt{}job-name\gt{}|client=\lt{}client-name\gt{}
816 purge jobs client=\lt{}client-name\gt{} (of all jobs)
818 purge volume|volume=\lt{}vol-name\gt{} (of all jobs)
820 For the {\bf purge} command to work on Volume Catalog database records the
821 {\bf VolStatus} must be Append, Full, Used, or Error.
823 The actual data written to the Volume will be unaffected by this command unless
824 you are using the \texttt{ActionOnPurge=Truncate} option on those Media.
826 To ask Bacula to truncate your \texttt{Purged} volumes, you need to use the
827 following command in interactive mode or in a RunScript:
829 *purge volume action=truncate storage=File allpools
830 # or by default, action=all
831 *purge volume action storage=File pool=Default
834 This is possible to specify the volume name, the media type, the pool, the
835 storage, etc\dots (see \texttt{help purge}) Be sure that your storage device is
836 idle when you decide to run this command.
839 \index[general]{python}
840 The python command takes a single argument {\bf restart}:
844 This causes the Python interpreter in the Director to be reinitialized.
845 This can be helpful for testing because once the Director starts and the
846 Python interpreter is initialized, there is no other way to make it
847 accept any changes to the startup script {\bf DirStartUp.py}. For more
848 details on Python scripting, please see the \ilink{Python
849 Scripting}{PythonChapter} chapter of this manual.
852 \index[general]{query}
853 This command reads a predefined SQL query from the query file (the name and
854 location of the query file is defined with the QueryFile resource record in
855 the Director's configuration file). You are prompted to select a query from
856 the file, and possibly enter one or more parameters, then the command is
857 submitted to the Catalog database SQL engine.
859 The following queries are currently available (version 2.2.7):
864 1: List up to 20 places where a File is saved regardless of the directory
865 2: List where the most recent copies of a file are saved
866 3: List last 20 Full Backups for a Client
867 4: List all backups for a Client after a specified time
868 5: List all backups for a Client
869 6: List Volume Attributes for a selected Volume
870 7: List Volumes used by selected JobId
871 8: List Volumes to Restore All Files
872 9: List Pool Attributes for a selected Pool
873 10: List total files/bytes by Job
874 11: List total files/bytes by Volume
875 12: List Files for a selected JobId
876 13: List Jobs stored on a selected MediaId
877 14: List Jobs stored for a given Volume name
878 15: List Volumes Bacula thinks are in changer
879 16: List Volumes likely to need replacement from age or errors
880 Choose a query (1-16):
885 \index[general]{quit}
886 This command terminates the console program. The console program sends the
887 {\bf quit} request to the Director and waits for acknowledgment. If the
888 Director is busy doing a previous command for you that has not terminated, it
889 may take some time. You may quit immediately by issuing the {\bf .quit}
890 command (i.e. quit preceded by a period).
893 \index[general]{relabel}
894 \index[general]{relabel}
895 This command is used to label physical volumes. The full form of this
898 relabel storage=\lt{}storage-name\gt{} oldvolume=\lt{}old-volume-name\gt{}
899 volume=\lt{}newvolume-name\gt{}
901 If you leave out any part, you will be prompted for it. In order for
902 the Volume (old-volume-name) to be relabeled, it must be in the catalog,
903 and the volume status must be marked {\bf Purged} or {\bf Recycle}.
904 This happens automatically as a result of applying retention periods, or
905 you may explicitly purge the volume using the {\bf purge} command.
907 Once the volume is physically relabeled, the old data previously written
908 on the Volume is lost and cannot be recovered.
911 \index[general]{release}
912 This command is used to cause the Storage daemon to rewind (release) the
913 current tape in the drive, and to re-read the Volume label the next time
916 release storage=\lt{}storage-name\gt{}
918 After a release command, the device is still kept open by Bacula (unless
919 Always Open is set to No in the Storage Daemon's configuration) so it
920 cannot be used by another program. However, with some tape drives, the
921 operator can remove the current tape and to insert a different one, and
922 when the next Job starts, Bacula will know to re-read the tape label to
923 find out what tape is mounted. If you want to be able to use the drive
924 with another program (e.g. {\bf mt}), you must use the {\bf unmount}
925 command to cause Bacula to completely release (close) the device.
928 \index[general]{reload}
929 The reload command causes the Director to re-read its configuration
930 file and apply the new values. The new values will take effect
931 immediately for all new jobs. However, if you change schedules,
932 be aware that the scheduler pre-schedules jobs up to two hours in
933 advance, so any changes that are to take place during the next two
934 hours may be delayed. Jobs that have already been scheduled to run
935 (i.e. surpassed their requested start time) will continue with the
936 old values. New jobs will use the new values. Each time you issue
937 a reload command while jobs are running, the prior config values
938 will queued until all jobs that were running before issuing
939 the reload terminate, at which time the old config values will
940 be released from memory. The Directory permits keeping up to
941 ten prior set of configurations before it will refuse a reload
942 command. Once at least one old set of config values has been
943 released it will again accept new reload commands.
945 While it is possible to reload the Director's configuration on the fly,
946 even while jobs are executing, this is a complex operation and not
947 without side effects. Accordingly, if you have to reload the Director's
948 configuration while Bacula is running, it is advisable to restart the
949 Director at the next convenient opportunity.
951 \label{restore_command}
953 \index[general]{restore}
954 The restore command allows you to select one or more Jobs (JobIds) to be
955 restored using various methods. Once the JobIds are selected, the File
956 records for those Jobs are placed in an internal Bacula directory tree,
957 and the restore enters a file selection mode that allows you to
958 interactively walk up and down the file tree selecting individual files
959 to be restored. This mode is somewhat similar to the standard Unix {\bf
960 restore} program's interactive file selection mode.
962 restore storage=\lt{}storage-name\gt{} client=\lt{}backup-client-name\gt{}
963 where=\lt{}path\gt{} pool=\lt{}pool-name\gt{} fileset=\lt{}fileset-name\gt{}
964 restoreclient=\lt{}restore-client-name\gt{}
965 select current all done
967 Where {\bf current}, if specified, tells the restore command to
968 automatically select a restore to the most current backup. If not
969 specified, you will be prompted. The {\bf all} specification tells the
970 restore command to restore all files. If it is not specified, you will
971 be prompted for the files to restore. For details of the {\bf restore}
972 command, please see the \ilink{Restore Chapter}{RestoreChapter} of this
975 The client keyword initially specifies the client from which the backup
976 was made and the client to which the restore will be make. However,
977 if the restoreclient keyword is specified, then the restore is written
982 This command allows you to schedule jobs to be run immediately. The full form
985 run job=\lt{}job-name\gt{} client=\lt{}client-name\gt{}
986 fileset=\lt{}FileSet-name\gt{} level=\lt{}level-keyword\gt{}
987 storage=\lt{}storage-name\gt{} where=\lt{}directory-prefix\gt{}
988 when=\lt{}universal-time-specification\gt{} spooldata=yes|no yes
990 Any information that is needed but not specified will be listed for
991 selection, and before starting the job, you will be prompted to accept,
992 reject, or modify the parameters of the job to be run, unless you have
993 specified {\bf yes}, in which case the job will be immediately sent to
996 On my system, when I enter a run command, I get the following prompt:
1000 A job name must be specified.
1001 The defined Job resources are:
1011 Select Job resource (1-9):
1016 If I then select number 5, I am prompted with:
1022 FileSet: Minou Full Set
1027 When: 2003-04-23 17:08:18
1028 OK to run? (yes/mod/no):
1033 If I now enter {\bf yes}, the Job will be run. If I enter {\bf mod}, I will
1034 be presented with the following prompt.
1038 Parameters to modify:
1046 Select parameter to modify (1-7):
1051 If you wish to start a job at a later time, you can do so by setting the When
1052 time. Use the {\bf mod} option and select {\bf When} (no. 6). Then enter the
1053 desired start time in YYYY-MM-DD HH:MM:SS format.
1055 The spooldata argument of the run command cannot be modified through the menu
1056 and is only accessible by setting its value on the intial command line. If
1057 no spooldata flag is set, the job, storage or schedule flag is used.
1060 \index[general]{setbandwidth}
1061 This command is used to limit the bandwidth of a running job or a client.
1063 setbandwidth limit=<nb> [ jobid=<id> | client=<cli> ]
1066 \index[general]{setdebug}
1067 \index[general]{setdebug}
1068 \index[general]{debugging}
1069 \index[general]{debugging Win32}
1070 \index[general]{Windows!debugging}
1071 This command is used to set the debug level in each daemon. The form of this
1074 setdebug level=nn [trace=0/1 client=\lt{}client-name\gt{} | dir | director |
1075 storage=\lt{}storage-name\gt{} | all]
1077 If trace=1 is set, then tracing will be enabled, and the daemon will be
1078 placed in trace mode, which means that all debug output as set by the
1079 debug level will be directed to the file {\bf bacula.trace} in the
1080 current directory of the daemon. Normally, tracing is needed only for
1081 Win32 clients where the debug output cannot be written to a terminal or
1082 redirected to a file. When tracing, each debug output message is
1083 appended to the trace file. You must explicitly delete the file when
1087 \index[general]{setip}
1088 Sets new client address -- if authorized.
1090 A console is authorized to use the {\bf SetIP} command only if it has a
1091 Console resource definition in both the Director and the Console. In
1092 addition, if the console name, provided on the {\bf Name =} directive,
1093 must be the same as a Client name, the user of that console is permitted
1094 to use the {\bf SetIP} command to change the Address directive in the
1095 Director's client resource to the IP address of the Console. This
1096 permits portables or other machines using DHCP (non-fixed IP addresses)
1097 to "notify" the Director of their current IP address.
1102 \index[general]{show}
1103 \index[general]{show}
1104 The show command will list the Director's resource records as defined in
1105 the Director's configuration file (normally {\bf bacula-dir.conf}).
1106 This command is used mainly for debugging purposes by developers.
1107 The following keywords are accepted on the
1108 show command line: catalogs, clients, counters, devices, directors,
1109 filesets, jobs, messages, pools, schedules, storages, all, help.
1110 Please don't confuse this command
1111 with the {\bf list}, which displays the contents of the catalog.
1114 \index[general]{sqlquery}
1115 The sqlquery command puts the Console program into SQL query mode where
1116 each line you enter is concatenated to the previous line until a
1117 semicolon (;) is seen. The semicolon terminates the command, which is
1118 then passed directly to the SQL database engine. When the output from
1119 the SQL engine is displayed, the formation of a new SQL command begins.
1120 To terminate SQL query mode and return to the Console command prompt,
1121 you enter a period (.) in column 1.
1123 Using this command, you can query the SQL catalog database directly.
1124 Note you should really know what you are doing otherwise you could
1125 damage the catalog database. See the {\bf query} command below for
1126 simpler and safer way of entering SQL queries.
1128 Depending on what database engine you are using (MySQL, PostgreSQL or
1129 SQLite), you will have somewhat different SQL commands available. For
1130 more detailed information, please refer to the MySQL, PostgreSQL or
1131 SQLite documentation.
1134 \index[general]{status}
1136 This command will display the status of all components. For the director, it
1137 will display the next jobs that are scheduled during the next 24 hours as
1138 well as the status of currently running jobs. For the Storage Daemon, you
1139 will have drive status or autochanger content. The File Daemon will give you
1140 information about current jobs like average speed or file accounting. The
1141 full form of this command is:
1143 status [all | dir=\lt{}dir-name\gt{} | director [days=nnn] |
1144 client=\lt{}client-name\gt{} | [slots] storage=\lt{}storage-name\gt{}]
1146 If you do a {\bf status dir}, the console will list any currently
1147 running jobs, a summary of all jobs scheduled to be run in the next 24
1148 hours, and a listing of the last ten terminated jobs with their statuses.
1149 The scheduled jobs summary will include the Volume name to be used. You
1150 should be aware of two things: 1. to obtain the volume name, the code
1151 goes through the same code that will be used when the job runs, but it
1152 does not do pruning nor recycling of Volumes; 2. The Volume listed is
1153 at best a guess. The Volume actually used may be different because of
1154 the time difference (more durations may expire when the job runs) and
1155 another job could completely fill the Volume requiring a new one.
1157 In the Running Jobs listing, you may find the following types of
1163 2507 Catalog MatouVerify.2004-03-13_05.05.02 is waiting execution
1164 5349 Full CatalogBackup.2004-03-13_01.10.00 is waiting for higher
1165 priority jobs to finish
1166 5348 Differe Minou.2004-03-13_01.05.09 is waiting on max Storage jobs
1167 5343 Full Rufus.2004-03-13_01.05.04 is running
1171 Looking at the above listing from bottom to top, obviously JobId 5343
1172 (Rufus) is running. JobId 5348 (Minou) is waiting for JobId 5343 to
1173 finish because it is using the Storage resource, hence the "waiting on
1174 max Storage jobs". JobId 5349 has a lower priority than all the other
1175 jobs so it is waiting for higher priority jobs to finish, and finally,
1176 JobId 2507 (MatouVerify) is waiting because only one job can run at a
1177 time, hence it is simply "waiting execution"
1179 If you do a {\bf status dir}, it will by default list the first
1180 occurrence of all jobs that are scheduled today and tomorrow. If you
1181 wish to see the jobs that are scheduled in the next three days (e.g. on
1182 Friday you want to see the first occurrence of what tapes are scheduled
1183 to be used on Friday, the weekend, and Monday), you can add the {\bf
1184 days=3} option. Note, a {\bf days=0} shows the first occurrence of jobs
1185 scheduled today only. If you have multiple run statements, the first
1186 occurrence of each run statement for the job will be displayed for the
1189 If your job seems to be blocked, you can get a general idea of the
1190 problem by doing a {\bf status dir}, but you can most often get a
1191 much more specific indication of the problem by doing a
1192 {\bf status storage=xxx}. For example, on an idle test system, when
1193 I do {\bf status storage=File}, I get:
1197 Connecting to Storage daemon File at 192.168.68.112:8103
1199 rufus-sd Version: 1.39.6 (24 March 2006) i686-pc-linux-gnu redhat (Stentz)
1200 Daemon started 26-Mar-06 11:06, 0 Jobs run since started.
1206 Jobs waiting to reserve a drive:
1210 JobId Level Files Bytes Status Finished Name
1211 ======================================================================
1212 59 Full 234 4,417,599 OK 15-Jan-06 11:54 kernsave
1216 Autochanger "DDS-4-changer" with devices:
1218 Device "DDS-4" (/dev/nst0) is mounted with Volume="TestVolume002"
1220 Slot 2 is loaded in drive 0.
1221 Total Bytes Read=0 Blocks Read=0 Bytes/block=0
1222 Positioned at File=0 Block=0
1224 Device "DVD-Writer" (/dev/hdc) is not open.
1225 Device "File" (/tmp) is not open.
1228 In Use Volume status:
1233 Now, what this tells me is that no jobs are running and that none of
1234 the devices are in use. Now, if I {\bf unmount} the autochanger, which
1235 will not be used in this example, and then start a Job that uses the
1236 File device, the job will block. When I re-issue the status storage
1237 command, I get for the Device status:
1244 Autochanger "DDS-4-changer" with devices:
1246 Device "DDS-4" (/dev/nst0) is not open.
1247 Device is BLOCKED. User unmounted.
1248 Drive 0 is not loaded.
1250 Device "DVD-Writer" (/dev/hdc) is not open.
1251 Device "File" (/tmp) is not open.
1252 Device is BLOCKED waiting for media.
1258 Now, here it should be clear that if a job were running that wanted
1259 to use the Autochanger (with two devices), it would block because
1260 the user unmounted the device. The real problem for the Job I started
1261 using the "File" device is that the device is blocked waiting for
1262 media -- that is Bacula needs you to label a Volume.
1265 \index[general]{time}
1266 Prints the current time.
1269 \index[general]{trace}
1270 Turn on/off trace to file.
1273 \index[general]{umount}
1274 For old-time Unix guys. See the unmount command for full details.
1277 \index[general]{unmount}
1278 This command causes the indicated Bacula Storage daemon to unmount the
1279 specified device. The forms of the command are the same as the mount command:
1282 unmount storage=<storage-name> [ drive=<num> ]
1284 unmount [ jobid=<id> | job=<job-name> ]
1288 Once you unmount a storage device, Bacula will no longer be able to use
1289 it until you issue a mount command for that device. If Bacula needs to
1290 access that device, it will block and issue mount requests periodically
1293 If the device you are unmounting is an autochanger, it will unload
1294 the drive you have specified on the command line. If no drive is
1295 specified, it will assume drive 1.
1297 \label{UpdateCommand}
1299 \index[general]{update}
1300 This command will update the catalog for either a specific Pool record, a Volume
1301 record, or the Slots in an autochanger with barcode capability. In the case
1302 of updating a Pool record, the new information will be automatically taken
1303 from the corresponding Director's configuration resource record. It can be
1304 used to increase the maximum number of volumes permitted or to set a maximum
1305 number of volumes. The following main keywords may be specified:
1308 media, volume, pool, slots, stats
1312 In the case of updating a Volume, you will be prompted for which value you
1313 wish to change. The following Volume parameters may be changed:
1319 Volume Retention Period
1322 Maximum Volume Files
1323 Maximum Volume Bytes
1331 All Volumes from Pool
1332 All Volumes from all Pools
1337 For slots {\bf update slots}, Bacula will obtain a list of slots and
1338 their barcodes from the Storage daemon, and for each barcode found, it
1339 will automatically update the slot in the catalog Media record to
1340 correspond to the new value. This is very useful if you have moved
1341 cassettes in the magazine, or if you have removed the magazine and
1342 inserted a different one. As the slot of each Volume is updated, the
1343 InChanger flag for that Volume will also be set, and any other Volumes
1344 in the Pool that were last mounted on the same Storage device
1345 will have their InChanger flag turned off. This permits
1346 Bacula to know what magazine (tape holder) is currently in the
1349 If you do not have barcodes, you can accomplish the same thing in
1350 version 1.33 and later by using the {\bf update slots scan} command.
1351 The {\bf scan} keyword tells Bacula to physically mount each tape and to
1352 read its VolumeName.
1354 For Pool {\bf update pool}, Bacula will move the Volume record from its
1355 existing pool to the pool specified.
1357 For {\bf Volume from Pool}, {\bf All Volumes from Pool} and {\bf All Volumes
1358 from all Pools}, the following values are updated from the Pool record:
1359 Recycle, RecyclePool, VolRetention, VolUseDuration, MaxVolJobs, MaxVolFiles,
1360 and MaxVolBytes. (RecyclePool feature is available with bacula 2.1.4 or
1363 The full form of the update command with all command line arguments is:
1367 update volume=xxx pool=yyy slots volstatus=xxx VolRetention=ddd
1368 VolUse=ddd MaxVolJobs=nnn MaxVolBytes=nnn Recycle=yes|no
1369 slot=nnn enabled=n recyclepool=zzz
1375 \index[general]{use}
1376 This command allows you to specify which Catalog database to use. Normally,
1377 you will be using only one database so this will be done automatically. In
1378 the case that you are using more than one database, you can use this command
1379 to switch from one to another.
1383 use [catalog=name-of-catalog]
1390 \index[general]{var name}
1391 This command takes a string or quoted string and does variable expansion on
1392 it the same way variable expansion is done on the {\bf LabelFormat} string.
1393 Thus, for the most part, you can test your LabelFormat strings. The
1394 difference between the {\bf var} command and the actual LabelFormat process
1395 is that during the var command, no job is running so "dummy" values are
1396 used in place of Job specific variables. Generally, however, you will get a
1397 good idea of what is going to happen in the real case.
1400 \index[general]{version}
1401 The command prints the Director's version.
1404 \index[general]{wait}
1405 The wait command causes the Director to pause until there are no jobs
1406 running. This command is useful in a batch situation such as regression
1407 testing where you wish to start a job and wait until that job completes
1408 before continuing. This command now has the following options:
1411 wait [jobid=nn] [jobuid=unique id] [job=job name]
1414 If specified with a specific JobId, ... the wait command will wait
1415 for that particular job to terminate before continuing.
1420 \section{Special dot Commands}
1421 \index[general]{Commands!Special dot}
1422 \index[general]{Special dot Commands}
1424 There is a list of commands that are prefixed with a period (.). These
1425 commands are intended to be used either by batch programs or graphical user
1426 interface front-ends. They are not normally used by interactive users. Once
1427 GUI development begins, this list will be considerably expanded. The following
1428 is the list of dot commands:
1432 .backups job=xxx list backups for specified job
1433 .clients list all client names
1434 .defaults client=xxx fileset=yyy list defaults for specified client
1435 .die cause the Director to segment fault (for debugging)
1436 .dir when in tree mode prints the equivalent to the dir command,
1437 but with fields separated by commas rather than spaces.
1439 .filesets list all fileset names
1440 .help help command output
1441 .jobs list all job names
1442 .levels list all levels
1443 .messages get quick messages
1444 .msgs return any queued messages
1445 .pools list all pool names
1447 .status get status output
1448 .storage return storage resource names
1449 .types list job types
1455 \section{Special At (@) Commands}
1456 \index[general]{Commands!Special At @}
1457 \index[general]{Special At (@) Commands}
1459 Normally, all commands entered to the Console program are immediately
1460 forwarded to the Director, which may be on another machine, to be executed.
1461 However, there is a small list of {\bf at} commands, all beginning with an at
1462 character (@), that will not be sent to the Director, but rather interpreted
1463 by the Console program directly. Note, these commands are implemented only in
1464 the tty console program and not in the Bat Console. These commands are:
1468 \item [@input \lt{}filename\gt{}]
1469 \index[general]{@input \lt{}filename\gt{}}
1470 Read and execute the commands contained in the file specified.
1472 \item [@output \lt{}filename\gt{} w/a]
1473 \index[general]{@output \lt{}filename\gt{} w/a}
1474 Send all following output to the filename specified either overwriting the
1475 file (w) or appending to the file (a). To redirect the output to the
1476 terminal, simply enter {\bf @output} without a filename specification.
1477 WARNING: be careful not to overwrite a valid file. A typical example during a
1478 regression test might be:
1489 \item [@tee \lt{}filename\gt{} w/a]
1490 \index[general]{@tee \lt{}filename\gt{} w/a}
1491 Send all subsequent output to both the specified file and the terminal. It is
1492 turned off by specifying {\bf @tee} or {\bf @output} without a filename.
1494 \item [@sleep \lt{}seconds\gt{}]
1495 \index[general]{@sleep \lt{}seconds\gt{}}
1496 Sleep the specified number of seconds.
1499 \index[general]{@time}
1500 Print the current time and date.
1503 \index[general]{@version}
1504 Print the console's version.
1507 \index[general]{@quit}
1511 \index[general]{@exit}
1514 \item [@\# anything]
1515 \index[general]{anything}
1519 \index[general]{@help}
1520 Get the list of every special @ commands.
1522 \item [@separator \lt{}char\gt{}]
1523 \index[general]{@separator}
1524 When using bconsole with readline, you can set the command separator to one
1525 of those characters to write commands who require multiple input on one line,
1526 or to put multiple commands on a single line.
1528 !$%&'()*+,-/:;<>?[]^`{|}~
1531 Note, if you use a semicolon (;) as a separator character, which is
1532 common, you will not be able to use the {\bf sql} command, which
1533 requires each command to be terminated by a semicolon.
1538 \section{Running the Console from a Shell Script}
1539 \index[general]{Script!Running the Console Program from a Shell}
1540 \index[general]{Running the Console Program from a Shell Script}
1542 You can automate many Console tasks by running the console program from a
1543 shell script. For example, if you have created a file containing the following
1548 ./bconsole -c ./bconsole.conf <<END_OF_DATA
1549 unmount storage=DDS-4
1555 when that file is executed, it will unmount the current DDS-4 storage device.
1556 You might want to run this command during a Job by using the {\bf
1557 RunBeforeJob} or {\bf RunAfterJob} records.
1559 It is also possible to run the Console program from file input where the file
1560 contains the commands as follows:
1564 ./bconsole -c ./bconsole.conf <filename
1568 where the file named {\bf filename} contains any set of console commands.
1570 As a real example, the following script is part of the Bacula regression
1571 tests. It labels a volume (a disk volume), runs a backup, then does a restore
1576 bin/bconsole -c bin/bconsole.conf <<END_OF_DATA
1579 @output /tmp/log1.out
1580 label volume=TestVolume001
1587 @output /tmp/log2.out
1598 The output from the backup is directed to /tmp/log1.out and the output from
1599 the restore is directed to /tmp/log2.out. To ensure that the backup and
1600 restore ran correctly, the output files are checked with:
1604 grep "^ *Termination: *Backup OK" /tmp/log1.out
1606 grep "^ *Termination: *Restore OK" /tmp/log2.out
1611 \section{Adding Volumes to a Pool}
1612 \index[general]{Adding Volumes to a Pool}
1613 \index[general]{Pool!Adding Volumes to a}
1615 If you have used the {\bf label} command to label a Volume, it will be
1616 automatically added to the Pool, and you will not need to add any media to the
1619 Alternatively, you may choose to add a number of Volumes to the pool without
1620 labeling them. At a later time when the Volume is requested by {\bf Bacula}
1621 you will need to label it.
1623 Before adding a volume, you must know the following information:
1626 \item The name of the Pool (normally "Default")
1627 \item The Media Type as specified in the Storage Resource in the Director's
1628 configuration file (e.g. "DLT8000")
1629 \item The number and names of the Volumes you wish to create.
1632 For example, to add media to a Pool, you would issue the following commands to
1633 the console program:
1638 Enter name of Pool to add Volumes to: Default
1639 Enter the Media Type: DLT8000
1640 Enter number of Media volumes to create. Max=1000: 10
1641 Enter base volume name: Save
1642 Enter the starting number: 1
1643 10 Volumes created in pool Default
1648 To see what you have added, enter:
1652 *list media pool=Default
1653 +-------+----------+---------+---------+-------+------------------+
1654 | MedId | VolumeNa | MediaTyp| VolStat | Bytes | LastWritten |
1655 +-------+----------+---------+---------+-------+------------------+
1656 | 11 | Save0001 | DLT8000 | Append | 0 | 0000-00-00 00:00 |
1657 | 12 | Save0002 | DLT8000 | Append | 0 | 0000-00-00 00:00 |
1658 | 13 | Save0003 | DLT8000 | Append | 0 | 0000-00-00 00:00 |
1659 | 14 | Save0004 | DLT8000 | Append | 0 | 0000-00-00 00:00 |
1660 | 15 | Save0005 | DLT8000 | Append | 0 | 0000-00-00 00:00 |
1661 | 16 | Save0006 | DLT8000 | Append | 0 | 0000-00-00 00:00 |
1662 | 17 | Save0007 | DLT8000 | Append | 0 | 0000-00-00 00:00 |
1663 | 18 | Save0008 | DLT8000 | Append | 0 | 0000-00-00 00:00 |
1664 | 19 | Save0009 | DLT8000 | Append | 0 | 0000-00-00 00:00 |
1665 | 20 | Save0010 | DLT8000 | Append | 0 | 0000-00-00 00:00 |
1666 +-------+----------+---------+---------+-------+------------------+
1671 Notice that the console program automatically appended a number to the base
1672 Volume name that you specify (Save in this case). If you don't want it to
1673 append a number, you can simply answer 0 (zero) to the question "Enter number
1674 of Media volumes to create. Max=1000:", and in this case, it will create a
1675 single Volume with the exact name you specify.