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 -h | --help
52
54 --db-sock=SOCKET
55 --db-nb-file=FILE
57 --db-sb-file=FILE
59 --db-nb-schema=FILE
61 --db-sb-schema=FILE
63 --db-sb-create-insecure-remote=yes|no
65 --db-nb-create-insecure-remote=yes|no
67 --ovn-controller-ssl-key=KEY
69 --ovn-controller-ssl-cert=CERT
71 --ovn-controller-ssl-ca-cert=CERT
73 --ovn-controller-ssl-bootstrap-ca-cert=CERT
75
77 --db-nb-sync-from-addr=IP ADDRESS
78 --db-nb-sync-from-port=PORT NUMBER
80 --db-nb-sync-from-proto=PROTO
82 --db-sb-sync-from-addr=IP ADDRESS
84 --db-sb-sync-from-port=PORT NUMBER
86 --db-sb-sync-from-proto=PROTO
88 --ovn-northd-nb-db=PROTO:IP ADDRESS: PORT..
90 --ovn-northd-sb-db=PROTO:IP ADDRESS: PORT..
92 CLUSTERING OPTIONS
94 --db-nb-cluster-local-addr=IP ADDRESS
95 --db-nb-cluster-local-port=PORT NUMBER
97 --db-nb-cluster-local-proto=PROTO (tcp/ssl)
99 --db-nb-cluster-remote-addr=IP ADDRESS
101 --db-nb-cluster-remote-port=PORT NUMBER
103 --db-nb-cluster-remote-proto=PROTO (tcp/ssl)
105 --db-sb-cluster-local-addr=IP ADDRESS
107 --db-sb-cluster-local-port=PORT NUMBER
109 --db-sb-cluster-local-proto=PROTO (tcp/ssl)
111 --db-sb-cluster-remote-addr=IP ADDRESS
113 --db-sb-cluster-remote-port=PORT NUMBER
115 --db-sb-cluster-remote-proto=PROTO (tcp/ssl)
117
119 Following are the optional configuration files. If present, it should
120 be located in the etc dir
121 ovnnb-active.conf
123 If present, this file should hold the url to connect to the active
124 Northbound DB server
125 tcp:x.x.x.x:6641
127 ovnsb-active.conf
129 If present, this file should hold the url to connect to the active
130 Southbound DB server
131 tcp:x.x.x.x:6642
133 ovn-northd-db-params.conf
135 If present, start_northd will not start the DB server even if
136 --ovn-manage-ovsdb=yes. This file should hold the database url parame‐
137 ters to be passed to ovn-northd.
138 --ovnnb-db=tcp:x.x.x.x:6641 --ovnsb-db=tcp:x.x.x.x:6642
140 RUNNING OVN DB SERVERS WITHOUT DETACHING
142 # ovn-ctl run_nb_ovsdb
143 This command runs the OVN nb ovsdb-server without passing the detach
145 option, making it to block until ovsdb-server exits. This command will
146 be useful for starting the OVN nb ovsdb-server in a container.
147 # ovn-ctl run_sb_ovsdb
149 This command runs the OVN sb ovsdb-server without passing the detach
151 option, making it to block until ovsdb-server exits. This command will
152 be useful for starting the OVN sb ovsdb-server in a container.
153
155 Run ovn-controller on a host already running OVS
156 # ovn-ctl start_controller
157 Run ovn-northd on a host already running OVS
159 # ovn-ctl start_northd
160 All-in-one OVS+OVN for testing
162 # ovs-ctl start --system-id="random"
163 # ovn-ctl start_northd
165 # ovn-ctl start_controller
167 Promote and demote ovsdb servers
169 # ovn-ctl promote_ovnnb
170 # ovn-ctl promote_ovnsb
172 # ovn-ctl --db-nb-sync-from-addr=x.x.x.x --db-nb-sync-from-port=6641
174 demote_ovnnb
175 # ovn-ctl --db-sb-sync-from-addr=x.x.x.x --db-sb-sync-from-port=6642
177 demote_ovnsb
178 Creating a clustered db on 3 nodes with IPs x.x.x.x, y.y.y.y and z.z.z.z
180 Starting OVN ovsdb servers and ovn-northd on the node with IP x.x.x.x
181 # ovn-ctl --db-nb-addr=x.x.x.x --db-nb-create-insecure-remote=yes
183 --db-sb-addr=x.x.x.x --db-sb-create-insecure-remote=yes --db-nb-clus‐
184 ter-local-addr=x.x.x.x --db-sb-cluster-local-addr=x.x.x.x
185 --ovn-northd-nb-db=tcp:x.x.x.x:6641,tcp:y.y.y.y:6641,tcp:z.z.z.z:6641
186 --ovn-northd-sb-db=tcp:x.x.x.x:6642,tcp:y.y.y.y:6642,tcp:z.z.z.z:6642
187 start_northd
188 Starting OVN ovsdb-servers and ovn-northd on the node with IP y.y.y.y and
190 joining the cluster started at x.x.x.x
191 # ovn-ctl --db-nb-addr=y.y.y.y --db-nb-create-insecure-remote=yes
193 --db-sb-addr=y.y.y.y --db-sb-create-insecure-remote=yes --db-nb-clus‐
194 ter-local-addr=y.y.y.y --db-sb-cluster-local-addr=y.y.y.y --db-nb-clus‐
195 ter-remote-addr=x.x.x.x --db-sb-cluster-remote-addr=x.x.x.x
196 --ovn-northd-nb-db=tcp:x.x.x.x:6641,tcp:y.y.y.y:6641,tcp:z.z.z.z:6641
197 --ovn-northd-sb-db=tcp:x.x.x.x:6642,tcp:y.y.y.y:6642,tcp:z.z.z.z:6642
198 start_northd
199 Starting OVN ovsdb-servers and ovn-northd on the node with IP z.z.z.z and
201 joining the cluster started at x.x.x.x
202 # ovn-ctl --db-nb-addr=z.z.z.z --db-nb-create-insecure-remote=yes
204 --db-nb-cluster-local-addr=z.z.z.z --db-sb-addr=z.z.z.z --db-sb-cre‐
205 ate-insecure-remote=yes --db-sb-cluster-local-addr=z.z.z.z
206 --db-nb-cluster-remote-addr=x.x.x.x --db-sb-cluster-remote-addr=x.x.x.x
207 --ovn-northd-nb-db=tcp:x.x.x.x:6641,tcp:y.y.y.y:6641,tcp:z.z.z.z:6641
208 --ovn-northd-sb-db=tcp:x.x.x.x:6642,tcp:y.y.y.y:6642,tcp:z.z.z.z:6642
209 start_northd
210 Passing ssl keys when starting OVN dbs will supercede the default ssl val‐
212 ues in db
213 Starting standalone ovn db server passing SSL certificates
214 # ovn-ctl --ovn-nb-db-ssl-key=/etc/openvswitch/ovnnb-privkey.pem
216 --ovn-nb-db-ssl-cert=/etc/openvswitch/ovnnb-cert.pem
217 --ovn-nb-db-ssl-ca-cert=/etc/openvswitch/cacert.pem
218 --ovn-sb-db-ssl-key=/etc/openvswitch/ovnsb-privkey.pem
219 --ovn-sb-db-ssl-cert=/etc/openvswitch/ovnsb-cert.pem
220 --ovn-sb-db-ssl-ca-cert=/etc/openvswitch/cacert.pem start_northd
221Open vSwitch 2.10.1 ovn-ctl ovn-ctl(8)