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 bwx-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 already is quite useful. Unfortunately, it has not been enhanced for
-some time now.
+style), and a QT GUI interface (Bat). 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.
Since the Console program interacts with the Director through the network, your
Console and Director programs do not necessarily need to run on the same
\index[general]{Configuration!Console}
When the Console starts, it reads a standard Bacula configuration file
-named {\bf bconsole.conf} or {\bf bgnome-console.conf} in the case of the GNOME
-Console version from the current directory unless you specify the {\bf {-}c}
+named {\bf bconsole.conf} or {\bf bat.conf} in the case of the Bat
+QT Console version from the current directory unless you specify the {\bf {-}c}
command line option (see below). 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
-dnn set debug level to nn
-n no conio
-s no signals
+ -u <nn> set command execution timeout to <nn> seconds
-t test - read configuration and exit
-? print this message.
\end{verbatim}
\normalsize
-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:
+After launching the Console program (bconsole), it will prompt you for the next
+command with an asterisk (*). 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:
\footnotesize
\begin{verbatim}
Used in the show, list, and llist commands. Takes no arguments.
\item [select]
Used in the restore command. Takes no argument.
+\item[limit]
+ Used in the setbandwidth command. Takes integer in KB/s unit.
\item [storages]
Used in the show command. Takes no arguments.
\item [schedules]
auto-display of messages on or off respectively. The default for the
console program is {\bf 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 bgnome-console program is {\bf on}, which
- means that messages will be displayed when they are received (usually
- within five seconds of them being generated).
+ displayed.
When autodisplay is turned off, you must explicitly retrieve the
messages with the {\bf messages} command. When autodisplay is turned
the actual bytes. As such, the estimated backup size will generally be
larger than an actual backup.
- The estimate command isn't currently compatible with the Accurate mode, it
- doesn't detect changes like with a backup using \textbf{Accurate=yes}.
+ The \texttt{estimate} command can use the accurate code to detect changes
+ and give a better estimation. You can set the accurate behavior on command
+ line using \texttt{accurate=yes/no} or use the Job setting as default value.
Optionally you may specify the keyword {\bf 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:
-
\begin{verbatim}
-estimate job=<job-name> listing client=<client-name>
+estimate job=<job-name> listing client=<client-name> accurate=<yes/no>
fileset=<fileset-name> level=<level-name>
\end{verbatim}
- Specification of the {\bf job} is sufficient, but you can also override
- the client, fileset and/or level by specifying them on the estimate
+ Specification of the {\bf job} is sufficient, but you can also override the
+ client, fileset, accurate and/or level by specifying them on the estimate
command line.
In the above, you can add "limit=nn" to limit the output to
nn jobs.
+ list joblog jobid=<id> (list job output if recorded in the catalog)
+
list jobmedia
list jobmedia jobid=<id>
For the {\bf purge} command to work on Volume Catalog database records the
{\bf VolStatus} must be Append, Full, Used, or Error.
-The actual data written to the Volume will be unaffected by this command.
+The actual data written to the Volume will be unaffected by this command unless
+you are using the \texttt{ActionOnPurge=Truncate} option on those Media.
+
+To ask Bacula to truncate your \texttt{Purged} volumes, you need to use the
+following command in interactive mode or in a RunScript:
+\begin{verbatim}
+*purge volume action=truncate storage=File allpools
+# or by default, action=all
+*purge volume action storage=File pool=Default
+\end{verbatim}
+
+This is possible to specify the volume name, the media type, the pool, the
+storage, etc\dots (see \texttt{help purge}) Be sure that your storage device is
+idle when you decide to run this command.
\item[python]
\index[general]{python}
and is only accessible by setting its value on the intial command line. If
no spooldata flag is set, the job, storage or schedule flag is used.
+\item[setbandwidth]
+ \index[general]{setbandwidth}
+ This command is used to limit the bandwidth of a running job or a client.
+
+setbandwidth limit=<nb> [ jobid=<id> | client=<cli> ]
+
\item [setdebug]
\index[general]{setdebug}
\index[general]{setdebug}
\index[general]{setip}
Sets new client address -- if authorized.
+ A console is authorized to use the {\bf SetIP} command only if it has a
+ Console resource definition in both the Director and the Console. In
+ addition, if the console name, provided on the {\bf Name =} directive,
+ must be the same as a Client name, the user of that console is permitted
+ to use the {\bf SetIP} command to change the Address directive in the
+ Director's client resource to the IP address of the Console. This
+ permits portables or other machines using DHCP (non-fixed IP addresses)
+ to "notify" the Director of their current IP address.
+
+
\item [show]
\index[general]{show}
the case that you are using more than one database, you can use this command
to switch from one to another.
-use \lt{}database-name\gt{}
+\footnotesize
+\begin{verbatim}
+ use [catalog=name-of-catalog]
+\end{verbatim}
+\normalsize
+
\item [var]
\label{var}
However, there is a small list of {\bf at} commands, all beginning with an 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:
+the tty console program and not in the Bat Console. These commands are:
\begin{description}
\index[general]{anything}
Comment
+\item [@help]
+ \index[general]{@help}
+ Get the list of every special @ commands.
+
\item [@separator \lt{}char\gt{}]
\index[general]{@separator}
When using bconsole with readline, you can set the command separator to one
\footnotesize
\begin{verbatim}
-grep "^Termination: *Backup OK" /tmp/log1.out
+grep "^ *Termination: *Backup OK" /tmp/log1.out
backupstat=$?
-grep "^Termination: *Restore OK" /tmp/log2.out
+grep "^ *Termination: *Restore OK" /tmp/log2.out
restorestat=$?
\end{verbatim}
\normalsize
projects / bacula / docs / blobdiff