1ovn-ctl(8)                    Open vSwitch 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
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       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

OPTIONS

43       --ovn-northd-priority=NICE
44
45       --ovn-northd-wrapper=WRAPPER
46
47       --ovn-controller-priority=NICE
48
49       --ovn-controller-wrapper=WRAPPER
50
51       --ovn-user=USER:GROUP
52
53       --ovs-user=USER:GROUP
54
55       -h | --help
56

FILE LOCATION OPTIONS

58       --db-sock=SOCKET
59
60       --db-nb-file=FILE
61
62       --db-sb-file=FILE
63
64       --db-nb-schema=FILE
65
66       --db-sb-schema=FILE
67
68       --db-sb-create-insecure-remote=yes|no
69
70       --db-nb-create-insecure-remote=yes|no
71
72       --ovn-controller-ssl-key=KEY
73
74       --ovn-controller-ssl-cert=CERT
75
76       --ovn-controller-ssl-ca-cert=CERT
77
78       --ovn-controller-ssl-bootstrap-ca-cert=CERT
79

ADDRESS AND PORT OPTIONS

81       --db-nb-sync-from-addr=IP ADDRESS
82
83       --db-nb-sync-from-port=PORT NUMBER
84
85       --db-nb-sync-from-proto=PROTO
86
87       --db-sb-sync-from-addr=IP ADDRESS
88
89       --db-sb-sync-from-port=PORT NUMBER
90
91       --db-sb-sync-from-proto=PROTO
92
93        --ovn-northd-nb-db=PROTO:IP ADDRESS: PORT..
94
95        --ovn-northd-sb-db=PROTO:IP ADDRESS: PORT..
96
97 CLUSTERING OPTIONS
98       --db-nb-cluster-local-addr=IP ADDRESS
99
100       --db-nb-cluster-local-port=PORT NUMBER
101
102       --db-nb-cluster-local-proto=PROTO (tcp/ssl)
103
104       --db-nb-cluster-remote-addr=IP ADDRESS
105
106       --db-nb-cluster-remote-port=PORT NUMBER
107
108       --db-nb-cluster-remote-proto=PROTO (tcp/ssl)
109
110       --db-sb-cluster-local-addr=IP ADDRESS
111
112       --db-sb-cluster-local-port=PORT NUMBER
113
114       --db-sb-cluster-local-proto=PROTO (tcp/ssl)
115
116       --db-sb-cluster-remote-addr=IP ADDRESS
117
118       --db-sb-cluster-remote-port=PORT NUMBER
119
120       --db-sb-cluster-remote-proto=PROTO (tcp/ssl)
121

CONFIGURATION FILES

123       Following  are  the optional configuration files. If present, it should
124       be located in the etc dir
125
126   ovnnb-active.conf
127       If present, this file should hold the url  to  connect  to  the  active
128       Northbound DB server
129
130       tcp:x.x.x.x:6641
131
132   ovnsb-active.conf
133       If  present,  this  file  should  hold the url to connect to the active
134       Southbound DB server
135
136       tcp:x.x.x.x:6642
137
138   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
143       --ovnnb-db=tcp:x.x.x.x:6641 --ovnsb-db=tcp:x.x.x.x:6642
144
145 RUNNING OVN DB SERVERS WITHOUT DETACHING
146       # ovn-ctl run_nb_ovsdb
147
148       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
152       # ovn-ctl run_sb_ovsdb
153
154       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

EXAMPLE USAGE

159   Run ovn-controller on a host already running OVS
160       # ovn-ctl start_controller
161
162   Run ovn-northd on a host already running OVS
163       # ovn-ctl start_northd
164
165   All-in-one OVS+OVN for testing
166       # ovs-ctl start --system-id="random"
167
168       # ovn-ctl start_northd
169
170       # ovn-ctl start_controller
171
172   Promote and demote ovsdb servers
173       # ovn-ctl promote_ovnnb
174
175       # ovn-ctl promote_ovnsb
176
177       #  ovn-ctl  --db-nb-sync-from-addr=x.x.x.x  --db-nb-sync-from-port=6641
178       demote_ovnnb
179
180       #  ovn-ctl  --db-sb-sync-from-addr=x.x.x.x  --db-sb-sync-from-port=6642
181       demote_ovnsb
182
183   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
186         #  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
193     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
196         #  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
204     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
207          #  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
215   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
219          #   ovn-ctl   --ovn-nb-db-ssl-key=/etc/openvswitch/ovnnb-privkey.pem
220       --ovn-nb-db-ssl-cert=/etc/openvswitch/ovnnb-cert.pem
221       --ovn-nb-db-ssl-ca-cert=/etc/openvswitch/cacert.pem
222       --ovn-sb-db-ssl-key=/etc/openvswitch/ovnsb-privkey.pem
223       --ovn-sb-db-ssl-cert=/etc/openvswitch/ovnsb-cert.pem
224       --ovn-sb-db-ssl-ca-cert=/etc/openvswitch/cacert.pem start_northd
225
226
227
228Open vSwitch 2.11.1                 ovn-ctl                         ovn-ctl(8)