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       --ovn-user=USER:GROUP
76
77       --ovs-user=USER:GROUP
78
79       -h | --help
80

FILE LOCATION OPTIONS

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

ADDRESS AND PORT OPTIONS

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

CLUSTERING OPTIONS

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

PROBE INTERVAL OPTIONS

199       --db-nb-probe-interval-to-active=Time in milliseconds
200
201       --db-sb-probe-interval-to-active=Time in milliseconds
202

CONFIGURATION FILES

204       Following  are  the optional configuration files. If present, it should
205       be located in the etc dir
206
207   ovnnb-active.conf
208       If present, this file should hold the url  to  connect  to  the  active
209       Northbound DB server
210
211       tcp:x.x.x.x:6641
212
213   ovnsb-active.conf
214       If  present,  this  file  should  hold the url to connect to the active
215       Southbound DB server
216
217       tcp:x.x.x.x:6642
218
219   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
224       --ovnnb-db=tcp:x.x.x.x:6641 --ovnsb-db=tcp:x.x.x.x:6642
225
226   ic-nb-active.conf
227       If present, this file should hold the url  to  connect  to  the  active
228       Interconnection Northbound DB server
229
230       tcp:x.x.x.x:6645
231
232   ic-sb-active.conf
233       If  present,  this  file  should  hold the url to connect to the active
234       Interconnection Southbound DB server
235
236       tcp:x.x.x.x:6646
237
238   ovn-ic-db-params.conf
239       If present, this file should hold the database  url  parameters  to  be
240       passed to ovn-ic.
241
242       --ic-nb-db=tcp:x.x.x.x:6645 --ic-sb-db=tcp:x.x.x.x:6646
243

RUNNING OVN DB SERVERS WITHOUT DETACHING

245       # ovn-ctl run_nb_ovsdb
246
247       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
251       # ovn-ctl run_sb_ovsdb
252
253       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
257       # ovn-ctl run_ic_nb_ovsdb
258
259       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
263       # ovn-ctl run_ic_sb_ovsdb
264
265       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

EXAMPLE USAGE

270   Run ovn-controller on a host already running OVS
271       # ovn-ctl start_controller
272
273   Run ovn-northd on a host already running OVS
274       # ovn-ctl start_northd
275
276   All-in-one OVS+OVN for testing
277       # ovs-ctl start --system-id="random"
278
279       # ovn-ctl start_northd
280
281       # ovn-ctl start_controller
282
283   Promote and demote ovsdb servers
284       # ovn-ctl promote_ovnnb
285
286       # ovn-ctl promote_ovnsb
287
288       #  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
291       #  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
294   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
297          #  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
304     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
307          #  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
315     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
318         #  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
326   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
330             #      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
336
337
338
339OVN 20.03.0                         ovn-ctl                         ovn-ctl(8)
Impressum