1VNSTAT.CONF(5) User Manuals VNSTAT.CONF(5)
2
6 vnstat.conf - vnStat configuration file
7
10 /etc/vnstat.conf
11
14 vnstat(1), vnstati(1) and vnstatd(1) all use the same configuration
15 file for storing configuration data. Some of the settings are common
16 for all three programs. The file contains keyword-argument pairs, one
17 per line. Lines starting with Arguments may optionally be enclosed in
18 double quotes (") in order to represent arguments containing spaces.
19 Arguments can be padded with spaces or tabulator characters. A hard‐
20 coded default value will be used if a keyword can't be found from the
21 configuration file.
22
25 BootVariation
26 Time in seconds how much the boot time reported by system kernel
27 can variate between updates.
28 CheckDiskSpace
31 Enable or disable the checking of at least some free disk space
32 before a database write. 1 = enabled, 0 = disabled.
33 DatabaseDir
36 Specifies the directory where interface databases are to be
37 stored. A full path must be given and a leading '/' isn't
38 required.
39 DayFormat, MonthFormat, TopFormat
42 Formatting of date in available outputs. Uses the same format as
43 date(1). (vnstat and vnstati only)
44 Interface
47 Default interface used when no other interface is specified on
48 the command line. (vnstat and vnstati only)
49 Locale Locale setting to be used for prints. This replaces the LC_ALL
52 environment variable. Set to "-" in order to use the system
53 default value. (vnstat and vnstati only)
54 MaxBandwidth
57 Maximum bandwidth for all interfaces. If the counted traffic
58 exceeds the given value then the data is assumed to be invalid
59 and rejected. Set to 0 in order to disable the feature. (vnstat
60 and vnstatd only)
61 MaxBW Same as MaxBandwidth but can be used for setting individual lim‐
64 its for selected interfaces. The name of the interface is speci‐
65 fied directly after the MaxBW keyword without spaces. For exam‐
66 ple MaxBWeth0 for eth0 and MaxBWppp0 for ppp0. (vnstat and
67 vnstatd only)
68 MonthRotate
71 Day of month that months are expected to change. Usually set to
72 1 but can be set to alternative values for example for tracking
73 monthly billed traffic where the billing period doesn't start on
74 the first day. (vnstat and vnstatd only)
75 OutputStyle
78 Modify the content and style of text outputs. 0 = minimal and
79 narrow output for terminal with limited width, 1 = normal output
80 with bar column visible, 2 = same as 1 except rate is visible in
81 summary and weekly outputs, 3 = rate column is visible in all
82 outputs where it is supported. (vnstat and vnstati only)
83 QueryMode
86 Default query mode when no parameters are given. 0 = normal, 1 =
87 days, 2 = months, 3 = top10, 4 = dumpdb, 5 = short, 6 = weeks, 7
88 = hours and 8 = xml. (vnstat only)
89 RateUnit
92 Select which unit is used when traffic rate is visible. 0 =
93 bytes, 1 = bits. (vnstat and vnstati only)
94 RXCharacter, TXCharacter
97 Character used for representing the percentual share of received
98 and transmitted traffic in daily output. (vnstat only)
99 RXHourCharacter, TXHourCharacter
102 Character used for representing the percentual share of received
103 and transmitted traffic in hourly output. (vnstat only)
104 Sampletime
107 Defines how many seconds the -tr option will sample traffic.
108 (vnstat only)
109 TrafficlessDays
112 Log days without any traffic to daily list. 1 = enabled, 0 =
113 disabled. (vnstat and vnstatd only)
114 UnitMode
117 Select how units are prefixed. 0 = IEC standard prefixes
118 (KiB/MiB/GiB/TiB), 1 = old style binary prefixes (KB/MB/GB/TB).
119 (vnstat and vnstati only)
120 UseFileLocking
123 Enable or disable the use of file locking during database
124 access. Disabling file locking may cause database corruption if
125 several processes are trying to write to the file at the same
126 time.
127
130 LogFile
131 Specify log file path and name to be used if UseLogging is set
132 to 1.
133 OfflineSaveInterval
136 How often in minutes cached interface data is saved to file when
137 all monitored interfaces are offline.
138 PidFile
141 Specify pid file path and name to be used.
142 PollInterval
145 How often in seconds interfaces are checked for status changes.
146 SaveInterval
149 How often in minutes cached interface data is saved to file.
150 SaveOnStatusChange
153 Enable or disable the additional saving to file of cached inter‐
154 face data when the availability of an interface changes, i.e.,
155 when an interface goes offline or comes online. 1 = enabled, 0 =
156 disabled.
157 UpdateInterval
160 How often in seconds the interface data is updated.
161 UseLogging
164 Enable or disable logging. 0 = disabled, 1 = logfile and 2 =
165 syslog.
166
169 CBackground
170 Background color.
171 CEdge Edge color if visible.
174 CHeader
177 Header background color.
178 CHeaderTitle
181 Header title text color.
182 CHeaderDate
185 Header date text color.
186 CLine Line color.
189 CLineL Lighter version of line color. Set to '-' in order to use a cal‐
192 culated value based on CLine.
193 CRx Color for received data.
196 CRxD Darker version of received data color. Set to '-' in order to
199 use a calculated value based on CRx.
200 CText Common text color.
203 CTx Color for transmitted data.
206 CTxD Darker version of transmitted data color. Set to '-' in order to
209 use a calculated value based on CTx.
210 HeaderFormat
213 Formatting of date in header. Uses the same format as date(1).
214 HourlyRate
217 Show hours with rate instead of transfered amount. 1 = enabled,
218 0 = disabled.
219 SummaryLayout
222 Select the used layout of the summary output. 1 = layout intro‐
223 duced in version 1.8 with monthly traffic included, 0 = layout
224 used before version 1.8, doesn't contain monthly traffic and
225 doesn't support average rate.
226 SummaryRate
229 Show rate in summary output if available. 1 = enabled, 0 = dis‐
230 abled.
231 TransparentBg
234 Set background color as transparent. 1 = enabled, 0 = disabled.
235
238 /etc/vnstat.conf
239 Config file that will be used unless $HOME/.vnstatrc exists or
240 alternative value is given as command line parameter.
241
244 Teemu Toivola <tst at iki dot fi>
245
248 vnstat(1), vnstati(1), vnstatd(1), units(7)
249version 1.11 JUNE 2011 VNSTAT.CONF(5)