git.sur5r.net Git - bacula/docs/blob - docs/manual-fr/monitorconf.tex

   1 %%
   2 %%
   3
   4 \section*{Monitor Configuration}
   5 \label{_MonitorChapter}
   6 \index[general]{Monitor Configuration }
   7 \index[general]{Configuration!Monitor }
   8 \addcontentsline{toc}{section}{Monitor Configuration}
   9
  10 \subsection*{General}
  11 \index[general]{General }
  12 \addcontentsline{toc}{subsection}{General}
  13
  14 The Monitor configuration file is a stripped down version of the Director
  15 configuration file, mixed with a Console configuration file. It simply
  16 contains the information necessary to contact Directors, Clients, and Storage
  17 daemons you want to monitor.
  18
  19 For a general discussion of configuration file and resources including the
  20 data types recognized by {\bf Bacula}, please see the
  21 \ilink{Configuration}{_ChapterStart16} chapter of this manual.
  22
  23 The following Monitor Resource definition must be defined:
  24
  25 \begin{itemize}
  26 \item
  27    \ilink{Monitor}{MonitorResource} -- to  define the Monitor's
  28    name used to connect to all the daemons and  the password used to connect to
  29 the Directors. Note, you must not  define more than one Monitor resource in
  30 the  Monitor configuration file.
  31 \item At least one
  32    \ilink{Client}{ClientResource1},
  33    \ilink{Storage}{StorageResource1} or
  34 \ilink{Director}{DirectorResource2} resource, to define the
  35 daemons to monitor.
  36 \end{itemize}
  37
  38 \subsection*{The Monitor Resource}
  39 \label{MonitorResource}
  40 \index[general]{Monitor Resource }
  41 \index[general]{Resource!Monitor }
  42 \addcontentsline{toc}{subsection}{Monitor Resource}
  43
  44 The Monitor resource defines the attributes of the Monitor running on the
  45 network. The parameters you define here must be configured as a Director
  46 resource in Clients and Storages configuration files, and as a Console
  47 resource in Directors configuration files.
  48
  49 \begin{description}
  50
  51 \item [Monitor]
  52    \index[fd]{Monitor }
  53    Start of the Monitor records.
  54
  55 \item [Name = \lt{}name\gt{}]
  56    \index[fd]{Name  }
  57    Specify the Director name used to connect  to Client and Storage, and the
  58 Console name used to connect to Director.  This record is required.
  59
  60 \item [Password = \lt{}password\gt{}]
  61    \index[fd]{Password  }
  62    Where the password is the  password needed for Directors to accept the Console
  63 connection.  This password must be identical to the {\bf Password} specified
  64 in  the {\bf Console} resource of the
  65 \ilink{Director's configuration}{_ChapterStart40} file. This
  66 record is required if you wish to monitor Directors.
  67
  68 \item [Refresh Interval = \lt{}time\gt{}]
  69    \index[fd]{Refresh Interval  }
  70    Specifies the time to wait  between status requests to each daemon. It can't
  71 be set to less than  1 second, or more than 10 minutes, and the default value
  72 is 5 seconds.
  73 \end{description}
  74
  75 \subsection*{The Director Resource}
  76 \label{DirectorResource2}
  77 \index[general]{Director Resource }
  78 \index[general]{Resource!Director }
  79 \addcontentsline{toc}{subsection}{Director Resource}
  80
  81 The Director resource defines the attributes of the Directors that are
  82 monitored by this Monitor.
  83
  84 As you are not permitted to define a Password in this resource, to avoid
  85 obtaining full Director privileges, you must create a Console resource in the
  86 \ilink{Director's configuration}{_ChapterStart40} file, using the
  87 Console Name and Password defined in the Monitor resource. To avoid security
  88 problems, you should configure this Console resource to allow access to no
  89 other daemons, and permit the use of only two commands: {\bf status} and {\bf
  90 .status} (see below for an example).
  91
  92 You may have multiple Director resource specifications in a single Monitor
  93 configuration file.
  94
  95 \begin{description}
  96
  97 \item [Director]
  98    \index[fd]{Director }
  99    Start of the Director records.
 100
 101 \item [Name = \lt{}name\gt{}]
 102    \index[fd]{Name  }
 103    The Director name used to identify  the Director in the list of monitored
 104 daemons. It is not required  to be the same as the one defined in the Director's
 105 configuration file.  This record is required.
 106
 107 \item [DIRPort = \lt{}port-number\gt{}]
 108    \index[fd]{DIRPort  }
 109    Specify the port to use to connect  to the Director. This value will most
 110 likely already be set to the value  you specified on the {\bf
 111 \verb:--:with-base-port} option of the  {\bf ./configure} command. This port must be
 112 identical to the  {\bf DIRport} specified in the {\bf Director} resource of
 113 the
 114 \ilink{Director's configuration}{_ChapterStart40} file.  The
 115 default is 9101 so this record is not normally specified.
 116
 117 \item [Address = \lt{}address\gt{}]
 118    \index[fd]{Address  }
 119    Where the address is a host name,  a fully qualified domain name, or a network
 120 address used to connect  to the Director.  This record is required.
 121 \end{description}
 122
 123 \subsection*{The Client Resource}
 124 \label{ClientResource1}
 125 \index[general]{Resource!Client }
 126 \index[general]{Client Resource }
 127 \addcontentsline{toc}{subsection}{Client Resource}
 128
 129 The Client resource defines the attributes of the Clients that are monitored
 130 by this Monitor.
 131
 132 You must create a Director resource in the
 133 \ilink{Client's configuration}{_ChapterStart25} file, using the
 134 Director Name defined in the Monitor resource. To avoid security problems, you
 135 should set the {\bf Monitor} directive to {\bf Yes} in this Director resource.
 136
 137
 138 You may have multiple Director resource specifications in a single Monitor
 139 configuration file.
 140
 141 \begin{description}
 142
 143 \item [Client (or FileDaemon)]
 144    \index[fd]{Client (or FileDaemon) }
 145    Start of the Client records.
 146
 147 \item [Name = \lt{}name\gt{}]
 148    \index[fd]{Name  }
 149    The Client name used to identify  the Director in the list of monitored
 150 daemons. It is not required  to be the same as the one defined in the Client's
 151 configuration file.  This record is required.
 152
 153 \item [Address = \lt{}address\gt{}]
 154    \index[fd]{Address  }
 155    Where the address is a host  name, a fully qualified domain name, or a network
 156 address in  dotted quad notation for a Bacula File daemon.  This record is
 157 required.
 158
 159 \item [FD Port = \lt{}port-number\gt{}]
 160    \index[fd]{FD Port  }
 161    Where the port is a port  number at which the Bacula File daemon can be
 162 contacted.  The default is 9102.
 163
 164 \item [Password = \lt{}password\gt{}]
 165    \index[fd]{Password  }
 166    This is the password to be  used when establishing a connection with the File
 167 services, so  the Client configuration file on the machine to be backed up
 168 must  have the same password defined for this Director. This record is
 169 required.
 170 \end{description}
 171
 172 \subsection*{The Storage Resource}
 173 \label{StorageResource1}
 174 \index[general]{Resource!Storage }
 175 \index[general]{Storage Resource }
 176 \addcontentsline{toc}{subsection}{Storage Resource}
 177
 178 The Storage resource defines the attributes of the Storages that are monitored
 179 by this Monitor.
 180
 181 You must create a Director resource in the
 182 \ilink{Storage's configuration}{_ChapterStart31} file, using the
 183 Director Name defined in the Monitor resource. To avoid security problems, you
 184 should set the {\bf Monitor} directive to {\bf Yes} in this Director resource.
 185
 186
 187 You may have multiple Director resource specifications in a single Monitor
 188 configuration file.
 189
 190 \begin{description}
 191
 192 \item [Storage]
 193    \index[fd]{Storage }
 194    Start of the Storage records.
 195
 196 \item [Name = \lt{}name\gt{}]
 197    \index[fd]{Name  }
 198    The Storage name used to identify  the Director in the list of monitored
 199 daemons. It is not required  to be the same as the one defined in the Storage's
 200 configuration file.  This record is required.
 201
 202 \item [Address = \lt{}address\gt{}]
 203    \index[fd]{Address  }
 204    Where the address is a host  name, a fully qualified domain name, or a network
 205 address in  dotted quad notation for a Bacula Storage daemon.  This record is
 206 required.
 207
 208 \item [SD Port = \lt{}port\gt{}]
 209    \index[fd]{SD Port  }
 210    Where port is the port to use to  contact the storage daemon for information
 211 and to start jobs.  This same port number must appear in the Storage resource
 212 of the  Storage daemon's configuration file. The default is 9103.
 213
 214 \item [Password = \lt{}password\gt{}]
 215    \index[sd]{Password  }
 216    This is the password to be used  when establishing a connection with the
 217 Storage services. This  same password also must appear in the Director
 218 resource of the Storage  daemon's configuration file. This record is required.
 219
 220 \end{description}
 221
 222 \subsection*{Tray Monitor Security}
 223 \index[general]{Tray Monitor Security}
 224 \addcontentsline{toc}{subsection}{Tray Monitor Security}
 225
 226 There is no security problem in relaxing the permissions on
 227 tray-monitor.conf as long as FD, SD and DIR are configured properly, so
 228 the passwords contained in this file only gives access to the status of
 229 the daemons. It could be a security problem if you consider the status
 230 information as potentially dangereous (I don't think it is the case).
 231
 232 Concerning Director's configuration: \\
 233 In tray-monitor.conf, the password in the Monitor resource must point to
 234 a restricted console in bacula-dir.conf (see the documentation). So, if
 235 you use this password with bconsole, you'll only have access to the
 236 status of the director (commands status and .status).
 237 It could be a security problem if there is a bug in the ACL code of the
 238 director.
 239
 240 Concerning File and Storage Daemons' configuration:\\
 241 In tray-monitor.conf, the Name in the Monitor resource must point to a
 242 Director resource in bacula-fd/sd.conf, with the Monitor directive set
 243 to Yes (once again, see the documentation).
 244 It could be a security problem if there is a bug in the code which check
 245 if a command is valid for a Monitor (this is very unlikely as the code
 246 is pretty simple).
 247
 248
 249 \subsection*{Sample Tray Monitor configuration}
 250 \label{SampleConfiguration1}
 251 \index[general]{Sample Tray Monitor configuration}
 252 \addcontentsline{toc}{subsection}{Sample Tray Monitor configuration}
 253
 254 An example Tray Monitor configuration file might be the following:
 255
 256 \footnotesize
 257 \begin{verbatim}
 258 #
 259 # Bacula Tray Monitor Configuration File
 260 #
 261 Monitor {
 262   Name = rufus-mon        # password for Directors
 263   Password = "GN0uRo7PTUmlMbqrJ2Gr1p0fk0HQJTxwnFyE4WSST3MWZseR"
 264   RefreshInterval = 10 seconds
 265 }
 266
 267 Client {
 268   Name = rufus-fd
 269   Address = rufus
 270   FDPort = 9102           # password for FileDaemon
 271   Password = "FYpq4yyI1y562EMS35bA0J0QC0M2L3t5cZObxT3XQxgxppTn"
 272 }
 273 Storage {
 274   Name = rufus-sd
 275   Address = rufus
 276   SDPort = 9103           # password for StorageDaemon
 277   Password = "9usxgc307dMbe7jbD16v0PXlhD64UVasIDD0DH2WAujcDsc6"
 278 }
 279 Director {
 280   Name = rufus-dir
 281   DIRport = 9101
 282   address = rufus
 283 }
 284 \end{verbatim}
 285 \normalsize
 286
 287 \subsubsection*{Sample File daemon's Director record.}
 288 \index[general]{Sample File daemon's Director record. }
 289 \index[general]{Record!Sample File daemon's Director }
 290 \addcontentsline{toc}{subsubsection}{Sample File daemon's Director record.}
 291
 292 Click
 293 \ilink{here to see the full example.}{SampleClientConfiguration}
 294
 295
 296 \footnotesize
 297 \begin{verbatim}
 298 #
 299 # Restricted Director, used by tray-monitor to get the
 300 #   status of the file daemon
 301 #
 302 Director {
 303   Name = rufus-mon
 304   Password = "FYpq4yyI1y562EMS35bA0J0QC0M2L3t5cZObxT3XQxgxppTn"
 305   Monitor = yes
 306 }
 307 \end{verbatim}
 308 \normalsize
 309
 310 \subsubsection*{Sample Storage daemon's Director record.}
 311 \index[general]{Record!Sample Storage daemon's Director }
 312 \index[general]{Sample Storage daemon's Director record. }
 313 \addcontentsline{toc}{subsubsection}{Sample Storage daemon's Director record.}
 314
 315 Click
 316 \ilink{here to see the full example.}{SampleConfiguration}
 317
 318 \footnotesize
 319 \begin{verbatim}
 320 #
 321 # Restricted Director, used by tray-monitor to get the
 322 #   status of the storage daemon
 323 #
 324 Director {
 325   Name = rufus-mon
 326   Password = "9usxgc307dMbe7jbD16v0PXlhD64UVasIDD0DH2WAujcDsc6"
 327   Monitor = yes
 328 }
 329 \end{verbatim}
 330 \normalsize
 331
 332 \subsubsection*{Sample Director's Console record.}
 333 \index[general]{Record!Sample Director's Console }
 334 \index[general]{Sample Director's Console record. }
 335 \addcontentsline{toc}{subsubsection}{Sample Director's Console record.}
 336
 337 Click
 338 \ilink{here to see the full
 339 example.}{SampleDirectorConfiguration}
 340
 341 \footnotesize
 342 \begin{verbatim}
 343 #
 344 # Restricted console used by tray-monitor to get the status of the director
 345 #
 346 Console {
 347   Name = Monitor
 348   Password = "GN0uRo7PTUmlMbqrJ2Gr1p0fk0HQJTxwnFyE4WSST3MWZseR"
 349   CommandACL = status, .status
 350 }
 351 \end{verbatim}
 352 \normalsize