1ovn-ctl(8)                        OVN Manual                        ovn-ctl(8)
2
3
4

NAME

6       ovn-ctl - Open Virtual Network northbound daemon lifecycle utility
7

SYNOPSIS

9       ovn-ctl [options] command [-- extra_args]
10

DESCRIPTION

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

COMMANDS

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

OPTIONS

61       --ovn-northd-priority=NICE
62
63       --ovn-northd-wrapper=WRAPPER
64
65       --ovn-controller-priority=NICE
66
67       --ovn-controller-wrapper=WRAPPER
68
69       --ovn-ic-priority=NICE
70
71       --ovn-ic-wrapper=WRAPPER
72
73       --ovsdb-nb-wrapper=WRAPPER
74
75       --ovsdb-sb-wrapper=WRAPPER
76
77       --ovn-user=USER:GROUP
78
79       --ovs-user=USER:GROUP
80
81       -h | --help
82

FILE LOCATION OPTIONS

84       --db-sock=SOCKET
85
86       --db-nb-file=FILE
87
88       --db-sb-file=FILE
89
90       --db-nb-schema=FILE
91
92       --db-sb-schema=FILE
93
94       --db-sb-create-insecure-remote=yes|no
95
96       --db-nb-create-insecure-remote=yes|no
97
98       --db-ic-nb-file=FILE
99
100       --db-ic-sb-file=FILE
101
102       --db-ic-nb-schema=FILE
103
104       --db-ic-sb-schema=FILE
105
106       --db-ic-sb-create-insecure-remote=yes|no
107
108       --db-ic-nb-create-insecure-remote=yes|no
109
110       --ovn-controller-ssl-key=KEY
111
112       --ovn-controller-ssl-cert=CERT
113
114       --ovn-controller-ssl-ca-cert=CERT
115
116       --ovn-controller-ssl-bootstrap-ca-cert=CERT
117

ADDRESS AND PORT OPTIONS

119       --db-nb-sync-from-addr=IP ADDRESS
120
121       --db-nb-sync-from-port=PORT NUMBER
122
123       --db-nb-sync-from-proto=PROTO
124
125       --db-sb-sync-from-addr=IP ADDRESS
126
127       --db-sb-sync-from-port=PORT NUMBER
128
129       --db-sb-sync-from-proto=PROTO
130
131       --db-ic-nb-sync-from-addr=IP ADDRESS
132
133       --db-ic-nb-sync-from-port=PORT NUMBER
134
135       --db-ic-nb-sync-from-proto=PROTO
136
137       --db-ic-sb-sync-from-addr=IP ADDRESS
138
139       --db-ic-sb-sync-from-port=PORT NUMBER
140
141       --db-ic-sb-sync-from-proto=PROTO
142
143        --ovn-northd-nb-db=PROTO:IP ADDRESS: PORT..
144
145        --ovn-northd-sb-db=PROTO:IP ADDRESS: PORT..
146
147        --ovn-ic-nb-db=PROTO:IP ADDRESS: PORT..
148
149        --ovn-ic-sb-db=PROTO:IP ADDRESS: PORT..
150

CLUSTERING OPTIONS

152       --db-nb-cluster-local-addr=IP ADDRESS
153
154       --db-nb-cluster-local-port=PORT NUMBER
155
156       --db-nb-cluster-local-proto=PROTO (tcp/ssl)
157
158       --db-nb-cluster-remote-addr=IP ADDRESS
159
160       --db-nb-cluster-remote-port=PORT NUMBER
161
162       --db-nb-cluster-remote-proto=PROTO (tcp/ssl)
163
164       --db-nb-election-timer=Timeout in milliseconds
165
166       --db-sb-cluster-local-addr=IP ADDRESS
167
168       --db-sb-cluster-local-port=PORT NUMBER
169
170       --db-sb-cluster-local-proto=PROTO (tcp/ssl)
171
172       --db-sb-cluster-remote-addr=IP ADDRESS
173
174       --db-sb-cluster-remote-port=PORT NUMBER
175
176       --db-sb-cluster-remote-proto=PROTO (tcp/ssl)
177
178       --db-sb-election-timer=Timeout in milliseconds
179
180       --db-ic-nb-cluster-local-addr=IP ADDRESS
181
182       --db-ic-nb-cluster-local-port=PORT NUMBER
183
184       --db-ic-nb-cluster-local-proto=PROTO (tcp/ssl)
185
186       --db-ic-nb-cluster-remote-addr=IP ADDRESS
187
188       --db-ic-nb-cluster-remote-port=PORT NUMBER
189
190       --db-ic-nb-cluster-remote-proto=PROTO (tcp/ssl)
191
192       --db-ic-sb-cluster-local-addr=IP ADDRESS
193
194       --db-ic-sb-cluster-local-port=PORT NUMBER
195
196       --db-ic-sb-cluster-local-proto=PROTO (tcp/ssl)
197
198       --db-ic-sb-cluster-remote-addr=IP ADDRESS
199
200       --db-ic-sb-cluster-remote-port=PORT NUMBER
201
202       --db-ic-sb-cluster-remote-proto=PROTO (tcp/ssl)
203

