1ovn-ctl(8) OVN Manual ovn-ctl(8)
2
6 ovn-ctl - Open Virtual Network northbound daemon lifecycle utility
7
9 ovn-ctl [options] command
10
12 This program is intended to be invoked internally by Open Virtual Net‐
13 work startup scripts. System administrators should not normally invoke
14 it directly.
15
17 start_northd
18 start_controller
19 start_controller_vtep
20 start_ic
21 stop_northd
22 stop_controller
23 stop_controller_vtep
24 stop_ic
25 restart_northd
26 restart_controller
27 restart_controller_vtep
28 restart_ic
29 promote_ovnnb
30 promote_ovnsb
31 demote_ovnnb
32 demote_ovnsb
33 status_ovnnb
34 status_ovnsb
35 start_ovsdb
36 start_nb_ovsdb
37 start_sb_ovsdb
38 stop_ovsdb
39 stop_nb_ovsdb
40 stop_sb_ovsdb
41 restart_ovsdb
42 run_nb_ovsdb
43 run_sb_ovsdb
44 promote_ic_nb
45 promote_ic_sb
46 demote_ic_nb
47 demote_ic_sb
48 status_ic_nb
49 status_ic_sb
50 start_ic_ovsdb
51 start_ic_nb_ovsdb
52 start_ic_sb_ovsdb
53 stop_ic_ovsdb
54 stop_ic_nb_ovsdb
55 stop_ic_sb_ovsdb
56 restart_ic_ovsdb
57 run_ic_nb_ovsdb
58 run_ic_sb_ovsdb
59
61 --ovn-northd-priority=NICE
62 --ovn-northd-wrapper=WRAPPER
64 --ovn-controller-priority=NICE
66 --ovn-controller-wrapper=WRAPPER
68 --ovn-ic-priority=NICE
70 --ovn-ic-wrapper=WRAPPER
72 --ovsdb-nb-wrapper=WRAPPER
74 --ovsdb-sb-wrapper=WRAPPER
76 --ovn-user=USER:GROUP
78 --ovs-user=USER:GROUP
80 -h | --help
82
84 --db-sock=SOCKET
85 --db-nb-file=FILE
87 --db-sb-file=FILE
89 --db-nb-schema=FILE
91 --db-sb-schema=FILE
93 --db-sb-create-insecure-remote=yes|no
95 --db-nb-create-insecure-remote=yes|no
97 --db-ic-nb-file=FILE
99 --db-ic-sb-file=FILE
101 --db-ic-nb-schema=FILE
103 --db-ic-sb-schema=FILE
105 --db-ic-sb-create-insecure-remote=yes|no
107 --db-ic-nb-create-insecure-remote=yes|no
109 --ovn-controller-ssl-key=KEY
111 --ovn-controller-ssl-cert=CERT
113 --ovn-controller-ssl-ca-cert=CERT
115 --ovn-controller-ssl-bootstrap-ca-cert=CERT
117
119 --db-nb-sync-from-addr=IP ADDRESS
120 --db-nb-sync-from-port=PORT NUMBER
122 --db-nb-sync-from-proto=PROTO
124 --db-sb-sync-from-addr=IP ADDRESS
126 --db-sb-sync-from-port=PORT NUMBER
128 --db-sb-sync-from-proto=PROTO
130 --db-ic-nb-sync-from-addr=IP ADDRESS
132 --db-ic-nb-sync-from-port=PORT NUMBER
134 --db-ic-nb-sync-from-proto=PROTO
136 --db-ic-sb-sync-from-addr=IP ADDRESS
138 --db-ic-sb-sync-from-port=PORT NUMBER
140 --db-ic-sb-sync-from-proto=PROTO
142 --ovn-northd-nb-db=PROTO:IP ADDRESS: PORT..
144 --ovn-northd-sb-db=PROTO:IP ADDRESS: PORT..
146 --ovn-ic-nb-db=PROTO:IP ADDRESS: PORT..
148 --ovn-ic-sb-db=PROTO:IP ADDRESS: PORT..
150
152 --db-nb-cluster-local-addr=IP ADDRESS
153 --db-nb-cluster-local-port=PORT NUMBER
155 --db-nb-cluster-local-proto=PROTO (tcp/ssl)
157 --db-nb-cluster-remote-addr=IP ADDRESS
159 --db-nb-cluster-remote-port=PORT NUMBER
161 --db-nb-cluster-remote-proto=PROTO (tcp/ssl)
163 --db-sb-cluster-local-addr=IP ADDRESS
165 --db-sb-cluster-local-port=PORT NUMBER
167 --db-sb-cluster-local-proto=PROTO (tcp/ssl)
169 --db-sb-cluster-remote-addr=IP ADDRESS
171 --db-sb-cluster-remote-port=PORT NUMBER
173 --db-sb-cluster-remote-proto=PROTO (tcp/ssl)
175 --db-ic-nb-cluster-local-addr=IP ADDRESS
177 --db-ic-nb-cluster-local-port=PORT NUMBER
179 --db-ic-nb-cluster-local-proto=PROTO (tcp/ssl)
181 --db-ic-nb-cluster-remote-addr=IP ADDRESS
183 --db-ic-nb-cluster-remote-port=PORT NUMBER
185 --db-ic-nb-cluster-remote-proto=PROTO (tcp/ssl)
187 --db-ic-sb-cluster-local-addr=IP ADDRESS
189 --db-ic-sb-cluster-local-port=PORT NUMBER
191 --db-ic-sb-cluster-local-proto=PROTO (tcp/ssl)
193 --db-ic-sb-cluster-remote-addr=IP ADDRESS
195 --db-ic-sb-cluster-remote-port=PORT NUMBER
197 --db-ic-sb-cluster-remote-proto=PROTO (tcp/ssl)
199
201 --db-nb-probe-interval-to-active=Time in milliseconds
202 --db-sb-probe-interval-to-active=Time in milliseconds
204
206 Following are the optional configuration files. If present, it should
207 be located in the etc dir
208 ovnnb-active.conf
210 If present, this file should hold the url to connect to the active
211 Northbound DB server
212 tcp:x.x.x.x:6641
214 ovnsb-active.conf
216 If present, this file should hold the url to connect to the active
217 Southbound DB server
218 tcp:x.x.x.x:6642
220 ovn-northd-db-params.conf
222 If present, start_northd will not start the DB server even if
223 --ovn-manage-ovsdb=yes. This file should hold the database url parame‐
224 ters to be passed to ovn-northd.
225 --ovnnb-db=tcp:x.x.x.x:6641 --ovnsb-db=tcp:x.x.x.x:6642
227 ic-nb-active.conf
229 If present, this file should hold the url to connect to the active In‐
230 terconnection Northbound DB server
231 tcp:x.x.x.x:6645
233 ic-sb-active.conf
235 If present, this file should hold the url to connect to the active In‐
236 terconnection Southbound DB server
237 tcp:x.x.x.x:6646
239 ovn-ic-db-params.conf
241 If present, this file should hold the database url parameters to be
242 passed to ovn-ic.
243 --ic-nb-db=tcp:x.x.x.x:6645 --ic-sb-db=tcp:x.x.x.x:6646
245
247 # ovn-ctl run_nb_ovsdb
248 This command runs the OVN nb ovsdb-server without passing the detach
250 option, making it to block until ovsdb-server exits. This command will
251 be useful for starting the OVN nb ovsdb-server in a container.
252 # ovn-ctl run_sb_ovsdb
254 This command runs the OVN sb ovsdb-server without passing the detach
256 option, making it to block until ovsdb-server exits. This command will
257 be useful for starting the OVN sb ovsdb-server in a container.
258 # ovn-ctl run_ic_nb_ovsdb
260 This command runs the OVN IC-NB ovsdb-server without passing the detach
262 option, making it to block until ovsdb-server exits. This command will
263 be useful for starting the OVN IC-NB ovsdb-server in a container.
264 # ovn-ctl run_ic_sb_ovsdb
266 This command runs the OVN IC-SB ovsdb-server without passing the detach
268 option, making it to block until ovsdb-server exits. This command will
269 be useful for starting the OVN IC-SB ovsdb-server in a container.
270
272 Run ovn-controller on a host already running OVS
273 # ovn-ctl start_controller
274 Run ovn-northd on a host already running OVS
276 # ovn-ctl start_northd
277 All-in-one OVS+OVN for testing
279 # ovs-ctl start --system-id="random"
280 # ovn-ctl start_northd
282 # ovn-ctl start_controller
284 Promote and demote ovsdb servers
286 # ovn-ctl promote_ovnnb
287 # ovn-ctl promote_ovnsb
289 # ovn-ctl --db-nb-sync-from-addr=x.x.x.x --db-nb-sync-from-port=6641
291 --db-nb-probe-interval-to-active=60000 demote_ovnnb
292 # ovn-ctl --db-sb-sync-from-addr=x.x.x.x --db-sb-sync-from-port=6642
294 --db-sb-probe-interval-to-active=60000 demote_ovnsb
295 Creating a clustered db on 3 nodes with IPs x.x.x.x, y.y.y.y and z.z.z.z
297 Starting OVN ovsdb servers and ovn-northd on the node with IP x.x.x.x
298 # ovn-ctl --db-nb-addr=x.x.x.x --db-nb-create-insecure-remote=yes
300 --db-sb-addr=x.x.x.x --db-sb-create-insecure-remote=yes --db-nb-clus‐
301 ter-local-addr=x.x.x.x --db-sb-cluster-local-addr=x.x.x.x
302 --ovn-northd-nb-db=tcp:x.x.x.x:6641,tcp:y.y.y.y:6641,tcp:z.z.z.z:6641
303 --ovn-northd-sb-db=tcp:x.x.x.x:6642,tcp:y.y.y.y:6642,tcp:z.z.z.z:6642
304 start_northd
305 Starting OVN ovsdb-servers and ovn-northd on the node with IP y.y.y.y and
307 joining the cluster started at x.x.x.x
308 # ovn-ctl --db-nb-addr=y.y.y.y --db-nb-create-insecure-remote=yes
310 --db-sb-addr=y.y.y.y --db-sb-create-insecure-remote=yes --db-nb-clus‐
311 ter-local-addr=y.y.y.y --db-sb-cluster-local-addr=y.y.y.y --db-nb-clus‐
312 ter-remote-addr=x.x.x.x --db-sb-cluster-remote-addr=x.x.x.x
313 --ovn-northd-nb-db=tcp:x.x.x.x:6641,tcp:y.y.y.y:6641,tcp:z.z.z.z:6641
314 --ovn-northd-sb-db=tcp:x.x.x.x:6642,tcp:y.y.y.y:6642,tcp:z.z.z.z:6642
315 start_northd
316 Starting OVN ovsdb-servers and ovn-northd on the node with IP z.z.z.z and
318 joining the cluster started at x.x.x.x
319 # ovn-ctl --db-nb-addr=z.z.z.z --db-nb-create-insecure-remote=yes
321 --db-nb-cluster-local-addr=z.z.z.z --db-sb-addr=z.z.z.z --db-sb-cre‐
322 ate-insecure-remote=yes --db-sb-cluster-local-addr=z.z.z.z
323 --db-nb-cluster-remote-addr=x.x.x.x --db-sb-cluster-remote-addr=x.x.x.x
324 --ovn-northd-nb-db=tcp:x.x.x.x:6641,tcp:y.y.y.y:6641,tcp:z.z.z.z:6641
325 --ovn-northd-sb-db=tcp:x.x.x.x:6642,tcp:y.y.y.y:6642,tcp:z.z.z.z:6642
326 start_northd
327 Passing ssl keys when starting OVN dbs will supercede the default ssl val‐
329 ues in db
330 Starting standalone ovn db server passing SSL certificates
331 # ovn-ctl --ovn-nb-db-ssl-key=/etc/ovn/ovnnb-privkey.pem
333 --ovn-nb-db-ssl-cert=/etc/ovn/ovnnb-cert.pem
334 --ovn-nb-db-ssl-ca-cert=/etc/ovn/cacert.pem
335 --ovn-sb-db-ssl-key=/etc/ovn/ovnsb-privkey.pem
336 --ovn-sb-db-ssl-cert=/etc/ovn/ovnsb-cert.pem
337 --ovn-sb-db-ssl-ca-cert=/etc/ovn/cacert.pem start_northd
338OVN 22.06.1 ovn-ctl ovn-ctl(8)