%%
%%

\chapter{Bacula Console}
\label{_ConsoleChapter}
\index[general]{Console!Bacula}
\index[general]{Bacula Console}
\index[general]{Console!Bacula}
\index[general]{Bacula Console}

Die {\bf Bacula Console} (manchmal auch das BenutzerInterface genannt) 
ist ein Programm, dass es dem Anwender oder System Aministrator erlaub,
den Bacula-Director-Dienst im laufenden Betrieb zu kontrollieren.

Momentan gibt es zwei Versionen des Console-Programms: eine Shell- (TTY)
und eine GNOME GUI-Version. Beide erlauben es dem Administrator oder
autorisierten Benutzern Bacula zu steuern. Sie k\"{o}nnen sich den Status
eines bestimmten Jobs bzw. den Inhalt des Katalogs anzeigen lassen,
oder bestimmte Aktionen mit Tapes und Autochangern durchf\"{u}hren.

Zus\"{a}tzlich gibt es noch die bwx-Console, die auf wxWidgets aufbaut,
und eine M\"{o}glichkeit bietet, den Wiederherstellungsproze{\ss} graphisch zu steuern.
Die bwx-Console befindet sich in einem fr\"{u}hen Entwicklungsstadium und
wurde leider seit einiger Zeit nicht weiterentwickelt. (Trotzdem kann sie sehr hilfreich sein.)

Da sich alle Bacula-Consolen \"{u}ber das Netzwerk mit dem Director-Dienst verbinden,
ist es nicht notwendig sie auf dem selben Computer laufen zu lassen.

Ein gewisses, minimales Grundwissen \"{u}ber die Console ist schon dann notwendig,
wenn Bacula auf mehr als einem Tape schreiben soll. Bacula wird n\"{a}mlich nach einem
leeren Band fragen, falls keines mehr verf\"{u}gbar ist, und erst nach dem mounten
eines neuen Tapes mittels der Console, wird Bacula weiterarbeiten k\"{o}nnen.

\section{Console Konfiguration}
\index[general]{Console Konfiguration}
\index[general]{Konfiguration!Console}
\index[general]{Console Konfiguration}
\index[general]{Konfiguration!Console}

Wenn Sie die Bacula-Console starten, liest sie ihre Standard-Konfigurations-Datei
namens {\bf bconsole.conf}, bzw. {\bf bgnome-console.conf} f\"{u}r die GNOME-Console, ein.
Im einfachsten Fall enth\"{a}llt diese Datei nur den Namen und die Adresse des Director-Dienstes
sowie das Passwort, dass f\"{u}r die Verbindung zum Director-Dienst ben\"{o}tigt wird.
F\"{u}r weitere Informationen zu dieser Datei, lesen Sie bitte das Kapitel \"{u}ber die \ilink{Console-Konfiguration-Datei}{ConsoleConfChapter} in diesem Handbuch.

\section{Benutzung des Console-Programms}
\index[general]{Benutzung des Console-Programms}
\index[general]{Programm!Benutzung des Console-}
\index[general]{Benutzung des Console-Programms}
\index[general]{Programm!Benutzungs des Console-}

Das Console-Programm kann mit den folgenden Optionen gestartet werden:
\footnotesize
\begin{verbatim}
Usage: bconsole [-s] [-c Konfigurations-Datei] [-d Debug-Level]
       -c <Datei>  gibt die zu verwendene Konfigurations-Datei an
       -dnn        setzt den Debug-Lavel auf nn
       -n          kein conio
       -s          keine Signale (*)
       -t          test - list die Konfigurations-Datei und beendet sich dann
       -?          gibt diese Hilfe aus.
\end{verbatim}
\normalsize

