X-Git-Url: http://git.onelab.eu/?a=blobdiff_plain;f=utilities%2Fovs-appctl.8.in;h=df5630978564fb64815651fa35a784f814843fb9;hb=d978fa4832bbc5176e05edd05bcdf2452a8dded2;hp=51085980b507a44b739510b418f3d6afc6a7b7c2;hpb=7d110e960278c0b1f5c39e398a3aab9d02e84c00;p=sliver-openvswitch.git diff --git a/utilities/ovs-appctl.8.in b/utilities/ovs-appctl.8.in index 51085980b..df5630978 100644 --- a/utilities/ovs-appctl.8.in +++ b/utilities/ovs-appctl.8.in @@ -4,7 +4,7 @@ . ns . IP "\\$1" .. -.TH ovs\-appctl 8 "November 2009" "Open vSwitch" "Open vSwitch Manual" +.TH ovs\-appctl 8 "@VERSION@" "Open vSwitch" "Open vSwitch Manual" .ds PN ovs\-appctl . .SH NAME @@ -18,12 +18,12 @@ ovs\-appctl \- utility for configuring running Open vSwitch daemons .br \fBovs\-appctl\fR \-\-version .SH DESCRIPTION -Open vSwitch daemons accept certain commands at runtime to control -their behavior and query their settings. Every daemon accepts the -commands for querying and adjusting its logging settings documented -under \fBLOGGING COMMANDS\fR below, and \fBovs\-vswitchd\fR in -particular accepts a number of additional commands documented in -\fBovs\-vswitchd\fR(8). +Open vSwitch daemons accept certain commands at runtime to control their +behavior and query their settings. Every daemon accepts a common set of +commands documented under \fBCOMMON COMMANDS\fR below. Some daemons +support additional commands documented in their own manpages. +\fBovs\-vswitchd\fR in particular accepts a number of additional +commands documented in \fBovs\-vswitchd\fR(8). .PP The \fBovs\-appctl\fR program provides a simple way to invoke these commands. The command to be sent is specified on \fBovs\-appctl\fR's @@ -54,55 +54,88 @@ as if it had been specified directly as the target. .IP The default target is \fBovs\-vswitchd\fR. . -.SH LOGGING COMMANDS +.SH COMMON COMMANDS +Every Open vSwitch daemon supports a common set of commands, which are +documented in this section. . -.PP -Open vSwitch has several log levels. The highest-severity log level -is: +.SS GENERAL COMMANDS +These commands display daemon-specific commands and the running version. +Note that these commands are different from the \fB\-\-help\fR and +\fB\-\-version\fR options that return information about the +\fBovs\-appctl\fR utility itself. +. +.IP "\fBhelp\fR" +Lists the commands supported by the target. +. +.IP "\fBversion\fR" +Displays the version and compilation date of the target. . -.IP "\fBOFF\fR" +.SS LOGGING COMMANDS +Open vSwitch has several log levels. The highest-severity log level is: +. +.IP "\fBoff\fR" No message is ever logged at this level, so setting a logging -facility's log level to \fBOFF\fR disables logging to that facility. +facility's log level to \fBoff\fR disables logging to that facility. . .PP -The following log levels, in order of descending severity, are enabled -by default: +The following log levels, in order of descending severity, are +available: . -.IP "\fBEMER\f" +.IP "\fBemer\fR" A major failure forced a process to abort. -.IP "\fBERR\fR" +.IP "\fBerr\fR" A high-level operation or a subsystem failed. Attention is warranted. -.IP "\fBWARN\fR" +.IP "\fBwarn\fR" A low-level operation failed, but higher-level subsystems may be able to recover. -.IP "\fBINFO\fR" +.IP "\fBinfo\fR" Information that may be useful in retrospect when investigating a problem. -.IP "\fBDBG\fR" +.IP "\fBdbg\fR" Information useful only to someone with intricate knowledge of the system, or that would commonly cause too-voluminous log output. Log messages at this level are not logged by default. . .PP -Every Open vSwitch daemon supports the following commands for -examining and adjusting log levels. +Every Open vSwitch daemon supports the following commands for examining +and adjusting log levels. .IP "\fBvlog/list\fR" Lists the known logging modules and their current levels. . -.IP "\fBvlog/set\fR \fImodule\fR[\fB:\fIfacility\fR[\fB:\fIlevel\fR]]" -Sets the logging level for \fImodule\fR in \fIfacility\fR to -\fIlevel\fR. The \fImodule\fR may be any valid module name (as -displayed by the \fB\-\-list\fR option) or the special name \fBANY\fR to -set the logging levels for all modules. The \fIfacility\fR may be -\fBsyslog\fR or \fBconsole\fR to set the levels for logging to the -system log or to the console, respectively, or \fBANY\fR to set the -logging levels for both facilities. If it is omitted, -\fIfacility\fR defaults to \fBANY\fR. The \fIlevel\fR must be one of +.IP "\fBvlog/set\fR [\fIspec\fR]" +Sets logging levels. Without any \fIspec\fR, sets the log level for +every module and facility to \fBdbg\fR. Otherwise, \fIspec\fR is a +list of words separated by spaces or commas or colons, up to one from +each category below: +. +.RS +.IP \(bu +A valid module name, as displayed by the \fBvlog/list\fR command on +\fBovs\-appctl\fR(8), limits the log level change to the specified +module. +. +.IP \(bu +\fBsyslog\fR, \fBconsole\fR, or \fBfile\fR, to limit the log level +change to only to the system log, to the console, or to a file, +respectively. +. +.IP \(bu \fBoff\fR, \fBemer\fR, \fBerr\fR, \fBwarn\fR, \fBinfo\fR, or -\fBdbg\fR, designating the -minimum severity of a message for it to be logged. If it is omitted, -\fIlevel\fR defaults to \fBdbg\fR. +\fBdbg\fR, to control the log level. Messages of the given severity +or higher will be logged, and messages of lower severity will be +filtered out. \fBoff\fR filters out all messages. +.RE +. +.IP +Case is not significant within \fIspec\fR. +.IP +Regardless of the log levels set for \fBfile\fR, logging to a file +will not take place unless the target application was invoked with the +\fB\-\-log\-file\fR option. +.IP +For compatibility with older versions of OVS, \fBany\fR is accepted as +a word but has no effect. . .IP "\fBvlog/set PATTERN:\fIfacility\fB:\fIpattern\fR" Sets the log pattern for \fIfacility\fR to \fIpattern\fR. Each time a @@ -126,6 +159,13 @@ The current date and time in ISO 8601 format (YYYY\-MM\-DD HH:MM:SS). The current date and time in the specified \fIformat\fR, which takes the same format as the \fItemplate\fR argument to \fBstrftime\fR(3). . +.IP \fB%D\fR +The current UTC date and time in ISO 8601 format (YYYY\-MM\-DD HH:MM:SS). +. +.IP \fB%D{\fIformat\fB}\fR +The current UTC date and time in the specified \fIformat\fR, which takes +the same format as the \fItemplate\fR argument to \fBstrftime\fR(3). +. .IP \fB%m\fR The message being logged. . @@ -147,6 +187,16 @@ The program's process ID (pid), as a decimal number. The number of milliseconds elapsed from the start of the application to the time the message was logged. . +.IP \fB%t\fR +The subprogram name, that is, an identifying name for the process or +thread that emitted the log message, such as \fBmonitor\fR for the +process used for \fB\-\-monitor\fR or \fBmain\fR for the primary +process or thread in a program. +. +.IP \fB%T\fR +The subprogram name enclosed in parentheses, e.g. \fB(monitor)\fR, or +the empty string for the primary process or thread in a program. +. .IP \fB%%\fR A literal \fB%\fR. .RE @@ -171,8 +221,12 @@ width. (A field wider than \fIwidth\fR is not truncated to fit.) .RE . .IP -The default pattern for console output is \fB%d{%b %d -%H:%M:%S}|%05N|%c|%p|%m\fR; for syslog output, \fB%05N|%c|%p|%m\fR. +The default pattern for console and file output is \fB%D{%Y-%m-%dT +%H:%M:%SZ}|%05N|%c|%p|%m\fR; for syslog output, \fB%05N|%c|%p|%m\fR. +. +.IP +Daemons written in Python (e.g. \fBovs\-xapi\-sync\fR, +\fBovs\-monitor\-ipsec) do not allow control over the log pattern. . .IP "\fBvlog/reopen\fR" Causes the daemon to close and reopen its log file. (This @@ -186,15 +240,9 @@ This has no effect if the target application was not invoked with the . .so lib/common.man . -.SH BUGS -. -The protocol used to speak to Open vSwitch daemons does not contain a -quoting mechanism, so command arguments should not generally contain -white space. -. .SH "SEE ALSO" . -\fBovs\-appctl\fR can control the following daemons: +\fBovs\-appctl\fR can control all Open vSwitch daemons, including: .BR ovs\-vswitchd (8), -.BR ovs\-controller (8), -.BR ovs\-brcompatd (8). +and +.BR ovsdb\-server (8).