OVN cheat sheet

OVN.md

Manpages

Architecture:

man ovn-architecture

OVN_Northbound:

man ovn-nb

OVN_Southbound:

man ovn-sb

... same for OVN_IC.

Northbound commands

Show database (LRs, LSs, NAT, addresses):

ovn-nbctl show
ovn-nbctl show <LS uuid>/<LS name>/<LR uuid>/<LR name>

Southbound commands

Show chassis and claimed ports:

ovn-sbctl show

Logical Flow actions details:

man ovn-sb
/Logical_Flow TABLE

Logical Flow pipeline stages description:

man ovn-northd
/LOGICAL FLOW TABLE STRUCTURE

Databases backup/restore

OVN_Northbound

backup:

ovsdb-client backup unix:///run/ovn/ovnnb_db.sock OVN_Northbound > nb-snap-$(date +%s).txt

restore:

ovsdb-client restore unix:///run/ovn/ovnnb_db.sock OVN_Northbound < ./nb-snap-1709808201.txt

OVN_Southbound

backup:

ovsdb-client backup unix:///run/ovn/ovnsb_db.sock OVN_Southbound > sb-snap-$(date +%s).txt

restore:

ovsdb-client restore unix:///run/ovn/ovnsb_db.sock OVN_Southbound < ./sb-snap-1709808201.txt

OVN_IC_Northbound

backup:

ovsdb-client backup unix:///run/ovn/ovn_ic_nb_db.sock OVN_IC_Northbound > ic-nb-snap-$(date +%s).txt

restore:

ovsdb-client restore unix:///run/ovn/ovn_ic_nb_db.sock OVN_IC_Northbound < ./ic-nb-snap-1709808201.txt

OVN_IC_Southbound

backup:

ovsdb-client backup unix:///run/ovn/ovn_ic_sb_db.sock OVN_IC_Southbound > ic-sb-snap-$(date +%s).txt

restore:

ovsdb-client restore unix:///run/ovn/ovn_ic_sb_db.sock OVN_IC_Southbound < ./ic-sb-snap-1709808201.txt

OVS.md

OVSDB

Query OVSDB

Pure OVSDB:

ovsdb-client dump
ovsdb-client dump <table_name>
ovsdb-client dump unix:///run/ovn/ovnnb_db.sock <table_name> 

For DB-specific: ovn northbound:

ovn-nbctl list logical-router
ovn-nbctl list logical-router <uuid>/<name>
ovs-vsctl list interface br-int

Search all routes by ip_prefix and nexthop:

ovn-nbctl find logical-router-static-route ip_prefix=<cidr> nexthop=<nexthop>

Upgrade database schema

For standalone/active-standby:

ovsdb-tool convert Open_vSwitch /usr/share/openvswitch/vswitch.ovsschema

For clustered DB:

ovsdb-client -t 30 convert unix:///run/ovn/ovnnb_db.sock /usr/share/ovn/ovn-nb.ovsschema

View ovsdb queries in logs

ovs-appctl -t /var/run/ovn/ovnnb_db.ctl vlog/set file:jsonrpc:info

OpenFlow

Dump openflow table for br-int:

ovs-ofctl dump-flows br-int

Dump only table 8:

ovs-ofctl dump-flows br-int table=8

Datapath flows

Dump full ovs DP cache flows (for simplicity, pass --names to see real ports names):

ovs-dpctl dump-flows --names

Trace DP flow against openflow tables:

ovs-appctl ofproto/trace '<dp flow match portion>'

Trace DP flow against openflow with OVN:

ovs-appctl ofproto/trace '<dp flow match portion>' | ovn-detrace

OVS daemons

ctl socket

List supported commands

ovs-appctl -t ovs-vswitchd list-commands

Show bfd information

ovs-appctl -t ovs-vswitchd bfd/show

View NB cluster status:

ovs-appctl -t /run/ovn/ovnnb_db.ctl cluster/status OVN_Northbound

View SB cluster status:

ovs-appctl -t /run/ovn/ovnsb_db.ctl cluster/status OVN_Southbound