(*) \elink{Signale}{http://de.wikipedia.org/wiki/Signal\_\%28Computer\%29}

Nach dem Start des Console-Programms zeigt es durch sein Prompt (*) an,
dass es auf Benutzereingaben wartet. (in der GNOME-Console gibt es kein Prompt,
geben Sie die Befehle bitte einfach in der Textbox unten im Fenster ein.)
Sie k\"{o}nnen in jeder Console einfach nur das Kommando eingeben, wenn weitere Parameter
erforderlich sind, wird das Programm Sie danach fragen. Alternativ k\"{o}nnen Sie
nat\"{u}rlich auch das komplette Kommando mit allen ben\"{o}tigten Parametern eingeben
und ausf\"{u}hren. Das normale Befehlsformat ist dieses:

\footnotesize
\begin{verbatim}
 <Kommando> <Parameter1>[=<Argument1>] <Parameter2>[=<Argument2>] ...
\end{verbatim}
\normalsize

wobei {\bf Kommando} einer der unten aufgef\"{u}hrten Console-Befehle
und {\bf Parameter} eines der unten aufgelisteten Schl\"{u}sselw\"{o}rter ist,
dem dann meistens ein {\bf Argument} folgt. Alle Befehle k\"{o}nnen in der
k\"{u}rzesten eindeutigen Form eingegeben werden. Falls zwei Befehle mit identischen
Buchstaben anfangen, wird der ausgef\"{u}hrt, der in der Ausgabe des {\bf help}-Kommandos
am weitesten oben steht. Wenn Sie das andere Kommando ausf\"{u}hren m\"{o}chten m\"{u}ssen Sie
dementsprechend mehr Buchstaben eingeben, um es eindeutig anzugeben. Keiner der
Parameter darf abgek\"{u}rzt werden.

Ein Beispiel:

\footnotesize
\begin{verbatim}
list files jobid=23
\end{verbatim}
\normalsize

zeigt alle gesicherten Dateien mit der JobID 23 an.

\footnotesize
\begin{verbatim}
show pools
\end{verbatim}
\normalsize

zeigt alle Pool-Konfigurations-Eintr\"{a}ge an. 

Die maximale L\"{a}nge der eingegebenen Befehle, mit Parametern, ist 511 Zeichen.
Falls Sie die Console \"{u}ber ein Script ansprechen, denken Sie bitte daran,
dass Sie dieses Limit nicht \"{u}berschreiten.

\section{Beenden des Console-Programs}
\index[general]{Programm!Beenden des Console-}
\index[general]{Beenden des Console-Programms}
\index[general]{Programm!Beenden des Console-}
\index[general]{Beenden des Console-Programms}

Normalerweise beenden Sie das Console-Programm durch die Eingabe von {\bf quit} oder {\bf exit}.
Allerdings wartet die Console bis der Director-Dienst das Kommando best\"{a}tigt. Wenn der
Director bereits ein l\"{a}nger laufendes Kommando ausf\"{u}hrt, kann es sein, dass das Beenden
der Console einen Moment dauert. Falls Sie die Console sofort verlassen wollen, k\"{o}nnen Sie
in dem Fall das Kommando {\bf .quit} verwenden.

Momentan gibt es keinen Weg ein laufendes Kommando nach dem Starten abzubrechen (z.B. mit STRG+C).
Allerdings k\"{o}nnen Sie jederzeit, wenn die Console Sie nach einer weiteren Eingabe fragt,
das aktuelle Kommmando beenden, indem Sie einen Punkt {\bf .} eingeben. Nach der Eingabe des Punktes,
werden Sie automatisch zum Hauptprompt oder bei verschachtelten Abfragen zum passenden letzten Prompt
zur\"{u}ckgeleitet. Bei einigen Eingaben, wie zum Beispiel der Frage nach einem Volume-Namen, wird
der Punkt als Eingabe gewertet und Sie haben beim n\"{a}chsten Prompt die M\"{o}glichkeit,
das Kommando abzubrechen.

\label{keywords}
\section{Alphabetische Liste der Console-Schl\"{u}sselw\"{o}rter}
\index[general]{Schl\"{u}sselw\"{o}rter!Alphabetische Liste der Console}
\index[general]{Alphabetische Liste der Console-Schl\"{u}sselw\"{o}rter}
\index[general]{Schl\"{u}sselw\"{o}rter!Alphabetische Liste der Console}
\index[general]{Alphabetische Liste der Console-Schl\"{u}sselw\"{o}rter}
Wenn es nicht anders angegeben ist, ben\"{o}tigt jedes der folgenden Schl\"{u}sselw\"{o}rter
(Parameter der Console-Befehle) ein Argument, welches dem Schl\"{u}sselwort,
getrennt durch ein Gleichheitszeichen, folgt.
Ein Beispiel:
\begin{verbatim}
jobid=536
\end{verbatim}

Bitte beachten Sie, dass diese Liste durch die st\"{a}ndig weitergehende
Entwicklung eventuell weder komplett, noch in der Richtigen alphabetischen
Reihenfolge sein kann.

\begin{description}
\item [restart]
  Parameter des python-Kommandos,
  dadurch wird der python-Interpreter neu gestartet. Ben\"{o}tigt keine Argumente.
\item [all]
  Parameter des status und show-Kommandos,
  dadurch werden alle Komponenten oder Eintr\"{a}ge ausgew\"{a}hlt
\item [allfrompool]
  Parameter des update-Kommandos,
  gibt an das alle Volumes des (im Parameter pool angegebenen) Pools
  aktualisiert werden sollen.
\item [allfrompools]
  Parameter des update-Kommandos,
  gibt an das alle Volumes aller Pools aktualisiert werden sollen.
\item [before]
  Parameter des restore-Kommandos.
\item [bootstrap]
  Parameter des restore-Kommandos.
\item [catalog]
  im use-Kommando erlaubt,
  um den zu benutzenden Katalog auszuw\"{a}hlen
\item [catalogs]
  Parameter des show-Kommandos.
  Ben\"{o}tigt keine Argumente.
\item [client | fd]
\item [clients]
  Parameter des show, list und llist-Kommandos,
  bezeichnet alle Clients. Ben\"{o}tigt keine Argumente.
\item [counters]
  im show-Kommando erlaubt.
  Ben\"{o}tigt keine Argumente.
\item [current]
  Parameter des restore-Kommandos.
  Ben\"{o}tigt keine Argumente.
\item [days]
  definiert die Anzahl der Tage, die das "list nextvol"-Kommando
  in Betracht ziehen soll. Der Parameter days kann auch im Kommando
  "status director" verwendet werden, um die geplanten Jobs f\"{u}r die
  angegebene Anzahl Tage zu zeigen.
\item [devices]
  Parameter des show-Kommandos.
  Ben\"{o}tigt keine Argumente.
\item [dir | director]
\item [directors]
  Parameter des show-Kommandos.
  Ben\"{o}tigt keine Argumente.
\item [directory]
  Parameter des restore-Kommandos.
  Das Argument gibt das wiederherzustellende Verzeichnis an.
\item [enabled]
  Dieser Parameter kann bei den Kommandos "update volumes" und "update slots"
  verwendet werden. Das Argument kann yes, true, no, false, archived, 0,1 oder 2 sein.
  0 ist identisch mit no oder false, 1 mit yes oder true und 2 mit archived.
  Archived Volumes werden weder benutzt noch automatisch aus dem Katalog gel\"{o}scht.
  Volumes die nicht enabled sind, werden nicht f\"{u}r das Backup oder die Wiederherstellung benutzt.
\item [done]
  wird im restore-Kommando benutzt.
  Ben\"{o}tigt keine Argumente.
\item [file]
  Parameter des restore-Kommandos.
\item [files]
  Parameter des list und llist-Kommandos.
  Ben\"{o}tigt keine Argumente.
\item [fileset]
\item [filesets]
  Parameter des show-Kommandos.
  Ben\"{o}tigt keine Argumente.
\item [help]
  Parameter des show-Kommandos.
  Ben\"{o}tigt keine Argumente.
\item [jobs]
  Parameter des show, list und llist-Kommandos.
  Ben\"{o}tigt keine Argumente.
\item [jobmedia]
  Parameter des list und llist-Kommandos.
  Ben\"{o}tigt keine Argumente.
\item [jobtotals]
  Parameter des list und llist-Kommandos.
  Ben\"{o}tigt keine Argumente.
\item [jobid]
  Parameter des list und llist-Kommandos.
  Die jobid ist die numerische Jobid, die im Job-Report angezeigt wird.
  Sie ist der Index f\"{u}r die Datenbankeintr\"{a}ge des entsprechenden Jobs.
  Da sie f\"{u}r alle in der Datenbank existierenden Jobs einzigartig ist,
  kann sie erst wiederverwendet werden, wenn der vorherige Job mit dieser Jobid
  aus der Datenbank gel\"{o}scht wurde.
\item [job | jobname]
  Parameter des list und llist-Kommandos.
  Der Job oder JobName entspricht dem Namen den Sie im Job-Eintr\"{a}g
  angegeben haben, somit bezieht er sich auf alle Jobs dieses Namens,
  die jemals gelaufen sind und deren Eintr\"{a}ge noch im Katalog existieren.
\item [level]
\item [listing]
  Parameter des estimate-Kommandos.
  Ben\"{o}tigt keine Argumente.
\item [limit]
\item [messages]
  Parameter des show-Kommandos.
  Ben\"{o}tigt keine Argumente.
\item [media]
  Parameter des list und llist-Kommandos.
  Ben\"{o}tigt keine Argumente.
\item [nextvol | nextvolume]
  Parameter des list und llist-Kommandos.
  Ben\"{o}tigt keine Argumente.
\item [on]
  Ben\"{o}tigt keine Argumente.
\item [off]
  Ben\"{o}tigt keine Argumente.
\item [pool]
\item [pools]
  Parameter des show, list und llist-Kommandos.
  Ben\"{o}tigt keine Argumente.
\item [select]
  Parameter des restore-Kommandos.
  Ben\"{o}tigt keine Argumente.
\item [storages]
  Parameter des show-Kommandos.
  Ben\"{o}tigt keine Argumente.
\item [schedules]
  Parameter des show-Kommandos.
  Ben\"{o}tigt keine Argumente.
\item [sd | store | storage]
\item [ujobid]
  Parameter des list-Kommandos.
  Die ujobid ist eine M\"{o}glichkeit einen Job eindeutig zu identifizieren.
  Momentan besteht die ujobid aus dem JobNamen und der Uhrzeit wann der Job gelaufen ist.
\item [volume]
\item [volumes]
  Parameter des list und llist-Kommandos.
  Ben\"{o}tigt keine Argumente.
\item [where]
  Parameter des restore-Kommandos.
\item [yes]
  Parameter des restore-Kommandos.
  Ben\"{o}tigt keine Argumente.
\end{description}

\label{list}
\section{Alphabetische Liste der Console-Kommandos}
\index[general]{Kommandos!Alphabetische Liste der Console-}
\index[general]{Alphabetische Liste der Console-Kommandos}
\index[general]{Kommandos!Alphabetische Liste der Console-}
\index[general]{Alphabetische Liste der Console-Kommandos}

Die folgenden Kommandos sind derzeit verf\"{u}gbar:

\begin{description}
\item [{add [pool=\lt{}pool-name\gt{} storage=\lt{}storage\gt{}
   jobid=\lt{}JobId\gt{}]} ]
   \index[general]{add}
   Das add-Kommando wird benutzt um Volumes zu einem bestehenden Pool
   hinzuzuf\"{u}gen. Dazu wird der Volume-Eintrag in der Datenbank erzeugt
   und das Volume dem Pool zugeordnet. Dabei erfolgt kein physikalischer Zugriff
   auf das Volume. Nach dem hinzuf\"{u}gen zu einem Pool, geht Bacula davon
   aus, dass das Volume wirklich existiert und auch bereits gelabelt ist.
   Dises Kommando wird normalerweise nicht benutzt, da Bacula die Volumes
   automatisch beim labeln einem Pool hinzuf\"{u}gt. Allerdings ist es hilfreich,
   falls Sie ein Volume aus dem Katalog gel\"{o}scht haben und es sp\"{a}ter wieder
   hinzuf\"{u}gen wollen.

   Typischerweise wird das label-Kommando anstelle des add-Kommandos benutzt, da
   es au{\ss}er dem labeln des physikalischen Volumes, die identischen Schritte
   wie das add-Kommando ausf\"{u}hrt. Das add-Kommando \"{a}ndert nur die Katalog-Eintr\"{a}ge
   und nicht die physikalischen Volumes. Die physikalischen Volumes m\"{u}ssen
   vorhanden und gelabelt sein (normalerweise mit dem label-Kommando). Trotzdem
   kann das add-Kommando sinnvoll sein, wenn Sie zum Beispiel eine bestimmte Anzahl
   von Volumes einem Pool hinzuf\"{u}gen wollen, wobei die Volumes erst zu einem
   sp\"{a}teren Zeitpunkt gelabelt werden. Auch um ein Volume eines anderen Bacula-Systems
   (bzw. anderen Director-Dienstes) zu importieren, kann das add-Kommando benutzt werden.
   Die erlaubten Zeichen f\"{u}r einen Volume-Namen finden Sie weiter unten
   in der Beschreibung des label-Kommandos.

\item [autodisplay on/off]
   \index[general]{autodisplay on/off}
   Das autodisplay-Kommando kennt zwei Parameter: {\bf on} und {\bf off},
   wodurch die automatische Anzeige von Nachrichten in der Console entsprechend
   ein- oder ausgeschaltet wird. Der Standardwert ist {\bf off}, was bedeutet, dass
   Sie \"{u}ber neue Meldungen benachrichtigt werden, sie aber nicht automatisch
   angezeigt werden. In der GNOME-Console ist das automatische Anzeigen dagegen
   standardm\"{a}{\ss}ig aktiviert, d.h. neue Meldungen werden automatisch
   ausgegeben, wenn sie vom Director-Dienst empfangen wurden (typischerweise innerhalb von
   ca. 5 Sekunden nachdem sie generiert wurden).

   Wenn autodisplay auf off steht, m\"{u}ssen Sie neu Nachrichten mit dem
   {\bf messages}-Kommando abrufen, um sie sich anzeigen zu lassen.
   Wenn autodiplay auf on steht, werden die Nachrichten angezeigt, sobald die Console sie
   empfangen hat.

\item [automount on/off]
   \index[general]{automount on/off}
   Das automount-Kommando kennt zwei Parameter: {\bf on} und {\bf off},
   die entsprechend das automatische mounten nach dem labeln ({\bf label}-Kommando)
   an- oder ausschalten. Der Standardwert ist on. Wenn automount ausgeschaltet ist,
   m\"{u}ssen Sie nach dem labeln eines Volumes dieses explizit mounten ({\bf mount}-Kommando),
   um es benutzen zu k\"{o}nnen.

\item [{cancel [jobid=\lt{}number\gt{} job=\lt{}job-name\gt{} ujobid=\lt{}unique-jobid\gt{}]}]
   \index[general]{cancel jobid}
   Das cancel-Kommande wird benutzt um einen Job abzubrechen und kennt die
   Parameter {\bf jobid=nnn} or {\bf job=xxx}, wober jobid die numerische JobID ist
   und job der Job-Name. Wenn Sie weder job noch jobid angeben, listet die Console
   alle in Frage kommenden Jobs auf und erlaubt Ihnen aus dieser Liste den abzubrechenden
   Job auszuw\"{a}hlen.

   Wenn ein Job als abzubrechen gekennzeichnet wurde, kann es einige Zeit dauern,
   bis er tats\"{a}chlich beendet wird (normalerweise innerhalb einer Minute).
   Dise Zeit ist aber abh\"{a}ngig davon, was der Job gerade tut.

\item [{create [pool=\lt{}pool-name\gt{}]}]
   \index[general]{create pool}
   Das create-Kommando wird normalerweise nicht benutzt, da die Pool-Eintr\"{a}ge
   im Katalog automatisch angelegt werden, wenn der Director-Dienst startet und
   er seine Pool-Konfiguration aus den Konfigurations-Dateien einliest. Falls ben\"{o}tigt,
   kann mit diesem Kommando ein Pool-Eintrag in der Katalog-Datenbank erstellt werden,
   der auf einem Pool-Konfigurations-Eintrag basiert, der in der Director-Dienst-Konfiguration
   enthalten ist. Einfach gesagt \"{u}bernimmt dieses Kommando nur den Pool-Eintrag aus der
   Konfiguration in die Datenbank. Normalerweise wird diese Kommando automatisch ausgef\"{u}hrt,
   wenn der Pool zum ersten mal in einem Job-Eintrag benutzt wird. Wenn Sie dieses Kommando
   auf einem bestehenden Pool ausf\"{u}hren, wird der Katalog sofort aktualisiert und enth\"{a}lt
   dann die identische Pool-Konfiguration, wie die Konfigurations-Dateien. Nach dem Erstellen
   eines Pool in den Konfigurations-Dateien werden Sie allerdings h\"{o}chstwahrscheinlich
   das {\bf label}-Kommando benutzen, um ein oder mehrere Volumes dem neuen Pool hinzuzuf\"{u}gen
   und die entsprechenden Eintr\"{a}ge im Katalog zu erzeugen, anstatt des create-Kommandos.

   Wenn ein Job gestartet wird und Bacula bemerkt, dass keine passender Pool-Eintrag im Katalog ist
   aber in den Konfigurations-Dateien, dann wird der Pool im Katalog automatisch angelegt.
   Wenn Sie m\"{o}chten, dass der Pool-Eintrag sofort (ohne das ein Job mit diesem Pool gestartet wurde)
   im Katalog erscheint, k\"{o}nnen Sie einfach diese Kommando ausf\"{u}hren, um diesen Vorgang
   zu erzwingen.

\item [{delete [volume=\lt{}vol-name\gt{} pool=\lt{}pool-name\gt{}  job
   jobid=\lt{}id\gt{}]}]
   \index[general]{delete}
   Das delete-Kommando wird benutzt um ein Volume, einen Pool oder einen Job-Eintrag,
   sowie jeweils alle dazugeh\"{o}rigen Datenbank-Eintr\"{a}ge, aus dem Katalog zu
   entfernen. Das Kommando \"{a}ndert nur die Katalog-Datenbank, es hat keine
   Auswirkungen auf die Konfigurations-Dateien oder die Daten auf den Volumes.
   Wir empfehlen Ihnen dieses Kommando nur zu benutzen, wenn Sie wirklich wissen was Sie tun.

   Wenn der Parameter {\bf Volume} angegeben wird, wird das entsprechende Volume aus dem Katalog
   gel\"{o}scht, wenn ein {\bf Pool} angeben wird, der entsprechende Pool und bei Angabe des Parameters
   {\bf Job} der entsprechende Job, sowie alle zu diesem Job geh\"{o}hrenden JobMedia- und Datei-Eintr\"{a}ge.
   Das delete-Kommando kann folgenderma{\ss}en aufgerufen werden:

\begin{verbatim}
delete pool=<pool-name>  oder
\end{verbatim}

\begin{verbatim}
delete volume=>volume-name> pool=>pool-name>  oder
\end{verbatim}

\begin{verbatim}
delete JobId=>job-id> JobId=>job-id2> ...  oder
\end{verbatim}

\begin{verbatim}
delete Job JobId=n,m,o-r,t ...
\end{verbatim}

   Das erste Beispiel l\"{o}scht einen Pool-Eintrag aus der Katalog-Datenbank.
   Das zweite l\"{o}scht einen Volume-Eintrag aus dem angegebenen Pool
   und das dritte Beispiel l\"{o}scht die genannten JobID-Eintr\"{a}ge aus
   dem Katalog. Es werden die JobIDs n, m, o, p, q, r und t gel\"{o}scht,
   wobei die JobID's n, m, o ... nat\"{u}rlich Zahlen entsprechen m\"{u}ssen.
   Wie Sie sehen kann das delete-Kommando Listen von JobIDs und auch Bereiche
   (z.B. o-r) verarbeiten.

\item [disable job\lt{}job-name\gt{}]
  \index[general]{disable}
  Das disable-Kommando erlaubt es Ihnen, zu verhindern das ein Job
  automatisch durch den Director-Dienst ausgef\"{u}hrt wird. Wenn Sie den Director-Dienst
  neu starten, wird der Status des Jobs wieder auf den Wert gesetzt, der
  im Job-Eintrag der Director-Konfiguration eingetragen ist.

\item [enable job\lt{}job-name\gt{}]
  \index[general]{enable}
  Das enable-Kommando erlaubt es Ihnen, einen Job der durch das
  disable-Kommando aus der automatischen Job-Planung entfernt wurde,
  wieder zu aktivieren. Wenn Sie den Director-Dienst neu starten,
  wird der Status des Jobs wieder auf den Wert gesetzt, der im
  Job-Eintrag der Director-Konfiguration eingetragen ist.

\label{estimate}
\item [estimate]
   \index[general]{estimate}
   Mit dem estimate-Kommando k\"{o}nnen Sie sich anzeigen lassen, welche
   Dateien durch einen bestimmten Job gesichert werden, ohne diesen Job
   ausf\"{u}hren zu m\"{u}ssen. Standardm\"{a}{\ss}ig wird dabei ein Voll-Backup
   angenommen. Sie k\"{o}nnen das aber durch den Parameter level entsprechend anpassen,
   indem Sie zum Beispiel {\bf level=Incremental} oder {\bf level=Differential} an das
   estimate-Kommando mit \"{u}bergeben. Wenn Sie im Aufruf des Kommandos keinen Job-Name
   angegeben, wird die Console Ihnen ein Auswahlliste der m\"{o}glichen Jobs anzeigen.
   Zus\"{a}tzlich k\"{o}nnen Sie noch die Parameter Client und FileSet angeben. Nach dem
   Starten des Kommandos wird der Director-Dienst den Client kontaktieren der daraufhin
   eine Liste der zu sichernden Dateien mit ihrer Gr\"{o}{\ss}e zur\"{u}ckgibt. Bitte beachten
   Sie, dass das estimate-Kommando nur die Anzahl der von der Datei belegten Bl\"{o}cke zur
   Bestimmung der Dateigr\"{o}{\ss}e einbezieht, so dass die Datenmenge die das estimate-Kommando
   anzeigt immer etwas gr\"{o}{\ss}er sein wird, als das echte Backup.

   Wahlweise k\"{o}nnen Sie noch den Parameter {\bf listing} mit \"{u}bergeben,
   dann wird eine Liste aller zu sichernden Dateien ausgegeben. Abh\"{a}ngig vom FileSet
   kann diese Liste sehr lang sein und es daher einige Zeit dauern, alle Dateien anzuzeigen.
   Das estimate-Kommando kann folgenderma{\ss}en aufgerufen werden:


\begin{verbatim}
estimate job=<job-name> listing client=<client-name> 
       fileset=<fileset-name> level=<level-name>  
\end{verbatim}

   die Angabe des Jobs ist ausreichend, aber Sie k\"{o}nnen durch Angabe
   des Clients, FileSets und/oder des Backup-Levels die entsprechenden Werte \"{u}berschreiben.

Zum Beispiel k\"{o}nnen Sie folgendes eingeben:

\footnotesize
\begin{verbatim}
     @output /tmp/listing
     estimate job=NightlySave listing level=Incremental
     @output
\end{verbatim}
\normalsize

   durch das erste Kommando wird die Ausgabe der Console in die Datei
   {\bf /tmp/listing} umgeleitet. Dann wird durch das estimate-Kommando
   eine Liste aller Dateien erstellt, die beim n\"{a}chsten inkrementellen
   Backup des Jobs {\bf NightlySave} gesichert werden. Die Console gibt dabei keine
   Meldungen aus, da die Ausgabe ja auf die Datei /tmp/listing zeigt. Durch
   das dritte Kommando @output wird die Umleitung der Ausgabe wieder aufgehoben.
   Beachten Sie bitte, dass die angezeigten Bytes in der Ausgabe des estimate-Kommandos
   \"{u}ber die Angabe der Dateigr\"{o}{\ss}e im Verzeichnis-Eintrag bestimmt wird.
   Das kann zu gro{\ss}en Abweichungen bei der ermittelten Backup-Gr\"{o}{\ss}e f\"{u}hren,
   falls im FileSet \elink{sparse}{http://de.wikipedia.org/wiki/Sparse-Datei}-Dateien
   vorhanden sind. sparse-Dateien finden sich oft auf 64-Bit-Maschinen, wo sie f\"{u}r
   bestimmte Systemdateien benutzt werden. Die angezeigten Bytes sind die Gesammtgr\"{o}{\ss}e
   der gesicherten Dateien, wenn die FileSet-Option "sparse" nicht gesetzt ist.
   Momentan gibt es keinen Weg, um mit dem estimate-Kommando die echte Backup-Gr\"{o}{\ss}e
   f\"{u}r ein FileSet anzuzeigen, bei dem die sparse-Option gesetzt ist.

\item [help]
   \index[general]{help}
   Das help-Kommando zeigt alle verf\"{u}gbaren Kommandos mit einer kurzen Beschreibung an.

\item [label]
   \index[general]{label}
   \index[general]{relabel}
   \index[general]{label}
   \index[general]{relabel}
   Das label-Kommando wird benutzt um physikalische Volumes zu labeln.
   Das label-Kommando kann folgenderma{\ss}en aufgerufen werden:

\begin{verbatim}
label storage=>storage-name> volume=>volume-name> slot=>slot>
\end{verbatim}

   Wenn Sie einen der Parameter storage, volume oder slot nicht angeben,
   werden Sie von der Console danach gefragt. Der Media-Typ wird automatisch
   anhand des Storage-Eintrags in der Director-Konfiguration gesetzt.
   Wenn alle ben\"{o}tigten Informationen vorliegen, kontaktiert die
   Console den angegebenen Storage-Dienst und sendet das label-Kommando.
   Wenn das labeln erfolgreich war, wird ein entsprechender Volume-Eintrag
   im passenden Pool erzeugt.

   Im Volume-Name d\"{u}rfen Buchstaben, Zahlen und folgende Sonderzeichen
   verwendet werden: Binde- ({\bf -}) und Unterstrich ({\bf \_}),
   Doppelpunkt ({\bf :}) und Punkt ({\bf .}). Alle anderen Zeichen,
   einschlie{\ss}lich des Leerzeichens, sind nicht erlaubt.
   Durch diese Einschr\"{a}nkung soll sichergestellt werden, dass
   die Volume-Namen gut lesbar sind und es nicht zu Benutzerfehlern
   aufgrund von Sonderzeichen im Namen kommt.

   Bitte beachten Sie, dass Bacula einen Ein-/Ausgabefehler meldet,
   wenn ein neues bzw. komplett leeres Volume gelabelt wird. Bacula
   versucht den ersten Block des Volumes zu lesen, um ein eventuell schon
   vorhandenes label nicht zu \"{u}berschreiben, dieser Versuch erzeugt
   den oben genannten Fehler. Um diesen Fehler zu vermeiden, k\"{o}nnen Sie
   mit den folgenden Shell-Kommandos ein EOF am den Anfang des Volumes schreiben:

\footnotesize
\begin{verbatim}
       mt rewind
       mt weof
       
\end{verbatim}
\normalsize

Das label-Kommando kann aufgrund verschiedener Gr\"{u}nde fehlschlagen:

\begin{enumerate}
\item Der angegebene Volume-Name existiert schon in der Katalog-Datenbank

\item Der Storage-Dienst hat schon ein Tape oder anderes Volume in dem
      ben\"{o}tigten Ger\"{a}t gemountet. In diesem Fall m\"{u}ssen Sie
      das Ger\"{a}t erst mit dem {\bf unmount}-Kommando freigeben und dann
      ein leeres Volume zum labeln einlegen.

\item Das Volume ist bereits gelabelt. Bacula wird niemals ein bestehendes label
      \"{u}berschreiben, solange das Volume nicht abgelaufen ist und Sie das
      {\bf relabel}-Kommando verwenden.

\item Es ist kein Volume im Ger\"{a}t.
\end{enumerate}

Es gibt zwei M\"{o}glichkeiten ein bestehendes Bacula-label zu \"{u}berschreiben.
Die brutale Methode ist es, einfach ein EOF an den Anfang des Volumes zu schreiben
(dabei wird das bestehende label durch das EOF \"{u}berschrieben).
Mit dem Programm {\bf mt} k\"{o}nnen Sie das zum Beispiel so tun:

\footnotesize
\begin{verbatim}
 [user@host]$  mt -f /dev/st0 rewind
 [user@host]$  mt -f /dev/st0 weof
\end{verbatim}
\normalsize

Ein Festplatten-Volume k\"{o}nnen Sie auch manuell l\"{o}schen.

Danach benutzten Sie das label-Kommando, um ein neues label zu erzeugen.
Allerdings kann diese Vorgehensweise Spuren des alten Volumes in der
Katalog-Datenbank hinterlassen.

Die bevorzugte Methode ein Volume neu zu labeln sollte es sein,
zuerst das Volume als bereinigt (purged) zu markieren. Das passiert entweder automatisch,
wenn die Aufbewahrungszeit (Volume-Retention) f\"{u}r das Volume abl\"{a}uft,
oder kann aber auch mit dem {\bf purge}-Kommando erzwungen werden.
Danach k\"{o}nnen Sie das {\bf relabel}-Kommando, wie weiter unten beschrieben, verwenden.

Falls Ihr Autochanger Barcode-Labels unterst\"{u}tzt, k\"{o}nnen Sie
alle Volumes im Autochanger, eins nach dem anderen, mit dem Kommando
{\bf label barcodes} labeln. Dabei wird jedes Tape mit Barcode nacheinander
im Laufwerk gemountet und mit der auf dem Barcode enthaltenen Zeichenfolge
als Namen gelabelt. Ein entsprechender Katalog-Eintrag wird automatisch
mit erzeugt. Jedes Volume mit einem Barcode der mit den Zeichen beginnt,
die im Pool-Eintrag als CleaningPrefix konfiguriert sind, wird wie ein
Reinigungsband behandelt und nicht gelabelt. Allerdings wird dabei auch
ein Katalog-Eintrag f\"{u}r das Reinigungsband erstellt.

Als Beispiel, mit dem Eintrag:
\footnotesize
\begin{verbatim}
        Pool {
          Name ...
          Cleaning Prefix = "CLN"
       }
\end{verbatim}
\normalsize

wird jedes Tape, dessen Barcode mit CLN beginnt, als Reinigungsband betrachtet
und nicht automatisch gemountet.
Das label-Kommando kann folgenderma{\ss}en aufgerufen werden:

\footnotesize
\begin{verbatim}
label storage=xxx pool=yyy slots=1-5,10 barcodes
\end{verbatim}
\normalsize

\item [list]
   \index[general]{list}
   Das list-Kommando zeigt den angegebenen Inhalt der Katalog-Datenbank an.
   Die verschiedenen Felder jedes Eintrags werden in einer Zeile ausgegeben.
   Die verschiedenen M\"{o}glichkeiten sind:
\footnotesize
\begin{verbatim}
   list jobs
   
   list jobid=<id>           (zeigt jobid <id> an)

   list ujobid<unique job name> (zeigt den job mit dem Namen <unique job name> an)
   
   list job=<job-name>   (zeigt alle Jobs mit dem Namen <job-name> an)

   list jobname=<job-name>  (identisch mit dem oberen)

                Im oberen Beispiel k\"{o}nnen Sie auch den Parameter limit=nn
                hinzuf\"{u}gen, um die Ausgabe des Kommandos auf nn Jobs zu begrenzen
   
   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>

   list nextvol job=<job-name> days=nnn

\end{verbatim}
\normalsize

   Die meisten der oben genannten Parameter sollten selbsterkl\"{a}rend sein.
   \"{U}blicherweise werden Sie, falls Sie nicht gen\"{u}gend Parameter angeben,
   von der Console nach den fehlenden Informationen gefragt.

   Das {\bf list nextvol}-Kommando gibt den Volume-Namen aus, der von dem angegebenen Job
   beim n\"{a}chsten Backup benutzt werden wird. Allerdings sollten Sie beachten, dass
   das tats\"{a}chlich benutzte Volume von einer Reihe von Faktoren, wie zum Beispiel
   von den vorher laufenden Jobs oder der Zeit wann der Job l\"{a}uft, abh\"{a}ngen kann.
   Eventuell wird ein Tape schon voll sein, das aber noch freien Platz hatte, als Sie
   das Kommando ausf\"{u}hrten. Dieses Kommando gibt Ihnen also nur einen Hinweis darauf,
   welches Tape benutzt werden k\"{o}nnte, aber es kann keine definitive Aussage dar\"{u}ber treffen.
   Zus\"{a}tzlich kann dieses Kommando mehrere Seiteneffekte haben, da es den selben
   Algorithmus durchl\"{a}uft, wie ein echter Backup-Job. Das bedeutet, dass es dazu f\"{u}hren kann,
   dass aufgrund dieses Kommandos Volumes automatisch recycled oder gelöscht (purged) werden.
   Standardm\"{a}{\ss}ig muss der angegebene Job innerhalb der n\"{a}chsten zwei Tage laufen,
   ansonsten wird kein Volume f\"{u}r den Job gefunden. Allerdings k\"{o}nnen Sie durch Angabe des Parameters
   {\bf days=nnn} bis zu 50 Tage in die Zukunft angeben, die das Kommando in die Berechnung
   mit einbeziehen soll. Falls Sie, zum Beispiel, Freitags sehen wollen, welches Volume am Montag
   vorrausssichtlich benutzt wird, k\"{o}nnen Sie folgendes Kommando benutzen:
   {\bf list nextvol job=MyJob days=3}.

   Wenn Sie bestimmte, von Ihnen \"{o}fter ben\"{o}tigte, eigene Kommandos anlegen wollen
   um sich bestimmte Inhalte der Katalog-Datenbank anzeigen zu lassen,
   k\"{o}nnen Sie diese der Datei {\bf query.sql} hinzu\"{u}gen. Allerdings
   erfordert das einiges an Wissen \"{u}ber SQL-Kommandos. Lesen Sie dazu bitte
   den Abschnitt \"{u}ber das {\bf query}-Kommando in diesem Kapitel.

   Weiter unten finden Sie auch eine Beispiel-Ausgabe des {\bf llist}-Kommandos,
   das Ihnen den kompletten Inhalt des Katalogs zu einem bestimmten Konfigurations-Eintrag
   anzeigt.

   Als ein Beispiel, kann Ihnen der Aufruf des Kommandos {\bf list pools} die folgenden
   Ausgaben anzeigen:

\footnotesize
\begin{verbatim}
+------+---------+---------+---------+----------+-------------+
| PoId | Name    | NumVols | MaxVols | PoolType | LabelFormat |
+------+---------+---------+---------+----------+-------------+
|    1 | Default |       0 |       0 | Backup   | *           |
|    2 | Recycle |       0 |       8 | Backup   | File        |
+------+---------+---------+---------+----------+-------------+
\end{verbatim}
\normalsize

   As mentioned above, the {\bf 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 {\bf status} will not cause a
   database record to be created.  The client database record will be
   created whether or not the 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 {\bf show clients}.

\item [llist]
   \index[general]{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 {\bf list pools} as in the example above, you enter
   {\bf llist pools} you might get the following output:

\footnotesize
\begin{verbatim}
          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
      
\end{verbatim}
\normalsize

\item [messages]
   \index[general]{messages}
   This command causes any pending  console messages to be immediately displayed.
 

\item [mount]
   \index[general]{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 normally
   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 {\bf
   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 unless you specify a {\bf slot} and possibly a
   {\bf drive}. The various forms of the mount command are:

mount  storage=\lt{}storage-name\gt{} [ slot=\lt{}num\gt{} ] [
       drive=\lt{}num\gt{} ]

mount [ jobid=\lt{}id\gt{} |  job=\lt{}job-name\gt{} ]

   If you have specified {\bf Automatic  Mount = yes} in the Storage daemon's
   Device resource,  under most circumstances, Bacula will automatically access 
   the Volume unless you have explicitly {\bf unmount}ed it in  the Console
   program. 

\item[python]
   \index[general]{python}
  The python command takes a single argument {\bf restart}:

python restart

   This causes the Python interpreter in the Director to be reinitialized.
   This can be helpful for testing because once the Director starts and the
   Python interpreter is initialized, there is no other way to make it
   accept any changes to the startup script {\bf DirStartUp.py}.  For more
   details on Python scripting, please see the \ilink{Python
   Scripting}{PythonChapter} chapter of this manual.

\label{ManualPruning}
\item [prune]
   \index[general]{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=\lt{}client-name\gt{} 
volume=\lt{}volume-name\gt{}  

   For a Volume to be pruned, the {\bf VolStatus} must be Full, Used, or
   Append, otherwise the pruning will not take place.

\item [purge]
   \index[general]{purge}
   The Purge command will delete associated Catalog database records from
   Jobs and Volumes without considering the retention period.  {\bf 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 {\bf purge} are:

purge files jobid=\lt{}jobid\gt{}|job=\lt{}job-name\gt{}|client=\lt{}client-name\gt{} 

purge jobs client=\lt{}client-name\gt{} (of all jobs)

purge volume|volume=\lt{}vol-name\gt{} (of all jobs)

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.  

\item [relabel]
   \index[general]{relabel}
   \index[general]{relabel}
   This command is used to label physical volumes.  The full form of this
   command is:

relabel storage=\lt{}storage-name\gt{} oldvolume=\lt{}old-volume-name\gt{}  
    volume=\lt{}newvolume-name\gt{} 
 
   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 {\bf Purged} or {\bf Recycle}.
   This happens automatically as a result of applying retention periods, or
   you may explicitly purge the volume using the {\bf purge} command.

   Once the volume is physically relabeled, the old data previously written
   on the Volume is lost and cannot be recovered.

\item [release]
   \index[general]{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=\lt{}storage-name\gt{}  

   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.  {\bf mt}), you must use the {\bf unmount}
   command to cause Bacula to completely release (close) the device.

\item [reload]
  \index[general]{reload}
  The reload command causes the Director to re-read its configuration
  file and apply the new values. The new values will take effect     
  immediately for all new jobs.  However, if you change schedules,
  be aware that the scheduler pre-schedules jobs up to two hours in
  advance, so any changes that are to take place during the next two
  hours may be delayed.  Jobs that have already been scheduled to run
  (i.e. surpassed their requested start time) will continue with the
  old values.  New jobs will use the new values. Each time you issue
  a reload command while jobs are running, the prior config values   
  will queued until all jobs that were running before issuing
  the reload terminate, at which time the old config values will
  be released from memory. The Directory permits keeping up to
  ten prior set of configurations before it will refuse a reload
  command. Once at least one old set of config values has been
  released it will again accept new reload commands. 

   While it is possible to reload the Director's configuration on the fly,
   even while jobs are executing, this is a complex operation and not
   without side effects.  Accordingly, if you have to reload the Director's
   configuration while Bacula is running, it is advisable to restart the
   Director at the next convenient opportunity.

\label{restore_command}
\item [restore]
   \index[general]{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 {\bf
   restore} program's interactive file selection mode.

restore storage=\lt{}storage-name\gt{} client=\lt{}backup-client-name\gt{} 
  where=\lt{}path\gt{} pool=\lt{}pool-name\gt{} fileset=\lt{}fileset-name\gt{} 
  restoreclient=\lt{}restore-client-name\gt{}
  select current all done  

   Where {\bf 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 {\bf 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 {\bf restore}
   command, please see the \ilink{Restore Chapter}{RestoreChapter} of this
   manual.

   The client keyword initially specifies the client from which the backup
   was made and the client to which the restore will be make.  However,
   if the restoreclient keyword is specified, then the restore is written
   to that client.

\item [run]
   \index[general]{run}
   This command allows you to schedule jobs  to be run immediately. The full form
   of the command is:

run job=\lt{}job-name\gt{} client=\lt{}client-name\gt{}
  fileset=\lt{}FileSet-name\gt{}  level=\lt{}level-keyword\gt{}
  storage=\lt{}storage-name\gt{}  where=\lt{}directory-prefix\gt{}
  when=\lt{}universal-time-specification\gt{}  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 {\bf 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:  

\footnotesize
\begin{verbatim}
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):
     
\end{verbatim}
\normalsize

If I then select number 5, I am prompted with:  

\footnotesize
\begin{verbatim}
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):
     
\end{verbatim}
\normalsize

If I now enter {\bf yes}, the Job will be run. If I enter {\bf mod},  I will
be presented with the following prompt.  

\footnotesize
\begin{verbatim}
Parameters to modify:
     1: Level
     2: Storage
     3: Job
     4: FileSet
     5: Client
     6: When
     7: Pool
Select parameter to modify (1-7):
     
\end{verbatim}
\normalsize

If you wish to start a job at a later time, you can do so by setting  the When
time. Use the {\bf mod} option and select {\bf When} (no. 6).  Then enter the
desired start time in YYYY-MM-DD HH:MM:SS format.  

\item [setdebug]
   \index[general]{setdebug}
   \index[general]{setdebug}
   \index[general]{debugging}
   \index[general]{debugging Win32}
   \index[general]{Windows!debugging}
   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=\lt{}client-name\gt{} | dir | director |
  storage=\lt{}storage-name\gt{} | all]  

   If trace=1 is set, then tracing will be enabled, and the daemon will be
   placed in trace mode, which means that all debug output as set by the
   debug level will be directed to the file {\bf bacula.trace} in the
   current directory of the daemon.  Normally, tracing is needed 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.

\item [show]
   \index[general]{show}
   \index[general]{show}
   The show command will list the Director's resource records as defined in
   the Director's configuration file (normally {\bf bacula-dir.conf}).
   This command is used mainly for debugging purposes by developers.     
   The following keywords are accepted on the
   show command line: catalogs, clients, counters, devices, directors,
   filesets, jobs, messages, pools, schedules, storages, all, help.
   Please don't confuse this command
   with the {\bf list}, which displays the contents of the catalog.

\item [sqlquery]
   \index[general]{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 {\bf query} command below for
   simpler and safer way of entering SQL queries.

   Depending on what database engine you are using (MySQL, PostgreSQL or
   SQLite), you will have somewhat different SQL commands available.  For
   more detailed information, please refer to the MySQL, PostgreSQL or
   SQLite documentation.

\item [status]
   \index[general]{status}
   This command will display the status of the next jobs that are scheduled
   during the next 24 hours as well as the status of currently
   running jobs.  The full form of this command is:

status [all | dir=\lt{}dir-name\gt{} | director | 
  client=\lt{}client-name\gt{} | storage=\lt{}storage-name\gt{} |
  days=nnn]

   If you do a {\bf 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 ten 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, but it
   does not do pruning nor recycling of Volumes; 2.  The Volume listed is
   at best a 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:


\footnotesize
\begin{verbatim}
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
\end{verbatim}
\normalsize

   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"

   If you do a {\bf status dir}, it will by default list the first
   occurrence of all jobs that are scheduled today and tomorrow.  If you
   wish to see the jobs that are scheduled in the next three days (e.g.  on
   Friday you want to see the first occurrence of what tapes are scheduled
   to be used on Friday, the weekend, and Monday), you can add the {\bf
   days=3} option.  Note, a {\bf days=0} shows the first occurrence of jobs
   scheduled today only.  If you have multiple run statements, the first
   occurrence of each run statement for the job will be displayed for the
   period specified.

   If your job seems to be blocked, you can get a general idea of the
   problem by doing a {\bf status dir}, but you can most often get a 
   much more specific indication of the problem by doing a
   {\bf status storage=xxx}.  For example, on an idle test system, when
   I do {\bf status storage=File}, I get:
\footnotesize
\begin{verbatim}
status storage=File
Connecting to Storage daemon File at 192.168.68.112:8103

rufus-sd Version: 1.39.6 (24 March 2006) i686-pc-linux-gnu redhat (Stentz)
Daemon started 26-Mar-06 11:06, 0 Jobs run since started.

Running Jobs:
No Jobs running.
====

Jobs waiting to reserve a drive:
====

Terminated Jobs:
 JobId  Level   Files          Bytes Status   Finished        Name 
======================================================================
    59  Full        234      4,417,599 OK       15-Jan-06 11:54 kernsave
====

Device status:
utochanger "DDS-4-changer" with devices:
   "DDS-4" (/dev/nst0)
Device "DDS-4" (/dev/nst0) is mounted with Volume="TestVolume002"
Pool="*unknown*"
    Slot 2 is loaded in drive 0.
    Total Bytes Read=0 Blocks Read=0 Bytes/block=0
    Positioned at File=0 Block=0
Device "Dummy" is not open or does not exist.
No DEVICE structure.

Device "DVD-Writer" (/dev/hdc) is not open.
Device "File" (/tmp) is not open.
====

In Use Volume status:
====
\end{verbatim}
\normalsize

Now, what this tells me is that no jobs are running and that none of
the devices are in use.  Now, if I {\bf unmount} the autochanger, which
will not be used in this example, and then start a Job that uses the
File device, the job will block.  When I re-issue the status storage
command, I get for the Device status:

\footnotesize
\begin{verbatim}
status storage=File
...
Device status:
Autochanger "DDS-4-changer" with devices:
   "DDS-4" (/dev/nst0)
Device "DDS-4" (/dev/nst0) is not open.
    Device is BLOCKED. User unmounted.
    Drive 0 is not loaded.
Device "Dummy" is not open or does not exist.
No DEVICE structure.

Device "DVD-Writer" (/dev/hdc) is not open.
Device "File" (/tmp) is not open.
    Device is BLOCKED waiting for media.
====
...
\end{verbatim}
\normalsize

Now, here it should be clear that if a job were running that wanted
to use the Autochanger (with two devices), it would block because
the user unmounted the device. The real problem for the Job I started
using the "File" device is that the device is blocked waiting for
media -- that is Bacula needs you to label a Volume.

\item [unmount]
   \index[general]{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:
\footnotesize
\begin{verbatim}
unmount storage=<storage-name> [ drive=<num> ]

unmount [ jobid=<id> | job=<job-name> ]
\end{verbatim}
\normalsize

   Once you unmount a storage device, Bacula will no longer be able to use
   it until you issue a mount command for that device. If Bacula needs to
   access that device, it will block and issue mount requests periodically
   to the operator.

   If the device you are unmounting is an autochanger, it will unload
   the drive you have specified on the command line. If no drive is 
   specified, it will assume drive 1.

\label{UpdateCommand}
\item [update]
   \index[general]{update}
   This command will update the 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:  
\footnotesize
\begin{verbatim}
   media, volume, pool, slots  
\end{verbatim}
\normalsize

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:  

\footnotesize
\begin{verbatim}
 
   Volume Status
   Volume Retention Period
   Volume Use Duration
   Maximum Volume Jobs
   Maximum Volume Files
   Maximum Volume Bytes
   Recycle Flag
   Recycle Pool
   Slot
   InChanger Flag
   Pool
   Volume Files
   Volume from Pool
   All Volumes from Pool
   All Volumes from all Pools
   
\end{verbatim}
\normalsize

   For slots {\bf 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 that were last mounted on the same Storage device
   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 {\bf update slots scan} command.
   The {\bf scan} keyword tells Bacula to physically mount each tape and to
   read its VolumeName.

   For Pool {\bf update pool}, Bacula will move the Volume record from its
   existing pool to the pool specified.

   For {\bf Volume from Pool}, {\bf All Volumes from Pool} and {\bf All Volumes
     from all Pools}, the following values are updated from the Pool record:
   Recycle, RecyclePool, VolRetention, VolUseDuration, MaxVolJobs, MaxVolFiles,
   and MaxVolBytes.  (RecyclePool feature is available with bacula 2.1.4 or
   higher.)

   The full form of the update command with all command line arguments is:

\footnotesize
\begin{verbatim}
       update volume=xxx pool=yyy slots volstatus=xxx VolRetention=ddd
         VolUse=ddd MaxVolJobs=nnn MaxVolBytes=nnn Recycle=yes|no
         slot=nnn enabled=n recyclepool=zzz
      
\end{verbatim}
\normalsize

\item [use]
   \index[general]{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 \lt{}database-name\gt{} 

\item [var]
   \label{var}
   \index[general]{var name}
   This command takes a string or quoted string and  does variable expansion on
   it the same way variable expansion  is done on the {\bf LabelFormat} string.
   Thus, for the  most part, you can test your LabelFormat strings. The
   difference  between the {\bf 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.  

\item [version]
   \index[general]{version}
   The command prints the Director's version.  

\item [quit]
   \index[general]{quit}
   This command terminates the console program. The  console program sends the
   {\bf 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  {\bf .quit}
   command (i.e. quit preceded by a period).  

\item [query]
   \index[general]{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):  

\footnotesize
\begin{verbatim}
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):
      
\end{verbatim}
\normalsize

\item [exit]
   \index[general]{exit}
   This command terminates the console program.  

\item [wait]
   \index[general]{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. This command now has the following options:
\footnotesize
\begin{verbatim}
   wait [jobid=nn] [jobuid=unique id] [job=job name]
\end{verbatim}
\normalsize
   If specified with a specific JobId, ... the wait command will wait
   for that particular job to terminate before continuing.

\end{description}

\label{dotcommands}
\section{Special dot Commands}
\index[general]{Commands!Special dot}
\index[general]{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: 

\footnotesize
\begin{verbatim}
.backups job=xxx      list backups for specified job
.clients              list all client names
.defaults client=xxx fileset=yyy  list defaults for specified client
.die                  cause the Director to segment fault (for debugging)
.dir                  when in tree mode prints the equivalent to the dir command,
                        but with fields separated by commas rather than spaces.
.exit                 quit
.filesets             list all fileset names
.help                 help command output
.jobs                 list all job names
.levels               list all levels
.messages             get quick messages
.msgs                 return any queued messages
.pools                list all pool names
.quit                 quit
.status               get status output
.storage              return storage resource names
.types                list job types
\end{verbatim}
\normalsize

\label{atcommands}

\section{Special At (@) Commands}
\index[general]{Commands!Special At @}
\index[general]{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 {\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: 

\begin{description}

\item [@input \lt{}filename\gt{}]
   \index[general]{@input \lt{}filename\gt{}}
   Read and execute the commands  contained in the file specified.  

\item [@output \lt{}filename\gt{} w/a]
   \index[general]{@output \lt{}filename\gt{} 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  {\bf @output} without a filename specification.
WARNING: be careful  not to overwrite a valid file. A typical example during a
regression  test might be:  

\footnotesize
\begin{verbatim}
    @output /dev/null
    commands ...
    @output
    
\end{verbatim}
\normalsize

\item [@tee \lt{}filename\gt{} w/a]
   \index[general]{@tee \lt{}filename\gt{} w/a}
   Send all subsequent output to  both the specified file and the terminal. It is
   turned off by  specifying {\bf @tee} or {\bf @output} without a filename.  

\item [@sleep \lt{}seconds\gt{}]
   \index[general]{@sleep \lt{}seconds\gt{}}
   Sleep the specified number of seconds.  

\item [@time]
   \index[general]{@time}
   Print the current time and date.  

\item [@version]
   \index[general]{@version}
   Print the console's version.  

\item [@quit]
   \index[general]{@quit}
   quit  

\item [@exit]
   \index[general]{@exit}
   quit  

\item [@\# anything]
   \index[general]{anything}
   Comment 
\end{description}

\label{scripting}

\section{Running the Console from a Shell Script}
\index[general]{Script!Running the Console Program from a Shell}
\index[general]{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: 

\footnotesize
\begin{verbatim}
 ./bconsole -c ./bconsole.conf <<END_OF_DATA
 unmount storage=DDS-4
 quit
 END_OF_DATA
\end{verbatim}
\normalsize

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 {\bf
RunBeforeJob} or {\bf RunAfterJob} records. 

It is also possible to run the Console program from file input where the file
contains the commands as follows: 

\footnotesize
\begin{verbatim}
./bconsole -c ./bconsole.conf <filename
\end{verbatim}
\normalsize

where the file named {\bf 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. 

\footnotesize
\begin{verbatim}
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
\end{verbatim}
\normalsize

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: 

\footnotesize
\begin{verbatim}
grep "^Termination: *Backup OK" /tmp/log1.out
backupstat=$?
grep "^Termination: *Restore OK" /tmp/log2.out
restorestat=$?
\end{verbatim}
\normalsize

\section{Adding Volumes to a Pool}
\index[general]{Adding Volumes to a Pool}
\index[general]{Pool!Adding Volumes to a}

If you have used the {\bf 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 {\bf Bacula}
you will need to label it. 

Before adding a volume, you must know the following information: 

\begin{enumerate}
\item The name of the Pool (normally "Default")  
\item The Media Type as specified in the Storage Resource  in the Director's
   configuration file (e.g. "DLT8000")  
\item The number and names of the Volumes you wish to create. 
\end{enumerate}

For example, to add media to a Pool, you would issue the following commands to
the console program: 

\footnotesize
\begin{verbatim}
*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
*
\end{verbatim}
\normalsize

To see what you have added, enter: 

\footnotesize
\begin{verbatim}
*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 |
+-------+----------+---------+---------+-------+------------------+
*
\end{verbatim}
\normalsize

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. 