PROBE INTERVAL OPTIONS

205       --db-nb-probe-interval-to-active=Time in milliseconds
206
207       --db-sb-probe-interval-to-active=Time in milliseconds
208

EXTRA OPTIONS

210       Any  options  after  ’-’ will be passed on to the binary run by command
211       with the exception of start_northd, which can have options specified in
212       ovn-northd-db-params.conf.  Any  extra_args passed to start_northd will
213       be passed to the ovsdb-servers if --ovn-manage-ovsdb=yes
214

CONFIGURATION FILES

216       Following are the optional configuration files. If present,  it  should
217       be located in the etc dir
218
219   ovnnb-active.conf
220       If  present,  this  file  should  hold the url to connect to the active
221       Northbound DB server
222
223       tcp:x.x.x.x:6641
224
225   ovnsb-active.conf
226       If present, this file should hold the url  to  connect  to  the  active
227       Southbound DB server
228
229       tcp:x.x.x.x:6642
230
231   ovn-northd-db-params.conf
232       If  present,  start_northd  will  not  start  the  DB  server  even  if
233       --ovn-manage-ovsdb=yes. This file should hold the database url  parame‐
234       ters to be passed to ovn-northd.
235
236       --ovnnb-db=tcp:x.x.x.x:6641 --ovnsb-db=tcp:x.x.x.x:6642
237
238   ic-nb-active.conf
239       If  present, this file should hold the url to connect to the active In‐
240       terconnection Northbound DB server
241
242       tcp:x.x.x.x:6645
243
244   ic-sb-active.conf
245       If present, this file should hold the url to connect to the active  In‐
246       terconnection Southbound DB server
247
248       tcp:x.x.x.x:6646
249
250   ovn-ic-db-params.conf
251       If  present,  this  file  should hold the database url parameters to be
252       passed to ovn-ic.
253
254       --ic-nb-db=tcp:x.x.x.x:6645 --ic-sb-db=tcp:x.x.x.x:6646
255

RUNNING OVN DB SERVERS WITHOUT DETACHING

257       # ovn-ctl run_nb_ovsdb
258
259       This command runs the OVN 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 nb ovsdb-server in a container.
262
263       # ovn-ctl run_sb_ovsdb
264
265       This command runs the OVN 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 sb ovsdb-server in a container.
268
269       # ovn-ctl run_ic_nb_ovsdb
270
271       This command runs the OVN IC-NB ovsdb-server without passing the detach
272       option,  making it to block until ovsdb-server exits. This command will
273       be useful for starting the OVN IC-NB ovsdb-server in a container.
274
275       # ovn-ctl run_ic_sb_ovsdb
276
277       This command runs the OVN IC-SB ovsdb-server without passing the detach
278       option,  making it to block until ovsdb-server exits. This command will
279       be useful for starting the OVN IC-SB ovsdb-server in a container.
280

EXAMPLE USAGE

