
|
 |
Configuring Bacula
|
Index
|
Critical Items Before Going Production
|
|
|
Bacula Console
General
The Bacula Console (sometimes called the User Agent) is a program
that allows the user or the System Administrator, to interact with the
Bacula Director daemon while the daemon is running.
The current Bacula Console comes in two versions: a
shell interface (TTY style), and a GNOME GUI interface.
Both permit the administrator or authorized users to interact
with Bacula. You can determine the status of a particular
job, examine the contents of the Catalog as well as
perform certain tape manipulations with the Console program.
In addition, there is a wx-console built with wxWidgets that
allows a graphic restore of files. As of version 1.34.1 it is
in an early stage of development, but it quite useful.
Since the Console program interacts with the Director by
the network, your Console and Director programs do not necessarily
need to run on the same machine.
In fact, a certain minimal knowledge of the Console program is needed
in order for Bacula to be able to write on more than one tape, because
when Bacula requests a new tape, it waits until the user, via the
Console program, indicates that the new tape is mounted.
Configuration
When the Console starts, it reads a standard Bacula configuration file
named bconsole.conf or gnome-console.conf in the case of
the GNOME Console version. This file allows default configuration of
the Console, and at the current time, the only Resource Record defined
is the Director resource, which gives the Console the name and address
of the Director. For more information on configuration of the Console
program, please see the Console Configuration
File Chapter of this document.
Running the Console Program
After launching the Console program (bconsole), it will prompt you for
the next command with an asterisk (*). (Note, in the GNOME version, the
prompt is not present; you simply enter the commands you want in the
command text box at the bottom of the screen.) Generally, for all
commands, you can simply enter the command name and the Console program
will prompt you for the necessary arguments. Alternatively, in most
cases, you may enter the command followed by arguments. The general
format is:
<command> <keyword1>[=<argument1>] <keyword2>[=<argument2>] ...
where command is one of the commands listed below;
keyword is one of the keywords listed below (usually
followed by an argument); and argument is the value.
The command may be abbreviated to the shortest unique form.
If two commands have the same starting letters, the one that
will be selected is the one that appears first in the
help listing. If you want the second command, simply
spell out the full command. None of the keywords following
the command may be abbreviated.
For example:
list files jobid=23
will list all files saved for JobId 23. Or:
show pools
will display all the Pool resource records.
Stopping the Console Program
Normally, you simply enter quit or exit and the
Console program will terminate. However, it waits until the
Director acknowledges the command. If the Director is already
doing a lengthy command (e.g. prune), it may take some time.
If you want to immediately terminate the Console program,
enter the .quit command.
There is currently no way to interrupt a Console command
once issued (i.e. ctl-C does not work). However, if you
are at a prompt that is asking you to select one of
several possibilities and you would like to abort the
command, you can enter a period (.), and in most
cases, you will either be returned to the main command prompt
or if appropriate the previous prompt (in the case of nested
prompts). In a few places such as where it is asking for a
Volume name, the period will be taken to be the Volume name.
In that case, you will most likely be able to cancel at the
next prompt.
Alphabetic List of Console Commands
The following commands are currently implemented:
- add [pool=<pool-name> storage=<storage> jobid=<JobId>]
- This command is used to add Volumes to an existing Pool. The
Volume names entered are placed in the Catalog and thus become
available for backup operations. Normally, the label
command is used rather than this command because the label
command labels the physical media (tape) and does the equivalent of
the add command. This command affects only the Catalog and
not the physical media (data on Volumes). The physical media must
exist and be labeled before use (usually with the label
command). This command can, however, be useful if you wish to add
a number of Volumes to the Pool that will be physically labeled at
a later time. It can also be useful if you are importing a tape
from another site. Please see the label command below for
the list of legal characters in a Volume name.
- autodisplay on/off
- This command accepts on or
off as an argument, and turns auto-display of messages on or
off respectively. The default for the console program is
off, which means that you will be notified when there are
console messages pending, but they will not automatically be
displayed. The default for the gnome-console program is
on, which means that messages will be displayed when
they are received (usually within 5 seconds of them being
generated).
When autodisplay is turned off, you must explicitly
retrieve the messages with the messages command. When
autodisplay is turned on, the messages will be displayed on the
console as they are received.
- automount on/off
- This command accepts on or off as
the argument, and turns auto-mounting of the tape after a
label command on or off respectively. The default is
on. If automount is turned off, you must explicitly
mount the tape after a label command to use it.
- cancel [jobid=<number> job=<job-name>]
- This
command is used to cancel a job and accepts jobid=nnn or
job=xxx as an argument where nnn is replaced by the JobId
and xxx is replaced by the job name. If you do not specify a
keyword, the Console program will prompt you with the names of all
the active jobs allowing you to choose one.
Once a Job is marked to be canceled, it may take a bit of time
(generally within a minute) before it actually terminates,
depending on what operations it is doing.
- create [pool=<pool-name>]
- This command is used to
create a Pool record in the database using the Pool resource record
defined in the Director's configuration file. So in a sense, this
command simply transfers the information from the Pool resource in
the configuration file into the Catalog. Normally this command is
done automatically for you when the Director starts providing the
Pool is referenced within a Job resource. If you use this command
on an existing Pool, it will automatically update the Catalog to
have the same information as the Pool resource. After creating a
Pool, you will most likely use the label command to label
one or more volumes and add their names to the Media database.
When starting a Job, if Bacula determines that there is
no Pool record in the database, but there is a Pool resource of the
appropriate name, it will create it for you. If you want the Pool
record to appear in the database immediately, simply use this
command to force it to be created.
- delete [volume=<vol-name> pool=<pool-name>
job jobid=<id>]
- The delete command is used to delete
a Volume, Pool or Job record from the Catalog as well as all
associated Volume records that were created. This command operates
only on the Catalog database and has no effect on the actual data
written to a Volume. This command can be dangerous and we strongly
recommend that you do not use it unless you know what you are
doing.
If the keyword Volume appears on the command
line, the named Volume will be deleted from the catalog, if the
keyword Pool appears on the command line, a Pool will be
deleted, and if the keyword Job appears on the command line,
a Job and all its associated records (File and JobMedia) will be
deleted from the catalog. The full form of this command is:
delete pool=<pool-name>
or
delete volume=<volume-name> pool=<pool-name>
or
delete JobId=<job-id> JobId=<job-id2> ...
or
delete Job JobId=n,m,o-r,t ...
The first form deletes a Pool record
from the catalog database. The second form deletes a Volume record
from the specified pool in the catalog database. The
third form delete the specified Job record from the catalog
database. The last form deletes JobId records for JobIds n,m,o,p,
q,r, and t. When each one of the n,m,... is, of course, a number.
- estimate
- Using this command, you can get an idea how
many files will be backed up, or if you are unsure about
your Include statements in your FileSet, you can test them
without doing an actual backup. The default is to assume
a Full backup. However, you can override this by specifying
a level=Incremental or level=Differential
on the command line. A Job name must
be specified or you will be prompted for one,
and optionally a Client and FileSet may be specified
on the command line. It then
contacts the client which computes the number of files and
bytes that would be backed up. Please note that this is
an estimated calculated from the number of blocks in the
file rather than by reading the actual bytes. As such, the
estimated backup size will generally be larger than
an actual backup.
Optionally you may specify the keyword listing in
which case, all the files to be backed up will be listed.
Note, it could take quite some time to display them if the
backup is large. The full form is:
estimate job=<job-name> listing client=<client-name>
fileset=<fileset-name> level=<level-name>
Specification of the job is sufficient, but you can also
override the client, fileset and/or level
by specifying them on the estimate command line.
As an example, you might do:
@output /tmp/listing
estimate job=NightlySave listing level=Incremental
@output
which will do a full listing of all files to be backed up for the
Job NightlySave during an Incremental save and put it in the
file /tmp/listing.
- help
- This command displays the list of commands available.
- label
- This command is used to label physical volumes.
The full form of this command is:
label storage=<storage-name> volume=<volume-name> slot=<slot>
If you leave out any part, you will be prompted for it.
The media type is automatically taken from the Storage resource
definition that you supply. Once the necessary information is
obtained, the Console program contacts the specified Storage
daemon and requests that the tape be labeled. If the tape labeling
is successful, the Console program will create a Volume record
in the appropriate Pool.
The Volume name is restricted to letters, numbers, and
the special characters hyphen (-), underscore (_),
colon (:), and period (.).
All other characters including a space are illegal.
This restriction is to ensure good readability of Volume names
to reduce operator errors.
Please note, when labeling a blank tape, Bacula will get
read I/O error when it attempts to ensure that the tape is already
labeled. If you wish to avoid getting these messages, please write
and EOF mark on your tape before attempting to label it:
mt rewind
mt weof
The label command can fail for a number of reasons:
- The Volume name you specify is already in the
Volume database.
- The Storage daemon has a tape already mounted on the
device, in which case you must unmount
the device, insert a blank tape, then do the
label command.
- The tape in the device is already a Bacula labeled tape.
(Bacula will never relabel a Bacula labeled tape unless
it is recycled and you use the relabel command).
- There is no tape in the drive.
There are two ways to relabel a volume that already has
a Bacula label. The brute
force method is to write an end of file mark on the tape
using the system mt program, something like the
following:
mt -f /dev/st0 rewind
mt -f /dev/st0 weof
Then you use the label command to add a new label.
However, this could leave traces of the old volume in the
catalog.
The preferable method to relabel a tape is to first purge
the volume, either automatically, or explicitly with the
purge command, then use the relabel command described
below.
If your autochanger has barcode labels, you can label all the
Volumes in your autochanger one after another by using the
label barcodes command. For each tape in the changer containing
a barcode, Bacula will mount the tape and then label it with the
same name as the barcode. An appropriate Media record will also be
created in the catalog. Any barcode that begins with the same characters
as specified on the "CleaningPrefix=xxx" command, will be treated as a
cleaning tape, and will not be labeled. For example with:
Pool {
Name ...
Cleaning Prefix = "CLN"
}
Any slot containing a barcode of CLNxxxx will be treated as a cleaning
tape and will not be mounted. Note, the full form of the command is:
update storage=xxx pool=yyy slots=1-5,10 barcodes
- list
- The list command lists the requested contents of the
Catalog. The various fields of each record are listed on a single
line. If there The various forms of the list command are:
list jobs
list jobid=<id>
list job=<job-name>
list jobmedia
list jobmedia jobid=<id>
list jobmedia job=<job-name>
list files jobid=<id>
list files job=<job-name>
list pools
list clients
list jobtotals
list volumes
list volumes jobid=<id>
list volumes pool=<pool-name>
list volumes job=<job-name>
list volume=<volume-name>
list nextvolume job=<job-name>
list nextvol job=<job-name>
What most of the above commands do should be more or
less obvious. In general if you do not specify all
the command line arguments, the command will prompt you
for what is needed.
The list nextvol command will print the Volume
name to be used by the specified job. You should be aware
that exactly what Volume will be used depends on a lot
of factors including the time and what a prior job
will do. It may fill a tape that is not full when
you issue this command. As a consequence, this command
will give you a good estimate of what Volume will be
used but not a definitive answer. In addition, this
command may have certain side effect because it
runs through the same algorithm as a job,
which means it may automatically purge or recycle a
Volume.
If you wish to add specialized commands that list the contents
of the catalog, you can do so by adding them to the
query.sql file. However, this takes some knowledge
of programming SQL. Please see the query command below for
additional information. See below for listing the full contents
of a catalog record with the llist command.
As an example, the command list pools might produce
the following output:
+------+---------+---------+---------+----------+-------------+
| PoId | Name | NumVols | MaxVols | PoolType | LabelFormat |
+------+---------+---------+---------+----------+-------------+
| 1 | Default | 0 | 0 | Backup | * |
| 2 | Recycle | 0 | 8 | Backup | File |
+------+---------+---------+---------+----------+-------------+
As mentioned above, the list command lists what is in the
database. Some things are put into the database immediately when
Bacula starts up, but in general, most things are put in only when
they are first used, which is the case for a Client as with Job
records, etc.
Bacula should create a client record in the database the first
time you run a job for that client. Doing a status will not
cause a database record to be created. The client database record
will be created whether or not job fails, but it must at least
start. When the Client is actually contacted, additional info
from the client will be added to the client record (a "uname -a"
output).
If you want to see what Client resources you have available in
your conf file, you use the Console command show clients.
- llist
- The llist or "long list" command takes
all the same arguments that the list command described above does.
The difference is that the llist command list the full contents
of each database record selected. It does so by listing the
various fields of the record vertically, with one field per
line. It is possible to produce a very large number of output
lines with this command.
If instead of the list pools as in the example above,
you enter llist pools you might get the following output:
PoolId: 1
Name: Default
NumVols: 0
MaxVols: 0
UseOnce: 0
UseCatalog: 1
AcceptAnyVolume: 1
VolRetention: 1,296,000
VolUseDuration: 86,400
MaxVolJobs: 0
MaxVolBytes: 0
AutoPrune: 0
Recycle: 1
PoolType: Backup
LabelFormat: *
PoolId: 2
Name: Recycle
NumVols: 0
MaxVols: 8
UseOnce: 0
UseCatalog: 1
AcceptAnyVolume: 1
VolRetention: 3,600
VolUseDuration: 3,600
MaxVolJobs: 1
MaxVolBytes: 0
AutoPrune: 0
Recycle: 1
PoolType: Backup
LabelFormat: File
- messages
- This command causes any pending
console messages to be immediately displayed.
- mount
- The mount command is used to get Bacula to
read a volume on a physical device. It is a way to tell
Bacula that you have mounted a tape and that Bacula should
examine the tape. This command is used only after there was
no Volume in a drive and Bacula requests you to mount a new
Volume or when you have specifically unmounted a Volume with
the unmount console command, which causes Bacula to
close the drive. If you have an autoloader, the mount
command will not cause Bacula to operate the autoloader. The
various forms of the mount command are:
mount
storage=<storage-name> mount [ jobid=<id> |
job=<job-name> ] If you have specified Automatic
Mount = yes in the Storage daemon's Device resource,
under most circumstances, Bacula will automatically access
the Volume unless you have explicitly unmounted it in
the Console program.
- prune
- The Prune command allows you to safely
remove expired database records from Jobs and Volumes.
This command works only on the Catalog database and does not
affect data written to Volumes. In all
cases, the Prune command applies a retention period to the
specified records. You can Prune expired File entries from
Job records; you can Prune expired Job records from the
database, and you can Prune both expired Job and File records
from specified Volumes.
prune files|jobs|volume client=<client-name>
volume=<volume-name>
For a Volume to be pruned, the VolStatus
must be Full, Used, or Append, otherwise the pruning will not
take place.
- purge
- The Purge command will delete associated
Catalog database
records from Jobs and Volumes without considering the
retention period. Purge works only on the Catalog database
and does not affect data written to Volumes.
This command can be dangerous because you
can delete catalog records associated with current backups of
files, and we recommend
that you do not use it unless you know what you are doing.
The permitted forms of purge are:
purge files jobid=<jobid>|job=<job-name>|client=<client-name>
purge jobs client=<client-name> (of all jobs)
purge volume|volume=<vol-name> (of all jobs)
For the purge command to work on Volume Catalog database
records the VolStatus
must be Append, Full, Used, or Error.
The actual data written to the Volume will be unaffected by
this command.
- relabel
- This command is used to label physical volumes.
The full form of this command is:
relabel storage=<storage-name> volume=<newvolume-name>
name=<old-volume-name>
If you leave out any part, you will be prompted for it.
In order for the Volume (old-volume-name) to be relabeled,
it must be in the catalog, and the volume status must
be marked Purged or Recycle. This happens automatically as a
result of applying retention periods, or you may explicitly
purge the volume using the purge command.
Once the volume is physically relabeled, the old data written on
the Volume is lost and cannot be recovered.
- release
- This command is used to cause the Storage
daemon to rewind (release) the current tape in the drive, and
to re-read the Volume label the next time the tape is used.
release storage=<storage-name>
After a release command, the device is still kept open
by Bacula (unless Always Open is set to No in the Storage
Daemon's configuration) so it cannot be used by another program.
However, with some tape drives,
the operator can remove the current tape and to insert a
different one, and when the next Job starts, Bacula will
know to re-read the tape label to find out what tape is
mounted. If you want to be able to use the drive with
another program (e.g. mt), you must use the unmount
command to cause Bacula to completely release (close) the device.
- restore
- The restore command allows you to select one
or more Jobs (JobIds) to be restored using various methods.
Once the JobIds are selected, the File records
for those Jobs are placed in an internal Bacula directory
tree, and the restore enters a file selection mode that allows
you to interactively walk up and down the file tree selecting
individual files to be restored. This mode is somewhat similar to
the standard Unix restore program's interactive file
selection mode.
restore storage=<storage-name> client=<client-name>
where=<path> pool=<pool-name> fileset=<fileset-name>
select current all done
Where current, if specified, tells the restore command
to automatically select a restore to the most current backup.
If not specified, you will be prompted. The all specification
tells the restore command to restore all files. If it is not
specified, you will be prompted for the files to restore.
For details of the restore command, please see the
Restore Chapter of this manual.
- run
- This command allows you to schedule jobs
to be run immediately. The full form of the command is:
run job=<job-name> client=<client-name> fileset=<FileSet-name>
level=<level-keyword> storage=<storage-name>
where=<directory-prefix> when=<universal-time-specification>
yes
Any information that is needed but not specified will be
listed for selection, and before starting the job, you will
be prompted to accept, reject, or modify the parameters of
the job to be run, unless you have specified yes, in
which case the job will be immediately sent to the scheduler.
On my system, when I enter a run command, I get the following
prompt:
A job name must be specified.
The defined Job resources are:
1: Matou
2: Polymatou
3: Rufus
4: Minimatou
5: Minou
6: PmatouVerify
7: MatouVerify
8: RufusVerify
9: Watchdog
Select Job resource (1-9):
If I then select number 5, I am prompted with:
Run Backup job
JobName: Minou
FileSet: Minou Full Set
Level: Incremental
Client: Minou
Storage: DLTDrive
Pool: Default
When: 2003-04-23 17:08:18
OK to run? (yes/mod/no):
If I now enter yes, the Job will be run. If I enter mod,
I will be presented with the following prompt.
Parameters to modify:
1: Level
2: Storage
3: Job
4: FileSet
5: Client
6: When
7: Pool
Select parameter to modify (1-7):
If you wish to start a job at a later time, you can do so by setting
the When time. Use the mod option and select When (no. 6).
Then enter the desired start time in YYYY-MM-DD HH:MM:SS format.
- setdebug
- This command is used to set the debug level in each
daemon. The form of this command is:
setdebug level=nn [trace=0/1 client=<client-name> | dir | director | storage=<storage-name> | all]
If trace=1 is set, then the tracing will be enabled, and the
daemon where the setdebug applies will be placed in trace mode, and
all debug output will go to the file bacula.trace in the
current directory of the daemon. Normally, tracing is used only for
Win32 clients where the debug output cannot be written to a terminal
or redirected to a file. When tracing, each debug output message is
appended to the trace file. You must explicitly delete the file when
you are done.
- show
- The show command will
list the Director's resource records as defined in
the Director's configuration file (normally bacula-dir.conf).
This command is used mainly for debugging purposes by developers.
The following keywords are accepted on the show command line:
directors, clients, counters, jobs, storages, catalogs,
schedules, filesets, groups, pools, messages, all, help.
Please don't confuse this command with the list, which displays
the contents of the catalog.
- sqlquery
- The sqlquery command puts the Console program
into SQL query mode where each line you enter is concatenated
to the previous line until a semicolon (;) is seen. The semicolon
terminates the command, which is then passed directly
to the SQL database engine. When the output from the SQL engine
is displayed, the formation of a new SQL command begins. To
terminate SQL query mode and return to the Console command
prompt, you enter a period (.) in column 1.
Using this command, you can query the SQL catalog database
directly. Note you should really know what you are doing otherwise
you could damage the catalog database. See the query command below
for simpler and safer way of entering SQL queries.
Depending on what database engine you are using (MySQL or SQLite),
you will have somewhat different SQL commands available. For more
detailed information, please refer to the MySQL or SQLite documentation.
- status
- This command will display the status of the next
jobs that are scheduled during the next twenty-four hours as
well as the status of currently running jobs. The full form
of this command is:
status [all | dir=<dir-name> | director |
client=<client-name> | storage=<storage-name>]
If you do a status dir, the console will list
any currently running jobs, a summary of all
jobs scheduled to be run in the next 24 hours, and
a listing of the last 10 terminated jobs with their
statuses. The scheduled jobs summary
will include the Volume name to be used. You should be aware
of two things: 1. to obtain the volume name, the code
goes through the same code that will be used when the
job runs, which means that it may prune or recycle a Volume;
2. The Volume listed is only a best guess. The Volume
actually used may be different because of the time
difference (more durations may expire when the job
runs) and another job could completely fill the Volume
requiring a new one.
In the Running Jobs listing, you may find the following
types of information:
2507 Catalog MatouVerify.2004-03-13_05.05.02 is waiting execution
5349 Full CatalogBackup.2004-03-13_01.10.00 is waiting for higher
priority jobs to finish
5348 Differe Minou.2004-03-13_01.05.09 is waiting on max Storage jobs
5343 Full Rufus.2004-03-13_01.05.04 is running
Looking at the above listing from bottom to top,
obviously JobId 5343 (Rufus) is running. JobId 5348
(Minou) is waiting for JobId 5343 to finish because it is using the
Storage resource, hence the "waiting on max Storage jobs". JobId
5349 has a lower priority than all the other jobs so it is waiting for
higher priority jobs to finish, and finally, JobId 2508 (MatouVerify)
is waiting because only one job can run at a time, hence it is simply
"waiting execution".
- unmount
- This command causes the indicated Bacula Storage
daemon to unmount the specified device. The forms of the command
are the same as the mount command:
unmount storage=<storage-name>
unmount [ jobid=<id> | job=<job-name> ]
- update
- This command will update catalog for
either a specific Pool record, a Volume record, or the Slots in an
autochanger with barcode capability. In the case of updating a
Pool record, the new information will be automatically taken from
the corresponding Director's configuration resource record. It
can be used to increase the maximum number of volumes permitted or
to set a maximum number of volumes. The following main
keywords may be specified:
media, volume, pool, slots
In the case of updating a
Volume, you will be prompted for which value you wish to change.
The following Volume parameters may be changed:
Volume Status
Volume Retention Period
Volume Use Duration
Maximum Volume Jobs
Maximum Volume Files
Maximum Volume Bytes
Recycle Flag
Slot
InChanger Flag
Pool
Volume Files
Volume from Pool
All Volumes from Pool
For slots update slots, Bacula will obtain a
list of slots and their barcodes from the Storage daemon,
and for each barcode found, it will automatically update the
slot in the catalog Media record to correspond to the new value.
This is very useful if you have moved cassettes in the magazine,
or if you have removed the magazine and inserted a different
one. As the slot of each Volume is updated, the InChanger flag for
that Volume will also be set, and any other Volumes in the Pool
will have their InChanger flag turned off. This permits Bacula to
know what magazine (tape holder) is currently in the autochanger.
If you do not have barcodes, you can accomplish the same thing
in version 1.33 and later by using the update slots scan
command. The scan keyword tells Bacula to physically mount
each tape and to read its VolumeName.
For Pool update pool, Bacula will move
the Volume record from its existing poole to the pool specified.
For Volume from Pool and All Volumes from Pool,
the following values are updated from the Pool record:
Recycle, VolRetention, VolUseDuration, MaxVolJobs, MaxVolFiles,
and MaxVolBytes.
The full form of the update command with all command line
arguments is:
update volume=xxx pool=yyy slots volstatus=xxx VolRetention=ddd
VolUse=ddd MaxVolJobs=nnn MaxVolBytes=nnn Recycle=yes/no
slot=nnn
- use
- This command allows you to specify which Catalog
database to use. Normally, you will be using only one database so
this will be done automatically. In the case that you are using
more than one database, you can use this command to switch from
one to another.
use <database-name>
- var
- This command takes a string or quoted string and
does variable expansion on it the same way variable expansion
is done on the LabelFormat string. Thus, for the
most part, you can test your LabelFormat strings. The difference
between the var command and the actual LabelFormat process
is that during the var command, no job is running so "dummy"
values are used in place of Job specific variables. Generally,
however, you will get a good idea of what is going to happen
in the real case.
- version
- The command prints the Director's version.
- quit
- This command terminates the console program. The
console program sends the quit request to the Director
and waits for acknowledgment. If the Director is busy doing
a previous command for you that has not terminated, it may
take some time. You may quit immediately by issuing the
.quit command (i.e. quit preceded by a period).
- query
- This command reads a predefined SQL query from
the query file (the name and location of the
query file is defined with the QueryFile resource record in
the Director's configuration file). You are prompted to select
a query from the file, and possibly enter one or more parameters,
then the command is submitted to the Catalog database SQL engine.
The following queries are currently available (version 1.24):
Available queries:
1: List Job totals:
2: List where a file is saved:
3: List where the most recent copies of a file are saved:
4: List total files/bytes by Job:
5: List total files/bytes by Volume:
6: List last 20 Full Backups for a Client:
7: List Volumes used by selected JobId:
8: List Volumes to Restore All Files:
9: List where a File is saved:
Choose a query (1-9):
- exit
- This command terminates the console program.
- wait
- The wait command causes the Director to pause
until there are no jobs running. This command is useful in
a batch situation such as regression testing where you
wish to start a job and wait until that job completes
before continuing.
Special dot Commands
There is a list of commands that are prefixed with a period (.).
These commands are intended to be used either by batch programs
or graphical user interface front-ends. They are not normally used
by interactive users. Once GUI development begins, this list
will be considerably expanded.
The following is the list of dot commands:
.die cause the Director to segment fault (for debugging)
.jobs list all job names
.filesets list all fileset names
.clients list all client names
.msgs return any queued messages
.quit quit
.exit quit
Special At (@) Commands
Normally, all commands entered to the Console program are immediately
forwarded to the Director, which may be on another machine, to be
executed. However, there is a small list of at commands,
all beginning with a at character (@), that will not be sent to
the Director, but rather interpreted by the Console program directly.
Note, these commands are implemented only in the tty console program
and not in the GNOME Console.
These commands are:
- @input <filename>
- Read and execute the commands
contained in the file specified.
- @output <filename> w/a
- Send all following output to the
filename specified either overwriting the file (w) or appending to
the file (a). To redirect the output to the terminal, simply enter
@output without a filename specification. WARNING: be careful
not to overwrite a valid file. A typical example during a regression
test might be:
@output /dev/null
commands ...
@output
- @tee <filename> w/a
- Send all subsequent output to
both the specified file and the terminal. It is turned off by
specifying @tee or @output without a filename.
- @sleep <seconds>
- Sleep the specified number of seconds.
- @time
- Print the current time and date.
- @version
- Print the console's version.
- @quit
- quit
- @exit
- quit
- @# anything
- Comment
Running the Console Program from a Shell Script
You can automate many Console tasks by running the
console program from a shell script. For example, if
you have created a file containing the
following commands:
./bconsole -c ./bconsole.conf <<END_OF_DATA
unmount storage=DDS-4
quit
END_OF_DATA
when that file is executed, it will unmount
the current DDS-4 storage device. You might want
to run this command during a Job by using the
RunBeforeJob or RunAfterJob
records.
It is also possible to run the Console program
from file input where the file contains the
commands as follows:
./bconsole -c ./bconsole.conf <filename
where the file named filename contains
any set of console commands.
As a real example, the following script is part
of the Bacula regression tests. It labels a volume
(a disk volume), runs a backup, then does a restore
of the files saved.
bin/bconsole -c bin/bconsole.conf <<END_OF_DATA
@output /dev/null
messages
@output /tmp/log1.out
label volume=TestVolume001
run job=Client1 yes
wait
messages
@#
@# now do a restore
@#
@output /tmp/log2.out
restore current all
yes
wait
messages
@output
quit
END_OF_DATA
The output from the backup is directed to
/tmp/log1.out and the output from the restore
is directed to /tmp/log2.out. To ensure that
the backup and restore ran correctly, the output
files are checked with:
grep "^Termination: *Backup OK" /tmp/log1.out
backupstat=$?
grep "^Termination: *Restore OK" /tmp/log2.out
restorestat=$?
Adding Volumes to a Pool
If you have used the label command to label a
Volume, it will be automatically added to the Pool,
and you will not need to add any media to the pool.
Alternatively, you may choose to add a number of
Volumes to the pool without labeling them. At a
later time when the Volume is requested by Bacula
you will need to label it.
Before adding a volume,
you must know the following information:
- The name of the Pool (normally "Default")
- The Media Type as specified in the Storage Resource
in the Director's configuration file (e.g. "DLT8000")
- The number and names of the Volumes you wish to create.
For example, to add media to a Pool, you would issue the
following commands to the console program:
*add
Enter name of Pool to add Volumes to: Default
Enter the Media Type: DLT8000
Enter number of Media volumes to create. Max=1000: 10
Enter base volume name: Save
Enter the starting number: 1
10 Volumes created in pool Default
*
To see what you have added, enter:
*list media pool=Default
+-------+----------+---------+---------+-------+------------------+
| MedId | VolumeNa | MediaTyp| VolStat | Bytes | LastWritten |
+-------+----------+---------+---------+-------+------------------+
| 11 | Save0001 | DLT8000 | Append | 0 | 0000-00-00 00:00 |
| 12 | Save0002 | DLT8000 | Append | 0 | 0000-00-00 00:00 |
| 13 | Save0003 | DLT8000 | Append | 0 | 0000-00-00 00:00 |
| 14 | Save0004 | DLT8000 | Append | 0 | 0000-00-00 00:00 |
| 15 | Save0005 | DLT8000 | Append | 0 | 0000-00-00 00:00 |
| 16 | Save0006 | DLT8000 | Append | 0 | 0000-00-00 00:00 |
| 17 | Save0007 | DLT8000 | Append | 0 | 0000-00-00 00:00 |
| 18 | Save0008 | DLT8000 | Append | 0 | 0000-00-00 00:00 |
| 19 | Save0009 | DLT8000 | Append | 0 | 0000-00-00 00:00 |
| 20 | Save0010 | DLT8000 | Append | 0 | 0000-00-00 00:00 |
+-------+----------+---------+---------+-------+------------------+
*
Notice that the console program automatically appended a number to the
base Volume name that you specify (Save in this case). If you don't want
it to append a number, you can simply answer 0 (zero) to the question
"Enter number of Media volumes to create. Max=1000:", and
in this case, it will create a single Volume with the exact name you
specify.
Configuring Bacula
|
Index
|
Critical Items Before Going Production
|
|
 |
|
|