]> git.sur5r.net Git - bacula/docs/blobdiff - docs/manual/dirdconf.tex
Updates
[bacula/docs] / docs / manual / dirdconf.tex
index d3850fbacc85a06169654b89ec834eaf32dffb4b..83603369b348ed0921616e5ca688e514ef731be3 100644 (file)
@@ -29,10 +29,10 @@ Messages. We present them here in the most logical order for defining them:
 \item 
    \ilink{Director}{DirectorResource4} -- to  define the Director's
    name and its access password used for authenticating the Console program.
-Only a single  Director resource definition may appear in the Director's 
-configuration file.  If you have either {\bf /dev/random} or  {\bf bc} on your
-machine, Bacula will generate a random password during the configuration
-process, otherwise it will  be left blank. 
+   Only a single  Director resource definition may appear in the Director's 
+   configuration file.  If you have either {\bf /dev/random} or  {\bf bc} on your
+   machine, Bacula will generate a random password during the configuration
+   process, otherwise it will  be left blank. 
 \item 
    \ilink{Job}{JobResource} -- to define the backup/restore Jobs 
    and to tie together the Client, FileSet and Schedule resources to  be used
@@ -94,21 +94,21 @@ in the  graphical user interface. This directive is optional.
 \item [Password = \lt{}UA-password\gt{}]
    \index[dir]{Password }
    Specifies the password that  must be supplied for the default Bacula Console
-to be  authorized. The same password must appear in the  {\bf Director}
-resource of the Console configuration file.  For added security, the password
-is never actually passed  across the network but rather a challenge response
-hash code  created with the password. This directive is required. If you  have
-either {\bf /dev/random} or {\bf bc} on your machine,  Bacula will generate a
-random password during the  configuration process, otherwise it will be left
-blank and  you must manually supply it.  
+   to be  authorized. The same password must appear in the  {\bf Director}
+   resource of the Console configuration file.  For added security, the password
+   is never actually passed  across the network but rather a challenge response
+   hash code  created with the password. This directive is required. If you  have
+   either {\bf /dev/random} or {\bf bc} on your machine,  Bacula will generate a
+   random password during the  configuration process, otherwise it will be left
+   blank and  you must manually supply it.  
 
 \item [Messages = \lt{}Messages-resource-name\gt{}]
    \index[dir]{Messages }
    The messages resource  specifies where to deliver Director messages that are
-not associated  with a specific Job. Most messages are specific to a job and
-will  be directed to the Messages resource specified by the job. However, 
-there are a few messages that can occur when no job is running.  This
-directive is required.  
+   not associated  with a specific Job. Most messages are specific to a job and
+   will  be directed to the Messages resource specified by the job. However, 
+   there are a few messages that can occur when no job is running.  This
+   directive is required.  
 
 \item [Working Directory = \lt{}Directory\gt{}]
    \index[dir]{Working Directory }
@@ -138,22 +138,22 @@ Directory} as  defined above.  This directive is required.
 
 \item [Scripts Directory = \lt{}Directory\gt{}]
    \index[dir]{Scripts Directory }
-   This directive is optional and, if defined, specifies a directory in which
-the Director 
-will look for the Python startup script {\bf DirStartup.py}. This directory
-may be shared by other Bacula daemons.  Standard shell expansion of the
-directory is done when the configuration file is read so that values such 
-as {\bf \$HOME} will be properly expanded.
+   This directive is optional and, if defined, specifies a directory in
+   which the Director will look for the Python startup script {\bf
+   DirStartup.py}.  This directory may be shared by other Bacula daemons.
+   Standard shell expansion of the directory is done when the configuration
+   file is read so that values such as {\bf \$HOME} will be properly
+   expanded.
 
 \item [QueryFile = \lt{}Path\gt{}]
    \index[dir]{QueryFile }
-   This directive  is mandatory and specifies a directory and file in which the
-Director  can find the canned SQL statements for the {\bf Query} command of 
-the Console. Standard shell expansion of the {\bf Path} is done  when the
-configuration file is read so that values such as  {\bf \$HOME} will be
-properly expanded. This directive is required.  
-\label{DirMaxConJobs}
+   This directive is mandatory and specifies a directory and file in which
+   the Director can find the canned SQL statements for the {\bf Query}
+   command of the Console.  Standard shell expansion of the {\bf Path} is
+   done when the configuration file is read so that values such as {\bf
+   \$HOME} will be properly expanded.  This directive is required.
 
