This program is intended to be invoked internally by Open Virtual
Network startup scripts. System administrators should not
normally invoke it directly.
Any options after ’-’ will be passed on to the binary run by
command with the exception of start_northd, which can have
options specified in ovn-northd-db-params.conf. Any extra_args
passed to start_northd will be passed to the ovsdb-servers if
--ovn-manage-ovsdb=yes
Following are the optional configuration files. If present, it
should be located in the etc dir
ovnnb-active.conf
If present, this file should hold the url to connect to the
active Northbound DB server
tcp:x.x.x.x:6641ovnsb-active.conf
If present, this file should hold the url to connect to the
active Southbound DB server
tcp:x.x.x.x:6642ovn-northd-db-params.conf
If present, start_northd will not start the DB server even if
--ovn-manage-ovsdb=yes. This file should hold the database url
parameters to be passed to ovn-northd.
--ovnnb-db=tcp:x.x.x.x:6641 --ovnsb-db=tcp:x.x.x.x:6642ic-nb-active.conf
If present, this file should hold the url to connect to the
active Interconnection Northbound DB server
tcp:x.x.x.x:6645ic-sb-active.conf
If present, this file should hold the url to connect to the
active Interconnection Southbound DB server
tcp:x.x.x.x:6646ovn-ic-db-params.conf
If present, this file should hold the database url parameters to
be passed to ovn-ic.
--ic-nb-db=tcp:x.x.x.x:6645 --ic-sb-db=tcp:x.x.x.x:6646
# ovn-ctl run_nb_ovsdb
This command runs the OVN nb ovsdb-server without passing the
detach option, making it to block until ovsdb-server exits. This
command will be useful for starting the OVN nb ovsdb-server in a
container.
# ovn-ctl run_sb_ovsdb
This command runs the OVN sb ovsdb-server without passing the
detach option, making it to block until ovsdb-server exits. This
command will be useful for starting the OVN sb ovsdb-server in a
container.
# ovn-ctl run_ic_nb_ovsdb
This command runs the OVN IC-NB ovsdb-server without passing the
detach option, making it to block until ovsdb-server exits. This
command will be useful for starting the OVN IC-NB ovsdb-server in
a container.
# ovn-ctl run_ic_sb_ovsdb
This command runs the OVN IC-SB ovsdb-server without passing the
detach option, making it to block until ovsdb-server exits. This
command will be useful for starting the OVN IC-SB ovsdb-server in
a container.
Run ovn-controller on a host already running OVS# ovn-ctl start_controllerRun ovn-northd on a host already running OVS# ovn-ctl start_northdAll-in-one OVS+OVN for testing# ovs-ctl start --system-id="random"# ovn-ctl start_northd# ovn-ctl start_controllerPromote and demote ovsdb servers# ovn-ctl promote_ovnnb# ovn-ctl promote_ovnsb# ovn-ctl --db-nb-sync-from-addr=x.x.x.x--db-nb-sync-from-port=6641--db-nb-probe-interval-to-active=60000 demote_ovnnb# ovn-ctl --db-sb-sync-from-addr=x.x.x.x--db-sb-sync-from-port=6642--db-sb-probe-interval-to-active=60000 demote_ovnsbCreating a clustered db on 3 nodes with IPs x.x.x.x, y.y.y.y andz.z.z.zStarting OVN ovsdb servers and ovn-northd on the node with IPx.x.x.x# ovn-ctl --db-nb-addr=x.x.x.x--db-nb-create-insecure-remote=yes --db-sb-addr=x.x.x.x--db-sb-create-insecure-remote=yes--db-nb-cluster-local-addr=x.x.x.x--db-sb-cluster-local-addr=x.x.x.x--ovn-northd-nb-db=tcp:x.x.x.x:6641,tcp:y.y.y.y:6641,tcp:z.z.z.z:6641--ovn-northd-sb-db=tcp:x.x.x.x:6642,tcp:y.y.y.y:6642,tcp:z.z.z.z:6642start_northdStarting OVN ovsdb-servers and ovn-northd on the node with IPy.y.y.y and joining the cluster started at x.x.x.x# ovn-ctl --db-nb-addr=y.y.y.y--db-nb-create-insecure-remote=yes --db-sb-addr=y.y.y.y--db-sb-create-insecure-remote=yes--db-nb-cluster-local-addr=y.y.y.y--db-sb-cluster-local-addr=y.y.y.y--db-nb-cluster-remote-addr=x.x.x.x--db-sb-cluster-remote-addr=x.x.x.x--ovn-northd-nb-db=tcp:x.x.x.x:6641,tcp:y.y.y.y:6641,tcp:z.z.z.z:6641--ovn-northd-sb-db=tcp:x.x.x.x:6642,tcp:y.y.y.y:6642,tcp:z.z.z.z:6642start_northdStarting OVN ovsdb-servers and ovn-northd on the node with IPz.z.z.z and joining the cluster started at x.x.x.x# ovn-ctl --db-nb-addr=z.z.z.z--db-nb-create-insecure-remote=yes--db-nb-cluster-local-addr=z.z.z.z --db-sb-addr=z.z.z.z--db-sb-create-insecure-remote=yes--db-sb-cluster-local-addr=z.z.z.z--db-nb-cluster-remote-addr=x.x.x.x--db-sb-cluster-remote-addr=x.x.x.x--ovn-northd-nb-db=tcp:x.x.x.x:6641,tcp:y.y.y.y:6641,tcp:z.z.z.z:6641--ovn-northd-sb-db=tcp:x.x.x.x:6642,tcp:y.y.y.y:6642,tcp:z.z.z.z:6642start_northdPassing ssl keys when starting OVN dbs will supersede the default sslvalues in dbStarting standalone ovn db server passing SSL certificates# ovn-ctl --ovn-nb-db-ssl-key=/etc/ovn/ovnnb-privkey.pem--ovn-nb-db-ssl-cert=/etc/ovn/ovnnb-cert.pem--ovn-nb-db-ssl-ca-cert=/etc/ovn/cacert.pem--ovn-sb-db-ssl-key=/etc/ovn/ovnsb-privkey.pem--ovn-sb-db-ssl-cert=/etc/ovn/ovnsb-cert.pem--ovn-sb-db-ssl-ca-cert=/etc/ovn/cacert.pem start_northdAvoiding automatic clustered OVN database schema upgrade
If you desire more control over clustered DB schema upgrade, you
can opt-out of automatic on-start upgrade attempts with
--no-db-cluster-schema-upgrade.
Start OVN NB and SB clustered databases on host with IP x.x.x.xwithout schema upgrade# ovn-ctl start_nb_ovsdb --db-nb-cluster-local-addr=x.x.x.x--no-db-cluster-schema-upgrade # ovn-ctl start_sb_ovsdb--db-sb-cluster-local-addr=x.x.x.x --no-db-cluster-schema-upgradeTrigger clustered DB schema upgrade manually# ovsdb-client convert unix:/var/run/ovn/ovnnb_db.sock/usr/local/share/ovn/ovn-nb.ovsschema # ovsdb-client convertunix:/var/run/ovn/ovnsb_db.sock/usr/local/share/ovn/ovn-sb.ovsschema
This page is part of the Open Virtual Network (Daemons for Open
vSwitch that translate virtual network configurations into
OpenFlow) project. Information about the project can be found at
⟨https://www.ovn.org/⟩. If you have a bug report for this manual
page, send it to [email protected]. This page was obtained
from the project's upstream Git repository
⟨https://github.com/ovn-org/ovn⟩ on 2024-06-14. (At that time,
the date of the most recent commit that was found in the
repository was 2024-06-12.) If you discover any rendering
problems in this HTML version of the page, or you believe there
is a better or more up-to-date source for the page, or you have
corrections or improvements to the information in this COLOPHON
(which is not part of the original manual page), send a mail to
[email protected]OVN 24.03.90 ovn-ctl ovn-ctl(8)