|
1 | 1 | <html><head><meta charset="UTF-8"></head><body><pre> |
2 | | -OVS-APPCTL(8) Open vSwitch OVS-APPCTL(8) |
3 | | - |
4 | | - |
| 2 | +<u>OVS-APPCTL</u>(8) Open vSwitch <u>OVS-APPCTL</u>(8) |
5 | 3 |
|
6 | 4 | <b>NAME</b> |
7 | 5 | ovs-appctl - utility for configuring running Open vSwitch daemons |
|
17 | 15 | <b>DESCRIPTION</b> |
18 | 16 | Open vSwitch daemons accept certain commands at runtime to control |
19 | 17 | their behavior and query their settings. Every daemon accepts a common |
20 | | - set of commands documented under <u>Common</u> <u>Commands</u> below. Some daemons |
21 | | - support additional commands documented in their own manpages. |
| 18 | + set of commands documented under <u>Common</u> <u>Commands</u> below. Some daemons |
| 19 | + support additional commands documented in their own manpages. |
22 | 20 | <b>ovs-vswitchd</b> in particular accepts a number of additional commands doc‐ |
23 | 21 | umented in <b>ovs-vswitchd(8)</b>. |
24 | 22 |
|
|
33 | 31 |
|
34 | 32 | Tells <b>ovs-appctl</b> which daemon to contact. |
35 | 33 |
|
36 | | - If <target> begins with <b>/</b> it must name a Unix domain socket on which |
37 | | - an Open vSwitch daemon is listening for control channel connections. |
| 34 | + If <target> begins with <b>/</b> it must name a Unix domain socket on which |
| 35 | + an Open vSwitch daemon is listening for control channel connections. |
38 | 36 | By default, each daemon listens on a Unix domain socket in the rundir |
39 | 37 | (e.g. <b>/run</b>) named <b><program>.<pid>.ctl</b>, where <program> is the pro‐ |
40 | 38 | gram’s name and <pid> is its process ID. For example, if |
|
50 | 48 |
|
51 | 49 | On Windows, <target> can be an absolute path to a file that contains |
52 | 50 | a localhost TCP port on which an Open vSwitch daemon is listening for |
53 | | - control channel connections. By default, each daemon writes the TCP |
54 | | - port on which it is listening for control connection into the file |
55 | | - <b><program>.ctl</b> located inside the rundir. If <target> is not an abso‐ |
56 | | - lute path, <b>ovs-appctl</b> looks in the rundir for a file named <b><tar‐</b> |
| 51 | + control channel connections. By default, each daemon writes the TCP |
| 52 | + port on which it is listening for control connection into the file |
| 53 | + <b><program>.ctl</b> located inside the rundir. If <target> is not an ab‐ |
| 54 | + solute path, <b>ovs-appctl</b> looks in the rundir for a file named <b><tar‐</b> |
57 | 55 | <b>get>.ctl</b>. The default target is <b>ovs-vswitchd</b>. |
58 | 56 |
|
59 | 57 | • <b>-T</b> <b><secs></b> or <b>--timeout=<secs></b> |
60 | 58 |
|
61 | | - By default, or with a <secs> of <b>0</b>, <b>ovs-appctl</b> waits forever to con‐ |
62 | | - nect to the daemon and receive a response. This option limits run‐ |
63 | | - time to approximately <secs> seconds. If the timeout expires, |
| 59 | + By default, or with a <secs> of <b>0</b>, <b>ovs-appctl</b> waits forever to con‐ |
| 60 | + nect to the daemon and receive a response. This option limits run‐ |
| 61 | + time to approximately <secs> seconds. If the timeout expires, |
64 | 62 | <b>ovs-appctl</b> exits with a <b>SIGALRM</b> signal. |
65 | 63 |
|
66 | 64 | <b>COMMON</b> <b>COMMANDS</b> |
67 | | - Every Open vSwitch daemon supports a common set of commands, which are |
| 65 | + Every Open vSwitch daemon supports a common set of commands, which are |
68 | 66 | documented in this section. |
69 | 67 |
|
70 | 68 | <b>General</b> <b>Commands</b> |
71 | | - These commands display daemon-specific commands and the running ver‐ |
72 | | - sion. Note that these commands are different from the <b>--help</b> and |
73 | | - <b>--version</b> options that return information about the <b>ovs-appctl</b> utility |
| 69 | + These commands display daemon-specific commands and the running ver‐ |
| 70 | + sion. Note that these commands are different from the <b>--help</b> and |
| 71 | + <b>--version</b> options that return information about the <b>ovs-appctl</b> utility |
74 | 72 | itself. |
75 | 73 |
|
76 | 74 | • <b>list-commands</b> |
|
82 | 80 | Displays the version and compilation date of the target. |
83 | 81 |
|
84 | 82 | <b>Logging</b> <b>Commands</b> |
85 | | - Open vSwitch has several log levels. The highest-severity log level |
| 83 | + Open vSwitch has several log levels. The highest-severity log level |
86 | 84 | is: |
87 | 85 |
|
88 | 86 | • <b>off</b> |
89 | 87 |
|
90 | | - No message is ever logged at this level, so setting a logging desti‐ |
| 88 | + No message is ever logged at this level, so setting a logging desti‐ |
91 | 89 | nation’s log level to <b>off</b> disables logging to that destination. |
92 | 90 |
|
93 | | - The following log levels, in order of descending severity, are avail‐ |
| 91 | + The following log levels, in order of descending severity, are avail‐ |
94 | 92 | able: |
95 | 93 |
|
96 | 94 | • <b>emer</b> |
|
99 | 97 |
|
100 | 98 | • <b>err</b> |
101 | 99 |
|
102 | | - A high-level operation or a subsystem failed. Attention is war‐ |
| 100 | + A high-level operation or a subsystem failed. Attention is war‐ |
103 | 101 | ranted. |
104 | 102 |
|
105 | 103 | • <b>warn</b> |
|
131 | 129 |
|
132 | 130 | • <b>vlog/set</b> [<spec>] |
133 | 131 |
|
134 | | - Sets logging levels. Without any <spec>, sets the log level for ev‐ |
135 | | - ery module and destination to <b>dbg</b>. Otherwise, <spec> is a list of |
136 | | - words separated by spaces or commas or colons, up to one from each |
| 132 | + Sets logging levels. Without any <spec>, sets the log level for |
| 133 | + every module and destination to <b>dbg</b>. Otherwise, <spec> is a list of |
| 134 | + words separated by spaces or commas or colons, up to one from each |
137 | 135 | category below: |
138 | 136 |
|
139 | | - • A valid module name, as displayed by the <b>vlog/list</b> command on |
| 137 | + • A valid module name, as displayed by the <b>vlog/list</b> command on |
140 | 138 | <b>ovs-appctl(8)</b>, limits the log level change to the specified module. |
141 | 139 |
|
142 | | - • <b>syslog</b>, <b>console</b>, or <b>file</b>, to limit the log level change to only to |
| 140 | + • <b>syslog</b>, <b>console</b>, or <b>file</b>, to limit the log level change to only to |
143 | 141 | the system log, to the console, or to a file, respectively. |
144 | 142 |
|
145 | | - On Windows platform, <b>syslog</b> is only useful if <target> was started |
| 143 | + On Windows platform, <b>syslog</b> is only useful if <target> was started |
146 | 144 | with the <b>--syslog-target</b> option (it has no effect otherwise). |
147 | 145 |
|
148 | 146 | • <b>off</b>, <b>emer</b>, <b>err</b>, <b>warn</b>, <b>info</b>, or <b>dbg</b>, to control the log level. Mes‐ |
|
153 | 151 | Case is not significant within <spec>. |
154 | 152 |
|
155 | 153 | Regardless of the log levels set for <b>file</b>, logging to a file will not |
156 | | - take place unless the target application was invoked with the |
| 154 | + take place unless the target application was invoked with the |
157 | 155 | <b>--log-file</b> option. |
158 | 156 |
|
159 | | - For compatibility with older versions of OVS, <b>any</b> is accepted within |
| 157 | + For compatibility with older versions of OVS, <b>any</b> is accepted within |
160 | 158 | <spec> but it has no effect. |
161 | 159 |
|
162 | 160 | • <b>vlog/set</b> <b>PATTERN:<destination>:<pattern></b> |
163 | 161 |
|
164 | | - Sets the log pattern for <destination> to <pattern>. Each time a |
165 | | - message is logged to <destination>, <pattern> determines the mes‐ |
| 162 | + Sets the log pattern for <destination> to <pattern>. Each time a |
| 163 | + message is logged to <destination>, <pattern> determines the mes‐ |
166 | 164 | sage’s formatting. Most characters in <pattern> are copied literally |
167 | 165 | to the log, but special escapes beginning with <b>%</b> are expanded as fol‐ |
168 | 166 | lows: |
|
177 | 175 |
|
178 | 176 | • <b>%c</b> |
179 | 177 |
|
180 | | - The name of the module (as shown by <b>ovs-appctl</b> <b>--list</b>) logging the |
| 178 | + The name of the module (as shown by <b>ovs-appctl</b> <b>--list</b>) logging the |
181 | 179 | message. |
182 | 180 |
|
183 | 181 | • <b>%d</b> |
|
186 | 184 |
|
187 | 185 | • <b>%d{<format>}</b> |
188 | 186 |
|
189 | | - The current date and time in the specified <format>, which takes |
190 | | - the same format as the <template> argument to <b>strftime(3)</b>. As an |
191 | | - extension, any <b>#</b> characters in <format> will be replaced by frac‐ |
192 | | - tional seconds, e.g. use <b>%H:%M:%S.###</b> for the time to the nearest |
193 | | - millisecond. Sub-second times are only approximate and currently |
| 187 | + The current date and time in the specified <format>, which takes |
| 188 | + the same format as the <template> argument to <b>strftime(3)</b>. As an |
| 189 | + extension, any <b>#</b> characters in <format> will be replaced by frac‐ |
| 190 | + tional seconds, e.g. use <b>%H:%M:%S.###</b> for the time to the nearest |
| 191 | + millisecond. Sub-second times are only approximate and currently |
194 | 192 | decimal places after the third will always be reported as zero. |
195 | 193 |
|
196 | 194 | • <b>%D</b> |
197 | 195 |
|
198 | | - The current UTC date and time in ISO 8601 format (YYYY-MM-DD |
| 196 | + The current UTC date and time in ISO 8601 format (YYYY-MM-DD |
199 | 197 | HH:MM:SS). |
200 | 198 |
|
201 | 199 | • <b>%D{<format>}</b> |
202 | 200 |
|
203 | | - The current UTC date and time in the specified <format>, which |
204 | | - takes the same format as the <template> argument to <b>strftime``(3).</b> |
| 201 | + The current UTC date and time in the specified <format>, which |
| 202 | + takes the same format as the <template> argument to <b>strftime``(3).</b> |
205 | 203 | <b>Supports</b> <b>the</b> <b>same</b> <b>extension</b> <b>for</b> <b>sub-second</b> <b>resolution</b> <b>as</b> <b>``%d{...}</b>. |
206 | 204 |
|
207 | 205 | • <b>%E</b> |
|
232 | 230 |
|
233 | 231 | • <b>%r</b> |
234 | 232 |
|
235 | | - The number of milliseconds elapsed from the start of the applica‐ |
| 233 | + The number of milliseconds elapsed from the start of the applica‐ |
236 | 234 | tion to the time the message was logged. |
237 | 235 |
|
238 | 236 | • <b>%t</b> |
239 | 237 |
|
240 | | - The subprogram name, that is, an identifying name for the process |
241 | | - or thread that emitted the log message, such as <b>monitor</b> for the |
242 | | - process used for <b>--monitor</b> or <b>main</b> for the primary process or |
| 238 | + The subprogram name, that is, an identifying name for the process |
| 239 | + or thread that emitted the log message, such as <b>monitor</b> for the |
| 240 | + process used for <b>--monitor</b> or <b>main</b> for the primary process or |
243 | 241 | thread in a program. |
244 | 242 |
|
245 | 243 | • <b>%T</b> |
|
256 | 254 |
|
257 | 255 | • <b>-</b> |
258 | 256 |
|
259 | | - Left justify the escape’s expansion within its field width. Right |
| 257 | + Left justify the escape’s expansion within its field width. Right |
260 | 258 | justification is the default. |
261 | 259 |
|
262 | 260 | • <b>0</b> |
263 | 261 |
|
264 | | - Pad the field to the field width with <b>0</b> characters. Padding with |
| 262 | + Pad the field to the field width with <b>0</b> characters. Padding with |
265 | 263 | spaces is the default. |
266 | 264 |
|
267 | 265 | • <width> |
268 | 266 |
|
269 | | - A number specifies the minimum field width. If the escape expands |
270 | | - to fewer characters than <width> then it is padded to fill the |
| 267 | + A number specifies the minimum field width. If the escape expands |
| 268 | + to fewer characters than <width> then it is padded to fill the |
271 | 269 | field width. (A field wider than <width> is not truncated to fit.) |
272 | 270 |
|
273 | | - The default pattern for console and file output is <b>%D{%Y-%m-%dT</b> |
| 271 | + The default pattern for console and file output is <b>%D{%Y-%m-%dT</b> |
274 | 272 | <b>%H:%M:%SZ}|%05N|%c|%p|%m</b>; for syslog output, <b>%05N|%c|%p|%m</b>. |
275 | 273 |
|
276 | | - Daemons written in Python (e.g. <b>ovs-monitor-ipsec</b>) do not allow con‐ |
| 274 | + Daemons written in Python (e.g. <b>ovs-monitor-ipsec</b>) do not allow con‐ |
277 | 275 | trol over the log pattern. |
278 | 276 |
|
279 | 277 | • <b>vlog/set</b> <b>FACILITY:<facility></b> |
280 | 278 |
|
281 | | - Sets the RFC5424 facility of the log message. <facility> can be one |
282 | | - of <b>kern</b>, <b>user</b>, <b>mail</b>, <b>daemon</b>, <b>auth</b>, <b>syslog</b>, <b>lpr</b>, <b>news</b>, <b>uucp</b>, <b>clock</b>, |
283 | | - <b>ftp</b>, <b>ntp</b>, <b>audit</b>, <b>alert</b>, <b>clock2</b>, <b>local0</b>, <b>local1</b>, <b>local2</b>, <b>local3</b>, <b>lo‐</b> |
| 279 | + Sets the RFC5424 facility of the log message. <facility> can be one |
| 280 | + of <b>kern</b>, <b>user</b>, <b>mail</b>, <b>daemon</b>, <b>auth</b>, <b>syslog</b>, <b>lpr</b>, <b>news</b>, <b>uucp</b>, <b>clock</b>, |
| 281 | + <b>ftp</b>, <b>ntp</b>, <b>audit</b>, <b>alert</b>, <b>clock2</b>, <b>local0</b>, <b>local1</b>, <b>local2</b>, <b>local3</b>, <b>lo‐</b> |
284 | 282 | <b>cal4</b>, <b>local5</b>, <b>local6</b> or <b>local7</b>. |
285 | 283 |
|
286 | 284 | • <b>vlog/close</b> |
287 | 285 |
|
288 | | - Causes the daemon to close its log file, if it is open. (Use |
| 286 | + Causes the daemon to close its log file, if it is open. (Use |
289 | 287 | <b>vlog/reopen</b> to reopen it later.) |
290 | 288 |
|
291 | 289 | • <b>vlog/reopen</b> |
292 | 290 |
|
293 | | - Causes the daemon to close its log file, if it is open, and then re‐ |
294 | | - open it. (This is useful after rotating log files, to cause a new |
| 291 | + Causes the daemon to close its log file, if it is open, and then re‐ |
| 292 | + open it. (This is useful after rotating log files, to cause a new |
295 | 293 | log file to be used.) |
296 | 294 |
|
297 | 295 | This has no effect if the target application was not invoked with the |
|
315 | 313 | 2016-2021, The Open vSwitch Development Community |
316 | 314 |
|
317 | 315 |
|
318 | | - |
319 | | - |
320 | | -3.3 Feb 17, 2024 OVS-APPCTL(8) |
| 316 | +3.3 Jun 07, 2024 <u>OVS-APPCTL</u>(8) |
321 | 317 | </pre></body></html> |
0 commit comments