ovs-vsctl: reconnect to the database if connection was dropped
[sliver-openvswitch.git] / lib / vlog-unixctl.man
1 .de IQ
2 .  br
3 .  ns
4 .  IP "\\$1"
5 ..
6 .SS "VLOG COMMANDS"
7 These commands manage \fB\*(PN\fR's logging settings.
8 .IP "\fBvlog/set\fR [\fIspec\fR]"
9 Sets logging levels.  Without any \fIspec\fR, sets the log level for
10 every module and facility to \fBdbg\fR.  Otherwise, \fIspec\fR is a
11 list of words separated by spaces or commas or colons, up to one from
12 each category below:
13 .
14 .RS
15 .IP \(bu
16 A valid module name, as displayed by the \fBvlog/list\fR command on
17 \fBovs\-appctl\fR(8), limits the log level change to the specified
18 module.
19 .
20 .IP \(bu
21 \fBsyslog\fR, \fBconsole\fR, or \fBfile\fR, to limit the log level
22 change to only to the system log, to the console, or to a file,
23 respectively.
24 .IP
25 On Windows platform, \fBsyslog\fR is accepted as a word and is only
26 useful along with the \fB\-\-syslog\-target\fR option (the word has no
27 effect otherwise).
28 .
29 .IP \(bu 
30 \fBoff\fR, \fBemer\fR, \fBerr\fR, \fBwarn\fR, \fBinfo\fR, or
31 \fBdbg\fR, to control the log level.  Messages of the given severity
32 or higher will be logged, and messages of lower severity will be
33 filtered out.  \fBoff\fR filters out all messages.  See
34 \fBovs\-appctl\fR(8) for a definition of each log level.
35 .RE
36 .
37 .IP
38 Case is not significant within \fIspec\fR.
39 .IP
40 Regardless of the log levels set for \fBfile\fR, logging to a file
41 will not take place unless \fB\*(PN\fR was invoked with the
42 \fB\-\-log\-file\fR option.
43 .IP
44 For compatibility with older versions of OVS, \fBany\fR is accepted as
45 a word but has no effect.
46 .RE
47 .IP "\fBvlog/set PATTERN:\fIfacility\fB:\fIpattern\fR"
48 Sets the log pattern for \fIfacility\fR to \fIpattern\fR.  Refer to
49 \fBovs\-appctl\fR(8) for a description of the valid syntax for \fIpattern\fR.
50 .
51 .IP "\fBvlog/list\fR"
52 Lists the supported logging modules and their current levels.
53 .
54 .IP "\fBvlog/reopen\fR"
55 Causes \fB\*(PN\fR to close and reopen its log file.  (This is useful
56 after rotating log files, to cause a new log file to be used.)
57 .IP
58 This has no effect unless \fB\*(PN\fR was invoked with the
59 \fB\-\-log\-file\fR option.
60 .
61 .IP "\fBvlog/disable\-rate\-limit \fR[\fImodule\fR]..."
62 .IQ "\fBvlog/enable\-rate\-limit \fR[\fImodule\fR]..."
63 By default, \fB\*(PN\fR limits the rate at which certain messages can
64 be logged.  When a message would appear more frequently than the
65 limit, it is suppressed.  This saves disk space, makes logs easier to
66 read, and speeds up execution, but occasionally troubleshooting
67 requires more detail.  Therefore, \fBvlog/disable\-rate\-limit\fR
68 allows rate limits to be disabled at the level of an individual log
69 module.  Specify one or more module names, as displayed by the
70 \fBvlog/list\fR command.  Specifying either no module names at all or
71 the keyword \fBany\fR disables rate limits for every log module.
72 .
73 .IP
74 The \fBvlog/enable\-rate\-limit\fR command, whose syntax is the same
75 as \fBvlog/disable\-rate\-limit\fR, can be used to re-enable a rate
76 limit that was previously disabled.