1ovn-controller(8) OVN Manual ovn-controller(8)
2
6 ovn-controller - Open Virtual Network local controller
7
9 ovn-controller [options] [ovs-database]
10
12 ovn-controller is the local controller daemon for OVN, the Open Virtual
13 Network. It connects up to the OVN Southbound database (see ovn-sb(5))
14 over the OVSDB protocol, and down to the Open vSwitch database (see
15 ovs-vswitchd.conf.db(5)) over the OVSDB protocol and to ovs-vswitchd(8)
16 via OpenFlow. Each hypervisor and software gateway in an OVN deployment
17 runs its own independent copy of ovn-controller; thus, ovn-controller’s
18 downward connections are machine-local and do not run over a physical
19 network.
20
22 ACL log messages are logged through ovn-controller’s logging mechanism.
23 ACL log entries have the module acl_log at log level info. Configuring
24 logging is described below in the Logging Options section.
25
27 Daemon Options
28 --pidfile[=pidfile]
29 Causes a file (by default, program.pid) to be created indicating
30 the PID of the running process. If the pidfile argument is not
31 specified, or if it does not begin with /, then it is created in
32 .
33 If --pidfile is not specified, no pidfile is created.
35 --overwrite-pidfile
37 By default, when --pidfile is specified and the specified pid‐
38 file already exists and is locked by a running process, the dae‐
39 mon refuses to start. Specify --overwrite-pidfile to cause it to
40 instead overwrite the pidfile.
41 When --pidfile is not specified, this option has no effect.
43 --detach
45 Runs this program as a background process. The process forks,
46 and in the child it starts a new session, closes the standard
47 file descriptors (which has the side effect of disabling logging
48 to the console), and changes its current directory to the root
49 (unless --no-chdir is specified). After the child completes its
50 initialization, the parent exits.
51 --monitor
53 Creates an additional process to monitor this program. If it
54 dies due to a signal that indicates a programming error (SIGA‐
55 BRT, SIGALRM, SIGBUS, SIGFPE, SIGILL, SIGPIPE, SIGSEGV, SIGXCPU,
56 or SIGXFSZ) then the monitor process starts a new copy of it. If
57 the daemon dies or exits for another reason, the monitor process
58 exits.
59 This option is normally used with --detach, but it also func‐
61 tions without it.
62 --no-chdir
64 By default, when --detach is specified, the daemon changes its
65 current working directory to the root directory after it de‐
66 taches. Otherwise, invoking the daemon from a carelessly chosen
67 directory would prevent the administrator from unmounting the
68 file system that holds that directory.
69 Specifying --no-chdir suppresses this behavior, preventing the
71 daemon from changing its current working directory. This may be
72 useful for collecting core files, since it is common behavior to
73 write core dumps into the current working directory and the root
74 directory is not a good directory to use.
75 This option has no effect when --detach is not specified.
77 --no-self-confinement
79 By default this daemon will try to self-confine itself to work
80 with files under well-known directories determined at build
81 time. It is better to stick with this default behavior and not
82 to use this flag unless some other Access Control is used to
83 confine daemon. Note that in contrast to other access control
84 implementations that are typically enforced from kernel-space
85 (e.g. DAC or MAC), self-confinement is imposed from the user-
86 space daemon itself and hence should not be considered as a full
87 confinement strategy, but instead should be viewed as an addi‐
88 tional layer of security.
89 --user=user:group
91 Causes this program to run as a different user specified in
92 user:group, thus dropping most of the root privileges. Short
93 forms user and :group are also allowed, with current user or
94 group assumed, respectively. Only daemons started by the root
95 user accepts this argument.
96 On Linux, daemons will be granted CAP_IPC_LOCK and
98 CAP_NET_BIND_SERVICES before dropping root privileges. Daemons
99 that interact with a datapath, such as ovs-vswitchd, will be
100 granted three additional capabilities, namely CAP_NET_ADMIN,
101 CAP_NET_BROADCAST and CAP_NET_RAW. The capability change will
102 apply even if the new user is root.
103 On Windows, this option is not currently supported. For security
105 reasons, specifying this option will cause the daemon process
106 not to start.
107 Logging Options
109 -v[spec]
110 --verbose=[spec]
111 Sets logging levels. Without any spec, sets the log level for ev‐
112 ery module and destination to dbg. Otherwise, spec is a list of
113 words separated by spaces or commas or colons, up to one from each
114 category below:
115 • A valid module name, as displayed by the vlog/list command
117 on ovs-appctl(8), limits the log level change to the speci‐
118 fied module.
119 • syslog, console, or file, to limit the log level change to
121 only to the system log, to the console, or to a file, re‐
122 spectively. (If --detach is specified, the daemon closes
123 its standard file descriptors, so logging to the console
124 will have no effect.)
125 On Windows platform, syslog is accepted as a word and is
127 only useful along with the --syslog-target option (the word
128 has no effect otherwise).
129 • off, emer, err, warn, info, or dbg, to control the log
131 level. Messages of the given severity or higher will be
132 logged, and messages of lower severity will be filtered
133 out. off filters out all messages. See ovs-appctl(8) for a
134 definition of each log level.
135 Case is not significant within spec.
137 Regardless of the log levels set for file, logging to a file will
139 not take place unless --log-file is also specified (see below).
140 For compatibility with older versions of OVS, any is accepted as a
142 word but has no effect.
143 -v
145 --verbose
146 Sets the maximum logging verbosity level, equivalent to --ver‐
147 bose=dbg.
148 -vPATTERN:destination:pattern
150 --verbose=PATTERN:destination:pattern
151 Sets the log pattern for destination to pattern. Refer to ovs-ap‐
152 pctl(8) for a description of the valid syntax for pattern.
153 -vFACILITY:facility
155 --verbose=FACILITY:facility
156 Sets the RFC5424 facility of the log message. facility can be one
157 of kern, user, mail, daemon, auth, syslog, lpr, news, uucp, clock,
158 ftp, ntp, audit, alert, clock2, local0, local1, local2, local3,
159 local4, local5, local6 or local7. If this option is not specified,
160 daemon is used as the default for the local system syslog and lo‐
161 cal0 is used while sending a message to the target provided via
162 the --syslog-target option.
163 --log-file[=file]
165 Enables logging to a file. If file is specified, then it is used
166 as the exact name for the log file. The default log file name used
167 if file is omitted is /var/log/ovn/program.log.
168 --syslog-target=host:port
170 Send syslog messages to UDP port on host, in addition to the sys‐
171 tem syslog. The host must be a numerical IP address, not a host‐
172 name.
173 --syslog-method=method
175 Specify method as how syslog messages should be sent to syslog
176 daemon. The following forms are supported:
177 • libc, to use the libc syslog() function. Downside of using
179 this options is that libc adds fixed prefix to every mes‐
180 sage before it is actually sent to the syslog daemon over
181 /dev/log UNIX domain socket.
182 • unix:file, to use a UNIX domain socket directly. It is pos‐
184 sible to specify arbitrary message format with this option.
185 However, rsyslogd 8.9 and older versions use hard coded
186 parser function anyway that limits UNIX domain socket use.
187 If you want to use arbitrary message format with older
188 rsyslogd versions, then use UDP socket to localhost IP ad‐
189 dress instead.
190 • udp:ip:port, to use a UDP socket. With this method it is
192 possible to use arbitrary message format also with older
193 rsyslogd. When sending syslog messages over UDP socket ex‐
194 tra precaution needs to be taken into account, for example,
195 syslog daemon needs to be configured to listen on the spec‐
196 ified UDP port, accidental iptables rules could be inter‐
197 fering with local syslog traffic and there are some secu‐
198 rity considerations that apply to UDP sockets, but do not
199 apply to UNIX domain sockets.
200 • null, to discard all messages logged to syslog.
202 The default is taken from the OVS_SYSLOG_METHOD environment vari‐
204 able; if it is unset, the default is libc.
205 PKI Options
207 PKI configuration is required in order to use SSL for the connections
208 to the Northbound and Southbound databases.
209 -p privkey.pem
211 --private-key=privkey.pem
212 Specifies a PEM file containing the private key used as
213 identity for outgoing SSL connections.
214 -c cert.pem
216 --certificate=cert.pem
217 Specifies a PEM file containing a certificate that certi‐
218 fies the private key specified on -p or --private-key to be
219 trustworthy. The certificate must be signed by the certifi‐
220 cate authority (CA) that the peer in SSL connections will
221 use to verify it.
222 -C cacert.pem
224 --ca-cert=cacert.pem
225 Specifies a PEM file containing the CA certificate for ver‐
226 ifying certificates presented to this program by SSL peers.
227 (This may be the same certificate that SSL peers use to
228 verify the certificate specified on -c or --certificate, or
229 it may be a different one, depending on the PKI design in
230 use.)
231 -C none
233 --ca-cert=none
234 Disables verification of certificates presented by SSL
235 peers. This introduces a security risk, because it means
236 that certificates cannot be verified to be those of known
237 trusted hosts.
238 --bootstrap-ca-cert=cacert.pem
240 When cacert.pem exists, this option has the same effect
241 as -C or --ca-cert. If it does not exist, then the exe‐
242 cutable will attempt to obtain the CA certificate from
243 the SSL peer on its first SSL connection and save it to
244 the named PEM file. If it is successful, it will immedi‐
245 ately drop the connection and reconnect, and from then on
246 all SSL connections must be authenticated by a certifi‐
247 cate signed by the CA certificate thus obtained.
248 This option exposes the SSL connection to a man-in-the-
250 middle attack obtaining the initial CA certificate, but
251 it may be useful for bootstrapping.
252 This option is only useful if the SSL peer sends its CA
254 certificate as part of the SSL certificate chain. The SSL
255 protocol does not require the server to send the CA cer‐
256 tificate.
257 This option is mutually exclusive with -C and --ca-cert.
259 --peer-ca-cert=peer-cacert.pem
261 Specifies a PEM file that contains one or more additional
262 certificates to send to SSL peers. peer-cacert.pem should
263 be the CA certificate used to sign the program’s own cer‐
264 tificate, that is, the certificate specified on -c or
265 --certificate. If the program’s certificate is self-
266 signed, then --certificate and --peer-ca-cert should
267 specify the same file.
268 This option is not useful in normal operation, because
270 the SSL peer must already have the CA certificate for the
271 peer to have any confidence in the program’s identity.
272 However, this offers a way for a new installation to
273 bootstrap the CA certificate on its first SSL connection.
274 Other Options
276 -h
277 --help
278 Prints a brief help message to the console.
279 -V
281 --version
282 Prints version information to the console.
283
285 ovn-controller retrieves most of its configuration information from the
286 local Open vSwitch’s ovsdb-server instance. The default location is
287 db.sock in the local Open vSwitch’s "run" directory. It may be overrid‐
288 den by specifying the ovs-database argument as an OVSDB active or pas‐
289 sive connection method, as described in ovsdb(7).
290 ovn-controller assumes it gets configuration information from the fol‐
292 lowing keys in the Open_vSwitch table of the local OVS instance:
293 external_ids:system-id
295 The chassis name to use in the Chassis table. Changing
296 the system-id while ovn-controller is running is not di‐
297 rectly supported. Users have two options: either first
298 gracefully stop ovn-controller or manually delete the
299 stale Chassis and Chassis_Private records after changing
300 the system-id.
301 external_ids:hostname
303 The hostname to use in the Chassis table.
304 external_ids:ovn-bridge
306 The integration bridge to which logical ports are at‐
307 tached. The default is br-int. If this bridge does not
308 exist when ovn-controller starts, it will be created au‐
309 tomatically with the default configuration suggested in
310 ovn-architecture(7).
311 external_ids:ovn-bridge-datapath-type
313 This configuration is optional. If set, then the datapath
314 type of the integration bridge will be set to the config‐
315 ured value. If this option is not set, then ovn-con‐
316 troller will not modify the existing datapath-type of the
317 integration bridge.
318 external_ids:ovn-remote
320 The OVN database that this system should connect to for
321 its configuration, in one of the same forms documented
322 above for the ovs-database.
323 external_ids:ovn-monitor-all
325 A boolean value that tells if ovn-controller should moni‐
326 tor all records of tables in ovs-database. If set to
327 false, it will conditionally monitor the records that is
328 needed in the current chassis.
329 It is more optimal to set it to true in use cases when
331 the chassis would anyway need to monitor most of the
332 records in ovs-database, which would save the overhead of
333 conditions processing, especially for server side. Typi‐
334 cally, set it to true for environments that all workloads
335 need to be reachable from each other.
336 Default value is false.
338 external_ids:ovn-remote-probe-interval
340 The inactivity probe interval of the connection to the
341 OVN database, in milliseconds. If the value is zero, it
342 disables the connection keepalive feature.
343 If the value is nonzero, then it will be forced to a
345 value of at least 1000 ms.
346 external_ids:ovn-openflow-probe-interval
348 The inactivity probe interval of the OpenFlow connection
349 to the OpenvSwitch integration bridge, in seconds. If the
350 value is zero, it disables the connection keepalive fea‐
351 ture.
352 If the value is nonzero, then it will be forced to a
354 value of at least 5s.
355 external_ids:ovn-encap-type
357 The encapsulation type that a chassis should use to con‐
358 nect to this node. Multiple encapsulation types may be
359 specified with a comma-separated list. Each listed encap‐
360 sulation type will be paired with ovn-encap-ip.
361 Supported tunnel types for connecting hypervisors are
363 geneve and stt. Gateways may use geneve, vxlan, or stt.
364 Due to the limited amount of metadata in vxlan, the capa‐
366 bilities and performance of connected gateways will be
367 reduced versus other tunnel formats.
368 external_ids:ovn-encap-ip
370 The IP address that a chassis should use to connect to
371 this node using encapsulation types specified by exter‐
372 nal_ids:ovn-encap-type.
373 external_ids:ovn-encap-df_default
375 indicates the DF flag handling of the encapulation. Set
376 to true to set the DF flag for new data paths or false to
377 clear the DF flag.
378 external_ids:ovn-bridge-mappings
380 A list of key-value pairs that map a physical network
381 name to a local ovs bridge that provides connectivity to
382 that network. An example value mapping two physical net‐
383 work names to two ovs bridges would be: phys‐
384 net1:br-eth0,physnet2:br-eth1.
385 external_ids:ovn-encap-csum
387 ovn-encap-csum indicates that encapsulation checksums can
388 be transmitted and received with reasonable performance.
389 It is a hint to senders transmitting data to this chassis
390 that they should use checksums to protect OVN metadata.
391 Set to true to enable or false to disable. Depending on
392 the capabilities of the network interface card, enabling
393 encapsulation checksum may incur performance loss. In
394 such cases, encapsulation checksums can be disabled.
395 external_ids:ovn-encap-tos
397 ovn-encap-tos indicates the value to be applied to OVN
398 tunnel interface’s option:tos as specified in the
399 Open_vSwitch database Interface table. Please refer to
400 Open VSwitch Manual for details.
401 external_ids:ovn-cms-options
403 A list of options that will be consumed by the CMS Plugin
404 and which specific to this particular chassis. An example
405 would be: cms_option1,cms_option2:foo.
406 external_ids:ovn-transport-zones
408 The transport zone(s) that this chassis belongs to.
409 Transport zones is a way to group different chassis so
410 that tunnels are only formed between members of the same
411 group(s). Multiple transport zones may be specified with
412 a comma-separated list. For example: tz1,tz2,tz3.
413 If not set, the Chassis will be considered part of a de‐
415 fault transport zone.
416 external_ids:ovn-chassis-mac-mappings
418 A list of key-value pairs that map a chassis specific mac
419 to a physical network name. An example value mapping two
420 chassis macs to two physical network names would be:
421 physnet1:aa:bb:cc:dd:ee:ff,physnet2:a1:b2:c3:d4:e5:f6.
422 These are the macs that ovn-controller will replace a
423 router port mac with, if packet is going from a distrib‐
424 uted router port on vlan type logical switch.
425 external_ids:ovn-is-interconn
427 The boolean flag indicates if the chassis is used as an
428 interconnection gateway.
429 external_ids:ovn-match-northd-version
431 The boolean flag indicates if ovn-controller needs to
432 check ovn-northd version. If this flag is set to true and
433 the ovn-northd’s version (reported in the Southbound
434 database) doesn’t match with the ovn-controller’s inter‐
435 nal version, then it will stop processing the southbound
436 and local Open vSwitch database changes. The default
437 value is considered false if this option is not defined.
438 external_ids:ovn-ofctrl-wait-before-clear
440 The time, in milliseconds, to wait before clearing flows
441 in OVS after OpenFlow connection/reconnection during
442 ovn-controller initialization. The purpose of this wait
443 is to give time for ovn-controller to compute the new
444 flows before clearing existing ones, to avoid data plane
445 down time during ovn-controller restart/upgrade at large
446 scale environments where recomputing the flows takes more
447 than a few seconds or even longer. It is difficult for
448 ovn-controller to determine when the new flows computing
449 is completed, because of the dynamics in the cloud envi‐
450 ronments, which is why this configuration is provided for
451 users to adjust based on the scale of the environment. By
452 default, it is 0, which means clearing existing flows
453 without waiting. Not setting the value, or setting it too
454 small, may result in data plane down time during up‐
455 grade/restart, while setting it too big may result in un‐
456 necessary extra control plane latency of applying new
457 changes of CMS during upgrade/restart. In most cases, a
458 slightly bigger value is not harmful, because the extra
459 control plane latency happens only once during the Open‐
460 Flow connection. To get a reasonable range of the value
461 setting, it is recommended to run the below commands on a
462 node in the target environment and then set this configu‐
463 ration to twice the value of Maximum shown in the output
464 of the second command.
465 • ovn-appctl -t ovn-controller inc-engine/recompute
467 • ovn-appctl -t ovn-controller stopwatch/show
469 flow-generation
470 external_ids:ovn-enable-lflow-cache
472 The boolean flag indicates if ovn-controller should en‐
473 able/disable the logical flow in-memory cache it uses
474 when processing Southbound database logical flow changes.
475 By default caching is enabled.
476 external_ids:ovn-limit-lflow-cache
478 When used, this configuration value determines the maxi‐
479 mum number of logical flow cache entries ovn-controller
480 may create when the logical flow cache is enabled. By de‐
481 fault the size of the cache is unlimited.
482 external_ids:ovn-memlimit-lflow-cache-kb
484 When used, this configuration value determines the maxi‐
485 mum size of the logical flow cache (in KB) ovn-controller
486 may create when the logical flow cache is enabled. By de‐
487 fault the size of the cache is unlimited.
488 external_ids:ovn-trim-limit-lflow-cache
490 When used, this configuration value sets the minimum num‐
491 ber of entries in the logical flow cache starting with
492 which automatic memory trimming is performed. By default
493 this is set to 10000 entries.
494 external_ids:ovn-trim-wmark-perc-lflow-cache
496 When used, this configuration value sets the percentage
497 from the high watermark number of entries in the logical
498 flow cache under which automatic memory trimming is per‐
499 formed. E.g., if the trim watermark percentage is set to
500 50%, automatic memory trimming happens only when the num‐
501 ber of entries in the logical flow cache gets reduced to
502 less than half of the last measured high watermark. By
503 default this is set to 50.
504 external_ids:ovn-trim-timeout-ms
506 When used, this configuration value specifies the time,
507 in milliseconds, since the last logical flow cache opera‐
508 tion after which ovn-controller performs memory trimming
509 regardless of how many entries there are in the cache. By
510 default this is set to 30000 (30 seconds).
511 external_ids:ovn-set-local-ip
513 The boolean flag indicates if ovn-controller when create
514 tunnel ports should set local_ip parameter. Can be hepl‐
515 ful to pin source outer IP for the tunnel when multiple
516 interfaces are used on the host for overlay traffic.
517 ovn-controller reads the following values from the Open_vSwitch data‐
519 base of the local OVS instance:
520 datapath-type from Bridge table
522 This value is read from local OVS integration bridge row
523 of Bridge table and populated in other_config:datapath-
524 type of the Chassis table in the OVN_Southbound database.
525 iface-types from Open_vSwitch table
527 This value is populated in external_ids:iface-types of
528 the Chassis table in the OVN_Southbound database.
529 private_key, certificate, ca_cert, and bootstrap_ca_cert from
531 SSL table
532 These values provide the SSL configuration used for con‐
533 necting to the OVN southbound database server when an SSL
534 connection type is configured via external_ids:ovn-re‐
535 mote. Note that this SSL configuration can also be pro‐
536 vided via command-line options, the configuration in the
537 database takes precedence if both are present.
538
540 ovn-controller uses a number of external_ids keys in the Open vSwitch
541 database to keep track of ports and interfaces. For proper operation,
542 users should not change or clear these keys:
543 external_ids:ovn-chassis-id in the Port table
545 The presence of this key identifies a tunnel port within
546 the integration bridge as one created by ovn-controller
547 to reach a remote chassis. Its value is the chassis ID of
548 the remote chassis.
549 external_ids:ct-zone-* in the Bridge table
551 Logical ports and gateway routers are assigned a connec‐
552 tion tracking zone by ovn-controller for stateful ser‐
553 vices. To keep state across restarts of ovn-controller,
554 these keys are stored in the integration bridge’s Bridge
555 table. The name contains a prefix of ct-zone- followed by
556 the name of the logical port or gateway router’s zone
557 key. The value for this key identifies the zone used for
558 this port.
559 external_ids:ovn-localnet-port in the Port table
561 The presence of this key identifies a patch port as one
562 created by ovn-controller to connect the integration
563 bridge and another bridge to implement a localnet logical
564 port. Its value is the name of the logical port with type
565 set to localnet that the port implements. See exter‐
566 nal_ids:ovn-bridge-mappings, above, for more information.
567 Each localnet logical port is implemented as a pair of
569 patch ports, one in the integration bridge, one in a dif‐
570 ferent bridge, with the same external_ids:ovn-local‐
571 net-port value.
572 external_ids:ovn-l2gateway-port in the Port table
574 The presence of this key identifies a patch port as one
575 created by ovn-controller to connect the integration
576 bridge and another bridge to implement a l2gateway logi‐
577 cal port. Its value is the name of the logical port with
578 type set to l2gateway that the port implements. See ex‐
579 ternal_ids:ovn-bridge-mappings, above, for more informa‐
580 tion.
581 Each l2gateway logical port is implemented as a pair of
583 patch ports, one in the integration bridge, one in a dif‐
584 ferent bridge, with the same external_ids:ovn-l2gate‐
585 way-port value.
586 external-ids:ovn-l3gateway-port in the Port table
588 This key identifies a patch port as one created by
589 ovn-controller to implement a l3gateway logical port. Its
590 value is the name of the logical port with type set to
591 l3gateway. This patch port is similar to the OVN logical
592 patch port, except that l3gateway port can only be bound
593 to a particular chassis.
594 external-ids:ovn-logical-patch-port in the Port table
596 This key identifies a patch port as one created by
597 ovn-controller to implement an OVN logical patch port
598 within the integration bridge. Its value is the name of
599 the OVN logical patch port that it implements.
600 external-ids:ovn-startup-ts in the Bridge table
602 This key represents the timestamp (in milliseconds) at
603 which ovn-controller process was started.
604 external-ids:ovn-nb-cfg in the Bridge table
606 This key represents the last known OVN_South‐
607 bound.SB_Global.nb_cfg value for which all flows have
608 been successfully installed in OVS.
609 external-ids:ovn-nb-cfg-ts in the Bridge table
611 This key represents the timestamp (in milliseconds) of
612 the last known OVN_Southbound.SB_Global.nb_cfg value for
613 which all flows have been successfully installed in OVS.
614 external_ids:ovn-installed and external_ids:ovn-installed-ts in
616 the Interface table
617 This key is set after all openflow operations correspond‐
618 ing to the OVS interface have been processed by ovs-
619 vswitchd. At the same time a timestamp, in milliseconds
620 since the epoch, is stored in external_ids:ovn-in‐
621 stalled-ts.
622
624 ovn-controller reads from much of the OVN_Southbound database to guide
625 its operation. ovn-controller also writes to the following tables:
626 Chassis
628 Upon startup, ovn-controller creates a row in this table
629 to represent its own chassis. Upon graceful termination,
630 e.g. with ovs-appctl -t ovn-controller exit (but not
631 SIGTERM), ovn-controller removes its row.
632 Encap Upon startup, ovn-controller creates a row or rows in
634 this table that represent the tunnel encapsulations by
635 which its chassis can be reached, and points its Chassis
636 row to them. Upon graceful termination, ovn-controller
637 removes these rows.
638 Port_Binding
640 At runtime, ovn-controller sets the chassis columns of
641 ports that are resident on its chassis to point to its
642 Chassis row, and, conversely, clears the chassis column
643 of ports that point to its Chassis row but are no longer
644 resident on its chassis. The chassis column has a weak
645 reference type, so when ovn-controller gracefully exits
646 and removes its Chassis row, the database server automat‐
647 ically clears any remaining references to that row.
648 MAC_Binding
650 At runtime, ovn-controller updates the MAC_Binding table
651 as instructed by put_arp and put_nd logical actions.
652 These changes persist beyond the lifetime of ovn-con‐
653 troller.
654
656 ovs-appctl can send commands to a running ovn-controller process. The
657 currently supported commands are described below.
658 exit Causes ovn-controller to gracefully terminate.
660 ct-zone-list
662 Lists each local logical port and its connection tracking
663 zone.
664 meter-table-list
666 Lists each meter table entry and its local meter id.
667 group-table-list
669 Lists each group table entry and its local group id.
670 inject-pkt microflow
672 Injects microflow into the connected Open vSwitch in‐
673 stance. microflow must contain an ingress logical port
674 (inport argument) that is present on the Open vSwitch in‐
675 stance.
676 The microflow argument describes the packet whose for‐
678 warding is to be simulated, in the syntax of an OVN logi‐
679 cal expression, as described in ovn-sb(5), to express
680 constraints. The parser understands prerequisites; for
681 example, if the expression refers to ip4.src, there is no
682 need to explicitly state ip4 or eth.type == 0x800.
683 connection-status
685 Show OVN SBDB connection status for the chassis.
686 recompute
688 Trigger a full compute iteration in ovn-controller based
689 on the contents of the Southbound database and local OVS
690 database.
691 This command is intended to use only in the event of a
693 bug in the incremental processing engine in ovn-con‐
694 troller to avoid inconsistent states. It should therefore
695 be used with care as full recomputes are cpu intensive.
696 sb-cluster-state-reset
698 Reset southbound database cluster status when databases
699 are destroyed and rebuilt.
700 If all databases in a clustered southbound database are
702 removed from disk, then the stored index of all databases
703 will be reset to zero. This will cause ovn-controller to
704 be unable to read or write to the southbound database,
705 because it will always detect the data as stale. In such
706 a case, run this command so that ovn-controller will re‐
707 set its local index so that it can interact with the
708 southbound database again.
709 debug/delay-nb-cfg-report seconds
711 This command is used to delay ovn-controller updating the
712 nb_cfg back to OVN_Southbound database. This is useful
713 when ovn-nbctl --wait=hv is used to measure end-to-end
714 latency in a large scale environment. See ovn-nbctl(8)
715 for more details.
716 lflow-cache/flush
718 Flushes the ovn-controller logical flow cache.
719 lflow-cache/show-stats
721 Displays logical flow cache statistics: enabled/disabled,
722 per cache type entry counts.
723 inc-engine/show-stats
725 Display ovn-controller engine counters. For each engine
726 node the following counters have been added:
727 • recompute
729 • compute
731 • abort
733 inc-engine/show-stats engine_node_name counter_name
735 Display the ovn-controller engine counter(s) for the
736 specified engine_node_name. counter_name is optional and
737 can be one of recompute, compute or abort.
738 inc-engine/clear-stats
740 Reset ovn-controller engine counters.
741OVN 22.12.0 ovn-controller ovn-controller(8)