%%
\section*{Bacula Console}
-\label{_ChapterStart23}
-\index[general]{Console!Bacula }
-\index[general]{Bacula Console }
+\label{_ConsoleChapter}
+\index[general]{Console!Bacula}
+\index[general]{Bacula Console}
+\index[console]{Console!Bacula}
+\index[console]{Bacula Console}
\addcontentsline{toc}{section}{Bacula Console}
\subsection*{General}
-\index[general]{General }
+\index[general]{General}
\addcontentsline{toc}{subsection}{General}
The {\bf Bacula Console} (sometimes called the User Agent) is a program that
requests a new tape, it waits until the user, via the Console program,
indicates that the new tape is mounted.
-\subsection*{Configuration}
-\index[general]{Configuration }
-\addcontentsline{toc}{subsection}{Configuration}
+\subsection*{Console Configuration}
+\index[general]{Console Configuration}
+\index[general]{Configuration!Console}
+\index[console]{Console Configuration}
+\index[console]{Configuration!Console}
+\addcontentsline{toc}{subsection}{Console Configuration}
When the Console starts, it reads a standard Bacula configuration file named
{\bf bconsole.conf} or {\bf gnome-console.conf} in the case of the GNOME
this document.
\subsection*{Running the Console Program}
-\index[general]{Running the Console Program }
-\index[general]{Program!Running the Console }
+\index[general]{Running the Console Program}
+\index[general]{Program!Running the Console}
+\index[console]{Running the Console Program}
+\index[console]{Program!Running the Console}
\addcontentsline{toc}{subsection}{Running the Console Program}
After launching the Console program (bconsole), it will prompt you for the
will display all the Pool resource records.
\subsection*{Stopping the Console Program}
-\index[general]{Program!Stopping the Console }
-\index[general]{Stopping the Console Program }
+\index[general]{Program!Stopping the Console}
+\index[general]{Stopping the Console Program}
+\index[console]{Program!Stopping the Console}
+\index[console]{Stopping the Console Program}
\addcontentsline{toc}{subsection}{Stopping the Console Program}
Normally, you simply enter {\bf quit} or {\bf exit} and the Console program
the case of nested prompts). In a few places such as where it is asking for a
Volume name, the period will be taken to be the Volume name. In that case, you
will most likely be able to cancel at the next prompt.
-\label{list}
+\label{keywords}
+\subsection*{Alphabetic List of Console Keywords}
+\index[general]{Keywords!Alphabetic List of Console}
+\index[general]{Alphabetic List of Console Keywords}
+\index[console]{Keywords!Alphabetic List of Console}
+\index[console]{Alphabetic List of Console Keywords}
+\addcontentsline{toc}{subsection}{Alphabetic List of Console Keywords}
+Unless otherwise specified, each of the following keywords
+takes an argument, which is specified after the keyword following
+an equal sign. For example:
+
+\begin{verbatim}
+jobid=536
+\end{verbatim}
+
+Please note, this list is incomplete as it is currently in
+the process of being created and is not currently totally in
+alphabetic
+order ...
+
+\begin{description}
+\item [restart]
+ Permitted on the python command, and causes the Python
+ interpreter to be restarted. Takes no argument.
+\item [all]
+ Permitted on the status and show commands to specify all components or
+ resources respectively.
+\item [before]
+ Used in the restore command.
+\item [bootstrap]
+ Used in the restore command.
+\item [catalog]
+ Allowed in the use command to specify the catalog name
+ to be used.
+\item [catalogs]
+ Used in the show command. Takes no arguments.
+\item [client | fd]
+\item [clients]
+ Used in the show, list, and llist commands. Takes no arguments.
+\item [counters]
+ Used in the show command. Takes no arguments.
+\item [current]
+ Used in the restore command. Takes no argument.
+\item [days]
+\item [devices]
+ Used in the show command. Takes no arguments.
+\item [dir | director]
+\item [directors]
+ Used in the show command. Takes no arguments.
+\item [directory]
+ Used in the restore command.
+\item [done]
+ Used in the restore command. Takes no argument.
+\item [file]
+ Used in the restore command.
+\item [files]
+ Used in the list and llist commands. Takes no arguments.
+\item [fileset]
+\item [filesets]
+ Used in the show command. Takes no arguments.
+\item [help]
+ Used in the show command. Takes no arguments.
+\item [jobs]
+ Used in the show, list and llist commands. Takes no arguments.
+\item [jobmedia]
+ Used in the list and llist commands. Takes no arguments.
+\item [jobtotals]
+ Used in the list and llist commands. Takes no arguments.
+\item [jobid]
+ The JobId is the numeric jobid that is printed in the Job
+ Report output. It is the index of the database record for the
+ given job. While it is unique for all the existing Job records
+ in the catalog database, the same JobId can be reused once a
+ Job is removed from the catalog. Probably you will refer
+ specific Jobs that ran using their numeric JobId.
+\item [job | jobname]
+ The Job or Jobname keyword refers to the name you specified
+ in the Job resource, and hence it refers to any number of
+ Jobs that ran. It is typically useful if you want to list
+ all jobs of a particular name.
+\item [level]
+\item [listing]
+ Permitted on the estimate command. Takes no argument.
+\item [limit]
+\item [messages]
+ Used in the show command. Takes no arguments.
+\item [media]
+ Used in the list and llist commands. Takes no arguments.
+\item [nextvol | nextvolume]
+ Used in the list and llist commands. Takes no arguments.
+\item [on]
+ Takes no keyword.
+\item [off]
+ Takes no keyword.
+\item [pool]
+\item [pools]
+ Used in the show, list, and llist commands. Takes no arguments.
+\item [select]
+ Used in the restore command. Takes no argument.
+\item [storages]
+ Used in the show command. Takes no arguments.
+\item [schedules]
+ Used in the show command. Takes no arguments.
+\item [sd | store | storage]
+\item [ujobid]
+ The ujobid is a unique job identification that is printed
+ in the Job Report output. At the current time, it consists
+ of the Job name (from the Name directive for the job) appended
+ with the date and time the job was run. This keyword is useful
+ if you want to completely identify the Job instance run.
+\item [volume]
+\item [volumes]
+ Used in the list and llist commands. Takes no arguments.
+\item [where]
+ Used in the restore command.
+\item [yes]
+ Used in the restore command. Takes no argument.
+\end{description}
+
+\label{list}
\subsection*{Alphabetic List of Console Commands}
-\index[general]{Commands!Alphabetic List of Console }
-\index[general]{Alphabetic List of Console Commands }
+\index[general]{Commands!Alphabetic List of Console}
+\index[general]{Alphabetic List of Console Commands}
+\index[console]{Commands!Alphabetic List of Console}
+\index[console]{Alphabetic List of Console Commands}
\addcontentsline{toc}{subsection}{Alphabetic List of Console Commands}
The following commands are currently implemented:
\begin{description}
\item [{add [pool=\lt{}pool-name\gt{} storage=\lt{}storage\gt{}
jobid=\lt{}JobId\gt{}]} ]
- \index[console]{add [pool }
+ \index[console]{add}
This command is used to add Volumes to an existing Pool. The Volume names
entered are placed in the Catalog and thus become available for backup
operations. Normally, the {\bf label} command is used rather than this
command below for the list of legal characters in a Volume name.
\item [autodisplay on/off]
- \index[console]{autodisplay on/off }
- This command accepts {\bf on} or {\bf off} as an argument, and turns
-auto-display of messages on or off respectively. The default for the console
-program is {\bf off}, which means that you will be notified when there are
-console messages pending, but they will not automatically be displayed. The
-default for the gnome-console program is {\bf on}, which means that messages
-will be displayed when they are received (usually within 5 seconds of them
-being generated).
-
-When autodisplay is turned off, you must explicitly retrieve the messages
-with the {\bf messages} command. When autodisplay is turned on, the messages
-will be displayed on the console as they are received.
+ \index[console]{autodisplay on/off}
+ This command accepts {\bf on} or {\bf off} as an argument, and turns
+ auto-display of messages on or off respectively. The default for the
+ console program is {\bf off}, which means that you will be notified when
+ there are console messages pending, but they will not automatically be
+ displayed. The default for the gnome-console program is {\bf on}, which
+ means that messages will be displayed when they are received (usually
+ within 5 seconds of them being generated).
+
+ When autodisplay is turned off, you must explicitly retrieve the
+ messages with the {\bf messages} command. When autodisplay is turned
+ on, the messages will be displayed on the console as they are received.
\item [automount on/off]
- \index[console]{automount on/off }
- This command accepts {\bf on} or {\bf off} as the argument, and turns
-auto-mounting of the tape after a {\bf label} command on or off respectively.
-The default is {\bf on}. If {\bf automount} is turned off, you must
-explicitly {\bf mount} the tape after a label command to use it.
-
-\item [{cancel [jobid=\lt{}number\gt{} job=\lt{}job-name\gt{}]}]
- \index[console]{cancel [jobid }
- This command is used to cancel a job and accepts {\bf jobid=nnn} or {\bf
-job=xxx} as an argument where nnn is replaced by the JobId and xxx is
-replaced by the job name. If you do not specify a keyword, the Console
-program will prompt you with the names of all the active jobs allowing you to
-choose one.
-
-Once a Job is marked to be canceled, it may take a bit of time (generally
-within a minute) before it actually terminates, depending on what operations
-it is doing.
+ \index[console]{automount on/off}
+ This command accepts {\bf on} or {\bf off} as the argument, and turns
+ auto-mounting of the tape after a {\bf label} command on or off
+ respectively. The default is {\bf on}. If {\bf automount} is turned
+ off, you must explicitly {\bf mount} the tape after a label command to
+ use it.
+
+\item [{cancel [jobid=\lt{}number\gt{} job=\lt{}job-name\gt{} ujobid=\lt{}unique-jobid\gt{}]}]
+ \index[console]{cancel jobid}
+ This command is used to cancel a job and accepts {\bf jobid=nnn} or {\bf
+ job=xxx} as an argument where nnn is replaced by the JobId and xxx is
+ replaced by the job name. If you do not specify a keyword, the Console
+ program will prompt you with the names of all the active jobs allowing
+ you to choose one.
+
+ Once a Job is marked to be canceled, it may take a bit of time
+ (generally within a minute) before it actually terminates, depending on
+ what operations it is doing.
\item [{ create [pool=\lt{}pool-name\gt{}]}]
- \index[console]{create [pool }
- This command is used to create a Pool record in the database using the Pool
-resource record defined in the Director's configuration file. So in a sense,
-this command simply transfers the information from the Pool resource in the
-configuration file into the Catalog. Normally this command is done
-automatically for you when the Director starts providing the Pool is
-referenced within a Job resource. If you use this command on an existing
-Pool, it will automatically update the Catalog to have the same information
-as the Pool resource. After creating a Pool, you will most likely use the
-{\bf label} command to label one or more volumes and add their names to the
-Media database.
-
-When starting a Job, if Bacula determines that there is no Pool record in the
-database, but there is a Pool resource of the appropriate name, it will
-create it for you. If you want the Pool record to appear in the database
-immediately, simply use this command to force it to be created.
+ \index[console]{create pool}
+ This command is used to create a Pool record in the database using the
+ Pool resource record defined in the Director's configuration file. So
+ in a sense, this command simply transfers the information from the Pool
+ resource in the configuration file into the Catalog. Normally this
+ command is done automatically for you when the Director starts providing
+ the Pool is referenced within a Job resource. If you use this command
+ on an existing Pool, it will automatically update the Catalog to have
+ the same information as the Pool resource. After creating a Pool, you
+ will most likely use the {\bf label} command to label one or more
+ volumes and add their names to the Media database.
+
+ When starting a Job, if Bacula determines that there is no Pool record
+ in the database, but there is a Pool resource of the appropriate name,
+ it will create it for you. If you want the Pool record to appear in the
+ database immediately, simply use this command to force it to be created.
\item [{ delete [volume=\lt{}vol-name\gt{} pool=\lt{}pool-name\gt{} job
- jobid=\lt{}id\gt{}] }]
- \index[console]{delete }
-The delete command is used to delete a Volume, Pool or Job record from the
-Catalog as well as all associated Volume records that were created. This
-command operates only on the Catalog database and has no effect on the actual
-data written to a Volume. This command can be dangerous and we strongly
-recommend that you do not use it unless you know what you are doing.
-
-If the keyword {\bf Volume} appears on the command line, the named Volume
-will be deleted from the catalog, if the keyword {\bf Pool} appears on the
-command line, a Pool will be deleted, and if the keyword {\bf Job} appears on
-the command line, a Job and all its associated records (File and JobMedia)
-will be deleted from the catalog. The full form of this command is:
+ jobid=\lt{}id\gt{}]}]
+ \index[console]{delete}
+ The delete command is used to delete a Volume, Pool or Job record from
+ the Catalog as well as all associated catalog Volume records that were
+ created. This command operates only on the Catalog database and has no
+ effect on the actual data written to a Volume. This command can be
+ dangerous and we strongly recommend that you do not use it unless you
+ know what you are doing.
+
+ If the keyword {\bf Volume} appears on the command line, the named
+ Volume will be deleted from the catalog, if the keyword {\bf Pool}
+ appears on the command line, a Pool will be deleted, and if the keyword
+ {\bf Job} appears on the command line, a Job and all its associated
+ records (File and JobMedia) will be deleted from the catalog. The full
+ form of this command is:
delete pool=\lt{}pool-name\gt{}
-or
+ or
delete volume=\lt{}volume-name\gt{} pool=\lt{}pool-name\gt{} or
delete Job JobId=n,m,o-r,t ...
-The first form deletes a Pool record from the catalog database. The second
-form deletes a Volume record from the specified pool in the catalog database.
-The third form deletes the specified Job record from the catalog database.
-The last form deletes JobId records for JobIds n,m,o,p, q,r, and t. Where each
-one of the n,m,... is, of course, a number.
-\label{estimate}
+ The first form deletes a Pool record from the catalog database. The
+ second form deletes a Volume record from the specified pool in the
+ catalog database. The third form deletes the specified Job record from
+ the catalog database. The last form deletes JobId records for JobIds
+ n, m, o, p, q, r, and t. Where each one of the n,m,... is, of course, a
+ number. That is a "delete jobid" accepts lists and ranges of
+ jobids.
+
+\item [disable job\lt{}job-name\gt{}]
+ \index[console]{enable}
+ This command permits you to disable a Job for automatic scheduling.
+ The job may have been previously enabled with the Job resource
+ {\bf Enabled} directive or using the console {\bf enable} command.
+ The next time the Director is restarted or the conf file is reloaded,
+ the Enable/Disable state will be set to the value in the Job resource
+ (default enabled).
+
+\item [enable job\lt{}job-name\gt{}]
+ \index[console]{enable}
+ This command permits you to enable a Job for automatic scheduling.
+ The job may have been previously disabled with the Job resource
+ {\bf Enabled} directive or using the console {\bf disable} command.
+ The next time the Director is restarted or the conf file is reloaded,
+ the Enable/Disable state will be set to the value in the Job resource
+ (default enabled).
+\label{estimate}
\item [estimate]
- \index[console]{estimate }
- Using this command, you can get an idea how many files will be backed up, or
-if you are unsure about your Include statements in your FileSet, you can test
-them without doing an actual backup. The default is to assume a Full backup.
-However, you can override this by specifying a {\bf level=Incremental} or
-{\bf level=Differential} on the command line. A Job name must be specified
-or you will be prompted for one, and optionally a Client and FileSet may be
-specified on the command line. It then contacts the client which computes
-the number of files and bytes that would be backed up. Please note that this
-is an estimate calculated from the number of blocks in the file rather than
-by reading the actual bytes. As such, the estimated backup size will
-generally be larger than an actual backup.
-
-Optionally you may specify the keyword {\bf listing} in which case, all the
-files to be backed up will be listed. Note, it could take quite some time to
-display them if the backup is large. The full form is:
+ \index[console]{estimate}
+ Using this command, you can get an idea how many files will be backed
+ up, or if you are unsure about your Include statements in your FileSet,
+ you can test them without doing an actual backup. The default is to
+ assume a Full backup. However, you can override this by specifying a
+ {\bf level=Incremental} or {\bf level=Differential} on the command line.
+ A Job name must be specified or you will be prompted for one, and
+ optionally a Client and FileSet may be specified on the command line.
+ It then contacts the client which computes the number of files and bytes
+ that would be backed up. Please note that this is an estimate
+ calculated from the number of blocks in the file rather than by reading
+ the actual bytes. As such, the estimated backup size will generally be
+ larger than an actual backup.
+
+ Optionally you may specify the keyword {\bf listing} in which case, all the
+ files to be backed up will be listed. Note, it could take quite some time to
+ display them if the backup is large. The full form is:
estimate job=\lt{}job-name\gt{} listing client=\lt{}client-name\gt{}
fileset=\lt{}fileset-name\gt{} level=\lt{}level-name\gt{}
-Specification of the {\bf job} is sufficient, but you can also override the
-client, fileset and/or level by specifying them on the estimate command line.
+ Specification of the {\bf job} is sufficient, but you can also override
+ the client, fileset and/or level by specifying them on the estimate
+ command line.
As an example, you might do:
@output /tmp/listing
estimate job=NightlySave listing level=Incremental
@output
-
\end{verbatim}
\normalsize
/tmp/listing}.
\item [help]
- \index[console]{help }
+ \index[console]{help}
This command displays the list of commands available.
\item [label]
- \index[console]{label }
+ \index[console]{label}
+ \index[console]{relabel}
+ \index[general]{label}
+ \index[general]{relabel}
This command is used to label physical volumes. The full form of this command
-is:
+ is:
label storage=\lt{}storage-name\gt{} volume=\lt{}volume-name\gt{}
slot=\lt{}slot\gt{}
-If you leave out any part, you will be prompted for it. The media type is
-automatically taken from the Storage resource definition that you supply.
-Once the necessary information is obtained, the Console program contacts the
-specified Storage daemon and requests that the tape be labeled. If the tape
-labeling is successful, the Console program will create a Volume record in
-the appropriate Pool.
+ If you leave out any part, you will be prompted for it. The media type
+ is automatically taken from the Storage resource definition that you
+ supply. Once the necessary information is obtained, the Console program
+ contacts the specified Storage daemon and requests that the tape be
+ labeled. If the tape labeling is successful, the Console program will
+ create a Volume record in the appropriate Pool.
-The Volume name is restricted to letters, numbers, and the special characters
-hyphen ({\bf -}), underscore ({\bf \_}), colon ({\bf :}), and period ({\bf
-.}). All other characters including a space are illegal. This restriction is
-to ensure good readability of Volume names to reduce operator errors.
+ The Volume name is restricted to letters, numbers, and the special
+ characters hyphen ({\bf -}), underscore ({\bf \_}), colon ({\bf :}), and
+ period ({\bf .}). All other characters including a space are illegal.
+ This restriction is to ensure good readability of Volume names to reduce
+ operator errors.
-Please note, when labeling a blank tape, Bacula will get {\bf read I/O error} when
-it attempts to ensure that the tape is already labeled. If you wish to avoid
-getting these messages, please write and EOF mark on your tape before
-attempting to label it:
+ Please note, when labeling a blank tape, Bacula will get {\bf read I/O
+ error} when it attempts to ensure that the tape is already labeled. If
+ you wish to avoid getting these messages, please write and EOF mark on
+ your tape before attempting to label it:
\footnotesize
\begin{verbatim}
The label command can fail for a number of reasons:
- \begin{enumerate}
- \item The Volume name you specify is already in the Volume database.
- \item The Storage daemon has a tape already mounted on the device, in which
+\begin{enumerate}
+\item The Volume name you specify is already in the Volume database.
+\item The Storage daemon has a tape already mounted on the device, in which
case you must {\bf unmount} the device, insert a blank tape, then do the
{\bf label} command.
- \item The tape in the device is already a Bacula labeled tape. (Bacula will
- never relabel a Bacula labeled tape unless it is recycled and you use the
+\item The tape in the device is already a Bacula labeled tape. (Bacula will
+ never relabel a Bacula labeled tape unless it is recycled and you use the
{\bf relabel} command).
- \item There is no tape in the drive.
- \end{enumerate}
+\item There is no tape in the drive.
+\end{enumerate}
-There are two ways to relabel a volume that already has a Bacula label. The
+There are two ways to relabel a volume that already has a Bacula label. The
brute force method is to write an end of file mark on the tape using the
system {\bf mt} program, something like the following:
\begin{verbatim}
mt -f /dev/st0 rewind
mt -f /dev/st0 weof
-
\end{verbatim}
\normalsize
each tape in the changer containing a barcode, Bacula will mount the tape and
then label it with the same name as the barcode. An appropriate Media record
will also be created in the catalog. Any barcode that begins with the same
-characters as specified on the ``CleaningPrefix=xxx'' command, will be
-treated as a cleaning tape, and will not be labeled. For example with:
+characters as specified on the "CleaningPrefix=xxx" directive in the
+Director's Pool resource, will be
+treated as a cleaning tape, and will not be labeled. However,
+an entry for the cleaning tape will be created in
+the catalog. For example with:
\footnotesize
\begin{verbatim}
Pool {
Name ...
Cleaning Prefix = "CLN"
- }
+ }
\end{verbatim}
\normalsize
\footnotesize
\begin{verbatim}
-
update storage=xxx pool=yyy slots=1-5,10 barcodes
\end{verbatim}
\normalsize
\item [list]
- \index[console]{list }
- The list command lists the requested contents of the Catalog. The various
-fields of each record are listed on a single line. The various forms
-of the list command are:
+ \index[console]{list}
+ The list command lists the requested contents of the Catalog. The
+ various fields of each record are listed on a single line. The various
+ forms of the list command are:
\footnotesize
\begin{verbatim}
list jobs
- list jobid=\lt{}id\gt{}
+ list jobid=<id> (list jobid id)
+
+ list ujobid<unique job name> (list job with unique name)
- list job=\lt{}job-name\gt{}
+ list job=<job-name> (list all jobs with "job-name")
+
+ list jobname=<job-name> (same as above)
+
+ In the above, you can add "limit=nn" to limit the output to
+ nn jobs.
list jobmedia
- list jobmedia jobid=\lt{}id\gt{}
+ list jobmedia jobid=<id>
- list jobmedia job=\lt{}job-name\gt{}
+ list jobmedia job=<job-name>
- list files jobid=\lt{}id\gt{}
+ list files jobid=<id>
- list files job=\lt{}job-name\gt{}
+ list files job=<job-name>
list pools
list volumes
- list volumes jobid=\lt{}id\gt{}
+ list volumes jobid=<id>
- list volumes pool=\lt{}pool-name\gt{}
+ list volumes pool=<pool-name>
- list volumes job=\lt{}job-name\gt{}
+ list volumes job=<job-name>
- list volume=\lt{}volume-name\gt{} list nextvolume job=\lt{}job-name\gt{}
+ list volume=<volume-name>
+
+ list nextvolume job=<job-name>
- list nextvol job=\lt{}job-name\gt{}
+ list nextvol job=<job-name>
+
+ list nextvol job=<job-name> days=nnn
+
+
+
\end{verbatim}
\normalsize
-What most of the above commands do should be more or less obvious. In general
-if you do not specify all the command line arguments, the command will prompt
-you for what is needed.
-
-The {\bf list nextvol} command will print the Volume name to be used by the
-specified job. You should be aware that exactly what Volume will be used
-depends on a lot of factors including the time and what a prior job will do.
-It may fill a tape that is not full when you issue this command. As a
-consequence, this command will give you a good estimate of what Volume will
-be used but not a definitive answer. In addition, this command may have
-certain side effect because it runs through the same algorithm as a job,
-which means it may automatically purge or recycle a Volume.
-
-If you wish to add specialized commands that list the contents of the
-catalog, you can do so by adding them to the {\bf query.sql} file. However,
-this takes some knowledge of programming SQL. Please see the {\bf query}
-command below for additional information. See below for listing the full
-contents of a catalog record with the {\bf llist} command.
-
-As an example, the command {\bf list pools} might produce the following
-output:
+
+ What most of the above commands do should be more or less obvious. In
+ general if you do not specify all the command line arguments, the
+ command will prompt you for what is needed.
+
+ The {\bf list nextvol} command will print the Volume name to be used by
+ the specified job. You should be aware that exactly what Volume will be
+ used depends on a lot of factors including the time and what a prior job
+ will do. It may fill a tape that is not full when you issue this
+ command. As a consequence, this command will give you a good estimate
+ of what Volume will be used but not a definitive answer. In addition,
+ this command may have certain side effect because it runs through the
+ same algorithm as a job, which means it may automatically purge or
+ recycle a Volume. By default, the job specified must run within the
+ next two days or no volume will be found. You can, however, use the
+ {\bf days=nnn} specification to specify up to 50 days. For example,
+ if on Friday, you want to see what Volume will be needed on Monday,
+ for job MyJob, you would use {\bf list nextvol job=MyJob days=3}.
+
+ If you wish to add specialized commands that list the contents of the
+ catalog, you can do so by adding them to the {\bf query.sql} file.
+ However, this takes some knowledge of programming SQL. Please see the
+ {\bf query} command below for additional information. See below for
+ listing the full contents of a catalog record with the {\bf llist}
+ command.
+
+ As an example, the command {\bf list pools} might produce the following
+ output:
\footnotesize
\begin{verbatim}
\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.
+ 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).
+ 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}.
+ 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[console]{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.
+ \index[console]{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:
+ 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}
\normalsize
\item [messages]
- \index[console]{messages }
+ \index[console]{messages}
This command causes any pending console messages to be immediately displayed.
\item [mount]
- \index[console]{mount }
- The mount command is used to get Bacula to read a volume on a physical
-device. It is a way to tell Bacula that you have mounted a tape and that
-Bacula should examine the tape. This command is used only after there was no
-Volume in a drive and Bacula requests you to mount a new Volume or when you
-have specifically unmounted a Volume with the {\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. The various forms of
-the mount command are:
+ \index[console]{mount}
+ The mount command is used to get Bacula to read a volume on a physical
+ device. It is a way to tell Bacula that you have mounted a tape and
+ that Bacula should examine the tape. This command is used only after
+ there was no Volume in a drive and Bacula requests you to mount a new
+ Volume or when you have specifically unmounted a Volume with the {\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. The various forms of the mount command are:
mount storage=\lt{}storage-name\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.
-\label{ManualPruning}
+ 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[console]{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}{_ChapterStart60} chapter of this manual.
+
+\label{ManualPruning}
\item [prune]
- \index[console]{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.
+ \index[console]{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.
+ 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[console]{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{}
+ \index[console]{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)
The actual data written to the Volume will be unaffected by this command.
\item [relabel]
- \index[console]{relabel }
- This command is used to label physical volumes. The full form of this command
-is:
-
-relabel storage=\lt{}storage-name\gt{} volume=\lt{}newvolume-name\gt{}
-name=\lt{}old-volume-name\gt{}
+ \index[console]{relabel}
+ \index[general]{relabel}
+ This command is used to label physical volumes. The full form of this
+ command is:
-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.
+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 written on the Volume
-is lost and cannot be recovered.
+ Once the volume is physically relabeled, the old data previously written
+ on the Volume is lost and cannot be recovered.
\item [release]
- \index[console]{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.
+ \index[console]{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.
-
+ 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[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.
+ \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=\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.
+ 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 }
+ \index[console]{run}
This command allows you to schedule jobs to be run immediately. The full form
-of the command is:
+ 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
+ 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.
+ 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:
+ On my system, when I enter a run command, I get the following prompt:
\footnotesize
\begin{verbatim}
desired start time in YYYY-MM-DD HH:MM:SS format.
\item [setdebug]
- \index[dir]{setdebug }
+ \index[dir]{setdebug}
This command is used to set the debug level in each daemon. The form of this
-command is:
+ command is:
setdebug level=nn [trace=0/1 client=\lt{}client-name\gt{} | dir | director |
-storage=\lt{}storage-name\gt{} | all]
+ storage=\lt{}storage-name\gt{} | all]
-If trace=1 is set, then the tracing will be enabled, and the daemon where the
-setdebug applies will be placed in trace mode, and all debug output will go
-to the file {\bf bacula.trace} in the current directory of the daemon.
-Normally, tracing is used only for Win32 clients where the debug output
-cannot be written to a terminal or redirected to a file. When tracing, each
-debug output message is appended to the trace file. You must explicitly
-delete the file when you are done.
+ If trace=1 is set, then the tracing will be enabled, and the daemon
+ where the setdebug applies will be placed in trace mode, and all debug
+ output will go to the file {\bf bacula.trace} in the current directory
+ of the daemon. Normally, tracing is used only for Win32 clients where
+ the debug output cannot be written to a terminal or redirected to a
+ file. When tracing, each debug output message is appended to the trace
+ file. You must explicitly delete the file when you are done.
\item [show]
- \index[console]{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: directors, clients, counters, jobs,
-storages, catalogs, schedules, filesets, groups, pools, messages, all, help.
-Please don't confuse this command with the {\bf list}, which displays the
-contents of the catalog.
+ \index[console]{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[dir]{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.
+ \index[dir]{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:
+ \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{}]
+ 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.
+ 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:
+ In the Running Jobs listing, you may find the following types of
+ information:
\footnotesize
\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\".</dd>
+ 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 }
+ \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=\lt{}storage-name\gt{}
+unmount storage=<storage-name>
-unmount [ jobid=\lt{}id\gt{} | job=\lt{}job-name\gt{} ]
+unmount [ jobid=<id> | job=<job-name> ]
\end{verbatim}
\normalsize
\label{UpdateCommand}
\item [update]
- \index[console]{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
\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 will have their InChanger
-flag turned off. This permits Bacula to know what magazine (tape holder) is
-currently in the autochanger.
+ 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.
+ 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 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.
+ 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:
+ The full form of the update command with all command line arguments is:
\footnotesize
\begin{verbatim}
\normalsize
\item [use]
- \index[console]{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
\item [var]
\label{var}
- \index[console]{var name }
+ \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
+ 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 }
+ \index[console]{version}
The command prints the Director's version.
\item [quit]
- \index[console]{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
command (i.e. quit preceded by a period).
\item [query]
- \index[console]{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
\normalsize
\item [exit]
- \index[console]{exit }
+ \index[console]{exit}
This command terminates the console program.
\item [wait]
- \index[console]{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
\label{dotcommands}
\subsection*{Special dot Commands}
-\index[general]{Commands!Special dot }
-\index[general]{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
\footnotesize
\begin{verbatim}
-.die cause the Director to segment fault (for debugging)
-.jobs list all job names
-.filesets list all fileset names
-.clients list all client names
-.msgs return any queued messages
-.quit quit
-.exit quit
+.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 }
+\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
\begin{description}
\item [@input \lt{}filename\gt{}]
- \index[console]{@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 }
+ \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.
\normalsize
\item [@tee \lt{}filename\gt{} w/a]
- \index[console]{@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{} }
+ \index[console]{@sleep \lt{}seconds\gt{}}
Sleep the specified number of seconds.
\item [@time]
- \index[console]{@time }
+ \index[console]{@time}
Print the current time and date.
\item [@version]
- \index[console]{@version }
+ \index[console]{@version}
Print the console's version.
\item [@quit]
- \index[console]{@quit }
+ \index[console]{@quit}
quit
\item [@exit]
- \index[console]{@exit }
+ \index[console]{@exit}
quit
\item [@\# anything]
- \index[console]{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 }
+\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}
\normalsize
\subsection*{Adding Volumes to a Pool}
-\index[general]{Adding Volumes to a Pool }
-\index[general]{Pool!Adding Volumes to a }
+\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
Before adding a volume, you must know the following information:
\begin{enumerate}
-\item The name of the Pool (normally ''Default``)
+\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``)
+ configuration file (e.g. "DLT8000")
\item The number and names of the Volumes you wish to create.
- \end{enumerate}
+\end{enumerate}
For example, to add media to a Pool, you would issue the following commands to
the console program:
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
+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.
projects / bacula / docs / blobdiff