From: Eric Bollengier <eric@eb.homelinux.org>
Date: Thu, 25 Nov 2010 12:31:58 +0000 (+0100)
Subject: update max bandwidth parameter documentation
X-Git-Tag: Release-5.2.1~57^2~5
X-Git-Url: https://git.sur5r.net/?a=commitdiff_plain;h=79bbaf51ab25acd447583175ecc251298821e0da;p=bacula%2Fdocs

update max bandwidth parameter documentation
---

diff --git a/docs/manuals/en/main/newfeatures.tex b/docs/manuals/en/main/newfeatures.tex
index d78e4a40..406fa754 100644
--- a/docs/manuals/en/main/newfeatures.tex
+++ b/docs/manuals/en/main/newfeatures.tex
@@ -6,8 +6,9 @@ released at some later date, probably near the end of 2010.
 \section{Job Bandwidth Limitation}
 
 A new directive may be added to FileDaemon or Director resources within the
-File Daemon configuration to allow users to limit the bandwidth used by a
-Job on a Client. It can be set for all Jobs globally or per Directors.
+File Daemon configuration to allow users to limit the bandwidth used by a Job
+on a Client. It can be set for all Jobs globally or per Directors in the File
+Daemon configuration, and per Job in the Director configuration file.
 
 For example:
 \begin{verbatim}
@@ -25,6 +26,31 @@ exceed 5MB/s of throughput when sending data to the Storage Daemon.
 
 You can specify the speed parameter in k/s, kb/s, m/s, mb/s.
 
+For example:
+\begin{verbatim}
+Job {
+  Name = locahost-data
+  FileSet = FS_localhost
+  Accurate = yes
+  ...
+  Maximum Bandwidth = 5MB/s
+  ...
+}
+\end{verbatim}
+
+The above example would cause job \texttt{localhost-data} to not exceed 5MB/s
+of throughput when sending data to the Storage Daemon.
+
+A new console commande \texttt{setbandwidth} permits to set dynamically the
+maximum throughput of a running Job or for future jobs of a Client.
+
+\begin{verbatim}
+* setbandwidth limit=1000000 jobid=10
+\end{verbatim}
+
+The \texttt{limit} parameter is in kb/s.
+
+\medskip
 This project was funded by Bacula Systems and is available with Bacula
 Enterprise Edition and Community Edition.