1ovn-ctl(8)                        OVN Manual                        ovn-ctl(8)
2
3
4
5build/.PP
6

NAME

8       ovn-ctl - Open Virtual Network northbound daemon lifecycle utility
9

SYNOPSIS

11       ovn-ctl [options] command
12

DESCRIPTION

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

COMMANDS

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

OPTIONS

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

FILE LOCATION OPTIONS

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

ADDRESS AND PORT OPTIONS

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

CLUSTERING OPTIONS

154       --db-nb-cluster-local-addr=IP ADDRESS
155
156       --db-nb-cluster-local-port=PORT NUMBER
157
158       --db-nb-cluster-local-proto=PROTO (tcp/ssl)
159
160       --db-nb-cluster-remote-addr=IP ADDRESS
161
162       --db-nb-cluster-remote-port=PORT NUMBER
163
164       --db-nb-cluster-remote-proto=PROTO (tcp/ssl)
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-ic-nb-cluster-local-addr=IP ADDRESS
179
180       --db-ic-nb-cluster-local-port=PORT NUMBER
181
182       --db-ic-nb-cluster-local-proto=PROTO (tcp/ssl)
183
184       --db-ic-nb-cluster-remote-addr=IP ADDRESS
185
186       --db-ic-nb-cluster-remote-port=PORT NUMBER
187
188       --db-ic-nb-cluster-remote-proto=PROTO (tcp/ssl)
189
190       --db-ic-sb-cluster-local-addr=IP ADDRESS
191
192       --db-ic-sb-cluster-local-port=PORT NUMBER
193
194       --db-ic-sb-cluster-local-proto=PROTO (tcp/ssl)
195
196       --db-ic-sb-cluster-remote-addr=IP ADDRESS
197
198       --db-ic-sb-cluster-remote-port=PORT NUMBER
199
200       --db-ic-sb-cluster-remote-proto=PROTO (tcp/ssl)
201

PROBE INTERVAL OPTIONS

203       --db-nb-probe-interval-to-active=Time in milliseconds
204
205       --db-sb-probe-interval-to-active=Time in milliseconds
206

CONFIGURATION FILES

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

RUNNING OVN DB SERVERS WITHOUT DETACHING

249       # ovn-ctl run_nb_ovsdb
250
251       This  command  runs  the OVN nb ovsdb-server without passing the detach
252       option, making it to block until ovsdb-server exits. This command  will
253       be useful for starting the OVN nb ovsdb-server in a container.
254
255       # ovn-ctl run_sb_ovsdb
256
257       This  command  runs  the OVN sb ovsdb-server without passing the detach
258       option, making it to block until ovsdb-server exits. This command  will
259       be useful for starting the OVN sb ovsdb-server in a container.
260
261       # ovn-ctl run_ic_nb_ovsdb
262
263       This command runs the OVN IC-NB ovsdb-server without passing the detach
264       option, making it to block until ovsdb-server exits. This command  will
265       be useful for starting the OVN IC-NB ovsdb-server in a container.
266
267       # ovn-ctl run_ic_sb_ovsdb
268
269       This command runs the OVN IC-SB ovsdb-server without passing the detach
270       option, making it to block until ovsdb-server exits. This command  will
271       be useful for starting the OVN IC-SB ovsdb-server in a container.
272

EXAMPLE USAGE

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