ovn-ctl - Open Virtual Network northbound daemon lifecycle utility
Contents
Address And Port Options
--db-nb-sync-from-addr=IPADDRESS--db-nb-sync-from-port=PORTNUMBER--db-nb-sync-from-proto=PROTO--db-sb-sync-from-addr=IPADDRESS--db-sb-sync-from-port=PORTNUMBER--db-sb-sync-from-proto=PROTO--db-ic-nb-sync-from-addr=IPADDRESS--db-ic-nb-sync-from-port=PORTNUMBER--db-ic-nb-sync-from-proto=PROTO--db-ic-sb-sync-from-addr=IPADDRESS--db-ic-sb-sync-from-port=PORTNUMBER--db-ic-sb-sync-from-proto=PROTO--ovn-northd-nb-db=PROTO:IPADDRESS:PORT..--ovn-northd-sb-db=PROTO:IPADDRESS:PORT..--ovn-ic-nb-db=PROTO:IPADDRESS:PORT..--ovn-ic-sb-db=PROTO:IPADDRESS:PORT..
Clustering Options
--db-nb-cluster-local-addr=IPADDRESS--db-nb-cluster-local-port=PORTNUMBER--db-nb-cluster-local-proto=PROTO(tcp/ssl)--db-nb-cluster-remote-addr=IPADDRESS--db-nb-cluster-remote-port=PORTNUMBER--db-nb-cluster-remote-proto=PROTO(tcp/ssl)--db-nb-election-timer=Timeoutinmilliseconds--db-sb-cluster-local-addr=IPADDRESS--db-sb-cluster-local-port=PORTNUMBER--db-sb-cluster-local-proto=PROTO(tcp/ssl)--db-sb-cluster-remote-addr=IPADDRESS--db-sb-cluster-remote-port=PORTNUMBER--db-sb-cluster-remote-proto=PROTO(tcp/ssl)--db-sb-election-timer=Timeoutinmilliseconds--db-ic-nb-cluster-local-addr=IPADDRESS--db-ic-nb-cluster-local-port=PORTNUMBER--db-ic-nb-cluster-local-proto=PROTO(tcp/ssl)--db-ic-nb-cluster-remote-addr=IPADDRESS--db-ic-nb-cluster-remote-port=PORTNUMBER--db-ic-nb-cluster-remote-proto=PROTO(tcp/ssl)--db-ic-sb-cluster-local-addr=IPADDRESS--db-ic-sb-cluster-local-port=PORTNUMBER--db-ic-sb-cluster-local-proto=PROTO(tcp/ssl)--db-ic-sb-cluster-remote-addr=IPADDRESS--db-ic-sb-cluster-remote-port=PORTNUMBER--db-ic-sb-cluster-remote-proto=PROTO(tcp/ssl)--db-cluster-schema-upgrade=yes|no
Commands
start_northdstart_controllerstart_controller_vtepstart_icstop_northdstop_controllerstop_controller_vtepstop_icrestart_northdrestart_controllerrestart_controller_vteprestart_icpromote_ovnnbpromote_ovnsbdemote_ovnnbdemote_ovnsbstatus_ovnnbstatus_ovnsbstart_ovsdbstart_nb_ovsdbstart_sb_ovsdbstop_ovsdbstop_nb_ovsdbstop_sb_ovsdbrestart_ovsdbrun_nb_ovsdbrun_sb_ovsdbpromote_ic_nbpromote_ic_sbdemote_ic_nbdemote_ic_sbstatus_ic_nbstatus_ic_sbstart_ic_ovsdbstart_ic_nb_ovsdbstart_ic_sb_ovsdbstop_ic_ovsdbstop_ic_nb_ovsdbstop_ic_sb_ovsdbrestart_ic_ovsdbrun_ic_nb_ovsdbrun_ic_sb_ovsdb
Configuration Files
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:6646Description
This program is intended to be invoked internally by Open Virtual Network startup scripts. System
administrators should not normally invoke it directly.
Example Usage
Runovn-controlleronahostalreadyrunningOVS#ovn-ctlstart_controllerRunovn-northdonahostalreadyrunningOVS#ovn-ctlstart_northdAll-in-oneOVS+OVNfortesting#ovs-ctlstart--system-id="random"#ovn-ctlstart_northd#ovn-ctlstart_controllerPromoteanddemoteovsdbservers#ovn-ctlpromote_ovnnb#ovn-ctlpromote_ovnsb#ovn-ctl--db-nb-sync-from-addr=x.x.x.x--db-nb-sync-from-port=6641--db-nb-probe-interval-to-active=60000demote_ovnnb#ovn-ctl--db-sb-sync-from-addr=x.x.x.x--db-sb-sync-from-port=6642--db-sb-probe-interval-to-active=60000demote_ovnsbCreatingaclustereddbon3nodeswithIPsx.x.x.x,y.y.y.yandz.z.z.zStartingOVNovsdbserversandovn-northdonthenodewithIPx.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_northdStartingOVNovsdb-serversandovn-northdonthenodewithIPy.y.y.yandjoiningtheclusterstartedatx.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_northdStartingOVNovsdb-serversandovn-northdonthenodewithIPz.z.z.zandjoiningtheclusterstartedatx.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_northdPassingsslkeyswhenstartingOVNdbswillsupersedethedefaultsslvaluesindbStartingstandaloneovndbserverpassingSSL/TLScertificates#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.pemstart_northdAvoidingautomaticclusteredOVNdatabaseschemaupgrade
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.
StartOVNNBandSBclustereddatabasesonhostwithIPx.x.x.xwithoutschemaupgrade#ovn-ctlstart_nb_ovsdb--db-nb-cluster-local-addr=x.x.x.x--no-db-cluster-schema-upgrade#ovn-ctlstart_sb_ovsdb--db-sb-cluster-local-addr=x.x.x.x--no-db-cluster-schema-upgradeTriggerclusteredDBschemaupgrademanually#ovsdb-clientconvertunix:/var/run/ovn/ovnnb_db.sock/usr/local/share/ovn/ovn-nb.ovsschema#ovsdb-clientconvertunix:/var/run/ovn/ovnsb_db.sock/usr/local/share/ovn/ovn-sb.ovsschema
OVN 25.03.0 ovn-ctl ovn-ctl(8)
Extra Options
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=yesFile Location Options
--db-sock=SOCKET--db-nb-file=FILE--db-sb-file=FILE--db-nb-schema=FILE--db-sb-schema=FILE--db-sb-create-insecure-remote=yes|no--db-nb-create-insecure-remote=yes|no--db-ic-nb-file=FILE--db-ic-sb-file=FILE--db-ic-nb-schema=FILE--db-ic-sb-schema=FILE--db-ic-sb-create-insecure-remote=yes|no--db-ic-nb-create-insecure-remote=yes|no--db-nb-config-file=FILE--db-sb-config-file=FILE--db-ic-nb-config-file=FILE--db-ic-sb-config-file=FILE--db-sb-relay-config-file=FILE--ovn-controller-ssl-key=KEY--ovn-controller-ssl-cert=CERT--ovn-controller-ssl-ca-cert=CERT--ovn-controller-ssl-bootstrap-ca-cert=CERT
Name
ovn-ctl - Open Virtual Network northbound daemon lifecycle utility
Options
--ovn-northd-priority=NICE--ovn-northd-wrapper=WRAPPER--ovn-controller-priority=NICE--ovn-controller-wrapper=WRAPPER--ovn-ic-priority=NICE--ovn-ic-wrapper=WRAPPER--ovsdb-nb-wrapper=WRAPPER--ovsdb-sb-wrapper=WRAPPER--ovn-user=USER:GROUP-h | --help
Probe Interval Options
--db-nb-probe-interval-to-active=Timeinmilliseconds--db-sb-probe-interval-to-active=Timeinmilliseconds
Protocol, Cipher And Ciphersuite Options
--ovn-controller-ssl-protocols=PROTOCOLS--ovn-ic-ssl-protocols=PROTOCOLS--ovn-northd-ssl-protocols=PROTOCOLS--ovn-nb-db-ssl-protocols=PROTOCOLS--ovn-sb-db-ssl-protocols=PROTOCOLS--ovn-ic-nb-db-ssl-protocols=PROTOCOLS--ovn-ic-sb-db-ssl-protocols=PROTOCOLS--ovn-controller-ssl-ciphers=CIPHERS--ovn-ic-ssl-ciphers=CIPHERS--ovn-northd-ssl-ciphers=CIPHERS--ovn-nb-db-ssl-ciphers=CIPHERS--ovn-sb-db-ssl-ciphers=CIPHERS--ovn-ic-nb-db-ssl-ciphers=CIPHERS--ovn-ic-sb-db-ssl-ciphers=CIPHERS--ovn-controller-ssl-ciphersuites=CIPHERSUITES--ovn-ic-ssl-ciphersuites=CIPHERSUITES--ovn-northd-ssl-ciphersuites=CIPHERSUITES--ovn-nb-db-ssl-ciphersuites=CIPHERSUITES--ovn-sb-db-ssl-ciphersuites=CIPHERSUITES--ovn-ic-nb-db-ssl-ciphersuites=CIPHERSUITES--ovn-ic-sb-db-ssl-ciphersuites=CIPHERSUITES
Running Ovn Db Servers Without Detaching
#ovn-ctlrun_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-ctlrun_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-ctlrun_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-ctlrun_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.
Synopsis
ovn-ctl [options] command [-- extra_args]
