Suite de console.tex.

[bacula/docs] / docs / manual-fr / console.tex

%%
%%

\section*{La console Bacula}
\label{_ConsoleChapter}
\index[general]{Console!Bacula}
\index[general]{La console Bacula}
\index[console]{Console!Bacula}
\index[console]{LA console Bacula}
\addcontentsline{toc}{section}{La console Bacula}

\subsection*{G\'en\'eralit\'es}
\index[general]{G\'en\'eralit\'es}
\addcontentsline{toc}{subsection}{G\'en\'eralit\'es}

La {\bf console Bacula} (parfois d\'esign\'ee "Agent utilisateur") est un programme 
qui permet \`a l'utilisateur autoris\'e ou \`a l'administrateur syst\`eme d'interagir 
avec le Director. 

Actuellement, la console Bacula existe en deux versions : une interface shell 
(fa{\c c}on TTY), et une interface graphique GNOME. Avec la console Bacula, vous 
pouvez d\'eterminer l'\'etat d'un job particulier, examiner le contenu du 
catalogue et effectuer certaines manipulations de cartouches.

Il existe d'autre part un programme nomm\'e wx-console, b\^atie avec wxWidgets qui 
offre une interface graphique aux op\'erations de restauration.

Etant donn\'e que la Console interagit avec le Director au travers du r\'eseau, 
il n'est pas n\'ecessaire que les deux programmes r\'esident sur la m\^eme machine.

Bacula a besoin d'un minimum de retour de la Console afin de pouvoir utiliser plus 
d'une cartouche. En effet, lorsqu'il en r\'eclame une nouvelle, il attend jusqu'\`a 
ce qu'un op\'erateur lui indique, via la Console, qu'une nouvelle cartouche est mont\'ee.

\subsection*{Configuration de la Console}
\index[general]{Configuration de la Console}
\index[general]{Configuration!Console}
\index[console]{Configuration de la Console}
\index[console]{Configuration!Console}
\addcontentsline{toc}{subsection}{Configuration de la Console}

Lors de son lancement, la Console lit le fichier de configuration standard 
nomm\'e {\bf bconsole.conf} (ou {\bf gnome-console.conf} dans le cas de la version 
GNOME) Ce fichier d\'efinit une configuration par d\'efaut de la Console et, \`a l'heure 
actuelle, la seule ressource d\'efinie est la ressource Director, qui informe 
la Console du nom et de l'adresse du Director. Pour plus d'informations sur la 
configuration de la Console, voyez le chapitre \ilink{Configurer la Console}{_ChapterStart36} 
de ce manuel.

\subsection*{Utiliser la Console}
\index[general]{Utiliser la Console}
\index[general]{Console!Utiliser la}
\index[console]{Utiliser la Console}
\index[console]{Console!Utiliser la}
\addcontentsline{toc}{subsection}{Utiliser la Console}

Apr\`es son d\'emarrage, la Console est en attente de vos commandes, ce qui 
est indiqu\'e par une ast\'erisque (*) (ce n'est pas le cas dans la version 
GNOME o\`u vous saisissez vos commandes dans la boite texte en bas de l'\'ecran). 
Vous pouvez, pour toutes les commandes, vous contenter d'entrer le nom de la 
commande, la Console se chargera de vous demander les arguments n\'ecessaires, 
mais dans la plupart des cas, vous pouvez entrer les commandes suivies de leurs 
arguments. Le format g\'en\'eral est :

\footnotesize
\begin{verbatim}
 <command> <keyword1>[=<argument1>] <keyword2>[=<argument2>] ...
\end{verbatim}
\normalsize

O\`u {\bf command} est l'une des commandes \'enum\'er\'ees ci-dessous, {\bf keyword} 
est l'un des mots-clef \'enum\'er\'es ci-dessous (usuellement suivi d'un argument), 
et {\bf argument} est la valeur du mot-clef. La commande peut \^etre abr\'eg\'ee 
jusqu'\`a sa plus courte abr\'eviation unique. Si deux commandes commencent 
par les m\^emes lettres, c'est celle qui appara\^it en t\^ete dans la liste fournie 
par la commande {\bf help} qui sera s\'electionn\'ee si votre abr\'eviation est 
ambig\"ue. Aucun des mots-clef suivant la commande ne peut \^etre abr\'eg\'e.

Par exemple :

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

\'enum\`ere les fichiers sauvegard\'es par le job de JobId 23. 

Cette autre commande :

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

affiche toutes les ressources Pool.

\subsection*{Quitter la Console}
\index[general]{Console!Quitter}
\index[general]{Quitter la Console}
\index[console]{Console!Quitter}
\index[console]{Quitter la Console}
\addcontentsline{toc}{subsection}{Quitter la Console}

Normalement, le programme Console se termine si vous saisissez  {\bf quit} 
ou {\bf exit}. Cependant, il il attend jusq"\`a ce que le Director ait pris 
en compte la commande, ce qui peut prendre du temps si ce dernier est d\'ej\`a 
occup\'e \`a une t\^ache longue (par exemple, un \'elagage du catalogue). Si vous voulez 
quitter la Console imm\'ediatement, utilisez la commande {\bf .quit}.

Il n'existe actuellement aucun moyen d'interrompre une commande de la Console 
une fois lanc\'ee (Ctrl-C ne marche pas). En revanche, \`a l'invite d'une commande 
vous demandant de choisir parmi plusieurs possibilit\'es, vous pouvez annuler 
la commande en entrant un point ({\bf .}), vous serez dans la plupart des cas 
ramen\'e \`a l'invite principal, ou \`a l'invite pr\'ec\'edente, dans le cas de choix 
imbriqu\'es. En quelques endroits, comme celui o\`u l'on vous demande un 
nom de volume, le point sera pris pour la r\'eponse (Bacula pensera que vous 
voulez nommer votre volume "."). Dans cette situation, vous serez la plupart 
du temps en mesure d'annuler \`a l'invite suivante.

\label{keywords}
\subsection*{Index des mots-clef de la Console}
\index[general]{Mots-clef!Index Console}
\index[general]{Index des mots-clef de la Console}
\index[console]{Mots-clef!Index Console}
\index[console]{Index des mots-clef de la Console}
\addcontentsline{toc}{subsection}{Index des mots-clef de la Console}
Sauf sp\'ecification contraire, chacun des mots-clef suivant admet un argument, 
qui est sp\'ecifi\'e apr\`es le mot-clef suivi du signe \'egale. Par exemple :

\begin{verbatim}
jobid=536
\end{verbatim}

Notez que cette liste est probablement incompl\`ete, car le processus de cr\'eation 
est toujours en cours. Il se peut aussi qu'elle ne soit pas dans l'ordre 
alphab\'etique.

\begin{description}
\item [restart]
 Permis dans la commande {\it python}, provoque le red\'emarrage de 
 l'interpr\'eteur Python. Ne prend pas d'arguments.
\item [all]
  Permis dans les commandes {\it status} et {\it show} pour sp\'ecifier, respectivement,  tous les 
  composants ou toutes les ressources.
\item [before]
  Utilis\'e dans la commande {\it restore}.
\item [bootstrap]
  Utilis\'e dans la commande {\it restore}.
\item [catalog]
  Permis dans la commande {\it use} pour sp\'ecifier le nom de catalogue \`a utiliser. 
\item [catalogs]
  Utilis\'e dans la commande {\it show}. Ne prend pas d'arguments
\item [client | fd]
\item [clients]
  Utilis\'e dans les commandes {\it show}, {\it list}, et {\it llist}. ne prend pas d'arguments.
\item [counters]
  Utilis\'e dans la commande {\it show}. Ne prend pas d'arguments.
\item [current]
  Utilis\'e dans la commande {\it restore}. Ne prend pas d'arguments.
\item [days]
\item [devices]
  Utilis\'e dans la commande {\it show}. Ne prend pas d'arguments.
\item [dir | director]
\item [directors]
  Utilis\'e dans la commande {\it show}. Ne prend pas d'arguments.
\item [directory]
  Utilis\'e dans la commande {\it restore}.
\item [done]
  Utilis\'e dans la commande {\it restore}. Ne prend pas d'arguments.
\item [file]
  Utilis\'e dans la commande {\it restore}.
\item [files]
  Utilis\'e dans les commandes {\it list}, et {\it llist}. ne prend pas d'arguments.
\item [fileset]
\item [filesets]
 Utilis\'e dans la commande {\it show}. Ne prend pas d'arguments.
\item [help]
 Utilis\'e dans la commande {\it show}. Ne prend pas d'arguments.
\item [jobs]
  Utilis\'e dans les commandes {\it show}, {\it list} et {\it llist}. Ne prend pas d'arguments.
\item [jobmedia]
  Utilis\'e dans les commandes {\it list}, et {\it llist}. ne prend pas d'arguments.
\item [jobtotals]
  Utilis\'e dans les commandes {\it list}, et {\it llist}. ne prend pas d'arguments.
\item [jobid]
  Le JobId est le num\'ero de job qui est affich\'e dans le rapport de job. 
  C'est l'index du catalogue pour le job donn\'e. Bien qu'il soit unique 
  pour tous les jobs existant dans le catalogue, le m\^eme JobId peut 
  \^etre r\'eutilis\'e une fois qu'un job a \'et\'e supprim\'e du catalogue. 
  Vous d\'esignerez certainement les jobs sp\'ecifiques par leur JobId.
\item [job | jobname]
  Le mot-clef Job ou Jobname se r\'ef\`ere au nom que vous avez sp\'ecifi\'e 
  dans la ressource Job, et donc peut d\'esigner plusieurs jobs effectu\'es. 
  C'est particuli\`erement utile lorsque vous voulez la liste des jobs 
  execut\'es portant un nom particulier.
\item [level]
\item [listing]
  Permis dans la commande {\it estimate}. Ne prend pas d'arguments.
\item [limit]
\item [messages]
  Utilis\'e dans la commande {\it show}. Ne prend pas d'arguments.
\item [media]
 Utilis\'e dans les commandes {\it list}, et {\it llist}. ne prend pas d'arguments.
\item [nextvol | nextvolume]
  Utilis\'e dans les commandes {\it list}, et {\it llist}. ne prend pas d'arguments.
\item [on]
  Ne prend pas d'arguments.
\item [off]
  Ne prend pas d'arguments.
\item [pool]
\item [pools]
  Utilis\'e dans les commandes, {\it show}, {\it list}, et {\it llist}. ne prend pas d'arguments.
\item [select]
  Utilis\'e dans la commande {\it restore}. Ne prend pas d'arguments.
\item [storages]
  Utilis\'e dans la commande {\it show}. Ne prend pas d'arguments.
\item [schedules]
  Utilis\'e dans la commande {\it show}. Ne prend pas d'arguments.
\item [sd | store | storage]
\item [ujobid]
  L'ujobid est un identificateur unique de job qui est affich\'e dans 
  le rapport du job. Actuellement, il consiste en le nom du job 
  (celui de la directive Name de ce job) suffix\'e de la date et de 
  l'heure d'ex\'ecution du job. Ce mot-clef est utile si vous voulez 
  identifier compl\`etement l'instance du job ex\'ecut\'e.
\item [volume]
\item [volumes]
  Utilis\'e dans les commandes {\it list}, et {\it llist}. ne prend pas d'arguments.
\item [where]
  Utilis\'e dans la commande {\it restore}. Ne prend pas d'arguments.
\item [yes]
  Utilis\'e dans la commande {\it restore}. Ne prend pas d'arguments.
\end{description}

\label{list}
\subsection*{Index des commandes de la Console}
\index[general]{Commandes!Index des commandes de la Console}
\index[general]{Index des commandes de la Console}
\index[console]{Commandes!Index des commandes de la Console}
\index[console]{Index des commandes de la Console}
\addcontentsline{toc}{subsection}{Index des commandes de la Console}

Les commandes suivantes sont actuellement impl\'ement\'ees :

\begin{description}
\item [{add [pool=\lt{}pool-name\gt{} storage=\lt{}storage\gt{}
   jobid=\lt{}JobId\gt{}]} ]
   \index[console]{add}
Cette commande sert \`a ajouter des volumes \`a un pool existant. Les noms des 
volumes saisis sont plac\'es dans le catalogue et deviennent ainsi disponibles 
pour les sauvegardes. Normalement, on pr\'ef\`er utiliser la commande {\bf label} 
qui remplit les m\^emes fonctions en plus d'apposer une \'etiquette logicielle 
(label) sur les bandes, par opposition \`a {\bf add} qui se contente de 
r\'ef\'erencer le volume dans le catalogue. Ainsi, si vous utilisez {\bf add}, 
le volume doit pr\'eexister et \^etre d\'ej\`a \'etiquet\'e. Cette commande peut 
cependant \^etre utile si vous voulez ajouter plusieurs cartouches dans un 
pool en ne les \'etiquettant que plus tard. Elle peut aussi se r\'ev\'eler utile 
si vous importez des cartouches provenant d'un autre site. Consultez le 
paragraphe sur la commande {\bf label} pour conna\^itre la liste des 
caract\`eres autoris\'es dans un nom de volume.

\item [autodisplay on/off]
   \index[console]{autodisplay on/off}
  Cette commande accepte les arguments {\bf on} ou {\bf off} et active ou 
  d\'esactive l'affichage automatique des messages. La valeur par d\'efaut dans 
  la Console est {\bf off}, ce qui signifie que les messages en attente 
  vous sont notifi\'es, mais qu'ils ne sont pas automatiquement affich\'es. 
  La valeur par d\'efaut pour la console GNOME est {\bf on}, ainsi les 
  messages sont affich\'es lorqu'ils sont re{\c c}us (habituellement dans les 5 secondes 
  apr\`es qu'ils aient \'et\'e g\'en\'er\'es).

  Lorsque l'affichage automatique est d\'esactiv\'e, vous devez explicitement 
  en demander l'affichage avec la commande {\bf messages}.

\item [automount on/off]
   \index[console]{automount on/off}
  Cette commande accepte les arguments {\bf on} ou {\bf off} et active ou
  d\'esactive le montage automatique de la cartouche apr\`es une commande {\bf label}.
  La valeur par d\'efaut est {\bf on}. Si le montage automatique est d\'esactiv\'e, 
  vous devez explicitement monter la cartouche apr\`es avoir utilis\'e {\bf label} 
  pour pouvoir \'ecrire dessus.

\item [{cancel [jobid=\lt{}number\gt{} job=\lt{}job-name\gt{} ujobid=\lt{}unique-jobid\gt{}]}]
   \index[console]{cancel jobid}
   Cette commande sert \`a supprimer un job et admet les arguments {\bf jobid=nnn} 
   ou {\bf job=xxx} o\`u nnn est \`a remplacer par le JobId et xxx par le nom de 
   job. Si vous lancez cette commande sans arguments, la Console vous propose 
   de choisir parmi les jobs actifs celui \`a supprimer. 

   Une fois qu'un job est marqu\'e "A supprimer", il peut se passer quelques instants 
   (en g\'en\'eral, moins d'une minute) avant qu'il se termine, en fonction des 
   op\'erations en cours.

\item [{ create [pool=\lt{}pool-name\gt{}]}]
   \index[console]{create pool}
   Cette commande sert \`a cr\'eer un enregistrement Pool dans le catalogue 
   selon les ressources Pool d\'efinis dans le fichier de configuration 
   du Director. En un sens, cette commande se content de transf\'erer 
   l'information depuis la ressource Pool dans le fichier de configuration 
   vers le catalogue. En principe, cete commande est automatiquement 
   ex\'ecut\'ee au lancement du Director, pourvu que le pool soit r\'ef\'erenc\'e 
   dans une ressource Job. Si vous utilisez cette commande sur un pool 
   existant, elle met \`a jour le catalogue en foction des informations de 
   la ressource Pool. Apr\`es avoir cr\'e\'e un pool, vous uiliserez 
   probablement la commande {\bf label} pour \'etiqueter un ou plusieurs 
   volumes et enregistrer leurs noms dans le catalogue.
   
   Si, au lancement d'un job, Bacula d\'etermine qu'il n'y a pas de pool 
   enregistr\'e dans le catalogue, mais qu'il existe une ressource Pool pour 
   le pool appropri\'e, alors il le cr\'e\'e pour vous. Si vous voulez le voir 
   appara\^itre imm\'ediatement dans le catalogue, utilisez cette commande pour 
   forcer sa cr\'eation imm\'ediate.

\item [{ delete [volume=\lt{}vol-name\gt{} pool=\lt{}pool-name\gt{}  job
   jobid=\lt{}id\gt{}]}]
   \index[console]{delete}
   Cette commande s'utilise pour supprimer un volume, un pool ou un job 
   du catalogue, ainsi que tous les enregistrements du catalogue qui leur 
   sont associ\'es. Cette commande op\`ere exclusivement sur le catalogue 
   et n'a aucune r\'epercussion sur les donn\'ees \'ecrites sur les cartouches. 
   Elle peut \^etre dangereuse, et nous vous recommandons fortement de ne 
   pas l'utiliser si vous ne savez pas exactement ce que vous faites.
   
   Voici la forme compl\`ete de cette commande :

delete pool=\lt{}pool-name\gt{}
   
   supprime un pool du catalogue.

delete volume=\lt{}volume-name\gt{} pool=\lt{}pool-name\gt{} 

   supprime du catalogue un volume du pool sp\'ecifi\'e.

delete JobId=\lt{}job-id\gt{} JobId=\lt{}job-id2\gt{} ... 

  supprime du catalogue le job sp\'ecifi\'e.

delete Job JobId=n,m,o-r,t ...  
  
   supprime les job de JobIds m,n,o,p,q,r et t (o\`u m,n,... sont, bien sur, des 
   nombres). Ainsi, la commande "delete jobid" accepte les listes et les plages 
   de jobids.

\item [disable job\lt{}job-name\gt{}]
  \index[console]{enable}
  Cette commande vous permet de d\'esactiver un job normalement planifi\'e 
  pour ex\'ecution. Le job peut avoir \'et\'e pr\'ealablement activ\'e par la 
  directive {\bf Enabled} dans la ressource Job, ou avec la commande 
  {\bf enable} dans la Console. Au prochain d\'emarrage du Director, ou 
  si le fichier de configuration est recharg\'e, l'\'etat Enable/Disable sera 
  r\'etabli \`a celui sp\'ecifi\'e dans la ressource Job (la valeur par d\'efaut 
  est enabled).

\item [enable job\lt{}job-name\gt{}]
  \index[console]{enable}
 Cette commande vous permet de d'activer un job  planifi\'e
  pour ex\'ecution automatique. Le job peut avoir \'et\'e pr\'ealablement d\'esactiv\'e par la
  directive {\bf Disabled} dans la ressource Job, ou avec la commande
  {\bf disable} dans la Console. Au prochain d\'emarrage du Director, ou
  si le fichier de configuration est recharg\'e, l'\'etat Enable/Disable sera
  r\'etabli \`a celui sp\'ecifi\'e dans la ressource Job (la valeur par d\'efaut
  est enabled).

\label{estimate}
\item [estimate]
   \index[console]{estimate}
   Avec cette commande, vous pouvez vous faire une id\'ee du nombre de fichier 
    seront sauvegard\'es. Vous pouvez aussi l'utiliser pour \'eprouver les 
    param\`etres Include de vos FileSets sans passer par une sauvegarde 
    r\'eelle. Par d\'efaut, l'estimation est faite pour une sauvegarde Full.
    Cependant, vous pouvez passer outre ce comportement en sp\'ecifiant 
    {\bf level=Incremental} ou {\bf level=Differential} sur la ligne de 
    commande. Un nom de job doit \^etre sp\'ecifi\'e, faute de quoi il vous sera 
    demand\'e. Optionnellement, vous pouvez sp\'ecifier un client et un 
    FileSet sur la ligne de commande. Bacula contacte alors le client 
    et calcule le nombre de fichier et d'octets qui seraient 
    sauvegard\'es. Notez qu'il s'agit d'une estimation calcul\'ee d'apr\`es 
    le nombre de blocs dans les fichiers plut\^ot qu'en lisant le nombre 
    effectif d'octets. Aussi, la taille estim\'ee est g\'en\'eralement plus 
    importante que celle de la sauvegarde r\'eelle.

    Optionnellement, vous pouvez ajouter le mot-clef {\bf listing}, auquel cas 
    tous les fichiers \`a sauvegarder seront affich\'es. Notez qu'un tel affichage 
    peut prendre un certain temps s'il s'agit d'une grosse sauvegarde.
    Voici la forme compl\`ete de cette commande :


estimate job=\lt{}job-name\gt{} listing client=\lt{}client-name\gt{} 
fileset=\lt{}fileset-name\gt{} level=\lt{}level-name\gt{}  

    La sp\'ecification du {\bf job} est suffisante, mais vous pouvez aussi 
    passer outre le client, le FileSet et/ou le niveau en les 
    sp\'ecifiant sur la ligne de commande.

    Par exemple, vous pourriez faire ceci : 

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

ce qui produirait une liste compl\`ete de tous les fichiers \`a sauvegarder pour 
le job {\bf NightlySave} au cours d'une sauvegarde incr\'ementale, et qui 
consignerait cette liste dans le fichier {\bf /tmp/listing}.

\item [help]
   \index[console]{help}
   Cette commande affiche la liste des commandes disponibles.

\item [label]
   \index[console]{label}
   \index[console]{relabel}
   \index[general]{label}
   \index[general]{relabel}
   Cette commande est utilis\'ee pour \'etiqueter les volumes. La forme compl\`ete est :

label storage=\lt{}storage-name\gt{} volume=\lt{}volume-name\gt{}
slot=\lt{}slot\gt{}  

   Si vous omettez l'un quelconque des arguments, il vous sera r\'eclam\'e. 
   Le type de m\'edia est automatiquement r\'ecup\'er\'e de la ressource Storage. 
   Une fois que les informations requises sont r\'eunies, la Console 
   contacte le Storage Daemon sp\'ecifi\'e et lui ordonne d'\'etiqueter la 
   cartouche sp\'ecifi\'ee. Si l'\'etiquetage s'effectue correctement, la 
   Console cr\'e\'e un nouvel enregistrement dans le catalogue pour le 
   volume dans le pool appropri\'e.

   Les noms de volumes ne doivent contenir que des lettres, chiffres et 
   les caract\`eres sp\'eciaux tiret ({\bf -}), sous-lign\'e ({\bf \_}), double-point 
   ({\bf :}), et point ({\bf .}). Tous les autres caract\`eres, y compris l'espace, 
   sont ill\'egaux. Cette restriction vise \`a assurer une bonne lisibilit\'e 
   des noms de volumes pour r\'eduire le risque d'erreurs humaines.

   Notez que lors de l'\'etiquetage d'une cartouche vierge, Bacula obtient des 
   erreurs {\bf read I/O error} lorqu'il tente de v\'erifier si la cartouche 
   a d\'ej\`a un label. Si vous voulez \'eviter ce genre de message, placez un 
   indicateur de fin de fichier sur votre cartouche avant son \'etiquetage :

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

La commande label peut \'echouer pour plusieurs raisons :


\begin{enumerate}
\item Le nom de volume que vous avez sp\'ecifi\'e figure d\'ej\`a dans le catalogue.
\item Le Storage Daemon a d\'ej\`a une cartouche mont\'ee dans le lecteur. Dans ce cas, 
  vous devez la d\'emonter ({\bf unmount}) et ins\'erer une cartouche vierge 
  avant de lancer la commande {\bf label}.
\item La cartouche dans le lecteur porte d\'ej\`a une \'etiquette Bacula. 
  (Bacula ne r\'e-\'etiquette jamais une cartouche \`a moins qu'elle soit recycl\'ee 
  et que vous utilisiez la commande  {\bf relabel} ).
\item Il n'y a pas de cartouche dans le lecteur.
\end{enumerate}

Il existe deux moyens pour r\'e-\'etiqueter un volume qui porte d\'ej\`a une 
\'etiquette Bacula. La m\'ethode brutale consiste \`a \'ecrire une marque de fin de 
fichier sur la cartouche vec la commande du syst\`eme d'exploitation {\bf mt}, 
quelque chose dans ce style :

\footnotesize
\begin{verbatim}
       mt -f /dev/st0 rewind
       mt -f /dev/st0 weof
\end{verbatim}
\normalsize

puis d'utiliser la commande {\bf label} pour ajouter une nouvelle \'etiquette. 
Cette m\'ethode peut cependant laisser des traces de l'ancien volume dans le 
catalogue.

Il est pr\'ef\'erable d'utiliser la commande {\bf relabel} d\'ecrite ci-dessous sur 
un volume purg\'e (automatiquement ou avec la commande {\bf purge}).

Si votre librairie comporte un lecteur de codes barres, vous pouvez 
\'etiqueter tous les volumes qu'elle contient en 
utilisant la commande {\bf label barcodes}. En effet, apr\`es le lancement de 
cette commande, Bacula monte chaque cartouche l'une apr\`es l'autre et 
l'\'etiquette du nom de son code barres. simultan\'ement, l'enregistrement 
appropri\'e est cr\'e\'e dans le catalogue. Toute cartouche dont le code barres 
commence par les m\^emes caract\`eres que ceux sp\'ecifi\'es par la directive 
"CleaningPrefix" de la ressource Pool du director est consid\'er\'ee comme 
une cartouche de nettoyage et ne re{\c c}oit donc pas d'\'etiquette, bien 
qu'une entr\'ee dans le catalogue lui soit d\'edi\'ee. Par exemple avec :

\footnotesize
\begin{verbatim}
        Pool {
          Name ...
          Cleaning Prefix = "CLN"
       }
        
\end{verbatim}
\normalsize

tout slot contenant une cartouche de code barres CLNxxxxx sera trait\'ee en tant 
que cartouche de nettoyage et ne sera jamais mont\'ee. Notez que la forme 
compl\`ete de la commande est :

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

\item [list]
   \index[console]{list}
   La commande {\bf list} extrait du catalogue les informations demand\'ees. Les 
   diff\'erentes champs de chaque enregistrement sont \'enum\'er\'es sur une simple 
   ligne. Voici les diff\'erentes formes de la commande : 
   
\footnotesize
\begin{verbatim}
   list jobs
   
   list jobid=<id>           (affiche le jobid id)

   list ujobid=<unique job name> (affiche le job dont le nom unique est <unique job name>)
   
   list job=<job-name>   (Affiche tous les jobs dont le nom est "job-name")

   list jobname=<job-name>  (voir ci-dessus)

     Dans cette commande, vous pouvez ajouter "limit=nn" pour limiter la sortie \`a nn jobs. 
   
   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

   Ce que font la plupart des commandes ci-dessus devrait \^etre plus ou moins \'evident. 
   En g\'en\'eral, si vous ne sp\'ecifiez pas tous les arguments requis, la Console 
   vous sollicitera pour les arguments manquants.

   La commande {\bf list nextvol} affiche le nom du volume qui dera utilis\'e par 
   le job sp\'ecifi\'e. Soyez conscient que le prochain volume utilis\'e 
   pour un job d\'epend de nombreux facteurs dont le temps, et les autres 
   jobs qui seront ex\'ecut\'es avant celui sp\'ecifi\'e, qui peuvent remplir une 
   cartouche qui \'etait vide au moment de l'ex\'ecution de {\bf list nextvol}.
   Aussi, consid\'erez la r\'eponse fournie par cette commande comme une bonne 
   estimation plut\^ot que comme une r\'eponse d\'efinitive. De plus, cette commande 
   a certains effets de bord : \'etant donn\'e qu'elle ex\'ecute le m\^eme algorithme 
   qu'un job, elle est susceptible de purger ou recycler un volume. Par d\'efaut, 
   le job sp\'ecifi\'e doit \^etre ex\'ecut\'e dans les deux jours ou aucun volume 
   ne sera trouv\'e. Vous pouvez cependant sp\'ecifier jusqu'\`a 50 jours en avant 
   avec la directive {\bf days=nnn}. Si, par exemple, un vendredi, vous voulez 
   savoir quel volume sera requis lundi pour le job MyJob, utilisez 
   {\bf list nextvol job=MyJob days=3}.

   Si vous souhaitez ajouter vos propres commandes pour interroger le 
   catalogue, vous pouvez les placer dans le fichier {\bf query.sql}. 
   Cela demande quelques connaissances du langage SQL. Voyez le 
   paragraphe sur la commande  {\bf query} ci-dessous pour plus 
   d'informations. Voyez aussi le paragraphe sur la commande 
   {\bf llist} qui permet l'affichage complet des informations du 
   catalogue.
   
   Voici un exemple d'affichage produit par la commande {\bf list pools} :

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

   Comme mentionn\'e pr\'ec\'edemment, la commande {\bf list} affiche des 
   informations du catalogue. Certais \'el\'ements sont ajout\'es dans le catalogue 
   d\`es le d\'emarrage de Bacula, mais en g\'en\'eral, la plupart ne le sont que 
   lorsqu'ils sont utilis\'es pour la premi\`ere fois. C'est le cas des clients, 
   des jobs, etc.

   Bacula cr\'e\'e une entr\'ee relative \`a un nouveau client dans le catalogue 
   la premi\`ere fois que vous ex\'ecut\'ez un job pour ce client. L'entr\'ee est 
   cr\'e\'ee que le job aboutisse ou qu'il \'echoue, mais il doit au moins d\'emarrer. 
   Lorsque le client est contact\'e, des informations suppl\'ementaires sont 
   r\'ecup\'er\'ees du client (le r\'esultat d'un "uname -a") et ajout\'ees au 
   catalogue. Un {\bf status} n'entra\^ine pas l'enregistrement dans le catalogue. 

   Si vous voulez visualiser les ressources Client disponibles dans votre 
   catalogue, utilisez la commande {\bf show clients}.

\item [llist]
   \index[console]{llist}
   La commande {\bf llist} (pour "long list") admet les m\^emes arguments que la 
   commande list d\'ecrite ci-dessus. La diff\'erence est que {\bf llist} affiche 
   le contenu complet de chaque enregistrement du catalogue s\'electionn\'e. 
   L'affichage des diff\'erents champs est produit verticalement, un champ par 
   ligne. Cette commande peut \^etre tr\`es prolixe.
   
   Si, au lieu du {\bf list pools} de l'exemple pr\'ec\'edent, vous saisissez 
   {\bf llist pools}, vous obtiendrez un affichage de ce genre :

\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[console]{messages}
   Cette commande affiche imm\'ediatement tout message de la console en attente.
 

\item [mount]
   \index[console]{mount}
  
   La commande {\bf mount} est utilis\'ee pour obtenir de Bacula qu'il lise 
   un volume charg\'e dans un lecteur. C'est un moyen d'indiquer \`a Bacula 
   que vous avez charg\'e une cartouche qu'il doit examiner. Cette commande 
   n'est utilis\'ee que lorsque Bacula a demand\'e votre intervention pour 
   charger un lecteur vide, ou lorsque vous avez explicitement d\'emont\'e 
   un volume avec la commande {\bf unmount} dans la Console, ce qui 
   provoque la fermeture du lecteur. Si vous avez une librairie, vous ne 
   ferez pas op\'erer Bacula dessus avec la commande mount. Voici les 
   diff\'erentes formes de cette commande :

mount  storage=\lt{}storage-name\gt{}

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

   Si vous avez sp\'ecifi\'e {\bf Automatic  Mount = yes} dans la ressource 
   Device du Storage Daemon, Alors Bacula pourra acc\'eder automatiquement 
   au volume, \`a moins que vous ne l'ayez explicitement d\'emont\'e ({\bf unmount}) 
   dans la Console.

\item[python]
   \index[console]{python}
    La commande {\bf python} n'admet qu'un argument : {\bf restart}.
    
   La commande {\bf python} {\bf restart} r\'einitialise l'interpr\'eteur Python 
   du Director. Ceci peut \^etre tr\`es utile pour effectuer des tests, car une 
   fois que le Director est lanc\'e, et l'interpr\'eteur Python initialis\'e, 
   il n'y a pas d'autre moyen de lui faire int\'egrer des modifications 
   du script de d\'emarrage {\bf DirStartUp.py}. Pour plus de d\'etails sur 
   l'\'ecriture de scripts Python, consultez le chapitre \ilink{Ecrire des 
   scripts Python}{_ChapterStart60}.
   
\label{ManualPruning}
\item [prune]
   \index[console]{prune}
   La commande {\bf prune} permet d'\'elaguer en toute s\'ecurit\'e les 
   enregistrements expir\'es du catalogue pour les jobs et les volumes. 
   Cette commande n'affecte que le catalogue, et non les donn\'ees 
   \'ecrites sur les volumes. Dans tous les cas, la commande {\bf prune} 
   respecte les p\'eriodes de r\'etention des enregistrements sp\'ecifi\'es. 
   Vous pouvez \'elaguer les jobs expir\'es, ainsi que les jobs et fichiers 
   d'un volume sp\'ecifi\'e.

prune files|jobs|volume client=\lt{}client-name\gt{} 
volume=\lt{}volume-name\gt{}  

   Pour qu'un volume soit \'elagu\'e, son  {\bf VolStatus} doit \^etre Full, 
   Used, ou Append, faute de quoi l'\'elagage sera sans effet.
   
\item [purge]
   \index[console]{purge}
   La commande {\bf purge} efface les enregistrements sp\'ecifi\'es du catalogue 
   sans \'egards pour les p\'eriodes de r\'etention. {\bf Purge} n'affecte que le 
   catalogue, et non les donn\'ees \'ecrites sur les volumes. Cette commande 
   peut se r\'ev\'eler tr\`es dangereuse car vous pouvez parfaitement supprimer 
   les enregistrements relatifs \`a des sauvegardes valides et r\'ecentes. Aussi, 
   nous vous recommandons de ne pas l'utiliser \`a moins de savoir exactement 
   ce que vous faites. Voici les diff\'erentes formes de la commande {\bf purge} :
   
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)


   Pour qu'un volume puisse \^etre purg\'e, son {\bf VolStatus} doit \^etre Full,
   Used, ou Append, faute de quoi la purge sera sans effet.

\item [relabel]
   \index[console]{relabel}
   \index[general]{relabel}
   Cette commande sert \`a r\'e-\'etiqueter physiquement un volume. En voici 
   la forme compl\`ete :

relabel storage=\lt{}storage-name\gt{} oldvolume=\lt{}old-volume-name\gt{}  
    volume=\lt{}newvolume-name\gt{} 
 
   Si vous omettez l'un quelconque des arguments, la console vous sollicitera 
   pour obtenir les informations manquantes. Pour qu'un volume puisse \^etre 
   r\'e-\'etiquet\'e, il doit figurer dans le catalogue, et avoir le statut 
   {\bf Purged} ou {\bf Recycle}. Cette situation peut se pr\'esenter 
   automatiquement par l'application des p\'eriodes de r\'etention, ou vous 
   pouvez l'obtenir par une {\bf purge} explicite du volume.

   Une fois que le volume a \'et\'e physiquement r\'e-\'etiquet\'e, les donn\'ees 
   qu'il contenait sont d\'efinitivement et irr\'em\'ediablement perdues.

\item [release]
   \index[console]{release}
   Cette commande ordonne au Storage Daemon de rembobiner la cartouche 
   dans le lecteur, et de relire son \'etiquette \`a la prochaine utilisation 
   de la cartouche.

release storage=\lt{}storage-name\gt{}  

   Apr\`es cette commande, le lecteur est gard\'e \`a l'\'etat ouvert par Bacula 
   (sauf si l'option Always Open est d\'esactiv\'ee dans la configuration 
   du Storage Daemon), et il ne peut donc \^etre utilis\'e par un autre 
   programme. Toutefois, il est possible, avec certains lecteurs, de 
   changer la cartouche \`a ce stade. Lors du prochain job, Bacula saura 
   relire l'\'etiquette de la cartouche pour savoir laquelle est mont\'ee. 
   Si vous voulez \^etre en mesure d'utiliser le lecteur avec un autre 
   programme, par exemple {\bf mt}, vous devez uiliser la commande 
   {\bf unmount} pour que Bacula le lib\`ere compl\`etement.

\item [reload]
  \index[console]{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
  10 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[console]{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{}client-name\gt{} 
  where=\lt{}path\gt{} pool=\lt{}pool-name\gt{} fileset=\lt{}fileset-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}{_ChapterStart13} of this
   manual.

\item [run]
   \index[console]{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[console]{setdebug}
   \index[dir]{setdebug}
   \index[dir]{debugging}
   \index[dir]{debugging Win32}
   \index[dir]{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[console]{show}
   \index[dir]{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[console]{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[dir]{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=\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 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:


\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 3 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[console]{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>

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

\label{UpdateCommand}
\item [update]
   \index[console]{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
   Slot
   InChanger Flag
   Pool
   Volume Files
   Volume from Pool
   All Volumes from Pool
   
\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} and {\bf 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:

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

\item [use]
   \index[console]{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[console]{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[console]{version}
   The command prints the Director's version.  

\item [quit]
   \index[console]{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[console]{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[console]{exit}
   This command terminates the console program.  

\item [wait]
   \index[console]{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. 
\end{description}

\label{dotcommands}

\subsection*{Special dot Commands}
\index[general]{Commands!Special dot}
\index[general]{Special dot Commands}
\addcontentsline{toc}{subsection}{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
.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.
.jobs                 list all job names
.levels               list all levels
.filesets             list all fileset names
.clients              list all client names
.pools                list all pool names
.types                list job types
.msgs                 return any queued messages
.messages             get quick messages
.help                 help command output
.quit                 quit
.status               get status output
.exit                 quit
\end{verbatim}
\normalsize

\label{atcommands}

\subsection*{Special At (@) Commands}
\index[general]{Commands!Special At @}
\index[general]{Special At (@) Commands}
\addcontentsline{toc}{subsection}{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[console]{@input \lt{}filename\gt{}}
   Read and execute the commands  contained in the file specified.  

\item [@output \lt{}filename\gt{} w/a]
   \index[console]{@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[console]{@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[console]{@sleep \lt{}seconds\gt{}}
   Sleep the specified number of seconds.  

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

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

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

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

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

\label{scripting}

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

\subsection*{Adding Volumes to a Pool}
\index[general]{Adding Volumes to a Pool}
\index[general]{Pool!Adding Volumes to a}
\addcontentsline{toc}{subsection}{Adding Volumes to a Pool}

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.