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