1ovn-ctl(8) Open vSwitch 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 stop_northd
21 stop_controller
22 stop_controller_vtep
23 restart_northd
24 restart_controller
25 restart_controller_vtep
26 promote_ovnnb
27 promote_ovnsb
28 demote_ovnnb
29 demote_ovnsb
30 status_ovnnb
31 status_ovnsb
32 start_ovsdb
33 start_nb_ovsdb
34 start_sb_ovsdb
35 stop_ovsdb
36 stop_nb_ovsdb
37 stop_sb_ovsdb
38 restart_ovsdb
39 run_nb_ovsdb
40 run_sb_ovsdb
41
43 --ovn-northd-priority=NICE
44 --ovn-northd-wrapper=WRAPPER
46 --ovn-controller-priority=NICE
48 --ovn-controller-wrapper=WRAPPER
50 --ovn-user=USER:GROUP
52 --ovs-user=USER:GROUP
54 -h | --help
56
58 --db-sock=SOCKET
59 --db-nb-file=FILE
61 --db-sb-file=FILE
63 --db-nb-schema=FILE
65 --db-sb-schema=FILE
67 --db-sb-create-insecure-remote=yes|no
69 --db-nb-create-insecure-remote=yes|no
71 --ovn-controller-ssl-key=KEY
73 --ovn-controller-ssl-cert=CERT
75 --ovn-controller-ssl-ca-cert=CERT
77 --ovn-controller-ssl-bootstrap-ca-cert=CERT
79
81 --db-nb-sync-from-addr=IP ADDRESS
82 --db-nb-sync-from-port=PORT NUMBER
84 --db-nb-sync-from-proto=PROTO
86 --db-sb-sync-from-addr=IP ADDRESS
88 --db-sb-sync-from-port=PORT NUMBER
90 --db-sb-sync-from-proto=PROTO
92 --ovn-northd-nb-db=PROTO:IP ADDRESS: PORT..
94 --ovn-northd-sb-db=PROTO:IP ADDRESS: PORT..
96 CLUSTERING OPTIONS
98 --db-nb-cluster-local-addr=IP ADDRESS
99 --db-nb-cluster-local-port=PORT NUMBER
101 --db-nb-cluster-local-proto=PROTO (tcp/ssl)
103 --db-nb-cluster-remote-addr=IP ADDRESS
105 --db-nb-cluster-remote-port=PORT NUMBER
107 --db-nb-cluster-remote-proto=PROTO (tcp/ssl)
109 --db-sb-cluster-local-addr=IP ADDRESS
111 --db-sb-cluster-local-port=PORT NUMBER
113 --db-sb-cluster-local-proto=PROTO (tcp/ssl)
115 --db-sb-cluster-remote-addr=IP ADDRESS
117 --db-sb-cluster-remote-port=PORT NUMBER
119 --db-sb-cluster-remote-proto=PROTO (tcp/ssl)
121
123 Following are the optional configuration files. If present, it should
124 be located in the etc dir
125 ovnnb-active.conf
127 If present, this file should hold the url to connect to the active
128 Northbound DB server
129 tcp:x.x.x.x:6641
131 ovnsb-active.conf
133 If present, this file should hold the url to connect to the active
134 Southbound DB server
135 tcp:x.x.x.x:6642
137 ovn-northd-db-params.conf
139 If present, start_northd will not start the DB server even if
140 --ovn-manage-ovsdb=yes. This file should hold the database url parame‐
141 ters to be passed to ovn-northd.
142 --ovnnb-db=tcp:x.x.x.x:6641 --ovnsb-db=tcp:x.x.x.x:6642
144 RUNNING OVN DB SERVERS WITHOUT DETACHING
146 # ovn-ctl run_nb_ovsdb
147 This command runs the OVN nb ovsdb-server without passing the detach
149 option, making it to block until ovsdb-server exits. This command will
150 be useful for starting the OVN nb ovsdb-server in a container.
151 # ovn-ctl run_sb_ovsdb
153 This command runs the OVN sb ovsdb-server without passing the detach
155 option, making it to block until ovsdb-server exits. This command will
156 be useful for starting the OVN sb ovsdb-server in a container.
157
159 Run ovn-controller on a host already running OVS
160 # ovn-ctl start_controller
161 Run ovn-northd on a host already running OVS
163 # ovn-ctl start_northd
164 All-in-one OVS+OVN for testing
166 # ovs-ctl start --system-id="random"
167 # ovn-ctl start_northd
169 # ovn-ctl start_controller
171 Promote and demote ovsdb servers
173 # ovn-ctl promote_ovnnb
174 # ovn-ctl promote_ovnsb
176 # ovn-ctl --db-nb-sync-from-addr=x.x.x.x --db-nb-sync-from-port=6641
178 demote_ovnnb
179 # ovn-ctl --db-sb-sync-from-addr=x.x.x.x --db-sb-sync-from-port=6642
181 demote_ovnsb
182 Creating a clustered db on 3 nodes with IPs x.x.x.x, y.y.y.y and z.z.z.z
184 Starting OVN ovsdb servers and ovn-northd on the node with IP x.x.x.x
185 # ovn-ctl --db-nb-addr=x.x.x.x --db-nb-create-insecure-remote=yes
187 --db-sb-addr=x.x.x.x --db-sb-create-insecure-remote=yes --db-nb-clus‐
188 ter-local-addr=x.x.x.x --db-sb-cluster-local-addr=x.x.x.x
189 --ovn-northd-nb-db=tcp:x.x.x.x:6641,tcp:y.y.y.y:6641,tcp:z.z.z.z:6641
190 --ovn-northd-sb-db=tcp:x.x.x.x:6642,tcp:y.y.y.y:6642,tcp:z.z.z.z:6642
191 start_northd
192 Starting OVN ovsdb-servers and ovn-northd on the node with IP y.y.y.y and
194 joining the cluster started at x.x.x.x
195 # ovn-ctl --db-nb-addr=y.y.y.y --db-nb-create-insecure-remote=yes
197 --db-sb-addr=y.y.y.y --db-sb-create-insecure-remote=yes --db-nb-clus‐
198 ter-local-addr=y.y.y.y --db-sb-cluster-local-addr=y.y.y.y --db-nb-clus‐
199 ter-remote-addr=x.x.x.x --db-sb-cluster-remote-addr=x.x.x.x
200 --ovn-northd-nb-db=tcp:x.x.x.x:6641,tcp:y.y.y.y:6641,tcp:z.z.z.z:6641
201 --ovn-northd-sb-db=tcp:x.x.x.x:6642,tcp:y.y.y.y:6642,tcp:z.z.z.z:6642
202 start_northd
203 Starting OVN ovsdb-servers and ovn-northd on the node with IP z.z.z.z and
205 joining the cluster started at x.x.x.x
206 # ovn-ctl --db-nb-addr=z.z.z.z --db-nb-create-insecure-remote=yes
208 --db-nb-cluster-local-addr=z.z.z.z --db-sb-addr=z.z.z.z --db-sb-cre‐
209 ate-insecure-remote=yes --db-sb-cluster-local-addr=z.z.z.z
210 --db-nb-cluster-remote-addr=x.x.x.x --db-sb-cluster-remote-addr=x.x.x.x
211 --ovn-northd-nb-db=tcp:x.x.x.x:6641,tcp:y.y.y.y:6641,tcp:z.z.z.z:6641
212 --ovn-northd-sb-db=tcp:x.x.x.x:6642,tcp:y.y.y.y:6642,tcp:z.z.z.z:6642
213 start_northd
214 Passing ssl keys when starting OVN dbs will supercede the default ssl val‐
216 ues in db
217 Starting standalone ovn db server passing SSL certificates
218 # ovn-ctl --ovn-nb-db-ssl-key=/etc/ovn/ovnnb-privkey.pem
220 --ovn-nb-db-ssl-cert=/etc/ovn/ovnnb-cert.pem
221 --ovn-nb-db-ssl-ca-cert=/etc/ovn/cacert.pem
222 --ovn-sb-db-ssl-key=/etc/ovn/ovnsb-privkey.pem
223 --ovn-sb-db-ssl-cert=/etc/ovn/ovnsb-cert.pem
224 --ovn-sb-db-ssl-ca-cert=/etc/ovn/cacert.pem start_northd
225Open vSwitch 2.12.0 ovn-ctl ovn-ctl(8)