4 \chapter{Bacula Enterprise Console}
5 \label{_ConsoleChapter}
6 \index[general]{Console!Bacula}
7 \index[general]{Bacula Console}
9 The {\bf \mbacula{} Console} (sometimes called the User Agent) is a program
10 that allows the user or the System Administrator, to interact with the
11 \mbacula{} \director{} daemon while the daemon is running.
13 The current \mbacula{} Console comes in two versions: a shell interface (TTY
14 style), and a QT GUI interface (\bat{}). Both permit the administrator or
15 authorized users to interact with \mbacula{}. You can determine the status of a
16 particular job, examine the contents of the Catalog as well as perform certain
17 tape manipulations with the Console program.
19 Since the Console program interacts with the \director{} through the network,
20 your Console and \director{} programs do not necessarily need to run on the
23 In fact, a certain minimal knowledge of the Console program is needed in order
24 for \mbacula{} to be able to write on more than one tape, because when \mbacula{}
25 requests a new tape, it waits until the user, via the Console program,
26 indicates that the new tape is mounted.
28 \section{Console Configuration}
29 \index[general]{Console Configuration}
30 \index[general]{Configuration!Console}
32 When the Console starts, it reads a standard \mbacula{} configuration file
33 named {\bf bconsole.conf} or {\bf bat.conf} in the case of the Bat
34 QT Console version from the current directory unless you specify the {\bf {-}c}
35 command line option (see below). This file allows default configuration
36 of the Console, and at the current time, the only Resource Record defined
37 is the Director resource, which gives the Console the name and address of
38 the Director. For more information on configuration of the Console
39 program, please see the \bsysxrlink{Console Configuration}{ConsoleConfChapter}
40 {main}{chapter} of the \mainman{}.
42 \section{Running the Console Program}
43 \index[general]{Running the Console Program}
44 \index[general]{Program!Running the Console}
46 The console program can be run with the following options:
49 Usage: bconsole [-s] [-c config_file] [-d debug_level]
50 -c <file> set configuration file to file
51 -dnn set debug level to nn
54 -u <nn> set command execution timeout to <nn> seconds
55 -t test - read configuration and exit
56 -? print this message.
61 After launching the Console program (bconsole), it will prompt you for the next
62 command with an asterisk (*). Generally, for all commands, you can simply
63 enter the command name and the Console program will prompt you for the
64 necessary arguments. Alternatively, in most cases, you may enter the command
65 followed by arguments. The general format is:
69 <command> <keyword1>[=<argument1>] <keyword2>[=<argument2>] ...
73 where {\bf command} is one of the commands listed below; {\bf keyword} is one
74 of the keywords listed below (usually followed by an argument); and {\bf
75 argument} is the value. The command may be abbreviated to the shortest unique
76 form. If two commands have the same starting letters, the one that will be
77 selected is the one that appears first in the {\bf help} listing. If you want
78 the second command, simply spell out the full command. None of the keywords
79 following the command may be abbreviated.
89 will list all files saved for JobId 23. Or:
97 will display all the Pool resource records.
99 The maximum command line length is limited to 511 characters, so if you
100 are scripting the console, you may need to take some care to limit the
103 \section{Stopping the Console Program}
104 \index[general]{Program!Stopping the Console}
105 \index[general]{Stopping the Console Program}
107 Normally, you simply enter {\bf quit} or {\bf exit} and the Console program
108 will terminate. However, it waits until the Director acknowledges the command.
109 If the Director is already doing a lengthy command (e.g. prune), it may take
110 some time. If you want to immediately terminate the Console program, enter the
113 There is currently no way to interrupt a Console command once issued (i.e.
114 Ctrl-C does not work). However, if you are at a prompt that is asking you to
115 select one of several possibilities and you would like to abort the command,
116 you can enter a period ({\bf .}), and in most cases, you will either be
117 returned to the main command prompt or if appropriate the previous prompt (in
118 the case of nested prompts). In a few places such as where it is asking for a
119 Volume name, the period will be taken to be the Volume name. In that case, you
120 will most likely be able to cancel at the next prompt.
123 \section{Alphabetic List of Console Keywords}
124 \index[general]{Keywords!Alphabetic List of Console}
125 \index[general]{Alphabetic List of Console Keywords}
126 Unless otherwise specified, each of the following keywords
127 takes an argument, which is specified after the keyword following
128 an equal sign. For example:
134 Please note, this list is incomplete as it is currently in
135 the process of being created and is not currently totally in
141 Permitted on the python command, and causes the Python
142 interpreter to be restarted. Takes no argument.
144 Permitted on the status and show commands to specify all components or
145 resources respectively.
147 Permitted on the update command to specify that all Volumes in the
148 pool (specified on the command line) should be updated.
150 Permitted on the update command to specify that all Volumes in all
151 pools should be updated.
153 Used in the restore command.
155 Used in the restore command.
157 Allowed in the use command to specify the catalog name
160 Used in the show command. Takes no arguments.
163 Used in the show, list, and llist commands. Takes no arguments.
165 Used in the show command. Takes no arguments.
167 Used in the restore command. Takes no argument.
169 Used to define the number of days the "list nextvol" command
170 should consider when looking for jobs to be run. The days keyword
171 can also be used on the "status dir" command so that it will display
172 jobs scheduled for the number of days you want.
174 Used in the show command. Takes no arguments.
175 \item [dir | director]
177 Used in the show command. Takes no arguments.
179 Used in the restore command. Its argument specifies the directory
182 This keyword can appear on the {\bf update volume} as well
183 as the {\bf update slots} commands, and can
184 allows one of the following arguments: yes, true, no, false, archived,
185 0, 1, 2. Where 0 corresponds to no or false, 1 corresponds to yes or true, and
186 2 corresponds to archived. Archived volumes will not be used, nor will
187 the Media record in the catalog be pruned. Volumes that are not enabled,
188 will not be used for backup or restore.
190 Used in the restore command. Takes no argument.
192 Used in the restore command.
194 Used in the list and llist commands. Takes no arguments.
197 Used in the show command. Takes no arguments.
199 Used in the show command. Takes no arguments.
201 Used in the show, list and llist commands. Takes no arguments.
203 Used in the list and llist commands. Takes no arguments.
205 Used in the list and llist commands. Takes no arguments.
207 The JobId is the numeric jobid that is printed in the Job
208 Report output. It is the index of the database record for the
209 given job. While it is unique for all the existing Job records
210 in the catalog database, the same JobId can be reused once a
211 Job is removed from the catalog. Probably you will refer
212 specific Jobs that ran using their numeric JobId.
213 \item [job | jobname]
214 The Job or Jobname keyword refers to the name you specified
215 in the Job resource, and hence it refers to any number of
216 Jobs that ran. It is typically useful if you want to list
217 all jobs of a particular name.
220 Permitted on the estimate command. Takes no argument.
223 Used in the show command. Takes no arguments.
225 Used in the list and llist commands. Takes no arguments.
226 \item [nextvol | nextvolume]
227 Used in the list and llist commands. Takes no arguments.
234 Used in the show, list, and llist commands. Takes no arguments.
236 Used in the restore command. Takes no argument.
238 Used in the setbandwidth command. Takes integer in KB/s unit.
240 Used in the show command. Takes no arguments.
242 Used in the show command. Takes no arguments.
243 \item [sd | store | storage]
245 The ujobid is a unique job identification that is printed
246 in the Job Report output. At the current time, it consists
247 of the Job name (from the Name directive for the job) appended
248 with the date and time the job was run. This keyword is useful
249 if you want to completely identify the Job instance run.
252 Used in the list and llist commands. Takes no arguments.
254 Used in the restore command.
256 Used in the restore command. Takes no argument.
260 \section{Alphabetic List of Console Commands}
261 \index[general]{Commands!Alphabetic List of Console}
262 \index[general]{Alphabetic List of Console Commands}
263 \index[general]{Commands!Alphabetic List of Console}
264 \index[general]{Alphabetic List of Console Commands}
266 The following commands are currently implemented:
269 \item [{add [pool=\lt{}pool-name\gt{} storage=\lt{}storage\gt{}
270 jobid=\lt{}JobId\gt{}]} ]
272 This command is used to add Volumes to an existing Pool. That is,
273 it creates the Volume name in the catalog and inserts into the Pool
274 in the catalog, but does not attempt to access the physical Volume.
276 added, \mbacula{} expects that Volume to exist and to be labeled.
277 This command is not normally used since \mbacula{} will
278 automatically do the equivalent when Volumes are labeled. However,
279 there may be times when you have removed a Volume from the catalog
280 and want to later add it back.
282 Normally, the {\bf label} command is used rather than this command
283 because the {\bf label} command labels the physical media (tape, disk,
284 DVD, ...) and does the equivalent of the {\bf add} command. The {\bf
285 add} command affects only the Catalog and not the physical media (data
286 on Volumes). The physical media must exist and be labeled before use
287 (usually with the {\bf label} command). This command can, however, be
288 useful if you wish to add a number of Volumes to the Pool that will be
289 physically labeled at a later time. It can also be useful if you are
290 importing a tape from another site. Please see the {\bf label} command
291 below for the list of legal characters in a Volume name.
293 \item [autodisplay on/off]
294 \index[general]{autodisplay on/off}
295 This command accepts {\bf on} or {\bf off} as an argument, and turns
296 auto-display of messages on or off respectively. The default for the
297 console program is {\bf off}, which means that you will be notified when
298 there are console messages pending, but they will not automatically be
301 When autodisplay is turned off, you must explicitly retrieve the
302 messages with the {\bf messages} command. When autodisplay is turned
303 on, the messages will be displayed on the console as they are received.
305 \item [automount on/off]
306 \index[general]{automount on/off}
307 This command accepts {\bf on} or {\bf off} as the argument, and turns
308 auto-mounting of the Volume after a {\bf label} command on or off
309 respectively. The default is {\bf on}. If {\bf automount} is turned
310 off, you must explicitly {\bf mount} tape Volumes after a label command to
313 \item [{cancel [jobid=\lt{}number\gt{} job=\lt{}job-name\gt{} ujobid=\lt{}unique-jobid\gt{}]}]
314 \index[general]{cancel jobid}
315 This command is used to cancel a job and accepts {\bf jobid=nnn} or {\bf
316 job=xxx} as an argument where nnn is replaced by the JobId and xxx is
317 replaced by the job name. If you do not specify a keyword, the Console
318 program will prompt you with the names of all the active jobs allowing
321 Once a Job is marked to be canceled, it may take a bit of time
322 (generally within a minute but up to two hours) before the Job actually
323 terminates, depending on what operations it is doing.
324 Don't be surprised that you receive a Job not found message. That just
325 means that one of the three daemons had already canceled the job.
326 Messages numbered in the 1000's are from the Director, 2000's are from
327 the File daemon and 3000's from the Storage daemon.
330 \item [{create [pool=\lt{}pool-name\gt{}]}]
331 \index[general]{create pool}
332 This command is not normally used as the Pool records are automatically
333 created by the Director when it starts based on what it finds in
334 the conf file. If needed, this command can be
335 to create a Pool record in the database using the
336 Pool resource record defined in the Director's configuration file. So
337 in a sense, this command simply transfers the information from the Pool
338 resource in the configuration file into the Catalog. Normally this
339 command is done automatically for you when the Director starts providing
340 the Pool is referenced within a Job resource. If you use this command
341 on an existing Pool, it will automatically update the Catalog to have
342 the same information as the Pool resource. After creating a Pool, you
343 will most likely use the {\bf label} command to label one or more
344 volumes and add their names to the Media database.
346 When starting a Job, if \mbacula{} determines that there is no Pool record
347 in the database, but there is a Pool resource of the appropriate name,
348 it will create it for you. If you want the Pool record to appear in the
349 database immediately, simply use this command to force it to be created.
351 \item [{delete [volume=\lt{}vol-name\gt{} pool=\lt{}pool-name\gt{} job
352 jobid=\lt{}id\gt{}]}]
353 \index[general]{delete}
354 The delete command is used to delete a Volume, Pool or Job record from
355 the Catalog as well as all associated catalog Volume records that were
356 created. This command operates only on the Catalog database and has no
357 effect on the actual data written to a Volume. This command can be
358 dangerous and we strongly recommend that you do not use it unless you
359 know what you are doing.
361 If the keyword {\bf Volume} appears on the command line, the named
362 Volume will be deleted from the catalog, if the keyword {\bf Pool}
363 appears on the command line, a Pool will be deleted, and if the keyword
364 {\bf Job} appears on the command line, a Job and all its associated
365 records (File and JobMedia) will be deleted from the catalog. The full
366 form of this command is:
369 delete pool=<pool-name>
375 delete volume=<volume-name> pool=<pool-name> or
379 delete JobId=<job-id> JobId=<job-id2> ... or
383 delete Job JobId=n,m,o-r,t ...
386 The first form deletes a Pool record from the catalog database. The
387 second form deletes a Volume record from the specified pool in the
388 catalog database. The third form deletes the specified Job record from
389 the catalog database. The last form deletes JobId records for JobIds
390 n, m, o, p, q, r, and t. Where each one of the n,m,... is, of course, a
391 number. That is a "delete jobid" accepts lists and ranges of
394 \item [disable job\lt{}job-name\gt{}]
395 \index[general]{disable}
396 This command permits you to disable a Job for automatic scheduling.
397 The job may have been previously enabled with the Job resource
398 {\bf Enabled} directive or using the console {\bf enable} command.
399 The next time the Director is restarted or the conf file is reloaded,
400 the Enable/Disable state will be set to the value in the Job resource
401 (default enabled) as defined in the bacula-dir.conf file.
403 \item [enable job\lt{}job-name\gt{}]
404 \index[general]{enable}
405 This command permits you to enable a Job for automatic scheduling.
406 The job may have been previously disabled with the Job resource
407 {\bf Enabled} directive or using the console {\bf disable} command.
408 The next time the Director is restarted or the conf file is reloaded,
409 the Enable/Disable state will be set to the value in the Job resource
410 (default enabled) as defined in the bacula-dir.conf file.
414 \index[general]{estimate}
415 Using this command, you can get an idea how many files will be backed
416 up, or if you are unsure about your Include statements in your FileSet,
417 you can test them without doing an actual backup. The default is to
418 assume a Full backup. However, you can override this by specifying a
419 {\bf level=Incremental} or {\bf level=Differential} on the command line.
420 A Job name must be specified or you will be prompted for one, and
421 optionally a Client and FileSet may be specified on the command line.
422 It then contacts the client which computes the number of files and bytes
423 that would be backed up. Please note that this is an estimate
424 calculated from the number of blocks in the file rather than by reading
425 the actual bytes. As such, the estimated backup size will generally be
426 larger than an actual backup.
428 The \texttt{estimate} command can use the accurate code to detect changes
429 and give a better estimation. You can set the accurate behavior on command
430 line using \texttt{accurate=yes/no} or use the Job setting as default value.
432 Optionally you may specify the keyword {\bf listing} in which case, all the
433 files to be backed up will be listed. Note, it could take quite some time to
434 display them if the backup is large. The full form is:
437 estimate job=<job-name> listing client=<client-name> accurate=<yes/no>
438 fileset=<fileset-name> level=<level-name>
441 Specification of the {\bf job} is sufficient, but you can also override the
442 client, fileset, accurate and/or level by specifying them on the estimate
446 As an example, you might do:
451 estimate job=NightlySave listing level=Incremental
456 which will do a full listing of all files to be backed up for the Job {\bf
457 NightlySave} during an Incremental save and put it in the file {\bf
458 /tmp/listing}. Note, the byte estimate provided by this command is
459 based on the file size contained in the directory item. This can give
460 wildly incorrect estimates of the actual storage used if there are
461 sparse files on your systems. Sparse files are often found on 64 bit
462 systems for certain system files. The size that is returned is the size
463 \mbacula{} will backup if the sparse option is not specified in the FileSet.
464 There is currently no way to get an estimate of the real file size that
465 would be found should the sparse option be enabled.
468 \index[general]{exit}
469 This command terminates the console program.
473 Invoke the non-interactive gui mode.
479 \index[general]{help}
480 This command displays the list of commands available.
483 \index[general]{label}
484 \index[general]{relabel}
485 This command is used to label physical volumes. The full form of this command
489 label storage=<storage-name> volume=<volume-name>
493 If you leave out any part, you will be prompted for it. The media type
494 is automatically taken from the Storage resource definition that you
495 supply. Once the necessary information is obtained, the Console program
496 contacts the specified Storage daemon and requests that the Volume be
497 labeled. If the Volume labeling is successful, the Console program will
498 create a Volume record in the appropriate Pool.
500 The Volume name is restricted to letters, numbers, and the special
501 characters hyphen ({\bf -}), underscore ({\bf \_}), colon ({\bf :}), and
502 period ({\bf .}). All other characters including a space are invalid.
503 This restriction is to ensure good readability of Volume names to reduce
506 Please note, when labeling a blank tape, \mbacula{} will get {\bf read I/O
507 error} when it attempts to ensure that the tape is not already labeled. If
508 you wish to avoid getting these messages, please write an EOF mark on
509 your tape before attempting to label it:
519 The label command can fail for a number of reasons:
522 \item The Volume name you specify is already in the Volume database.
524 \item The Storage daemon has a tape or other Volume already mounted on the
525 device, in which case you must {\bf unmount} the device, insert a blank
526 tape, then do the {\bf label} command.
528 \item The Volume in the device is already a \mbacula{} labeled Volume. (\mbacula{} will
529 never relabel a \mbacula{} labeled Volume unless it is recycled and you use the
530 {\bf relabel} command).
532 \item There is no Volume in the drive.
535 There are two ways to relabel a volume that already has a \mbacula{} label. The
536 brute force method is to write an end of file mark on the tape using the
537 system {\bf mt} program, something like the following:
541 mt -f /dev/st0 rewind
546 For a disk volume, you would manually delete the Volume.
548 Then you use the {\bf label} command to add a new label. However, this could
549 leave traces of the old volume in the catalog.
551 The preferable method to relabel a Volume is to first {\bf purge} the volume,
552 either automatically, or explicitly with the {\bf purge} command, then use
553 the {\bf relabel} command described below.
555 If your autochanger has barcode labels, you can label all the Volumes in
556 your autochanger one after another by using the {\bf label barcodes}
557 command. For each tape in the changer containing a barcode, \mbacula{} will
558 mount the tape and then label it with the same name as the barcode. An
559 appropriate Media record will also be created in the catalog. Any barcode
560 that begins with the same characters as specified on the
561 "CleaningPrefix=xxx" directive in the Director's Pool resource, will be
562 treated as a cleaning tape, and will not be labeled. However, an entry for
563 the cleaning tape will be created in the catalog. For example with:
569 Cleaning Prefix = "CLN"
575 Any slot containing a barcode of CLNxxxx will be treated as a cleaning tape
576 and will not be mounted. Note, the full form of the command is:
580 label storage=xxx pool=yyy slots=1-5,10 barcodes
585 \index[general]{list}
586 The list command lists the requested contents of the Catalog. The
587 various fields of each record are listed on a single line. The various
588 forms of the list command are:
593 list jobid=<id> (list jobid id)
595 list ujobid=<unique job name> (list job with unique name)
597 list job=<job-name> (list all jobs with "job-name")
599 list jobname=<job-name> (same as above)
601 In the above, you can add "limit=nn" to limit the output to
604 list joblog jobid=<id> (list job output if recorded in the catalog)
608 list jobmedia jobid=<id>
610 list jobmedia job=<job-name>
612 list files jobid=<id>
614 list files job=<job-name>
624 list volumes jobid=<id>
626 list volumes pool=<pool-name>
628 list volumes job=<job-name>
630 list volume=<volume-name>
632 list nextvolume job=<job-name>
634 list nextvol job=<job-name>
636 list nextvol job=<job-name> days=nnn
641 What most of the above commands do should be more or less obvious. In
642 general if you do not specify all the command line arguments, the
643 command will prompt you for what is needed.
645 The {\bf list nextvol} command will print the Volume name to be used by
646 the specified job. You should be aware that exactly what Volume will be
647 used depends on a lot of factors including the time and what a prior job
648 will do. It may fill a tape that is not full when you issue this
649 command. As a consequence, this command will give you a good estimate
650 of what Volume will be used but not a definitive answer. In addition,
651 this command may have certain side effect because it runs through the
652 same algorithm as a job, which means it may automatically purge or
653 recycle a Volume. By default, the job specified must run within the
654 next two days or no volume will be found. You can, however, use the
655 {\bf days=nnn} specification to specify up to 50 days. For example,
656 if on Friday, you want to see what Volume will be needed on Monday,
657 for job MyJob, you would use {\bf list nextvol job=MyJob days=3}.
659 If you wish to add specialized commands that list the contents of the
660 catalog, you can do so by adding them to the {\bf query.sql} file.
661 However, this takes some knowledge of programming SQL. Please see the
662 {\bf query} command below for additional information. See below for
663 listing the full contents of a catalog record with the {\bf llist}
666 As an example, the command {\bf list pools} might produce the following
671 +------+---------+---------+---------+----------+-------------+
672 | PoId | Name | NumVols | MaxVols | PoolType | LabelFormat |
673 +------+---------+---------+---------+----------+-------------+
674 | 1 | Default | 0 | 0 | Backup | * |
675 | 2 | Recycle | 0 | 8 | Backup | File |
676 +------+---------+---------+---------+----------+-------------+
680 As mentioned above, the {\bf list} command lists what is in the
681 database. Some things are put into the database immediately when \mbacula{}
682 starts up, but in general, most things are put in only when they are
683 first used, which is the case for a Client as with Job records, etc.
685 \mbacula{} should create a client record in the database the first time you
686 run a job for that client. Doing a {\bf status} will not cause a
687 database record to be created. The client database record will be
688 created whether or not the job fails, but it must at least start. When
689 the Client is actually contacted, additional info from the client will
690 be added to the client record (a "uname -a" output).
692 If you want to see what Client resources you have available in your conf
693 file, you use the Console command {\bf show clients}.
696 \index[general]{llist}
697 The llist or "long list" command takes all the same arguments that the
698 list command described above does. The difference is that the llist
699 command list the full contents of each database record selected. It
700 does so by listing the various fields of the record vertically, with one
701 field per line. It is possible to produce a very large number of output
702 lines with this command.
704 If instead of the {\bf list pools} as in the example above, you enter
705 {\bf llist pools} you might get the following output:
716 VolRetention: 1,296,000
717 VolUseDuration: 86,400
733 VolUseDuration: 3,600
745 \index[general]{messages}
746 This command causes any pending console messages to be immediately displayed.
749 \index[general]{memory}
750 Print current memory usage.
754 \index[general]{mount}
755 The mount command is used to get \mbacula{} to read a volume on a physical
756 device. It is a way to tell \mbacula{} that you have mounted a tape and
757 that \mbacula{} should examine the tape. This command is normally
758 used only after there was no Volume in a drive and \mbacula{} requests you to mount a new
759 Volume or when you have specifically unmounted a Volume with the {\bf
760 unmount} console command, which causes \mbacula{} to close the drive. If
761 you have an autoloader, the mount command will not cause \mbacula{} to
762 operate the autoloader unless you specify a {\bf slot} and possibly a
763 {\bf drive}. The various forms of the mount command are:
765 mount storage=<storage-name> [ slot=<num> ] [
771 mount [ jobid=<id> | job=<job-name> ]
773 If you have specified {\bf Automatic Mount = yes} in the Storage daemon's
774 Device resource, under most circumstances, \mbacula{} will automatically access
775 the Volume unless you have explicitly {\bf unmount}ed it in the Console
778 \label{ManualPruning}
780 \index[general]{prune}
781 The Prune command allows you to safely remove expired database records from
782 Jobs, Volumes and Statistics. This command works only on the Catalog
783 database and does not affect data written to Volumes. In all cases, the
784 Prune command applies a retention period to the specified records. You can
785 Prune expired File entries from Job records; you can Prune expired Job
786 records from the database, and you can Prune both expired Job and File
787 records from specified Volumes.
789 prune files|jobs|volume|stats client=<client-name>
792 For a Volume to be pruned, the {\bf VolStatus} must be Full, Used, or
793 Append, otherwise the pruning will not take place.
796 \index[general]{purge}
797 The Purge command will delete associated Catalog database records from
798 Jobs and Volumes without considering the retention period. {\bf Purge}
799 works only on the Catalog database and does not affect data written to
800 Volumes. This command can be dangerous because you can delete catalog
801 records associated with current backups of files, and we recommend that
802 you do not use it unless you know what you are doing. The permitted
803 forms of {\bf purge} are:
805 purge files jobid=<jobid>|job=<job-name>|client=<client-name>
808 purge jobs client=<client-name> (of all jobs)
811 purge volume|volume=<vol-name> (of all jobs)
813 For the {\bf purge} command to work on Volume Catalog database records the
814 {\bf VolStatus} must be Append, Full, Used, or Error.
816 The actual data written to the Volume will be unaffected by this command unless
817 you are using the \texttt{ActionOnPurge=Truncate} option on those Media.
819 To ask \mbacula{} to truncate your \texttt{Purged} volumes, you need to use the
820 following command in interactive mode or in a RunScript:
822 *purge volume action=truncate storage=File allpools
823 # or by default, action=all
824 *purge volume action storage=File pool=Default
827 This is possible to specify the volume name, the media type, the pool, the
828 storage, etc\dots (see \texttt{help purge}) Be sure that your storage device is
829 idle when you decide to run this command.
832 \index[general]{python}
833 The python command takes a single argument {\bf restart}:
837 This causes the Python interpreter in the Director to be reinitialized.
838 This can be helpful for testing because once the Director starts and the
839 Python interpreter is initialized, there is no other way to make it
840 accept any changes to the startup script {\bf DirStartUp.py}. For more
841 details on Python scripting, please see the \bsysxrlink{Python Scripting}
842 {PythonChapter}{misc}{chapter} of the \miscman{}.
845 \index[general]{query}
846 This command reads a predefined SQL query from the query file (the name and
847 location of the query file is defined with the QueryFile resource record in
848 the Director's configuration file). You are prompted to select a query from
849 the file, and possibly enter one or more parameters, then the command is
850 submitted to the Catalog database SQL engine.
852 The following queries are currently available (version 2.2.7):
857 1: List up to 20 places where a File is saved regardless of the directory
858 2: List where the most recent copies of a file are saved
859 3: List last 20 Full Backups for a Client
860 4: List all backups for a Client after a specified time
861 5: List all backups for a Client
862 6: List Volume Attributes for a selected Volume
863 7: List Volumes used by selected JobId
864 8: List Volumes to Restore All Files
865 9: List Pool Attributes for a selected Pool
866 10: List total files/bytes by Job
867 11: List total files/bytes by Volume
868 12: List Files for a selected JobId
869 13: List Jobs stored on a selected MediaId
870 14: List Jobs stored for a given Volume name
871 15: List Volumes Bacula thinks are in changer
872 16: List Volumes likely to need replacement from age or errors
873 Choose a query (1-16):
878 \index[general]{quit}
879 This command terminates the console program. The console program sends the
880 {\bf quit} request to the Director and waits for acknowledgment. If the
881 Director is busy doing a previous command for you that has not terminated, it
882 may take some time. You may quit immediately by issuing the {\bf .quit}
883 command (i.e. quit preceded by a period).
886 \index[general]{relabel}
887 This command is used to label physical volumes. The full form of this
890 relabel storage=<storage-name> oldvolume=<old-volume-name>
891 volume=<newvolume-name>
893 If you leave out any part, you will be prompted for it. In order for
894 the Volume (old-volume-name) to be relabeled, it must be in the catalog,
895 and the volume status must be marked {\bf Purged} or {\bf Recycle}.
896 This happens automatically as a result of applying retention periods, or
897 you may explicitly purge the volume using the {\bf purge} command.
899 Once the volume is physically relabeled, the old data previously written
900 on the Volume is lost and cannot be recovered.
903 \index[general]{release}
904 This command is used to cause the Storage daemon to rewind (release) the
905 current tape in the drive, and to re-read the Volume label the next time
908 release storage=<storage-name>
910 After a release command, the device is still kept open by \mbacula{} (unless
911 Always Open is set to No in the Storage Daemon's configuration) so it
912 cannot be used by another program. However, with some tape drives, the
913 operator can remove the current tape and to insert a different one, and
914 when the next Job starts, \mbacula{} will know to re-read the tape label to
915 find out what tape is mounted. If you want to be able to use the drive
916 with another program (e.g. {\bf mt}), you must use the {\bf unmount}
917 command to cause \mbacula{} to completely release (close) the device.
920 \index[general]{reload}
921 The reload command causes the Director to re-read its configuration
922 file and apply the new values. The new values will take effect
923 immediately for all new jobs. However, if you change schedules,
924 be aware that the scheduler pre-schedules jobs up to two hours in
925 advance, so any changes that are to take place during the next two
926 hours may be delayed. Jobs that have already been scheduled to run
927 (i.e. surpassed their requested start time) will continue with the
928 old values. New jobs will use the new values. Each time you issue
929 a reload command while jobs are running, the prior config values
930 will queued until all jobs that were running before issuing
931 the reload terminate, at which time the old config values will
932 be released from memory. The Directory permits keeping up to
933 ten prior set of configurations before it will refuse a reload
934 command. Once at least one old set of config values has been
935 released it will again accept new reload commands.
937 While it is possible to reload the Director's configuration on the fly,
938 even while jobs are executing, this is a complex operation and not
939 without side effects. Accordingly, if you have to reload the Director's
940 configuration while \mbacula{} is running, it is advisable to restart the
941 Director at the next convenient opportunity.
943 \label{restore_command}
945 \index[general]{restore}
946 The restore command allows you to select one or more Jobs (JobIds) to be
947 restored using various methods. Once the JobIds are selected, the File
948 records for those Jobs are placed in an internal \mbacula{} directory tree,
949 and the restore enters a file selection mode that allows you to
950 interactively walk up and down the file tree selecting individual files
951 to be restored. This mode is somewhat similar to the standard Unix {\bf
952 restore} program's interactive file selection mode.
954 restore storage=<storage-name> client=<backup-client-name> where=<path> pool=<pool-name> fileset=<fileset-name> restoreclient=<restore-client-name> select current all done
956 Where {\bf current}, if specified, tells the restore command to
957 automatically select a restore to the most current backup. If not
958 specified, you will be prompted. The {\bf all} specification tells the
959 restore command to restore all files. If it is not specified, you will
960 be prompted for the files to restore. For details of the {\bf restore}
961 command, please see the \bsysxrlink{Restore}{RestoreChapter}{main}{chapter}
964 The client keyword initially specifies the client from which the backup
965 was made and the client to which the restore will be make. However,
966 if the restoreclient keyword is specified, then the restore is written
971 This command allows you to schedule jobs to be run immediately. The full form
974 run job=<job-name> client=<client-name>
975 fileset=<FileSet-name> level=<level-keyword>
976 storage=<storage-name> where=<directory-prefix>
977 when=<universal-time-specification> spooldata=yes|no yes
979 Any information that is needed but not specified will be listed for
980 selection, and before starting the job, you will be prompted to accept,
981 reject, or modify the parameters of the job to be run, unless you have
982 specified {\bf yes}, in which case the job will be immediately sent to
985 On my system, when I enter a run command, I get the following prompt:
989 A job name must be specified.
990 The defined Job resources are:
1000 Select Job resource (1-9):
1005 If I then select number 5, I am prompted with:
1011 FileSet: Minou Full Set
1016 When: 2003-04-23 17:08:18
1017 OK to run? (yes/mod/no):
1022 If I now enter {\bf yes}, the Job will be run. If I enter {\bf mod}, I will
1023 be presented with the following prompt.
1027 Parameters to modify:
1035 Select parameter to modify (1-7):
1040 If you wish to start a job at a later time, you can do so by setting the When
1041 time. Use the {\bf mod} option and select {\bf When} (no. 6). Then enter the
1042 desired start time in \texttt{YYYY-MM-DD HH:MM:SS} format.
1044 The spooldata argument of the run command cannot be modified through the menu
1045 and is only accessible by setting its value on the intial command line. If
1046 no spooldata flag is set, the job, storage or schedule flag is used.
1049 \index[general]{setbandwidth}
1050 This command is used to limit the bandwidth of a running job or a client.
1052 setbandwidth limit=<nb> [ jobid=<id> | client=<cli> ]
1055 \index[general]{setdebug}
1056 \index[general]{Debugging}
1057 \index[general]{Debugging Win32}
1058 \index[general]{Windows!debugging}
1059 This command is used to set the debug level in each daemon. The form of this
1062 setdebug level=nn [trace=0/1 client=<client-name> | dir | director |
1063 storage=<storage-name> | all]
1065 If \texttt{trace=1} is set, then tracing will be enabled, and the daemon will be
1066 placed in trace mode, which means that all debug output as set by the
1067 debug level will be directed to the file {\bf bacula.trace} in the
1068 current directory of the daemon. Normally, tracing is needed only for
1069 Win32 clients where the debug output cannot be written to a terminal or
1070 redirected to a file. When tracing, each debug output message is
1071 appended to the trace file. You must explicitly delete the file when
1075 \index[general]{setip}
1076 Sets new client address -- if authorized.
1078 A console is authorized to use the {\bf SetIP} command only if it has a
1079 Console resource definition in both the Director and the Console. In
1080 addition, if the console name, provided on the {\bf Name =} directive,
1081 must be the same as a Client name, the user of that console is permitted
1082 to use the {\bf SetIP} command to change the Address directive in the
1083 Director's client resource to the IP address of the Console. This
1084 permits portables or other machines using DHCP (non-fixed IP addresses)
1085 to "notify" the Director of their current IP address.
1090 \index[general]{show}
1091 The show command will list the Director's resource records as defined in
1092 the Director's configuration file (normally {\bf bacula-dir.conf}).
1093 This command is used mainly for debugging purposes by developers.
1094 The following keywords are accepted on the
1095 show command line: catalogs, clients, counters, devices, directors,
1096 filesets, jobs, messages, pools, schedules, storages, all, help.
1097 Please don't confuse this command
1098 with the {\bf list}, which displays the contents of the catalog.
1101 \index[general]{sqlquery}
1102 The sqlquery command puts the Console program into SQL query mode where
1103 each line you enter is concatenated to the previous line until a
1104 semicolon (;) is seen. The semicolon terminates the command, which is
1105 then passed directly to the SQL database engine. When the output from
1106 the SQL engine is displayed, the formation of a new SQL command begins.
1107 To terminate SQL query mode and return to the Console command prompt,
1108 you enter a period (.) in column 1.
1110 Using this command, you can query the SQL catalog database directly.
1111 Note you should really know what you are doing otherwise you could
1112 damage the catalog database. See the {\bf query} command below for
1113 simpler and safer way of entering SQL queries.
1115 Depending on what database engine you are using (MySQL, PostgreSQL or
1116 SQLite), you will have somewhat different SQL commands available. For
1117 more detailed information, please refer to the MySQL, PostgreSQL or
1118 SQLite documentation.
1121 \index[general]{status}
1123 This command will display the status of all components. For the director, it
1124 will display the next jobs that are scheduled during the next 24 hours as
1125 well as the status of currently running jobs. For the Storage Daemon, you
1126 will have drive status or autochanger content. The File Daemon will give you
1127 information about current jobs like average speed or file accounting. The
1128 full form of this command is:
1130 status [all | dir=<dir-name> | director [days=nnn] |
1131 client=<client-name> | [slots] storage=<storage-name>]
1133 If you do a {\bf status dir}, the console will list any currently
1134 running jobs, a summary of all jobs scheduled to be run in the next 24
1135 hours, and a listing of the last ten terminated jobs with their statuses.
1136 The scheduled jobs summary will include the Volume name to be used. You
1137 should be aware of two things: 1. to obtain the volume name, the code
1138 goes through the same code that will be used when the job runs, but it
1139 does not do pruning nor recycling of Volumes; 2. The Volume listed is
1140 at best a guess. The Volume actually used may be different because of
1141 the time difference (more durations may expire when the job runs) and
1142 another job could completely fill the Volume requiring a new one.
1144 In the Running Jobs listing, you may find the following types of
1150 2507 Catalog MatouVerify.2004-03-13_05.05.02 is waiting execution
1151 5349 Full CatalogBackup.2004-03-13_01.10.00 is waiting for higher
1152 priority jobs to finish
1153 5348 Differe Minou.2004-03-13_01.05.09 is waiting on max Storage jobs
1154 5343 Full Rufus.2004-03-13_01.05.04 is running
1158 Looking at the above listing from bottom to top, obviously JobId 5343
1159 (Rufus) is running. JobId 5348 (Minou) is waiting for JobId 5343 to
1160 finish because it is using the Storage resource, hence the "waiting on
1161 max Storage jobs". JobId 5349 has a lower priority than all the other
1162 jobs so it is waiting for higher priority jobs to finish, and finally,
1163 JobId 2507 (MatouVerify) is waiting because only one job can run at a
1164 time, hence it is simply "waiting execution"
1166 If you do a {\bf status dir}, it will by default list the first
1167 occurrence of all jobs that are scheduled today and tomorrow. If you
1168 wish to see the jobs that are scheduled in the next three days (e.g. on
1169 Friday you want to see the first occurrence of what tapes are scheduled
1170 to be used on Friday, the weekend, and Monday), you can add the {\bf
1171 days=3} option. Note, a {\bf days=0} shows the first occurrence of jobs
1172 scheduled today only. If you have multiple run statements, the first
1173 occurrence of each run statement for the job will be displayed for the
1176 If your job seems to be blocked, you can get a general idea of the
1177 problem by doing a {\bf status dir}, but you can most often get a
1178 much more specific indication of the problem by doing a
1179 {\bf \texttt{status storage=xxx}}. For example, on an idle test system, when
1180 I do {\bf \texttt{status storage=File}}, I get:
1184 Connecting to Storage daemon File at 192.168.68.112:8103
1186 rufus-sd Version: 1.39.6 (24 March 2006) i686-pc-linux-gnu redhat (Stentz)
1187 Daemon started 26-Mar-06 11:06, 0 Jobs run since started.
1193 Jobs waiting to reserve a drive:
1197 JobId Level Files Bytes Status Finished Name
1198 ======================================================================
1199 59 Full 234 4,417,599 OK 15-Jan-06 11:54 kernsave
1203 Autochanger "DDS-4-changer" with devices:
1205 Device "DDS-4" (/dev/nst0) is mounted with Volume="TestVolume002"
1207 Slot 2 is loaded in drive 0.
1208 Total Bytes Read=0 Blocks Read=0 Bytes/block=0
1209 Positioned at File=0 Block=0
1211 Device "DVD-Writer" (/dev/hdc) is not open.
1212 Device "File" (/tmp) is not open.
1215 In Use Volume status:
1220 Now, what this tells me is that no jobs are running and that none of
1221 the devices are in use. Now, if I {\bf unmount} the autochanger, which
1222 will not be used in this example, and then start a Job that uses the
1223 File device, the job will block. When I re-issue the status storage
1224 command, I get for the Device status:
1231 Autochanger "DDS-4-changer" with devices:
1233 Device "DDS-4" (/dev/nst0) is not open.
1234 Device is BLOCKED. User unmounted.
1235 Drive 0 is not loaded.
1237 Device "DVD-Writer" (/dev/hdc) is not open.
1238 Device "File" (/tmp) is not open.
1239 Device is BLOCKED waiting for media.
1245 Now, here it should be clear that if a job were running that wanted
1246 to use the Autochanger (with two devices), it would block because
1247 the user unmounted the device. The real problem for the Job I started
1248 using the "File" device is that the device is blocked waiting for
1249 media -- that is \mbacula{} needs you to label a Volume.
1252 \index[general]{time}
1253 Prints the current time.
1256 \index[general]{trace}
1257 Turn on/off trace to file.
1260 \index[general]{umount|see{unmount}}
1261 For old-time Unix guys. See the unmount command for full details.
1264 \index[general]{unmount}
1265 This command causes the indicated \mbacula{} Storage daemon to unmount the
1266 specified device. The forms of the command are the same as the mount command:
1269 unmount storage=<storage-name> [ drive=<num> ]
1271 unmount [ jobid=<id> | job=<job-name> ]
1275 Once you unmount a storage device, \mbacula{} will no longer be able to use
1276 it until you issue a mount command for that device. If \mbacula{} needs to
1277 access that device, it will block and issue mount requests periodically
1280 If the device you are unmounting is an autochanger, it will unload
1281 the drive you have specified on the command line. If no drive is
1282 specified, it will assume drive 1.
1284 \label{UpdateCommand}
1286 \index[general]{update}
1287 This command will update the catalog for either a specific Pool record, a Volume
1288 record, or the Slots in an autochanger with barcode capability. In the case
1289 of updating a Pool record, the new information will be automatically taken
1290 from the corresponding Director's configuration resource record. It can be
1291 used to increase the maximum number of volumes permitted or to set a maximum
1292 number of volumes. The following main keywords may be specified:
1295 media, volume, pool, slots, stats
1299 In the case of updating a Volume, you will be prompted for which value you
1300 wish to change. The following Volume parameters may be changed:
1306 Volume Retention Period
1309 Maximum Volume Files
1310 Maximum Volume Bytes
1318 All Volumes from Pool
1319 All Volumes from all Pools
1324 For slots {\bf update slots}, \mbacula{} will obtain a list of slots and
1325 their barcodes from the Storage daemon, and for each barcode found, it
1326 will automatically update the slot in the catalog Media record to
1327 correspond to the new value. This is very useful if you have moved
1328 cassettes in the magazine, or if you have removed the magazine and
1329 inserted a different one. As the slot of each Volume is updated, the
1330 InChanger flag for that Volume will also be set, and any other Volumes
1331 in the Pool that were last mounted on the same Storage device
1332 will have their InChanger flag turned off. This permits
1333 \mbacula{} to know what magazine (tape holder) is currently in the
1336 If you do not have barcodes, you can accomplish the same thing in
1337 version 1.33 and later by using the {\bf update slots scan} command.
1338 The {\bf scan} keyword tells \mbacula{} to physically mount each tape and to
1339 read its VolumeName.
1341 For Pool {\bf update pool}, \mbacula{} will move the Volume record from its
1342 existing pool to the pool specified.
1344 For {\bf Volume from Pool}, {\bf All Volumes from Pool} and {\bf All Volumes
1345 from all Pools}, the following values are updated from the Pool record:
1346 Recycle, RecyclePool, VolRetention, VolUseDuration, MaxVolJobs, MaxVolFiles,
1347 and MaxVolBytes. (RecyclePool feature is available with \mbacula{} 2.1.4 or
1350 The full form of the update command with all command line arguments is:
1354 update volume=xxx pool=yyy slots volstatus=xxx VolRetention=ddd
1355 VolUse=ddd MaxVolJobs=nnn MaxVolBytes=nnn Recycle=yes|no
1356 slot=nnn enabled=n recyclepool=zzz
1362 \index[general]{use}
1363 This command allows you to specify which Catalog database to use. Normally,
1364 you will be using only one database so this will be done automatically. In
1365 the case that you are using more than one database, you can use this command
1366 to switch from one to another.
1370 use [catalog=name-of-catalog]
1377 \index[general]{var name}
1378 This command takes a string or quoted string and does variable expansion on
1379 it the same way variable expansion is done on the {\bf LabelFormat} string.
1380 Thus, for the most part, you can test your LabelFormat strings. The
1381 difference between the {\bf var} command and the actual LabelFormat process
1382 is that during the var command, no job is running so "dummy" values are
1383 used in place of Job specific variables. Generally, however, you will get a
1384 good idea of what is going to happen in the real case.
1387 \index[general]{version}
1388 The command prints the Director's version.
1391 \index[general]{wait}
1392 The wait command causes the Director to pause until there are no jobs
1393 running. This command is useful in a batch situation such as regression
1394 testing where you wish to start a job and wait until that job completes
1395 before continuing. This command now has the following options:
1398 wait [jobid=nn] [jobuid=unique id] [job=job name]
1401 If specified with a specific JobId, ... the wait command will wait
1402 for that particular job to terminate before continuing.
1407 \section{Special dot Commands}
1408 \index[general]{Commands!Special dot (.)}
1409 \index[general]{Special dot (.) Commands}
1410 \index[general]{. commands}
1412 There is a list of commands that are prefixed with a period (.). These
1413 commands are intended to be used either by batch programs or graphical user
1414 interface front-ends. They are not normally used by interactive users. Once
1415 GUI development begins, this list will be considerably expanded. The following
1416 is the list of dot commands:
1420 .backups job=xxx list backups for specified job
1421 .clients list all client names
1422 .defaults client=xxx fileset=yyy list defaults for specified client
1423 .die cause the Director to segment fault (for debugging)
1424 .dir when in tree mode prints the equivalent to the dir command,
1425 but with fields separated by commas rather than spaces.
1427 .filesets list all fileset names
1428 .help help command output
1429 .jobs list all job names
1430 .levels list all levels
1431 .messages get quick messages
1432 .msgs return any queued messages
1433 .pools list all pool names
1435 .status get status output
1436 .storage return storage resource names
1437 .types list job types
1443 \section{Special At (@) Commands}
1444 \index[general]{Commands!Special At (\symbol{64})}
1445 \index[general]{Special At (\symbol{64}) Commands}
1446 \index[general]{\symbol{64} commands}
1448 Normally, all commands entered to the Console program are immediately
1449 forwarded to the Director, which may be on another machine, to be executed.
1450 However, there is a small list of {\bf at} commands, all beginning with an at
1451 character (@), that will not be sent to the Director, but rather interpreted
1452 by the Console program directly. Note, these commands are implemented only in
1453 the tty console program and not in the Bat Console. These commands are:
1457 \item [@input \lt{}filename\gt{}]
1458 \index[general]{\symbol{64}input \lt{}filename\gt{}}
1459 Read and execute the commands contained in the file specified.
1461 \item [@output \lt{}filename\gt{} w/a]
1462 \index[general]{\symbol{64}output \lt{}filename\gt{} w/a}
1463 Send all following output to the filename specified either overwriting the
1464 file (w) or appending to the file (a). To redirect the output to the
1465 terminal, simply enter {\bf @output} without a filename specification.
1466 WARNING: be careful not to overwrite a valid file. A typical example during a
1467 regression test might be:
1478 \item [@tee \lt{}filename\gt{} w/a]
1479 \index[general]{\symbol{64}tee \lt{}filename\gt{} w/a}
1480 Send all subsequent output to both the specified file and the terminal. It is
1481 turned off by specifying {\bf @tee} or {\bf @output} without a filename.
1483 \item [@sleep \lt{}seconds\gt{}]
1484 \index[general]{\symbol{64}sleep \lt{}seconds\gt{}}
1485 Sleep the specified number of seconds.
1488 \index[general]{\symbol{64}time}
1489 Print the current time and date.
1492 \index[general]{\symbol{64}version}
1493 Print the console's version.
1496 \index[general]{\symbol{64}quit}
1500 \index[general]{\symbol{64}exit}
1503 \item [@\# anything]
1504 \index[general]{anything}
1508 \index[general]{\symbol{64}help}
1509 Get the list of every special @ commands.
1511 \item [@separator \lt{}char\gt{}]
1512 \index[general]{\symbol{64}separator}
1513 When using bconsole with readline, you can set the command separator to one
1514 of those characters to write commands who require multiple input on one line,
1515 or to put multiple commands on a single line.
1517 !$%&'()*+,-/:;<>?[]^`{|}~
1520 Note, if you use a semicolon (;) as a separator character, which is
1521 common, you will not be able to use the {\bf sql} command, which
1522 requires each command to be terminated by a semicolon.
1527 \section{Running the Console from a Shell Script}
1528 \index[general]{Script!Running the Console Program from a Shell}
1529 \index[general]{Running the Console Program from a Shell Script}
1531 You can automate many Console tasks by running the console program from a
1532 shell script. For example, if you have created a file containing the following
1537 ./bconsole -c ./bconsole.conf <<END_OF_DATA
1538 unmount storage=DDS-4
1544 when that file is executed, it will unmount the current DDS-4 storage device.
1545 You might want to run this command during a Job by using the {\bf
1546 RunBeforeJob} or {\bf RunAfterJob} records.
1548 It is also possible to run the Console program from file input where the file
1549 contains the commands as follows:
1553 ./bconsole -c ./bconsole.conf <filename
1557 where the file named {\bf filename} contains any set of console commands.
1559 As a real example, the following script is part of the \mbacula{} regression
1560 tests. It labels a volume (a disk volume), runs a backup, then does a restore
1565 bin/bconsole -c bin/bconsole.conf <<END_OF_DATA
1568 @output /tmp/log1.out
1569 label volume=TestVolume001
1576 @output /tmp/log2.out
1587 The output from the backup is directed to /tmp/log1.out and the output from
1588 the restore is directed to /tmp/log2.out. To ensure that the backup and
1589 restore ran correctly, the output files are checked with:
1593 grep "^ *Termination: *Backup OK" /tmp/log1.out
1595 grep "^ *Termination: *Restore OK" /tmp/log2.out
1600 \section{Adding Volumes to a Pool}
1601 \index[general]{Adding Volumes to a Pool}
1602 \index[general]{Pool!Adding Volumes to a}
1604 If you have used the {\bf label} command to label a Volume, it will be
1605 automatically added to the Pool, and you will not need to add any media to the
1608 Alternatively, you may choose to add a number of Volumes to the pool without
1609 labeling them. At a later time when the Volume is requested by {\bf \mbacula{}}
1610 you will need to label it.
1612 Before adding a volume, you must know the following information:
1615 \item The name of the Pool (normally "Default")
1616 \item The Media Type as specified in the Storage Resource in the Director's
1617 configuration file (e.g. "DLT8000")
1618 \item The number and names of the Volumes you wish to create.
1621 For example, to add media to a Pool, you would issue the following commands to
1622 the console program:
1627 Enter name of Pool to add Volumes to: Default
1628 Enter the Media Type: DLT8000
1629 Enter number of Media volumes to create. Max=1000: 10
1630 Enter base volume name: Save
1631 Enter the starting number: 1
1632 10 Volumes created in pool Default
1637 To see what you have added, enter:
1641 *list media pool=Default
1642 +-------+----------+---------+---------+-------+------------------+
1643 | MedId | VolumeNa | MediaTyp| VolStat | Bytes | LastWritten |
1644 +-------+----------+---------+---------+-------+------------------+
1645 | 11 | Save0001 | DLT8000 | Append | 0 | 0000-00-00 00:00 |
1646 | 12 | Save0002 | DLT8000 | Append | 0 | 0000-00-00 00:00 |
1647 | 13 | Save0003 | DLT8000 | Append | 0 | 0000-00-00 00:00 |
1648 | 14 | Save0004 | DLT8000 | Append | 0 | 0000-00-00 00:00 |
1649 | 15 | Save0005 | DLT8000 | Append | 0 | 0000-00-00 00:00 |
1650 | 16 | Save0006 | DLT8000 | Append | 0 | 0000-00-00 00:00 |
1651 | 17 | Save0007 | DLT8000 | Append | 0 | 0000-00-00 00:00 |
1652 | 18 | Save0008 | DLT8000 | Append | 0 | 0000-00-00 00:00 |
1653 | 19 | Save0009 | DLT8000 | Append | 0 | 0000-00-00 00:00 |
1654 | 20 | Save0010 | DLT8000 | Append | 0 | 0000-00-00 00:00 |
1655 +-------+----------+---------+---------+-------+------------------+
1660 Notice that the console program automatically appended a number to the base
1661 Volume name that you specify (Save in this case). If you don't want it to
1662 append a number, you can simply answer 0 (zero) to the question "Enter number
1663 of Media volumes to create. Max=1000:", and in this case, it will create a
1664 single Volume with the exact name you specify.