1ovn-appctl(8) OVN Manual ovn-appctl(8)
2
6 ovn-appctl - utility for configuring running OVN daemons
7
9 ovn-appctl [-target=target | -t target] [-T secs | -timeout=secs] com‐
10 mand [arg...]
11 ovn-appctl -help
13 ovn-appctl -version
15
17 OVN daemons accept certain commands at runtime to control their behav‐
18 ior and query their settings. Every daemon accepts a common set of com‐
19 mands documented under COMMON COMMANDS below. Some daemons support ad‐
20 ditional commands documented in their own manpages.
21 The ovn-appctl program provides a simple way to invoke these commands.
23 The command to be sent is specified on ovn-appctl’s command line as
24 non-option arguments. ovn-appctl sends the command and prints the dae‐
25 mon’s response on standard output.
26 ovn-ctl is exactly similar to Open vSwitch ovs-appctl utility.
28
30 Every OVN daemon supports a common set of commands, which are docu‐
31 mented in this section.
32 General Commands
34 These commands display daemon-specific commands and the running ver‐
35 sion. Note that these commands are different from the -help and -ver‐
36 sion options that return information about the ovn-appctl utility it‐
37 self.
38 list-commands
40 Lists the commands supported by the target.
41 version
43 Displays the version and compilation date of the target.
44 Logging Commands
46 OVN has several log levels. The highest-severity log level is:
47 off No message is ever logged at this level, so setting a
49 logging destination’s log level to off disables logging
50 to that destination.
51 The following log levels, in order of descending severity, are avail‐
53 able:
54 emer A major failure forced a process to abort.
56 err A high-level operation or a subsystem failed. Attention
58 is warranted.
59 warn A low-level operation failed, but higher-level subsystems
61 may be able to recover.
62 info Information that may be useful in retrospect when inves‐
64 tigating a problem.
65 dbg Information useful only to someone with intricate knowl‐
67 edge of the system, or that would commonly cause too-vo‐
68 luminous log output. Log messages at this level are not
69 logged by default.
70 Every OVN daemon supports the following commands for examining and ad‐
72 justing log levels.
73 vlog/list
75 Lists the known logging modules and their current levels.
76 vlog/list-pattern
78 Lists logging pattern used for each destination.
79 vlog/set [spec]
81 Sets logging levels. Without any spec, sets the log level
82 for every module and destination to dbg. Otherwise, spec
83 is a list of words separated by spaces or commas or
84 colons, up to one from each category below:
85 • A valid module name, as displayed by the vlog/list
87 command on ovn-appctl(8), limits the log level
88 change to the specified module.
89 • syslog, console, or file, to limit the log level
91 change to only to the system log, to the console,
92 or to a file, respectively.
93 On Windows platform, syslog is accepted as a word
95 and is only useful if the target was started with
96 the --syslog-target option (the word has no effect
97 otherwise).
98 • off, emer, err, warn, info, or dbg, to control the
100 log level. Messages of the given severity or
101 higher will be logged, and messages of lower
102 severity will be filtered out. off filters out all
103 messages.
104 Case is not significant within spec.
106 vlog/set PATTERN:destination: pattern
108 Sets the log pattern for destination to pattern. Each
109 time a message is logged to destination, pattern deter‐
110 mines the message’s formatting. Most characters in pat‐
111 tern are copied literally to the log, but special escapes
112 beginning with % are expanded as follows:
113 • %A : The name of the application logging the mes‐
115 sage, e.g. ovn-controller.
116 • %B : The RFC5424 syslog PRI of the message.
118 • %c : The name of the module (as shown by ovn-ap‐
120 pctl -list) logging the message.
121 • %d : The current date and time in ISO 8601 format
123 (YYYY-MM-DD HH:MM:SS).
124 • %d{format} : The current date and time in the
126 specified format, which takes the same format as
127 the template argument to strftime(3). As an exten‐
128 sion, any # characters in format will be replaced
129 by fractional seconds, e.g. use %H:%M:%S.### for
130 the time to the nearest millisecond. Sub-second
131 times are only approximate and currently decimal
132 places after the third will always be reported as
133 zero.
134 • %D : The current UTC date and time in ISO 8601
136 format (YYYY-MM-DD HH:MM:SS).
137 • %D{format} : The current UTC date and time in the
139 specified format, which takes the same format as
140 the template argument to strftime(3). Supports the
141 same extension for sub-second resolution as
142 %d{...}.
143 • %E : The hostname of the node running the applica‐
145 tion.
146 • %m : The message being logged.
148 • %N : A serial number for this message within this
150 run of the program, as a decimal number. The first
151 message a program logs has serial number 1, the
152 second one has serial number 2, and so on.
153 • %n : A new-line.
155 • %p : The level at which the message is logged,
157 e.g. DBG.
158 • %P : The program’s process ID (pid), as a decimal
160 number.
161 • %r : The number of milliseconds elapsed from the
163 start of the application to the time the message
164 was logged.
165 • %t : The subprogram name, that is, an identifying
167 name for the process or thread that emitted the
168 log message, such as monitor for the process used
169 for -monitor or main for the primary process or
170 thread in a program.
171 • %T : The subprogram name enclosed in parentheses,
173 e.g. (monitor), or the empty string for the pri‐
174 mary process or thread in a program.
175 • %% : A literal %.
177 A few options may appear between the % and the format
179 specifier character, in this order:
180 • - : Left justify the escape’s expansion within its
182 field width. Right justification is the default.
183 • - : Pad the field to the field width with 0s. Pad‐
185 ding with spaces is the default.
186 width A number specifies the minimum field width. If the
188 escape expands to fewer characters than width then it is
189 padded to fill the field width. (A field wider than width
190 is not truncated to fit.)
191 The default pattern for console and file output is
193 %D{%Y-%m-%dT %H:%M:%SZ}|%05N|%c|%p|%m; for syslog output,
194 %05N|%c|%p|%m.
195 vlog/set FACILITY:facility
197 Sets the RFC5424 facility of the log message. facility
198 can be one of kern, user, mail, daemon, auth, syslog,
199 lpr, news, uucp, clock, ftp, ntp, audit, alert, clock2,
200 local0, local1, local2, local3, local4, local5, local6 or
201 local7.
202 vlog/close
204 Causes the daemon to close its log file, if it is open.
205 (Use vlog/reopen to reopen it later.)
206 vlog/reopen
208 Causes the daemon to close its log file, if it is open,
209 and then reopen it. (This is useful after rotating log
210 files, to cause a new log file to be used.)
211 This has no effect if the target application was not in‐
213 voked with the --log-file option.
214
216 -h
217 --help
218 Prints a brief help message to the console.
219 -V
221 --version
222 Prints version information to the console.
223OVN 23.09.2 ovn-appctl ovn-appctl(8)