+\label{DirMaxConJobs}
 \item [Maximum Concurrent Jobs = \lt{}number\gt{}]
 \index[dir]{Maximum Concurrent Jobs }
 \index[general]{Simultaneous Jobs}
@@ -184,24 +184,21 @@ of this manual.
 
 \item [FD Connect Timeout = \lt{}time\gt{}]
    \index[dir]{FD Connect Timeout }
-   where {\bf time}  is the time that the Director should continue attempting 
-to
-contact the File daemon to start a job, and after which the  Director will
-cancel the job. The default is 30 minutes. 
+   where {\bf time} is the time that the Director should continue
+   attempting to contact the File daemon to start a job, and after which
+   the Director will cancel the job.  The default is 30 minutes.
 
 \item [SD Connect Timeout = \lt{}time\gt{}]
    \index[dir]{SD Connect Timeout }
-   where {\bf time}  is the time that the Director should continue attempting 
-to
-contact the Storage daemon to start a job, and after which the  Director will
-cancel the job. The default is 30 minutes. 
+   where {\bf time} is the time that the Director should continue
+   attempting to contact the Storage daemon to start a job, and after which
+   the Director will cancel the job.  The default is 30 minutes.
 
 \item [DirAddresses = \lt{}IP-address-specification\gt{}]
    \index[dir]{DirAddresses }
-   Specify the ports and addresses on which the Director daemon will  listen for
-Bacula Console connections. Probably the simplest way  to explain this is to
-show
-an example: 
+   Specify the ports and addresses on which the Director daemon will listen
+   for Bacula Console connections.  Probably the simplest way to explain
+   this is to show an example:
 
 \footnotesize
 \begin{verbatim}
@@ -1718,7 +1715,7 @@ otherwise it will  be left blank.
    device name as defined on the {\bf Name} directive contained in the {\bf
    Device} resource definition of the {\bf Storage daemon} configuration
    file or if the device is an Autochanger, you must put the name as
