'\" p
.\" -*- nroff -*-
.TH "vtep" 5 " DB Schema 1.7.0" "Open vSwitch 2.10.1" "Open vSwitch Manual"
.fp 5 L CR              \\" Make fixed-width font available as \\fL.
.de TQ
.  br
.  ns
.  TP "\\$1"
..
.de ST
.  PP
.  RS -0.15in
.  I "\\$1"
.  RE
..
.SH NAME
vtep \- hardware_vtep database schema
.PP
.PP
.PP
.PP
This schema specifies relations that a VTEP can use to integrate physical ports into logical switches maintained by a network virtualization controller such as NSX\[char46]
.PP
.PP
Glossary:
.RS
.TP
VTEP
VXLAN Tunnel End Point, an entity which originates and/or terminates VXLAN tunnels\[char46]
.TP
HSC
Hardware Switch Controller\[char46]
.TP
NVC
Network Virtualization Controller, e\[char46]g\[char46] NSX\[char46]
.TP
VRF
Virtual Routing and Forwarding instance\[char46]
.RE
.SS "Common Column"
.PP
.PP
Some tables contain a column, named \fBother_config\fR\[char46] This column has the same form and purpose each place that it appears, so we describe it here to save space later\[char46]
.RS
.TP
\fBother_config\fR: map of string-string pairs
Key-value pairs for configuring rarely used or proprietary features\[char46]
.IP
Some tables do not have \fBother_config\fR column because no key-value pairs have yet been defined for them\[char46]
.RE
.SH "TABLE SUMMARY"
.PP
The following list summarizes the purpose of each of the tables in the
\fBhardware_vtep\fR database.  Each table is described in more detail on a later
page.
.IP "Table" 1in
Purpose
.TQ 1in
\fBGlobal\fR
Top-level configuration\[char46]
.TQ 1in
\fBManager\fR
OVSDB management connection\[char46]
.TQ 1in
\fBPhysical_Switch\fR
A physical switch\[char46]
.TQ 1in
\fBTunnel\fR
A tunnel created by a physical switch\[char46]
.TQ 1in
\fBPhysical_Port\fR
A port within a physical switch\[char46]
.TQ 1in
\fBLogical_Binding_Stats\fR
Statistics for a VLAN on a physical port bound to a logical network\[char46]
.TQ 1in
\fBLogical_Switch\fR
A layer\-2 domain\[char46]
.TQ 1in
\fBUcast_Macs_Local\fR
Unicast MACs (local)
.TQ 1in
\fBUcast_Macs_Remote\fR
Unicast MACs (remote)
.TQ 1in
\fBMcast_Macs_Local\fR
Multicast MACs (local)
.TQ 1in
\fBMcast_Macs_Remote\fR
Multicast MACs (remote)
.TQ 1in
\fBLogical_Router\fR
A logical L3 router\[char46]
.TQ 1in
\fBArp_Sources_Local\fR
ARP source addresses for logical routers
.TQ 1in
\fBArp_Sources_Remote\fR
ARP source addresses for logical routers
.TQ 1in
\fBPhysical_Locator_Set\fR
Physical_Locator_Set configuration\[char46]
.TQ 1in
\fBPhysical_Locator\fR
Physical_Locator configuration\[char46]
.TQ 1in
\fBACL_entry\fR
ACL_entry configuration\[char46]
.TQ 1in
\fBACL\fR
ACL configuration\[char46]
.\" check if in troff mode (TTY)
.if t \{
.bp
.SH "TABLE RELATIONSHIPS"
.PP
The following diagram shows the relationship among tables in the
database.  Each node represents a table.  Tables that are part of the
``root set'' are shown with double borders.  Each edge leads from the
table that contains it and points to the table that its value
represents.  Edges are labeled with their column names, followed by a
constraint on the number of allowed values: \fB?\fR for zero or one,
\fB*\fR for zero or more, \fB+\fR for one or more.  Thick lines
represent strong references; thin lines represent weak references.
.RS -1in
.ps -3
.PS
linethick = 1;
linethick = 0.500000;
box at 0.164224,2.585188 wid 0.328445 height 0.190710 "Global"
box at 0.164224,2.585188 wid 0.272889 height 0.135154
linethick = 1.000000;
box at 1.385279,2.728221 wid 0.423796 height 0.190710 "Manager"
linethick = 1.000000;
box at 1.385279,2.442156 wid 0.709861 height 0.190710 "Physical_Switch"
linethick = 1.000000;
box at 2.900394,2.786502 wid 0.603902 height 0.190710 "Physical_Port"
linethick = 1.000000;
box at 2.900394,0.985322 wid 0.349636 height 0.190710 "Tunnel"
linethick = 0.500000;
box at 4.860435,2.028926 wid 0.667485 height 0.190710 "Logical_Switch"
box at 4.860435,2.028926 wid 0.611929 height 0.135154
linethick = 0.500000;
box at 4.860435,2.643469 wid 0.286065 height 0.190710 "ACL"
box at 4.860435,2.643469 wid 0.230509 height 0.135154
linethick = 1.000000;
box at 4.860435,3.088434 wid 0.937645 height 0.190710 "Logical_Binding_Stats"
linethick = 1.000000;
box at 4.860435,0.784047 wid 0.741633 height 0.190710 "Physical_Locator"
linethick = 0.500000;
box at 2.900394,1.583961 wid 0.799914 height 0.190710 "Ucast_Macs_Local"
box at 2.900394,1.583961 wid 0.744358 height 0.135154
linethick = 0.500000;
box at 2.900394,1.281991 wid 0.884666 height 0.190710 "Ucast_Macs_Remote"
box at 2.900394,1.281991 wid 0.829110 height 0.135154
linethick = 0.500000;
box at 1.385279,2.097810 wid 0.810518 height 0.190710 "Mcast_Macs_Local"
box at 1.385279,2.097810 wid 0.754962 height 0.135154
linethick = 1.000000;
box at 2.900394,0.095355 wid 0.905872 height 0.190710 "Physical_Locator_Set"
linethick = 0.500000;
box at 1.385279,1.695183 wid 0.895269 height 0.190710 "Mcast_Macs_Remote"
box at 1.385279,1.695183 wid 0.839713 height 0.135154
linethick = 0.500000;
box at 2.900394,2.431553 wid 0.662183 height 0.190710 "Logical_Router"
box at 2.900394,2.431553 wid 0.606628 height 0.135154
linethick = 0.500000;
box at 2.900394,0.381420 wid 0.821121 height 0.190710 "Arp_Sources_Local"
box at 2.900394,0.381420 wid 0.765565 height 0.135154
linethick = 0.500000;
box at 2.900394,0.667485 wid 0.900571 height 0.190710 "Arp_Sources_Remote"
box at 2.900394,0.667485 wid 0.845015 height 0.135154
linethick = 0.500000;
box at 6.251092,2.643469 wid 0.497982 height 0.190710 "ACL_entry"
box at 6.251092,2.643469 wid 0.442426 height 0.135154
linethick = 1.000000;
spline -> from 0.328902,2.604488 to 0.328902,2.604488 to 0.546994,2.630005 to 0.931923,2.675089 to 1.172027,2.703238
"managers*" at 0.633043,2.704382
linethick = 1.000000;
spline -> from 0.329406,2.536557 to 0.329406,2.536557 to 0.360545,2.528738 to 0.393015,2.521529 to 0.423796,2.516304 to 0.622706,2.482548 to 0.847401,2.464126 to 1.029529,2.454094
"switches*" at 0.633043,2.556048
linethick = 1.000000;
spline -> from 1.740534,2.522864 to 1.740534,2.522864 to 2.000281,2.581908 to 2.348975,2.661167 to 2.595983,2.717312
"ports*" at 2.140186,2.699080
linethick = 1.000000;
spline -> from 1.664822,2.345733 to 1.664822,2.345733 to 1.724095,2.317546 to 1.783596,2.282761 to 1.832952,2.240842 to 2.151438,1.970263 to 2.174781,1.835240 to 2.352103,1.456796 to 2.414656,1.323260 to 2.345008,1.245107 to 2.447458,1.138958 to 2.520080,1.063666 to 2.630959,1.025295 to 2.724826,1.005690
"tunnels*" at 2.140186,2.190533
linethick = 1.000000;
spline -> from 3.202517,2.717084 to 3.202517,2.717084 to 3.282310,2.700187 to 3.368511,2.683175 to 3.448685,2.669940 to 3.822973,2.608074 to 3.953037,2.731234 to 4.296315,2.569283 to 4.353146,2.542508 to 4.622429,2.272233 to 4.767369,2.124395
"vlan_bindings value*" at 3.872557,2.709684
linethick = 1.000000;
spline -> from 3.202440,2.801263 to 3.202440,2.801263 to 3.485950,2.810837 to 3.921379,2.814460 to 4.296315,2.770597 to 4.440873,2.753662 to 4.602595,2.715138 to 4.715877,2.684892
"acl_bindings value*" at 3.872557,2.842113
linethick = 1.000000;
spline -> from 3.202631,2.855196 to 3.202631,2.855196 to 3.282424,2.872093 to 3.368587,2.889295 to 3.448685,2.903026 to 3.761144,2.956653 to 4.114759,3.003110 to 4.390144,3.036065
"vlan_stats value*" at 3.872557,3.059294
linethick = 1.000000;
spline -> from 3.077030,0.974337 to 3.077030,0.974337 to 3.342307,0.956945 to 3.859208,0.919832 to 4.296315,0.868798 to 4.358868,0.861513 to 4.424853,0.852626 to 4.489313,0.843358
"local" at 3.872557,0.987992
linethick = 1.000000;
spline -> from 3.075389,0.920099 to 3.075389,0.920099 to 3.159798,0.888060 to 3.262247,0.848316 to 3.353330,0.810518 to 3.396164,0.792743 to 3.403296,0.777754 to 3.448685,0.768142 to 3.795739,0.694490 to 4.201723,0.709212 to 4.488932,0.735912
"remote" at 3.872557,0.807886
linethick = 1.000000;
spline -> from 5.003849,2.643469 to 5.003849,2.643469 to 5.239185,2.643469 to 5.709857,2.643469 to 6.000881,2.643469
"acl_entries+" at 5.665613,2.683175
linethick = 1.000000;
spline -> from 3.301495,1.650786 to 3.301495,1.650786 to 3.351042,1.658757 to 3.401008,1.666653 to 3.448685,1.674014 to 3.824880,1.731914 to 3.929389,1.695336 to 4.296315,1.795840 to 4.422183,1.830282 to 4.557206,1.885435 to 4.663622,1.933456
"logical_switch" at 3.872557,1.835584
linethick = 1.000000;
spline -> from 3.300351,1.568018 to 3.300351,1.568018 to 3.681466,1.550282 to 4.209733,1.517975 to 4.296315,1.472701 to 4.551103,1.339433 to 4.733422,1.036280 to 4.814283,0.880470
"locator" at 3.872557,1.602498
linethick = 1.000000;
spline -> from 3.343146,1.281724 to 3.343146,1.281724 to 3.687874,1.288055 to 4.134211,1.312466 to 4.296315,1.393251 to 4.538135,1.513665 to 4.722361,1.786762 to 4.807799,1.932731
"logical_switch" at 3.872557,1.432957
linethick = 1.000000;
spline -> from 3.342803,1.208834 to 3.342803,1.208834 to 3.747261,1.141857 to 4.284491,1.052528 to 4.296315,1.048905 to 4.432482,1.006377 to 4.578184,0.937302 to 4.687652,0.880356
"locator" at 3.872557,1.231681
linethick = 1.000000;
spline -> from 1.790729,2.089762 to 1.790729,2.089762 to 2.483654,2.076031 to 3.882856,2.048302 to 4.524785,2.035600
"logical_switch" at 2.900394,2.116347
linethick = 1.000000;
spline -> from 1.605015,2.001845 to 1.605015,2.001845 to 1.683702,1.959850 to 1.768683,1.904850 to 1.832952,1.838216 to 2.173674,1.484944 to 2.197513,1.329363 to 2.352103,0.863497 to 2.440592,0.596770 to 2.264643,0.451868 to 2.447458,0.238387 to 2.462448,0.220850 to 2.479611,0.205437 to 2.498263,0.191896
"locator_set" at 2.140186,1.761436
linethick = 1.000000;
spline -> from 3.353445,0.078347 to 3.353445,0.078347 to 3.636420,0.084393 to 4.001859,0.123397 to 4.296315,0.259579 to 4.507622,0.357219 to 4.692229,0.564425 to 4.788728,0.687128
"locators+" at 3.872557,0.299308
linethick = 1.000000;
spline -> from 1.833639,1.782071 to 1.833639,1.782071 to 1.865602,1.787105 to 1.897412,1.791759 to 1.928307,1.795840 to 2.864884,1.919534 to 3.978973,1.986207 to 4.525167,2.013631
"logical_switch" at 2.900394,1.983918
linethick = 1.000000;
spline -> from 1.428456,1.598989 to 1.428456,1.598989 to 1.549824,1.339166 to 1.920106,0.617519 to 2.447458,0.238387 to 2.472212,0.220575 to 2.499293,0.204926 to 2.527480,0.191183
"locator_set" at 2.140186,0.802584
linethick = 1.000000;
spline -> from 3.231886,2.370716 to 3.231886,2.370716 to 3.578177,2.306790 to 4.097976,2.209680 to 4.296315,2.166694 to 4.370692,2.150560 to 4.450409,2.131947 to 4.525548,2.113753
"switch_binding value*" at 3.872557,2.365338
linethick = 1.000000;
spline -> from 3.232382,2.424611 to 3.232382,2.424611 to 3.516502,2.423581 to 3.935492,2.433917 to 4.296315,2.489833 to 4.441636,2.512375 to 4.603358,2.558680 to 4.716258,2.594571
"acl_binding value*" at 3.872557,2.529539
linethick = 1.000000;
spline -> from 3.312022,0.355754 to 3.312022,0.355754 to 3.594617,0.349930 to 3.975159,0.365576 to 4.296315,0.460870 to 4.458418,0.509043 to 4.624336,0.611721 to 4.733804,0.688463
"locator" at 3.872557,0.500614
linethick = 1.000000;
spline -> from 3.351118,0.591125 to 3.351118,0.591125 to 3.625931,0.557064 to 3.983169,0.535209 to 4.296315,0.588035 to 4.412648,0.607678 to 4.537372,0.648719 to 4.639974,0.688158
"locator" at 3.872557,0.627741
.ps +3
.PE
.RE\}
.bp
.SH "Global TABLE"
.PP
Top-level configuration for a hardware VTEP\[char46] There must be exactly one record in the \fBGlobal\fR table\[char46]
.SS "Summary:
.TQ 3.00in
\fBswitches\fR
set of \fBPhysical_Switch\fRs
.TQ .25in
\fIDatabase Configuration:\fR
.RS .25in
.TQ 2.75in
\fBmanagers\fR
set of \fBManager\fRs
.RE
.TQ .25in
\fICommon Column:\fR
.RS .25in
.TQ 2.75in
\fBother_config\fR
map of string-string pairs
.RE
.SS "Details:
.IP "\fBswitches\fR: set of \fBPhysical_Switch\fRs"
The physical switch or switches managed by the VTEP\[char46]
.IP
When a physical switch integrates support for this VTEP schema, which is expected to be the most common case, this column should point to one \fBPhysical_Switch\fR record that represents the switch itself\[char46] In another possible implementation, a server or a VM presents a VTEP schema front-end interface to one or more physical switches, presumably communicating with those physical switches over a proprietary protocol\[char46] In that case, this column would point to one \fBPhysical_Switch\fR for each physical switch, and the set might change over time as the front-end server comes to represent a differing set of switches\[char46]
.ST "Database Configuration:"
.PP
.PP
.PP
These columns primarily configure the database server (\fBovsdb\-server\fR), not the hardware VTEP itself\[char46]
.IP "\fBmanagers\fR: set of \fBManager\fRs"
Database clients to which the database server should connect or to which it should listen, along with options for how these connection should be configured\[char46] See the \fBManager\fR table for more information\[char46]
.ST "Common Column:"
.PP
The overall purpose of this column is described under \fBCommon
Column\fR at the beginning of this document\[char46]
.IP "\fBother_config\fR: map of string-string pairs"
.bp
.SH "Manager TABLE"
.PP
.PP
.PP
Configuration for a database connection to an Open vSwitch Database (OVSDB) client\[char46]
.PP
.PP
The database server can initiate and maintain active connections to remote clients\[char46] It can also listen for database connections\[char46]
.SS "Summary:
.TQ .25in
\fICore Features:\fR
.RS .25in
.TQ 2.75in
\fBtarget\fR
string (must be unique within table)
.RE
.TQ .25in
\fIClient Failure Detection and Handling:\fR
.RS .25in
.TQ 2.75in
\fBmax_backoff\fR
optional integer, at least 1,000
.TQ 2.75in
\fBinactivity_probe\fR
optional integer
.RE
.TQ .25in
\fIStatus:\fR
.RS .25in
.TQ 2.75in
\fBis_connected\fR
boolean
.TQ 2.75in
\fBstatus : last_error\fR
optional string
.TQ 2.75in
\fBstatus : state\fR
optional string, one of \fBACTIVE\fR, \fBBACKOFF\fR, \fBCONNECTING\fR, \fBIDLE\fR, or \fBVOID\fR
.TQ 2.75in
\fBstatus : sec_since_connect\fR
optional string, containing an integer, at least 0
.TQ 2.75in
\fBstatus : sec_since_disconnect\fR
optional string, containing an integer, at least 0
.TQ 2.75in
\fBstatus : locks_held\fR
optional string
.TQ 2.75in
\fBstatus : locks_waiting\fR
optional string
.TQ 2.75in
\fBstatus : locks_lost\fR
optional string
.TQ 2.75in
\fBstatus : n_connections\fR
optional string, containing an integer, at least 2
.RE
.TQ .25in
\fIConnection Parameters:\fR
.RS .25in
.TQ 2.75in
\fBother_config : dscp\fR
optional string, containing an integer
.RE
.SS "Details:
.ST "Core Features:"
.PP
.IP "\fBtarget\fR: string (must be unique within table)"
Connection method for managers\[char46]
.IP
The following connection methods are currently supported:
.RS
.TP
\fBssl:\fIhost\fB\fR[\fB:\fIport\fB\fR]
The specified SSL \fIport\fR (default: 6640) on the given \fIhost\fR, which can either be a DNS name (if built with unbound library) or an IP address\[char46]
.IP
SSL key and certificate configuration happens outside the database\[char46]
.TP
\fBtcp:\fIhost\fB\fR[\fB:\fIport\fB\fR]
The specified TCP \fIport\fR (default: 6640) on the given \fIhost\fR, which can either be a DNS name (if built with unbound library) or an IP address\[char46]
.TP
\fBpssl:\fR[\fIport\fR][\fB:\fIhost\fB\fR]
Listens for SSL connections on the specified TCP \fIport\fR (default: 6640)\[char46] If \fIhost\fR, which can either be a DNS name (if built with unbound library) or an IP address, is specified, then connections are restricted to the resolved or specified local IP address\[char46]
.TP
\fBptcp:\fR[\fIport\fR][\fB:\fIhost\fB\fR]
Listens for connections on the specified TCP \fIport\fR (default: 6640)\[char46] If \fIhost\fR, which can either be a DNS name (if built with unbound library) or an IP address, is specified, then connections are restricted to the resolved or specified local IP address\[char46]
.RE
.ST "Client Failure Detection and Handling:"
.PP
.IP "\fBmax_backoff\fR: optional integer, at least 1,000"
Maximum number of milliseconds to wait between connection attempts\[char46] Default is implementation-specific\[char46]
.IP "\fBinactivity_probe\fR: optional integer"
Maximum number of milliseconds of idle time on connection to the client before sending an inactivity probe message\[char46] If the Open vSwitch database does not communicate with the client for the specified number of seconds, it will send a probe\[char46] If a response is not received for the same additional amount of time, the database server assumes the connection has been broken and attempts to reconnect\[char46] Default is implementation-specific\[char46] A value of 0 disables inactivity probes\[char46]
.ST "Status:"
.PP
.IP "\fBis_connected\fR: boolean"
\fBtrue\fR if currently connected to this manager, \fBfalse\fR otherwise\[char46]
.IP "\fBstatus : last_error\fR: optional string"
A human-readable description of the last error on the connection to the manager; i\[char46]e\[char46] \fBstrerror(errno)\fR\[char46] This key will exist only if an error has occurred\[char46]
.IP "\fBstatus : state\fR: optional string, one of \fBACTIVE\fR, \fBBACKOFF\fR, \fBCONNECTING\fR, \fBIDLE\fR, or \fBVOID\fR"
The state of the connection to the manager:
.RS
.TP
\fBVOID\fR
Connection is disabled\[char46]
.TP
\fBBACKOFF\fR
Attempting to reconnect at an increasing period\[char46]
.TP
\fBCONNECTING\fR
Attempting to connect\[char46]
.TP
\fBACTIVE\fR
Connected, remote host responsive\[char46]
.TP
\fBIDLE\fR
Connection is idle\[char46] Waiting for response to keep-alive\[char46]
.RE
.IP
These values may change in the future\[char46] They are provided only for human consumption\[char46]
.IP "\fBstatus : sec_since_connect\fR: optional string, containing an integer, at least 0"
The amount of time since this manager last successfully connected to the database (in seconds)\[char46] Value is empty if manager has never successfully connected\[char46]
.IP "\fBstatus : sec_since_disconnect\fR: optional string, containing an integer, at least 0"
The amount of time since this manager last disconnected from the database (in seconds)\[char46] Value is empty if manager has never disconnected\[char46]
.IP "\fBstatus : locks_held\fR: optional string"
Space-separated list of the names of OVSDB locks that the connection holds\[char46] Omitted if the connection does not hold any locks\[char46]
.IP "\fBstatus : locks_waiting\fR: optional string"
Space-separated list of the names of OVSDB locks that the connection is currently waiting to acquire\[char46] Omitted if the connection is not waiting for any locks\[char46]
.IP "\fBstatus : locks_lost\fR: optional string"
Space-separated list of the names of OVSDB locks that the connection has had stolen by another OVSDB client\[char46] Omitted if no locks have been stolen from this connection\[char46]
.IP "\fBstatus : n_connections\fR: optional string, containing an integer, at least 2"
When \fBtarget\fR specifies a connection method that listens for inbound connections (e\[char46]g\[char46] \fBptcp:\fR or \fBpssl:\fR) and more than one connection is actually active, the value is the number of active connections\[char46] Otherwise, this key-value pair is omitted\[char46]
.IP
When multiple connections are active, status columns and key-value pairs (other than this one) report the status of one arbitrarily chosen connection\[char46]
.ST "Connection Parameters:"
.PP
.PP
.PP
Additional configuration for a connection between the manager and the database server\[char46]
.IP "\fBother_config : dscp\fR: optional string, containing an integer"
The Differentiated Service Code Point (DSCP) is specified using 6 bits in the Type of Service (TOS) field in the IP header\[char46] DSCP provides a mechanism to classify the network traffic and provide Quality of Service (QoS) on IP networks\[char46] The DSCP value specified here is used when establishing the connection between the manager and the database server\[char46] If no value is specified, a default value of 48 is chosen\[char46] Valid DSCP values must be in the range 0 to 63\[char46]
.bp
.SH "Physical_Switch TABLE"
.PP
A physical switch that implements a VTEP\[char46]
.SS "Summary:
.TQ 3.00in
\fBports\fR
set of \fBPhysical_Port\fRs
.TQ 3.00in
\fBtunnels\fR
set of \fBTunnel\fRs
.TQ .25in
\fINetwork Status:\fR
.RS .25in
.TQ 2.75in
\fBmanagement_ips\fR
set of strings
.TQ 2.75in
\fBtunnel_ips\fR
set of strings
.RE
.TQ .25in
\fIIdentification:\fR
.RS .25in
.TQ 2.75in
\fBname\fR
string (must be unique within table)
.TQ 2.75in
\fBdescription\fR
string
.RE
.TQ .25in
\fIError Notification:\fR
.RS .25in
.TQ 2.75in
\fBswitch_fault_status : mac_table_exhaustion\fR
none
.TQ 2.75in
\fBswitch_fault_status : tunnel_exhaustion\fR
none
.TQ 2.75in
\fBswitch_fault_status : lr_switch_bindings_fault\fR
none
.TQ 2.75in
\fBswitch_fault_status : lr_static_routes_fault\fR
none
.TQ 2.75in
\fBswitch_fault_status : lr_creation_fault\fR
none
.TQ 2.75in
\fBswitch_fault_status : lr_support_fault\fR
none
.TQ 2.75in
\fBswitch_fault_status : unspecified_fault\fR
none
.TQ 2.75in
\fBswitch_fault_status : unsupported_source_node_replication\fR
none
.RE
.TQ .25in
\fICommon Column:\fR
.RS .25in
.TQ 2.75in
\fBother_config\fR
map of string-string pairs
.RE
.SS "Details:
.IP "\fBports\fR: set of \fBPhysical_Port\fRs"
The physical ports within the switch\[char46]
.IP "\fBtunnels\fR: set of \fBTunnel\fRs"
Tunnels created by this switch as instructed by the NVC\[char46]
.ST "Network Status:"
.PP
.IP "\fBmanagement_ips\fR: set of strings"
IPv4 or IPv6 addresses at which the switch may be contacted for management purposes\[char46]
.IP "\fBtunnel_ips\fR: set of strings"
IPv4 or IPv6 addresses on which the switch may originate or terminate tunnels\[char46]
.IP
This column is intended to allow a \fBManager\fR to determine the \fBPhysical_Switch\fR that terminates the tunnel represented by a \fBPhysical_Locator\fR\[char46]
.ST "Identification:"
.PP
.IP "\fBname\fR: string (must be unique within table)"
Symbolic name for the switch, such as its hostname\[char46]
.IP "\fBdescription\fR: string"
An extended description for the switch, such as its switch login banner\[char46]
.ST "Error Notification:"
.PP
.PP
.PP
An entry in this column indicates to the NVC that this switch has encountered a fault\[char46] The switch must clear this column when the fault has been cleared\[char46]
.IP "\fBswitch_fault_status : mac_table_exhaustion\fR: none"
Indicates that the switch has been unable to process MAC entries requested by the NVC due to lack of table resources\[char46]
.IP "\fBswitch_fault_status : tunnel_exhaustion\fR: none"
Indicates that the switch has been unable to create tunnels requested by the NVC due to lack of resources\[char46]
.IP "\fBswitch_fault_status : lr_switch_bindings_fault\fR: none"
Indicates that the switch has been unable to create the logical router interfaces requested by the NVC due to conflicting configurations or a lack of hardware resources\[char46]
.IP "\fBswitch_fault_status : lr_static_routes_fault\fR: none"
Indicates that the switch has been unable to create the static routes requested by the NVC due to conflicting configurations or a lack of hardware resources\[char46]
.IP "\fBswitch_fault_status : lr_creation_fault\fR: none"
Indicates that the switch has been unable to create the logical router requested by the NVC due to conflicting configurations or a lack of hardware resources\[char46]
.IP "\fBswitch_fault_status : lr_support_fault\fR: none"
Indicates that the switch does not support logical routing\[char46]
.IP "\fBswitch_fault_status : unspecified_fault\fR: none"
Indicates that an error has occurred in the switch but that no more specific information is available\[char46]
.IP "\fBswitch_fault_status : unsupported_source_node_replication\fR: none"
Indicates that the requested source node replication mode cannot be supported by the physical switch; this specifically means in this context that the physical switch lacks the capability to support source node replication mode\[char46] This error occurs when a controller attempts to set source node replication mode for one of the logical switches that the physical switch is keeping context for\[char46] An NVC that observes this error should take appropriate action (for example reverting the logical switch to service node replication mode)\[char46] It is recommended that an NVC be proactive and test for support of source node replication by using a test logical switch on vtep physical switch nodes and then trying to change the replication mode to source node on this logical switch, checking for error\[char46] The NVC could remember this capability per vtep physical switch\[char46] Using mixed replication modes on a given logical switch is not recommended\[char46] Service node replication mode is considered a basic requirement since it only requires sending a packet to a single transport node, hence it is not expected that a switch should report that service node mode cannot be supported\[char46]
.ST "Common Column:"
.PP
The overall purpose of this column is described under \fBCommon
Column\fR at the beginning of this document\[char46]
.IP "\fBother_config\fR: map of string-string pairs"
.bp
.SH "Tunnel TABLE"
.PP
A tunnel created by a \fBPhysical_Switch\fR\[char46]
.SS "Summary:
.TQ 3.00in
\fBlocal\fR
\fBPhysical_Locator\fR
.TQ 3.00in
\fBremote\fR
\fBPhysical_Locator\fR
.TQ .25in
\fIBidirectional Forwarding Detection (BFD):\fR
.RS .25in
.TQ .25in
\fIBFD Local Configuration:\fR
.RS .25in
.TQ 2.50in
\fBbfd_config_local : bfd_dst_mac\fR
optional string
.TQ 2.50in
\fBbfd_config_local : bfd_dst_ip\fR
optional string
.RE
.TQ .25in
\fIBFD Remote Configuration:\fR
.RS .25in
.TQ 2.50in
\fBbfd_config_remote : bfd_dst_mac\fR
optional string
.TQ 2.50in
\fBbfd_config_remote : bfd_dst_ip\fR
optional string
.RE
.TQ .25in
\fIBFD Parameters:\fR
.RS .25in
.TQ 2.50in
\fBbfd_params : enable\fR
optional string, either \fBtrue\fR or \fBfalse\fR
.TQ 2.50in
\fBbfd_params : min_rx\fR
optional string, containing an integer, at least 1
.TQ 2.50in
\fBbfd_params : min_tx\fR
optional string, containing an integer, at least 1
.TQ 2.50in
\fBbfd_params : decay_min_rx\fR
optional string, containing an integer
.TQ 2.50in
\fBbfd_params : forwarding_if_rx\fR
optional string, either \fBtrue\fR or \fBfalse\fR
.TQ 2.50in
\fBbfd_params : cpath_down\fR
optional string, either \fBtrue\fR or \fBfalse\fR
.TQ 2.50in
\fBbfd_params : check_tnl_key\fR
optional string, either \fBtrue\fR or \fBfalse\fR
.RE
.TQ .25in
\fIBFD Status:\fR
.RS .25in
.TQ 2.50in
\fBbfd_status : enabled\fR
optional string, either \fBtrue\fR or \fBfalse\fR
.TQ 2.50in
\fBbfd_status : state\fR
optional string, one of \fBadmin_down\fR, \fBdown\fR, \fBinit\fR, or \fBup\fR
.TQ 2.50in
\fBbfd_status : forwarding\fR
optional string, either \fBtrue\fR or \fBfalse\fR
.TQ 2.50in
\fBbfd_status : diagnostic\fR
optional string
.TQ 2.50in
\fBbfd_status : remote_state\fR
optional string, one of \fBadmin_down\fR, \fBdown\fR, \fBinit\fR, or \fBup\fR
.TQ 2.50in
\fBbfd_status : remote_diagnostic\fR
optional string
.TQ 2.50in
\fBbfd_status : info\fR
optional string
.RE
.RE
.SS "Details:
.IP "\fBlocal\fR: \fBPhysical_Locator\fR"
Tunnel end-point local to the physical switch\[char46]
.IP "\fBremote\fR: \fBPhysical_Locator\fR"
Tunnel end-point remote to the physical switch\[char46]
.ST "Bidirectional Forwarding Detection (BFD):"
.PP
.PP
.PP
BFD, defined in RFC 5880, allows point to point detection of connectivity failures by occasional transmission of BFD control messages\[char46] VTEPs are expected to implement BFD\[char46]
.PP
.PP
BFD operates by regularly transmitting BFD control messages at a rate negotiated independently in each direction\[char46] Each endpoint specifies the rate at which it expects to receive control messages, and the rate at which it\(cqs willing to transmit them\[char46] An endpoint which fails to receive BFD control messages for a period of three times the expected reception rate will signal a connectivity fault\[char46] In the case of a unidirectional connectivity issue, the system not receiving BFD control messages will signal the problem to its peer in the messages it transmits\[char46]
.PP
.PP
A hardware VTEP is expected to use BFD to determine reachability of devices at the end of the tunnels with which it exchanges data\[char46] This can enable the VTEP to choose a functioning service node among a set of service nodes providing high availability\[char46] It also enables the NVC to report the health status of tunnels\[char46]
.PP
.PP
In many cases the BFD peer of a hardware VTEP will be an Open vSwitch instance\[char46] The Open vSwitch implementation of BFD aims to comply faithfully with the requirements put forth in RFC 5880\[char46] Open vSwitch does not implement the optional Authentication or ``Echo Mode\(cq\(cq features\[char46]
.ST "BFD Local Configuration:"
.PP
.PP
.PP
The HSC writes the key-value pairs in the \fBbfd_config_local\fR column to specify the local configurations to be used for BFD sessions on this tunnel\[char46]
.IP "\fBbfd_config_local : bfd_dst_mac\fR: optional string"
Set to an Ethernet address in the form \fIxx\fR:\fIxx\fR:\fIxx\fR:\fIxx\fR:\fIxx\fR:\fIxx\fR to set the MAC expected as destination for received BFD packets\[char46] The default is \fB00:23:20:00:00:01\fR\[char46]
.IP "\fBbfd_config_local : bfd_dst_ip\fR: optional string"
Set to an IPv4 address to set the IP address that is expected as destination for received BFD packets\[char46] The default is \fB169\[char46]254\[char46]1\[char46]0\fR\[char46]
.ST "BFD Remote Configuration:"
.PP
.PP
.PP
The \fBbfd_config_remote\fR column is the remote counterpart of the \fBbfd_config_local\fR column\[char46] The NVC writes the key-value pairs in this column\[char46]
.IP "\fBbfd_config_remote : bfd_dst_mac\fR: optional string"
Set to an Ethernet address in the form \fIxx\fR:\fIxx\fR:\fIxx\fR:\fIxx\fR:\fIxx\fR:\fIxx\fR to set the destination MAC to be used for transmitted BFD packets\[char46] The default is \fB00:23:20:00:00:01\fR\[char46]
.IP "\fBbfd_config_remote : bfd_dst_ip\fR: optional string"
Set to an IPv4 address to set the IP address used as destination for transmitted BFD packets\[char46] The default is \fB169\[char46]254\[char46]1\[char46]1\fR\[char46]
.ST "BFD Parameters:"
.PP
.PP
.PP
The NVC sets up key-value pairs in the \fBbfd_params\fR column to enable and configure BFD\[char46]
.IP "\fBbfd_params : enable\fR: optional string, either \fBtrue\fR or \fBfalse\fR"
True to enable BFD on this \fBTunnel\fR\[char46] If not specified, BFD will not be enabled by default\[char46]
.IP "\fBbfd_params : min_rx\fR: optional string, containing an integer, at least 1"
The shortest interval, in milliseconds, at which this BFD session offers to receive BFD control messages\[char46] The remote endpoint may choose to send messages at a slower rate\[char46] Defaults to \fB1000\fR\[char46]
.IP "\fBbfd_params : min_tx\fR: optional string, containing an integer, at least 1"
The shortest interval, in milliseconds, at which this BFD session is willing to transmit BFD control messages\[char46] Messages will actually be transmitted at a slower rate if the remote endpoint is not willing to receive as quickly as specified\[char46] Defaults to \fB100\fR\[char46]
.IP "\fBbfd_params : decay_min_rx\fR: optional string, containing an integer"
An alternate receive interval, in milliseconds, that must be greater than or equal to \fBbfd_params:min_rx\fR\[char46] The implementation should switch from \fBbfd_params:min_rx\fR to \fBbfd_params:decay_min_rx\fR when there is no obvious incoming data traffic at the tunnel, to reduce the CPU and bandwidth cost of monitoring an idle tunnel\[char46] This feature may be disabled by setting a value of 0\[char46] This feature is reset whenever \fBbfd_params:decay_min_rx\fR or \fBbfd_params:min_rx\fR changes\[char46]
.IP "\fBbfd_params : forwarding_if_rx\fR: optional string, either \fBtrue\fR or \fBfalse\fR"
When \fBtrue\fR, traffic received on the \fBTunnel\fR is used to indicate the capability of packet I/O\[char46] BFD control packets are still transmitted and received\[char46] At least one BFD control packet must be received every 100 * \fBbfd_params:min_rx\fR amount of time\[char46] Otherwise, even if traffic is received, the \fBbfd_params:forwarding\fR will be \fBfalse\fR\[char46]
.IP "\fBbfd_params : cpath_down\fR: optional string, either \fBtrue\fR or \fBfalse\fR"
Set to true to notify the remote endpoint that traffic should not be forwarded to this system for some reason other than a connectivity failure on the interface being monitored\[char46] The typical underlying reason is ``concatenated path down,\(cq\(cq that is, that connectivity beyond the local system is down\[char46] Defaults to false\[char46]
.IP "\fBbfd_params : check_tnl_key\fR: optional string, either \fBtrue\fR or \fBfalse\fR"
Set to true to make BFD accept only control messages with a tunnel key of zero\[char46] By default, BFD accepts control messages with any tunnel key\[char46]
.ST "BFD Status:"
.PP
.PP
.PP
The VTEP sets key-value pairs in the \fBbfd_status\fR column to report the status of BFD on this tunnel\[char46] When BFD is not enabled, with \fBbfd_params:enable\fR, the HSC clears all key-value pairs from \fBbfd_status\fR\[char46]
.IP "\fBbfd_status : enabled\fR: optional string, either \fBtrue\fR or \fBfalse\fR"
Set to true if the BFD session has been successfully enabled\[char46] Set to false if the VTEP cannot support BFD or has insufficient resources to enable BFD on this tunnel\[char46] The NVC will disable the BFD monitoring on the other side of the tunnel once this value is set to false\[char46]
.IP "\fBbfd_status : state\fR: optional string, one of \fBadmin_down\fR, \fBdown\fR, \fBinit\fR, or \fBup\fR"
Reports the state of the BFD session\[char46] The BFD session is fully healthy and negotiated if \fBUP\fR\[char46]
.IP "\fBbfd_status : forwarding\fR: optional string, either \fBtrue\fR or \fBfalse\fR"
Reports whether the BFD session believes this \fBTunnel\fR may be used to forward traffic\[char46] Typically this means the local session is signaling \fBUP\fR, and the remote system isn\(cqt signaling a problem such as concatenated path down\[char46]
.IP "\fBbfd_status : diagnostic\fR: optional string"
A diagnostic code specifying the local system\(cqs reason for the last change in session state\[char46] The error messages are defined in section 4\[char46]1 of [RFC 5880]\[char46]
.IP "\fBbfd_status : remote_state\fR: optional string, one of \fBadmin_down\fR, \fBdown\fR, \fBinit\fR, or \fBup\fR"
Reports the state of the remote endpoint\(cqs BFD session\[char46]
.IP "\fBbfd_status : remote_diagnostic\fR: optional string"
A diagnostic code specifying the remote system\(cqs reason for the last change in session state\[char46] The error messages are defined in section 4\[char46]1 of [RFC 5880]\[char46]
.IP "\fBbfd_status : info\fR: optional string"
A short message providing further information about the BFD status (possibly including reasons why BFD could not be enabled)\[char46]
.bp
.SH "Physical_Port TABLE"
.PP
A port within a \fBPhysical_Switch\fR\[char46]
.SS "Summary:
.TQ 3.00in
\fBvlan_bindings\fR
map of integer-\fBLogical_Switch\fR pairs, key in range 0 to 4,095
.TQ 3.00in
\fBacl_bindings\fR
map of integer-\fBACL\fR pairs, key in range 0 to 4,095
.TQ 3.00in
\fBvlan_stats\fR
map of integer-\fBLogical_Binding_Stats\fR pairs, key in range 0 to 4,095
.TQ .25in
\fIIdentification:\fR
.RS .25in
.TQ 2.75in
\fBname\fR
string
.TQ 2.75in
\fBdescription\fR
string
.RE
.TQ .25in
\fIError Notification:\fR
.RS .25in
.TQ 2.75in
\fBport_fault_status : invalid_vlan_map\fR
none
.TQ 2.75in
\fBport_fault_status : invalid_ACL_binding\fR
none
.TQ 2.75in
\fBport_fault_status : unspecified_fault\fR
none
.RE
.TQ .25in
\fICommon Column:\fR
.RS .25in
.TQ 2.75in
\fBother_config\fR
map of string-string pairs
.RE
.SS "Details:
.IP "\fBvlan_bindings\fR: map of integer-\fBLogical_Switch\fR pairs, key in range 0 to 4,095"
Identifies how VLANs on the physical port are bound to logical switches\[char46] If, for example, the map contains a (VLAN, logical switch) pair, a packet that arrives on the port in the VLAN is considered to belong to the paired logical switch\[char46] A value of zero in the VLAN field means that untagged traffic on the physical port is mapped to the logical switch\[char46]
.IP "\fBacl_bindings\fR: map of integer-\fBACL\fR pairs, key in range 0 to 4,095"
Attach Access Control Lists (ACLs) to the physical port\[char46] The column consists of a map of VLAN tags to \fBACL\fRs\[char46] If the value of the VLAN tag in the map is 0, this means that the ACL is associated with the entire physical port\[char46] Non-zero values mean that the ACL is to be applied only on packets carrying that VLAN tag value\[char46] Switches will not necessarily support matching on the VLAN tag for all ACLs, and unsupported ACL bindings will cause errors to be reported\[char46] The binding of an ACL to a specific VLAN and the binding of an ACL to the entire physical port should not be combined on a single physical port\[char46] That is, a mix of zero and non-zero keys in the map is not recommended\[char46]
.IP "\fBvlan_stats\fR: map of integer-\fBLogical_Binding_Stats\fR pairs, key in range 0 to 4,095"
Statistics for VLANs bound to logical switches on the physical port\[char46] An implementation that fully supports such statistics would populate this column with a mapping for every VLAN that is bound in \fBvlan_bindings\fR\[char46] An implementation that does not support such statistics or only partially supports them would not populate this column or partially populate it, respectively\[char46] A value of zero in the VLAN field refers to untagged traffic on the physical port\[char46]
.ST "Identification:"
.PP
.IP "\fBname\fR: string"
Symbolic name for the port\[char46] The name ought to be unique within a given \fBPhysical_Switch\fR, but the database is not capable of enforcing this\[char46]
.IP "\fBdescription\fR: string"
An extended description for the port\[char46]
.ST "Error Notification:"
.PP
.PP
.PP
An entry in this column indicates to the NVC that the physical port has encountered a fault\[char46] The switch must clear this column when the error has been cleared\[char46]
.IP "\fBport_fault_status : invalid_vlan_map\fR: none"
Indicates that a VLAN-to-logical-switch mapping requested by the controller could not be instantiated by the switch because of a conflict with local configuration\[char46]
.IP "\fBport_fault_status : invalid_ACL_binding\fR: none"
Indicates that an error has occurred in associating an ACL with a port\[char46]
.IP "\fBport_fault_status : unspecified_fault\fR: none"
Indicates that an error has occurred on the port but that no more specific information is available\[char46]
.ST "Common Column:"
.PP
The overall purpose of this column is described under \fBCommon
Column\fR at the beginning of this document\[char46]
.IP "\fBother_config\fR: map of string-string pairs"
.bp
.SH "Logical_Binding_Stats TABLE"
.PP
Reports statistics for the \fBLogical_Switch\fR with which a VLAN on a \fBPhysical_Port\fR is associated\[char46]
.SS "Summary:
.TQ .25in
\fIStatistics:\fR
.RS .25in
.TQ 2.75in
\fBpackets_from_local\fR
integer
.TQ 2.75in
\fBbytes_from_local\fR
integer
.TQ 2.75in
\fBpackets_to_local\fR
integer
.TQ 2.75in
\fBbytes_to_local\fR
integer
.RE
.SS "Details:
.ST "Statistics:"
.PP
These statistics count only packets to which the binding applies\[char46]
.IP "\fBpackets_from_local\fR: integer"
Number of packets sent by the \fBPhysical_Switch\fR\[char46]
.IP "\fBbytes_from_local\fR: integer"
Number of bytes in packets sent by the \fBPhysical_Switch\fR\[char46]
.IP "\fBpackets_to_local\fR: integer"
Number of packets received by the \fBPhysical_Switch\fR\[char46]
.IP "\fBbytes_to_local\fR: integer"
Number of bytes in packets received by the \fBPhysical_Switch\fR\[char46]
.bp
.SH "Logical_Switch TABLE"
.PP
A logical Ethernet switch, whose implementation may span physical and virtual media, possibly crossing L3 domains via tunnels; a logical layer\-2 domain; an Ethernet broadcast domain\[char46]
.SS "Summary:
.TQ .25in
\fIPer Logical-Switch Tunnel Key:\fR
.RS .25in
.TQ 2.75in
\fBtunnel_key\fR
optional integer
.RE
.TQ .25in
\fIReplication Mode:\fR
.RS .25in
.TQ 2.75in
\fBreplication_mode\fR
optional string, either \fBservice_node\fR or \fBsource_node\fR
.RE
.TQ .25in
\fIIdentification:\fR
.RS .25in
.TQ 2.75in
\fBname\fR
string (must be unique within table)
.TQ 2.75in
\fBdescription\fR
string
.RE
.TQ .25in
\fICommon Column:\fR
.RS .25in
.TQ 2.75in
\fBother_config\fR
map of string-string pairs
.RE
.SS "Details:
.ST "Per Logical-Switch Tunnel Key:"
.PP
.PP
.PP
Tunnel protocols tend to have a field that allows the tunnel to be partitioned into sub-tunnels: VXLAN has a VNI, GRE and STT have a key, CAPWAP has a WSI, and so on\[char46] We call these generically ``tunnel keys\[char46]\(cq\(cq Given that one needs to use a tunnel key at all, there are at least two reasonable ways to assign their values:
.RS
.IP \(bu
Per \fBLogical_Switch\fR+\fBPhysical_Locator\fR pair\[char46] That is, each logical switch may be assigned a different tunnel key on every \fBPhysical_Locator\fR\[char46] This model is especially flexible\[char46]
.IP
In this model, \fBPhysical_Locator\fR carries the tunnel key\[char46] Therefore, one \fBPhysical_Locator\fR record will exist for each logical switch carried at a given IP destination\[char46]
.IP \(bu
Per \fBLogical_Switch\fR\[char46] That is, every tunnel associated with a particular logical switch carries the same tunnel key, regardless of the \fBPhysical_Locator\fR to which the tunnel is addressed\[char46] This model may ease switch implementation because it imposes fewer requirements on the hardware datapath\[char46]
.IP
In this model, \fBLogical_Switch\fR carries the tunnel key\[char46] Therefore, one \fBPhysical_Locator\fR record will exist for each IP destination\[char46]
.RE
.IP "\fBtunnel_key\fR: optional integer"
This column is used only in the tunnel key per \fBLogical_Switch\fR model (see above), because only in that model is there a tunnel key associated with a logical switch\[char46]
.IP
For \fBvxlan_over_ipv4\fR encapsulation, when the tunnel key per \fBLogical_Switch\fR model is in use, this column is the VXLAN VNI that identifies a logical switch\[char46] It must be in the range 0 to 16,777,215\[char46]
.ST "Replication Mode:"
.PP
.PP
.PP
For handling L2 broadcast, multicast and unknown unicast traffic, packets can be sent to all members of a logical switch referenced by a physical switch\[char46] There are different modes to replicate the packets\[char46] The default mode of replication is to send the traffic to a service node, which can be a hypervisor, server or appliance, and let the service node handle replication to other transport nodes (hypervisors or other VTEP physical switches)\[char46] This mode is called service node replication\[char46] An alternate mode of replication, called source node replication involves the source node sending to all other transport nodes\[char46] Hypervisors are always responsible for doing their own replication for locally attached VMs in both modes\[char46] Service node replication mode is the default and considered a basic requirement because it only requires sending the packet to a single transport node\[char46]
.IP "\fBreplication_mode\fR: optional string, either \fBservice_node\fR or \fBsource_node\fR"
This optional column defines the replication mode per \fBLogical_Switch\fR\[char46] There are 2 valid values, \fBservice_node\fR and \fBsource_node\fR\[char46] If the column is not set, the replication mode defaults to service_node\[char46]
.ST "Identification:"
.PP
.IP "\fBname\fR: string (must be unique within table)"
Symbolic name for the logical switch\[char46]
.IP "\fBdescription\fR: string"
An extended description for the logical switch, such as its switch login banner\[char46]
.ST "Common Column:"
.PP
The overall purpose of this column is described under \fBCommon
Column\fR at the beginning of this document\[char46]
.IP "\fBother_config\fR: map of string-string pairs"
.bp
.SH "Ucast_Macs_Local TABLE"
.PP
.PP
.PP
Mapping of unicast MAC addresses to tunnels (physical locators)\[char46] This table is written by the HSC, so it contains the MAC addresses that have been learned on physical ports by a VTEP\[char46]
.SS "Summary:
.TQ 3.00in
\fBMAC\fR
string
.TQ 3.00in
\fBlogical_switch\fR
\fBLogical_Switch\fR
.TQ 3.00in
\fBlocator\fR
\fBPhysical_Locator\fR
.TQ 3.00in
\fBipaddr\fR
string
.SS "Details:
.IP "\fBMAC\fR: string"
A MAC address that has been learned by the VTEP\[char46]
.IP "\fBlogical_switch\fR: \fBLogical_Switch\fR"
The Logical switch to which this mapping applies\[char46]
.IP "\fBlocator\fR: \fBPhysical_Locator\fR"
The physical locator to be used to reach this MAC address\[char46] In this table, the physical locator will be one of the tunnel IP addresses of the appropriate VTEP\[char46]
.IP "\fBipaddr\fR: string"
The IP address to which this MAC corresponds\[char46] Optional field for the purpose of ARP supression\[char46]
.bp
.SH "Ucast_Macs_Remote TABLE"
.PP
.PP
.PP
Mapping of unicast MAC addresses to tunnels (physical locators)\[char46] This table is written by the NVC, so it contains the MAC addresses that the NVC has learned\[char46] These include VM MAC addresses, in which case the physical locators will be hypervisor IP addresses\[char46] The NVC will also report MACs that it has learned from other HSCs in the network, in which case the physical locators will be tunnel IP addresses of the corresponding VTEPs\[char46]
.SS "Summary:
.TQ 3.00in
\fBMAC\fR
string
.TQ 3.00in
\fBlogical_switch\fR
\fBLogical_Switch\fR
.TQ 3.00in
\fBlocator\fR
\fBPhysical_Locator\fR
.TQ 3.00in
\fBipaddr\fR
string
.SS "Details:
.IP "\fBMAC\fR: string"
A MAC address that has been learned by the NVC\[char46]
.IP "\fBlogical_switch\fR: \fBLogical_Switch\fR"
The Logical switch to which this mapping applies\[char46]
.IP "\fBlocator\fR: \fBPhysical_Locator\fR"
The physical locator to be used to reach this MAC address\[char46] In this table, the physical locator will be either a hypervisor IP address or a tunnel IP addresses of another VTEP\[char46]
.IP "\fBipaddr\fR: string"
The IP address to which this MAC corresponds\[char46] Optional field for the purpose of ARP supression\[char46]
.bp
.SH "Mcast_Macs_Local TABLE"
.PP
.PP
.PP
Mapping of multicast MAC addresses to tunnels (physical locators)\[char46] This table is written by the HSC, so it contains the MAC addresses that have been learned on physical ports by a VTEP\[char46] These may be learned by IGMP snooping, for example\[char46] This table also specifies how to handle unknown unicast and broadcast packets\[char46]
.SS "Summary:
.TQ 3.00in
\fBMAC\fR
string
.TQ 3.00in
\fBlogical_switch\fR
\fBLogical_Switch\fR
.TQ 3.00in
\fBlocator_set\fR
\fBPhysical_Locator_Set\fR
.TQ 3.00in
\fBipaddr\fR
string
.SS "Details:
.IP "\fBMAC\fR: string"
A MAC address that has been learned by the VTEP\[char46]
.IP
The keyword \fBunknown\-dst\fR is used as a special ``Ethernet address\(cq\(cq that indicates the locations to which packets in a logical switch whose destination addresses do not otherwise appear in \fBUcast_Macs_Local\fR (for unicast addresses) or \fBMcast_Macs_Local\fR (for multicast addresses) should be sent\[char46]
.IP "\fBlogical_switch\fR: \fBLogical_Switch\fR"
The Logical switch to which this mapping applies\[char46]
.IP "\fBlocator_set\fR: \fBPhysical_Locator_Set\fR"
The physical locator set to be used to reach this MAC address\[char46] In this table, the physical locator set will be contain one or more tunnel IP addresses of the appropriate VTEP(s)\[char46]
.IP "\fBipaddr\fR: string"
The IP address to which this MAC corresponds\[char46] Optional field for the purpose of ARP supression\[char46]
.bp
.SH "Mcast_Macs_Remote TABLE"
.PP
.PP
.PP
Mapping of multicast MAC addresses to tunnels (physical locators)\[char46] This table is written by the NVC, so it contains the MAC addresses that the NVC has learned\[char46] This table also specifies how to handle unknown unicast and broadcast packets\[char46]
.PP
.PP
Multicast packet replication may be handled by a service node, in which case the physical locators will be IP addresses of service nodes\[char46] If the VTEP supports replication onto multiple tunnels, using source node replication, then this may be used to replicate directly onto VTEP-hypervisor or VTEP-VTEP tunnels\[char46]
.SS "Summary:
.TQ 3.00in
\fBMAC\fR
string
.TQ 3.00in
\fBlogical_switch\fR
\fBLogical_Switch\fR
.TQ 3.00in
\fBlocator_set\fR
\fBPhysical_Locator_Set\fR
.TQ 3.00in
\fBipaddr\fR
string
.SS "Details:
.IP "\fBMAC\fR: string"
A MAC address that has been learned by the NVC\[char46]
.IP
The keyword \fBunknown\-dst\fR is used as a special ``Ethernet address\(cq\(cq that indicates the locations to which packets in a logical switch whose destination addresses do not otherwise appear in \fBUcast_Macs_Remote\fR (for unicast addresses) or \fBMcast_Macs_Remote\fR (for multicast addresses) should be sent\[char46]
.IP "\fBlogical_switch\fR: \fBLogical_Switch\fR"
The Logical switch to which this mapping applies\[char46]
.IP "\fBlocator_set\fR: \fBPhysical_Locator_Set\fR"
The physical locator set to be used to reach this MAC address\[char46] In this table, the physical locator set will be either a set of service nodes when service node replication is used or the set of transport nodes (defined as hypervisors or VTEPs) participating in the associated logical switch, when source node replication is used\[char46] When service node replication is used, the VTEP should send packets to one member of the locator set that is known to be healthy and reachable, which could be determined by BFD\[char46] When source node replication is used, the VTEP should send packets to all members of the locator set\[char46]
.IP "\fBipaddr\fR: string"
The IP address to which this MAC corresponds\[char46] Optional field for the purpose of ARP supression\[char46]
.bp
.SH "Logical_Router TABLE"
.PP
.PP
.PP
A logical router, or VRF\[char46] A logical router may be connected to one or more logical switches\[char46] Subnet addresses and interface addresses may be configured on the interfaces\[char46]
.SS "Summary:
.TQ 3.00in
\fBswitch_binding\fR
map of string-\fBLogical_Switch\fR pairs
.TQ 3.00in
\fBstatic_routes\fR
map of string-string pairs
.TQ 3.00in
\fBacl_binding\fR
map of string-\fBACL\fR pairs
.TQ .25in
\fIIdentification:\fR
.RS .25in
.TQ 2.75in
\fBname\fR
string (must be unique within table)
.TQ 2.75in
\fBdescription\fR
string
.RE
.TQ .25in
\fIError Notification:\fR
.RS .25in
.TQ 2.75in
\fBLR_fault_status : invalid_ACL_binding\fR
none
.TQ 2.75in
\fBLR_fault_status : unspecified_fault\fR
none
.RE
.TQ .25in
\fICommon Column:\fR
.RS .25in
.TQ 2.75in
\fBother_config\fR
map of string-string pairs
.RE
.SS "Details:
.IP "\fBswitch_binding\fR: map of string-\fBLogical_Switch\fR pairs"
Maps from an IPv4 or IPv6 address prefix in CIDR notation to a logical switch\[char46] Multiple prefixes may map to the same switch\[char46] By writing a 32-bit (or 128-bit for v6) address with a /N prefix length, both the router\(cqs interface address and the subnet prefix can be configured\[char46] For example, 192\[char46]68\[char46]1\[char46]1/24 creates a /24 subnet for the logical switch attached to the interface and assigns the address 192\[char46]68\[char46]1\[char46]1 to the router interface\[char46]
.IP "\fBstatic_routes\fR: map of string-string pairs"
One or more static routes, mapping IP prefixes to next hop IP addresses\[char46]
.IP "\fBacl_binding\fR: map of string-\fBACL\fR pairs"
Maps ACLs to logical router interfaces\[char46] The router interfaces are indicated using IP address notation, and must be the same interfaces created in the \fBswitch_binding\fR column\[char46] For example, an ACL could be associated with the logical router interface with an address of 192\[char46]68\[char46]1\[char46]1 as defined in the example above\[char46]
.ST "Identification:"
.PP
.IP "\fBname\fR: string (must be unique within table)"
Symbolic name for the logical router\[char46]
.IP "\fBdescription\fR: string"
An extended description for the logical router\[char46]
.ST "Error Notification:"
.PP
.PP
.PP
An entry in this column indicates to the NVC that the HSC has encountered a fault in configuring state related to the logical router\[char46]
.IP "\fBLR_fault_status : invalid_ACL_binding\fR: none"
Indicates that an error has occurred in associating an ACL with a logical router port\[char46]
.IP "\fBLR_fault_status : unspecified_fault\fR: none"
Indicates that an error has occurred in configuring the logical router but that no more specific information is available\[char46]
.ST "Common Column:"
.PP
The overall purpose of this column is described under \fBCommon
Column\fR at the beginning of this document\[char46]
.IP "\fBother_config\fR: map of string-string pairs"
.bp
.SH "Arp_Sources_Local TABLE"
.PP
.PP
.PP
MAC address to be used when a VTEP issues ARP requests on behalf of a logical router\[char46]
.PP
.PP
A distributed logical router is implemented by a set of VTEPs (both hardware VTEPs and vswitches)\[char46] In order for a given VTEP to populate the local ARP cache for a logical router, it issues ARP requests with a source MAC address that is unique to the VTEP\[char46] A single per-VTEP MAC can be re-used across all logical networks\[char46] This table contains the MACs that are used by the VTEPs of a given HSC\[char46] The table provides the mapping from MAC to physical locator for each VTEP so that replies to the ARP requests can be sent back to the correct VTEP using the appropriate physical locator\[char46]
.SS "Summary:
.TQ 3.00in
\fBsrc_mac\fR
string
.TQ 3.00in
\fBlocator\fR
\fBPhysical_Locator\fR
.SS "Details:
.IP "\fBsrc_mac\fR: string"
The source MAC to be used by a given VTEP\[char46]
.IP "\fBlocator\fR: \fBPhysical_Locator\fR"
The \fBPhysical_Locator\fR to use for replies to ARP requests from this MAC address\[char46]
.bp
.SH "Arp_Sources_Remote TABLE"
.PP
.PP
.PP
MAC address to be used when a remote VTEP issues ARP requests on behalf of a logical router\[char46]
.PP
.PP
This table is the remote counterpart of \fBArp_sources_local\fR\[char46] The NVC writes this table to notify the HSC of the MACs that will be used by remote VTEPs when they issue ARP requests on behalf of a distributed logical router\[char46]
.SS "Summary:
.TQ 3.00in
\fBsrc_mac\fR
string
.TQ 3.00in
\fBlocator\fR
\fBPhysical_Locator\fR
.SS "Details:
.IP "\fBsrc_mac\fR: string"
The source MAC to be used by a given VTEP\[char46]
.IP "\fBlocator\fR: \fBPhysical_Locator\fR"
The \fBPhysical_Locator\fR to use for replies to ARP requests from this MAC address\[char46]
.bp
.SH "Physical_Locator_Set TABLE"
.PP
.PP
.PP
A set of one or more \fBPhysical_Locator\fRs\[char46]
.PP
.PP
This table exists only because OVSDB does not have a way to express the type ``map from string to one or more \fBPhysical_Locator\fR records\[char46]\(cq\(cq
.SS "Summary:
.TQ 3.00in
\fBlocators\fR
immutable set of 1 or more \fBPhysical_Locator\fRs
.SS "Details:
.IP "\fBlocators\fR: immutable set of 1 or more \fBPhysical_Locator\fRs"
.bp
.SH "Physical_Locator TABLE"
.PP
.PP
.PP
Identifies an endpoint to which logical switch traffic may be encapsulated and forwarded\[char46]
.PP
.PP
The \fBvxlan_over_ipv4\fR encapsulation, the only encapsulation defined so far, can use either tunnel key model described in the ``Per Logical-Switch Tunnel Key\(cq\(cq section in the \fBLogical_Switch\fR table\[char46] When the tunnel key per \fBLogical_Switch\fR model is in use, the \fBtunnel_key\fR column in the \fBLogical_Switch\fR table is filled with a VNI and the \fBtunnel_key\fR column in this table is empty; in the key-per-tunnel model, the opposite is true\[char46] The former model is older, and thus likely to be more widely supported\[char46] See the ``Per Logical-Switch Tunnel Key\(cq\(cq section in the \fBLogical_Switch\fR table for further discussion of the model\[char46]
.SS "Summary:
.TQ 3.00in
\fBencapsulation_type\fR
immutable string, must be \fBvxlan_over_ipv4\fR
.TQ 3.00in
\fBdst_ip\fR
immutable string
.TQ 3.00in
\fBtunnel_key\fR
optional integer
.SS "Details:
.IP "\fBencapsulation_type\fR: immutable string, must be \fBvxlan_over_ipv4\fR"
The type of tunneling encapsulation\[char46]
.IP "\fBdst_ip\fR: immutable string"
For \fBvxlan_over_ipv4\fR encapsulation, the IPv4 address of the VXLAN tunnel endpoint\[char46]
.IP
We expect that this column could be used for IPv4 or IPv6 addresses in encapsulations to be introduced later\[char46]
.IP "\fBtunnel_key\fR: optional integer"
This column is used only in the tunnel key per \fBLogical_Switch\fR+\fBPhysical_Locator\fR model (see above)\[char46]
.IP
For \fBvxlan_over_ipv4\fR encapsulation, when the \fBLogical_Switch\fR+\fBPhysical_Locator\fR model is in use, this column is the VXLAN VNI\[char46] It must be in the range 0 to 16,777,215\[char46]
.bp
.SH "ACL_entry TABLE"
.PP
.PP
.PP
Describes the individual entries that comprise an Access Control List\[char46]
.PP
.PP
Each entry in the table is a single rule to match on certain header fields\[char46] While there are a large number of fields that can be matched on, most hardware cannot match on arbitrary combinations of fields\[char46] It is common to match on either L2 fields (described below in the L2 group of columns) or L3/L4 fields (the L3/L4 group of columns) but not both\[char46] The hardware switch controller may log an error if an ACL entry requires it to match on an incompatible mixture of fields\[char46]
.SS "Summary:
.TQ 3.00in
\fBsequence\fR
integer
.TQ .25in
\fIL2 fields:\fR
.RS .25in
.TQ 2.75in
\fBsource_mac\fR
optional string
.TQ 2.75in
\fBdest_mac\fR
optional string
.TQ 2.75in
\fBethertype\fR
optional string
.RE
.TQ .25in
\fIL3/L4 fields:\fR
.RS .25in
.TQ 2.75in
\fBsource_ip\fR
optional string
.TQ 2.75in
\fBsource_mask\fR
optional string
.TQ 2.75in
\fBdest_ip\fR
optional string
.TQ 2.75in
\fBdest_mask\fR
optional string
.TQ 2.75in
\fBprotocol\fR
optional integer
.TQ 2.75in
\fBsource_port_min\fR
optional integer
.TQ 2.75in
\fBsource_port_max\fR
optional integer
.TQ 2.75in
\fBdest_port_min\fR
optional integer
.TQ 2.75in
\fBdest_port_max\fR
optional integer
.TQ 2.75in
\fBtcp_flags\fR
optional integer
.TQ 2.75in
\fBtcp_flags_mask\fR
optional integer
.TQ 2.75in
\fBicmp_type\fR
optional integer
.TQ 2.75in
\fBicmp_code\fR
optional integer
.RE
.TQ 3.00in
\fBdirection\fR
string, either \fBegress\fR or \fBingress\fR
.TQ 3.00in
\fBaction\fR
string, either \fBdeny\fR or \fBpermit\fR
.TQ .25in
\fIError Notification:\fR
.RS .25in
.TQ 2.75in
\fBacle_fault_status : invalid_acl_entry\fR
none
.TQ 2.75in
\fBacle_fault_status : unspecified_fault\fR
none
.RE
.SS "Details:
.IP "\fBsequence\fR: integer"
The sequence number for the ACL entry for the purpose of ordering entries in an ACL\[char46] Lower numbered entries are matched before higher numbered entries\[char46]
.ST "L2 fields:"
.PP
.IP "\fBsource_mac\fR: optional string"
Source MAC address, in the form \fIxx\fR:\fIxx\fR:\fIxx\fR:\fIxx\fR:\fIxx\fR:\fIxx\fR
.IP "\fBdest_mac\fR: optional string"
Destination MAC address, in the form \fIxx\fR:\fIxx\fR:\fIxx\fR:\fIxx\fR:\fIxx\fR:\fIxx\fR
.IP "\fBethertype\fR: optional string"
Ethertype in hexadecimal, in the form \fI0xAAAA\fR
.ST "L3/L4 fields:"
.PP
.IP "\fBsource_ip\fR: optional string"
Source IP address, in the form \fIxx\[char46]xx\[char46]xx\[char46]xx\fR for IPv4 or appropriate colon-separated hexadecimal notation for IPv6\[char46]
.IP "\fBsource_mask\fR: optional string"
Mask that determines which bits of source_ip to match on, in the form \fIxx\[char46]xx\[char46]xx\[char46]xx\fR for IPv4 or appropriate colon-separated hexadecimal notation for IPv6\[char46]
.IP "\fBdest_ip\fR: optional string"
Destination IP address, in the form \fIxx\[char46]xx\[char46]xx\[char46]xx\fR for IPv4 or appropriate colon-separated hexadecimal notation for IPv6\[char46]
.IP "\fBdest_mask\fR: optional string"
Mask that determines which bits of dest_ip to match on, in the form \fIxx\[char46]xx\[char46]xx\[char46]xx\fR for IPv4 or appropriate colon-separated hexadecimal notation for IPv6\[char46]
.IP "\fBprotocol\fR: optional integer"
Protocol number in the IPv4 header, or value of the \(dqnext header\(dq field in the IPv6 header\[char46]
.IP "\fBsource_port_min\fR: optional integer"
Lower end of the range of source port values\[char46] The value specified is included in the range\[char46]
.IP "\fBsource_port_max\fR: optional integer"
Upper end of the range of source port values\[char46] The value specified is included in the range\[char46]
.IP "\fBdest_port_min\fR: optional integer"
Lower end of the range of destination port values\[char46] The value specified is included in the range\[char46]
.IP "\fBdest_port_max\fR: optional integer"
Upper end of the range of destination port values\[char46] The value specified is included in the range\[char46]
.IP "\fBtcp_flags\fR: optional integer"
Integer representing the value of TCP flags to match\[char46] For example, the SYN flag is the second least significant bit in the TCP flags\[char46] Hence a value of 2 would indicate that the \(dqSYN\(dq flag should be set (assuming an appropriate mask)\[char46]
.IP "\fBtcp_flags_mask\fR: optional integer"
Integer representing the mask to apply when matching TCP flags\[char46] For example, a value of 2 would imply that the \(dqSYN\(dq flag should be matched and all other flags ignored\[char46]
.IP "\fBicmp_type\fR: optional integer"
ICMP type to be matched\[char46]
.IP "\fBicmp_code\fR: optional integer"
ICMP code to be matched\[char46]
.IP "\fBdirection\fR: string, either \fBegress\fR or \fBingress\fR"
Direction of traffic to match on the specified port, either \(dqingress\(dq (toward the logical switch or router) or \(dqegress\(dq (leaving the logical switch or router)\[char46]
.IP "\fBaction\fR: string, either \fBdeny\fR or \fBpermit\fR"
Action to take for this rule, either \(dqpermit\(dq or \(dqdeny\(dq\[char46]
.ST "Error Notification:"
.PP
.PP
.PP
An entry in this column indicates to the NVC that the ACL could not be configured as requested\[char46] The switch must clear this column when the error has been cleared\[char46]
.IP "\fBacle_fault_status : invalid_acl_entry\fR: none"
Indicates that an ACL entry requested by the controller could not be instantiated by the switch, e\[char46]g\[char46] because it requires an unsupported combination of fields to be matched\[char46]
.IP "\fBacle_fault_status : unspecified_fault\fR: none"
Indicates that an error has occurred in configuring the ACL entry but no more specific information is available\[char46]
.bp
.SH "ACL TABLE"
.PP
.PP
.PP
Access Control List table\[char46] Each ACL is constructed as a set of entries from the \fBACL_entry\fR table\[char46] Packets that are not matched by any entry in the ACL are allowed by default\[char46]
.SS "Summary:
.TQ 3.00in
\fBacl_entries\fR
set of 1 or more \fBACL_entry\fRs
.TQ 3.00in
\fBacl_name\fR
string (must be unique within table)
.TQ .25in
\fIError Notification:\fR
.RS .25in
.TQ 2.75in
\fBacl_fault_status : invalid_acl\fR
none
.TQ 2.75in
\fBacl_fault_status : resource_shortage\fR
none
.TQ 2.75in
\fBacl_fault_status : unspecified_fault\fR
none
.RE
.SS "Details:
.IP "\fBacl_entries\fR: set of 1 or more \fBACL_entry\fRs"
A set of references to entries in the \fBACL_entry\fR table\[char46]
.IP "\fBacl_name\fR: string (must be unique within table)"
A human readable name for the ACL, which may (for example) be displayed on the switch CLI\[char46]
.ST "Error Notification:"
.PP
.PP
.PP
An entry in this column indicates to the NVC that the ACL could not be configured as requested\[char46] The switch must clear this column when the error has been cleared\[char46]
.IP "\fBacl_fault_status : invalid_acl\fR: none"
Indicates that an ACL requested by the controller could not be instantiated by the switch, e\[char46]g\[char46], because it requires an unsupported combination of fields to be matched\[char46]
.IP "\fBacl_fault_status : resource_shortage\fR: none"
Indicates that an ACL requested by the controller could not be instantiated by the switch due to a shortage of resources (e\[char46]g\[char46] TCAM space)\[char46]
.IP "\fBacl_fault_status : unspecified_fault\fR: none"
Indicates that an error has occurred in configuring the ACL but no more specific information is available\[char46]