1 .TH vlogconf 8 "June 2008" "OpenFlow" "OpenFlow Manual"
4 vlogconf \- configuration utility for OpenFlow logging in userspace
7 \fBvlogconf\fR [\fB-h\fR | \fB--help\fR] [\fItarget\fR...] [\fIaction\fR...]
9 The available \fItarget\fR options are:
11 [\fB-a\fR | \fB--all\fR] [\fB-t\fR \fIpid\fR | \fB--target=\fIpid\fR]
13 The available \fIaction\fR options are:
15 [\fB-l\fR | \fB--list\fR] [\fB-s\fR
16 \fImodule\fR[\fB:\fIfacility\fR[\fB:\fIlevel\fR]] |
17 \fB--set=\fImodule\fR[\fB:\fIfacility\fR[\fB:\fIlevel\fR]]]
20 The \fBvlogconf\fR program configures the logging system used by
21 OpenFlow userspace programs. The logging configuration may be modified
22 while OpenFlow programs are running.
24 \fBvlogconf\fR applies one or more actions to each of one or more
25 target processes. Targets may be specified as:
29 All running processes that \fBvlogconf\fR can control.
32 \fB-t \fIpid\fR, \fB--target=\fIpid\fR
33 The process with the specified \fIpid\fR. \fIpid\fR may also specify
34 an absolute path (beginning with `/') to the Unix domain socket for a
35 \fBvlogconf\fR-controllable process.
38 The available actions are:
41 \fB-l\fR, \fB--list\fR
42 Print the list of known modules and their current logging levels to
46 \fB-s\fR \fImodule\fR[\fB:\fIfacility\fR[\fB:\fIlevel\fR]], \fB--set=\fImodule\fR[\fB:\fIfacility\fR[\fB:\fIlevel\fR]]
48 Sets the logging level for \fImodule\fR in \fIfacility\fR to
49 \fIlevel\fR. The \fImodule\fR may be any valid module name (as
50 displayed by the \fB--list\fR option) or the special name \fBANY\fR to
51 set the logging levels for all modules. The \fIfacility\fR may be
52 \fBsyslog\fR or \fBconsole\fR to set the levels for logging to the
53 system log or to the console, respectively, or \fBANY\fR to set the
54 logging levels for both facilities. If it is omitted,
55 \fIfacility\fR defaults to \fBANY\fR. The \fIlevel\fR must be one of
56 \fBemer\fR, \fBerr\fR, \fBwarn\fR, or \fBdbg\fR, designating the
57 minimum severity of a message for it to be logged. If it is omitted,
58 \fIlevel\fR defaults to \fBdbg\fR.
61 \fB-s PATTERN:\fIfacility\fB:\fIpattern\fR, \fB--set=PATTERN:\fIfacility\fB:\fIpattern\fR
63 Sets the log pattern for \fIfacility\fR to \fIpattern\fR. Each time a
64 message is logged to \fIfacility\fR, \fIpattern\fR determines the
65 message's formatting. Most characters in \fIpattern\fR are copied
66 literally to the log, but special escapes beginning with \fB%\fR are
72 The name of the application logging the message, e.g. \fBsecchan\fR.
76 The name of the module (as shown by \fBvlogconf --list\fR) logging
81 The current date and time in ISO 8601 format (YYYY-MM-DD HH:MM:SS).
84 \fB%d{\fIformat\fB}\fR
85 The current date and time in the specified \fIformat\fR, which takes
86 the same format as the \fItemplate\fR argument to \fBstrftime\fR(3).
90 The message being logged.
94 A serial number for this message within this run of the program, as a
95 decimal number. The first message a program logs has serial number 1,
96 the second one has serial number 2, and so on.
104 The level at which the message is logged, e.g. \fBDBG\fR.
108 The program's process ID (pid), as a decimal number.
112 The number of milliseconds elapsed from the start of the application
113 to the time the message was logged.
121 A few options may appear between the \fB%\fR and the format specifier
122 character, in this order:
127 Left justify the escape's expansion within its field width. Right
128 justification is the default.
132 Pad the field to the field width with \fB0\fRs. Padding with spaces
137 A number specifies the minimum field width. If the escape expands to
138 fewer characters than \fIwidth\fR then it is padded to fill the field
139 width. (A field wider than \fIwidth\fR is not truncated to fit.)
143 The default pattern for console output is \fB%d{%b %d
144 %H:%M:%S}|%05N|%c|%p|%m\fR; for syslog output, \fB%05N|%c|%p|%m\fR.
148 \fB\-h\fR, \fB\-\^\-help\fR
149 Prints a brief help message to the console and exits.