-   defined on the {\bf Name} directive contained in the {\bf Autochanger
+   defined on the {\bf Name} directive contained in the {\bf Autochanger}
    resource definition of the {\bf Storage daemon}.  You can specify any
    name you would like (even the device name if you prefer) up to a maximum
    of 127 characters in length.  The physical device name associated with
@@ -1911,35 +1908,35 @@ The Pool Resource defined in the Director's configuration file
 
 \item [Pool]
    \index[dir]{Pool}
-   Start of the Pool resource. There must  be at least one Pool resource
-defined.
+   Start of the Pool resource.  There must be at least one Pool resource
+   defined.
 
 
 \item [Name = \lt{}name\gt{}]
    \index[dir]{Name }
-   The name of the pool.  For most applications, you will use the default pool 
-name {\bf Default}. This directive is required.  
+   The name of the pool.  For most applications, you will use the default
+   pool name {\bf Default}.  This directive is required.
 
 \item [Number of Volumes = \lt{}number\gt{}]
    \index[dir]{Number of Volumes }
-   This directive specifies  the number of volumes (tapes or files) contained in
-the pool.  Normally, it is defined and updated automatically by the  Bacula
-catalog handling routines. 
-\label{MaxVolumes}
+   This directive specifies the number of volumes (tapes or files)
+   contained in the pool.  Normally, it is defined and updated
+   automatically by the Bacula catalog handling routines.
 
+\label{MaxVolumes}
 \item [Maximum Volumes = \lt{}number\gt{}]
    \index[dir]{Maximum Volumes }
-   This directive specifies the  maximum number of volumes (tapes or files)
-contained in the pool.  This directive is optional, if omitted or set to zero,
-any number  of volumes will be permitted. In general, this directive is useful
-for Autochangers where there is a fixed number of Volumes, or  for File
-storage where you wish to ensure that the backups made to  disk files do not
-become too numerous or consume too much space.  
+   This directive specifies the maximum number of volumes (tapes or files)
+   contained in the pool.  This directive is optional, if omitted or set to
+   zero, any number of volumes will be permitted.  In general, this
+   directive is useful for Autochangers where there is a fixed number of
+   Volumes, or for File storage where you wish to ensure that the backups
+   made to disk files do not become too numerous or consume too much space.
 
 \item [Pool Type = \lt{}type\gt{}]
    \index[dir]{Pool Type }
-   This directive defines the pool  type, which corresponds to the type of Job
-being run. It is  required and may be one of the following:  
+   This directive defines the pool type, which corresponds to the type of
+   Job being run.  It is required and may be one of the following:
 
 \begin{itemize}
 \item [Backup]  
@@ -1952,32 +1949,31 @@ being run. It is  required and may be one of the following:
 
 \item [Use Volume Once = \lt{}yes|no\gt{}]
    \index[dir]{Use Volume Once }
-   This directive  if set to {\bf yes} specifies that each volume is to be  used
-only once. This is most useful when the Media is a  file and you want a new
-file for each backup that is  done. The default is {\bf no} (i.e. use volume
-any  number of times). This directive will most likely be phased out 
-(deprecated), so you are recommended to use {\bf Maximum Volume Jobs = 1} 
-instead.  
-
-Please note that the value defined by this directive in the  bacula-dir.conf
-file is the default value used when a Volume  is created. Once the volume is
-created, changing the value  in the bacula-dir.conf file will not change what
-is stored  for the Volume. To change the value for an existing Volume  you
-must use the {\bf update} command in the Console.  
+   This directive if set to {\bf yes} specifies that each volume is to be
+   used only once.  This is most useful when the Media is a file and you
+   want a new file for each backup that is done.  The default is {\bf no}
+   (i.e.  use volume any number of times).  This directive will most likely
+   be phased out (deprecated), so you are recommended to use {\bf Maximum
+   Volume Jobs = 1} instead.
+
+   The value defined by this directive in the bacula-dir.conf file is the
+   default value used when a Volume is created.  Once the volume is
+   created, changing the value in the bacula-dir.conf file will not change
+   what is stored for the Volume.  To change the value for an existing
+   Volume you must use the {\bf update} command in the Console.
 
 \item [Maximum Volume Jobs = \lt{}positive-integer\gt{}]
    \index[dir]{Maximum Volume Jobs }
-   This directive specifies  the maximum number of Jobs that can be written to
-the Volume. If  you specify zero (the default), there is no limit. Otherwise, 
-when the number of Jobs backed up to the Volume equals {\bf positive-integer} 
-the Volume will be marked {\bf Used}. When the Volume is marked  {\bf Used} it
-can no longer be used for appending Jobs, much like  the {\bf Full} status but
-it can be recycled if recycling is enabled, and thus used again.
-By setting {\bf
-MaximumVolumeJobs} to one, you get the same  effect as setting {\bf
-UseVolumeOnce = yes}.
-
-Please note that the value defined by this directive in the  bacula-dir.conf
+   This directive specifies the maximum number of Jobs that can be written
+   to the Volume.  If you specify zero (the default), there is no limit.
+   Otherwise, when the number of Jobs backed up to the Volume equals {\bf
+   positive-integer} the Volume will be marked {\bf Used}.  When the Volume
+   is marked {\bf Used} it can no longer be used for appending Jobs, much
+   like the {\bf Full} status but it can be recycled if recycling is
+   enabled, and thus used again.  By setting {\bf MaximumVolumeJobs} to
+   one, you get the same effect as setting {\bf UseVolumeOnce = yes}.
+
+The value defined by this directive in the  bacula-dir.conf
 file is the default value used when a Volume  is created. Once the volume is
 created, changing the value  in the bacula-dir.conf file will not change what
 is stored  for the Volume. To change the value for an existing Volume  you
@@ -1985,39 +1981,39 @@ must use the {\bf update} command in the Console.
 
 \item [Maximum Volume Files = \lt{}positive-integer\gt{}]
    \index[dir]{Maximum Volume Files }
-   This directive specifies  the maximum number of files that can be written to
-the Volume. If  you specify zero (the default), there is no limit. Otherwise, 
-when the number of files written to the Volume equals {\bf positive-integer} 
-the Volume will be marked {\bf Used}. When the Volume is marked  {\bf Used} it
-can no longer be used for appending Jobs, much like  the {\bf Full} status but
-it can be recycled if recycling is enabled and thus used again.
-This value is checked and the
-{\bf Used} status is set only  at the end of a job that writes to the
-particular volume.  
-
-Please note that the value defined by this directive in the  bacula-dir.conf
-file is the default value used when a Volume  is created. Once the volume is
-created, changing the value  in the bacula-dir.conf file will not change what
-is stored  for the Volume. To change the value for an existing Volume  you
-must use the {\bf update} command in the Console.  
+   This directive specifies the maximum number of files that can be written
+   to the Volume.  If you specify zero (the default), there is no limit.
+   Otherwise, when the number of files written to the Volume equals {\bf
+   positive-integer} the Volume will be marked {\bf Used}.  When the Volume
+   is marked {\bf Used} it can no longer be used for appending Jobs, much
+   like the {\bf Full} status but it can be recycled if recycling is
+   enabled and thus used again.  This value is checked and the {\bf Used}
+   status is set only at the end of a job that writes to the particular
+   volume.
+
+   The value defined by this directive in the bacula-dir.conf file is the
+   default value used when a Volume is created.  Once the volume is
+   created, changing the value in the bacula-dir.conf file will not change
+   what is stored for the Volume.  To change the value for an existing
+   Volume you must use the {\bf update} command in the Console.
 
 \item [Maximum Volume Bytes = \lt{}size\gt{}]
    \index[dir]{Maximum Volume Bytes }
-   This directive specifies  the maximum number of bytes that can be written to
-the Volume. If  you specify zero (the default), there is no limit except the 
-physical size of the Volume. Otherwise,  when the number of bytes written to
-the Volume equals {\bf size}  the Volume will be marked {\bf Used}. When the
-Volume is marked  {\bf Used} it can no longer be used for appending Jobs, much
-like  the {\bf Full} status but it can be recycled if recycling is enabled,
-and thus the Volume can be re-used after recycling.
-This value is checked and the {\bf Used} status set while  the job is writing
-to the particular volume.  
-
-Please note that the value defined by this directive in the  bacula-dir.conf
-file is the default value used when a Volume  is created. Once the volume is
-created, changing the value  in the bacula-dir.conf file will not change what
-is stored  for the Volume. To change the value for an existing Volume  you
-must use the {\bf update} command in the Console.  
+   This directive specifies the maximum number of bytes that can be written
+   to the Volume.  If you specify zero (the default), there is no limit
+   except the physical size of the Volume.  Otherwise, when the number of
+   bytes written to the Volume equals {\bf size} the Volume will be marked
+   {\bf Used}.  When the Volume is marked {\bf Used} it can no longer be
+   used for appending Jobs, much like the {\bf Full} status but it can be
+   recycled if recycling is enabled, and thus the Volume can be re-used
+   after recycling.  This value is checked and the {\bf Used} status set
+   while the job is writing to the particular volume.
+
+   The value defined by this directive in the bacula-dir.conf file is the
+   default value used when a Volume is created.  Once the volume is
+   created, changing the value in the bacula-dir.conf file will not change
+   what is stored for the Volume.  To change the value for an existing
+   Volume you must use the {\bf update} command in the Console.
 
 \item [Volume Use Duration = \lt{}time-period-specification\gt{}]
    \index[dir]{Volume Use Duration }
@@ -2321,29 +2317,28 @@ defined.
 
 \item [Name = \lt{}name\gt{}]
    \index[dir]{Name }
-   The name of the Catalog. No  necessary relation to the database server name.
-This name  will be specified in the Client resource directive indicating  that
-all catalog data for that Client is maintained in this  Catalog. This
-directive is required.  
+   The name of the Catalog.  No necessary relation to the database server
+   name.  This name will be specified in the Client resource directive
+   indicating that all catalog data for that Client is maintained in this
+   Catalog.  This directive is required.
 
 \item [password = \lt{}password\gt{}]
    \index[dir]{password }
-   This specifies the password  to use when logging into the database. This
-directive is required.  
+   This specifies the password to use when logging into the database.  This
+   directive is required.
 
 \item [DB Name = \lt{}name\gt{}]
    \index[dir]{DB Name }
-   This specifies the name of the  database. If you use multiple catalogs
-(databases), you specify  which one here. If you are using an external
-database server  rather than the internal one, you must specify a name that 
-is known to the server (i.e. you explicitly created the  Bacula tables using
-this name. This directive is  required. 
+   This specifies the name of the database.  If you use multiple catalogs
+   (databases), you specify which one here.  If you are using an external
+   database server rather than the internal one, you must specify a name
+   that is known to the server (i.e.  you explicitly created the Bacula
+   tables using this name.  This directive is required.
 
 \item [user = \lt{}user\gt{}]
    \index[dir]{user }
-   This specifies what user name  to use to log into the database. This
-directive
-is required.  
+   This specifies what user name to use to log into the database.  This
+   directive is required.
 
 \item [DB Socket = \lt{}socket-name\gt{}]
    \index[dir]{DB Socket }