282   Run ovn-controller on a host already running OVS
283       # ovn-ctl start_controller
284
285   Run ovn-northd on a host already running OVS
286       # ovn-ctl start_northd
287
288   All-in-one OVS+OVN for testing
289       # ovs-ctl start --system-id="random"
290
291       # ovn-ctl start_northd
292
293       # ovn-ctl start_controller
294
295   Promote and demote ovsdb servers
296       # ovn-ctl promote_ovnnb
297
298       # ovn-ctl promote_ovnsb
299
300       #  ovn-ctl  --db-nb-sync-from-addr=x.x.x.x  --db-nb-sync-from-port=6641
301       --db-nb-probe-interval-to-active=60000 demote_ovnnb
302
303       #  ovn-ctl  --db-sb-sync-from-addr=x.x.x.x  --db-sb-sync-from-port=6642
304       --db-sb-probe-interval-to-active=60000 demote_ovnsb
305
306   Creating a clustered db on 3 nodes with IPs x.x.x.x, y.y.y.y and z.z.z.z
307     Starting OVN ovsdb servers and ovn-northd on the node with IP x.x.x.x
308
309         #  ovn-ctl  --db-nb-addr=x.x.x.x   --db-nb-create-insecure-remote=yes
310       --db-sb-addr=x.x.x.x  --db-sb-create-insecure-remote=yes  --db-nb-clus‐
311       ter-local-addr=x.x.x.x               --db-sb-cluster-local-addr=x.x.x.x
312       --ovn-northd-nb-db=tcp:x.x.x.x:6641,tcp:y.y.y.y:6641,tcp:z.z.z.z:6641
313       --ovn-northd-sb-db=tcp:x.x.x.x:6642,tcp:y.y.y.y:6642,tcp:z.z.z.z:6642
314       start_northd
315
316     Starting OVN ovsdb-servers and ovn-northd on the node with IP y.y.y.y and
317     joining the cluster started at x.x.x.x
318
319         #  ovn-ctl  --db-nb-addr=y.y.y.y   --db-nb-create-insecure-remote=yes
320       --db-sb-addr=y.y.y.y  --db-sb-create-insecure-remote=yes  --db-nb-clus‐
321       ter-local-addr=y.y.y.y --db-sb-cluster-local-addr=y.y.y.y --db-nb-clus‐
322       ter-remote-addr=x.x.x.x             --db-sb-cluster-remote-addr=x.x.x.x
323       --ovn-northd-nb-db=tcp:x.x.x.x:6641,tcp:y.y.y.y:6641,tcp:z.z.z.z:6641
324       --ovn-northd-sb-db=tcp:x.x.x.x:6642,tcp:y.y.y.y:6642,tcp:z.z.z.z:6642
325       start_northd
326
327     Starting OVN ovsdb-servers and ovn-northd on the node with IP z.z.z.z and
328     joining the cluster started at x.x.x.x
329
330          #  ovn-ctl  --db-nb-addr=z.z.z.z  --db-nb-create-insecure-remote=yes
331       --db-nb-cluster-local-addr=z.z.z.z  --db-sb-addr=z.z.z.z   --db-sb-cre‐
332       ate-insecure-remote=yes              --db-sb-cluster-local-addr=z.z.z.z
333       --db-nb-cluster-remote-addr=x.x.x.x --db-sb-cluster-remote-addr=x.x.x.x
334       --ovn-northd-nb-db=tcp:x.x.x.x:6641,tcp:y.y.y.y:6641,tcp:z.z.z.z:6641
335       --ovn-northd-sb-db=tcp:x.x.x.x:6642,tcp:y.y.y.y:6642,tcp:z.z.z.z:6642
336       start_northd
337
338   Passing  ssl keys when starting OVN dbs will supersede the default ssl val‐
339       ues in db
340     Starting standalone ovn db server passing SSL certificates
341
342            #      ovn-ctl      --ovn-nb-db-ssl-key=/etc/ovn/ovnnb-privkey.pem
343       --ovn-nb-db-ssl-cert=/etc/ovn/ovnnb-cert.pem
344       --ovn-nb-db-ssl-ca-cert=/etc/ovn/cacert.pem
345       --ovn-sb-db-ssl-key=/etc/ovn/ovnsb-privkey.pem
346       --ovn-sb-db-ssl-cert=/etc/ovn/ovnsb-cert.pem
347       --ovn-sb-db-ssl-ca-cert=/etc/ovn/cacert.pem start_northd
348
349
350
351OVN 23.09.2                         ovn-ctl                         ovn-ctl(8)