GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  VTEP (5)

NAME

hardware_vtep - hardware_vtep database schema

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.

Glossary:

VTEP VXLAN Tunnel End Point, an entity which originates and/or terminates VXLAN tunnels.
HSC Hardware Switch Controller.
NVC Network Virtualization Controller, e.g. NSX.
VRF Virtual Routing and Forwarding instance.

CONTENTS

TABLE SUMMARY

The following list summarizes the purpose of each of the tables in the hardware_vtep database. Each table is described in more detail on a later page.
Table Purpose
Global
  Top-level configuration.
Manager
  OVSDB management connection.
Physical_Switch
  A physical switch.
Tunnel
  A tunnel created by a physical switch.
Physical_Port
  A port within a physical switch.
Logical_Binding_Stats
  Statistics for a VLAN on a physical port bound to a logical network.
Logical_Switch
  A layer-2 domain.
Ucast_Macs_Local
  Unicast MACs (local)
Ucast_Macs_Remote
  Unicast MACs (remote)
Mcast_Macs_Local
  Multicast MACs (local)
Mcast_Macs_Remote
  Multicast MACs (remote)
Logical_Router
  A logical L3 router.
Arp_Sources_Local
  ARP source addresses for logical routers
Arp_Sources_Remote
  ARP source addresses for logical routers
Physical_Locator_Set
  Physical_Locator_Set configuration.
Physical_Locator
  Physical_Locator configuration.

TABLE RELATIONSHIPS

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: ? for zero or one, * for zero or more, + for one or more. Thick lines represent strong references; thin lines represent weak references.

linethick = 1; linethick = 0.5; box at 1.695952789,1.959484422 wid 1.067553656 height 0.243245 "Mcast_Macs_Remote" box at 1.695952789,1.959484422 wid 1.01199810044444 height 0.187689444444444 linethick = 1; box at 3.533814711,2.817604133 wid 1.0946025 height 0.243245 "Physical_Locator_Set" linethick = 0.5; box at 5.93225906,1.060840094 wid 0.804070672 height 0.243245 "Logical_Switch" box at 5.93225906,1.060840094 wid 0.748515116444444 height 0.187689444444444 linethick = 0.5; box at 3.533814711,2.0675825 wid 0.939217594 height 0.243245 "Ucast_Macs_Local" box at 3.533814711,2.0675825 wid 0.883662038444444 height 0.187689444444444 linethick = 1; box at 5.93225906,2.770268656 wid 0.885119906 height 0.243245 "Physical_Locator" linethick = 1; box at 3.533814711,2.452736633 wid 0.4189214039 height 0.243245 "Tunnel" linethick = 0.5; box at 0.2027057883,0.500014422 wid 0.4054067117 height 0.243245 "Global" box at 0.2027057883,0.500014422 wid 0.349851156144444 height 0.187689444444444 linethick = 1; box at 1.695952789,0.709448367 wid 0.858119711 height 0.243245 "Physical_Switch" linethick = 1; box at 1.695952789,0.3445954617 wid 0.520252406 height 0.243245 "Manager" linethick = 1; box at 3.533814711,0.2364876539 wid 0.729735 height 0.243245 "Physical_Port" linethick = 0.5; box at 3.533814711,0.601350289 wid 0.797308461 height 0.243245 "Logical_Router" box at 3.533814711,0.601350289 wid 0.741752905444444 height 0.187689444444444 linethick = 0.5; box at 1.695952789,1.283798461 wid 0.945931156 height 0.243245 "Mcast_Macs_Local" box at 1.695952789,1.283798461 wid 0.890375600444444 height 0.187689444444444 linethick = 0.5; box at 3.533814711,1.695952789 wid 1.054077883 height 0.243245 "Ucast_Macs_Remote" box at 3.533814711,1.695952789 wid 0.998522327444444 height 0.187689444444444 linethick = 0.5; box at 3.533814711,3.689199617 wid 1.0946025 height 0.243245 "Arp_Sources_Remote" box at 3.533814711,3.689199617 wid 1.03904694444444 height 0.187689444444444 linethick = 0.5; box at 3.533814711,3.324332117 wid 0.979742211 height 0.243245 "Arp_Sources_Local" box at 3.533814711,3.324332117 wid 0.924186655444444 height 0.187689444444444 linethick = 1; box at 5.93225906,0.1216225 wid 1.128364906 height 0.243245 "Logical_Binding_Stats" linethick = 1; spline -> from 1.844429537,2.082031253 to 1.844429537,2.082031253 to 1.972425056,2.183075226 to 2.165512937,2.324595167 to 2.351352117,2.418925578 to 2.617267551,2.553926553 to 2.70391142,2.53996429 to 2.986513461,2.635170383 to 3.044405771,2.654678632 to 3.105800809,2.67520851 to 3.165687728,2.695251898 "locator_set" at 2.608121539,2.655408367 linethick = 1; spline -> from 1.805121145,1.83552677 to 1.805121145,1.83552677 to 1.925089579,1.70855288 to 2.13033971,1.517167714 to 2.351352117,1.425707594 to 2.639354197,1.306468895 to 4.653325499,1.151473181 to 5.52847236,1.088861918 "logical_switch" at 3.533814711,1.371609906 linethick = 1; spline -> from 4.082721378,2.889507355 to 4.082721378,2.889507355 to 4.123294644,2.89315603 to 4.163624665,2.896318215 to 4.202738461,2.898653367 to 4.664368822,2.926529244 to 4.782780488,2.941172593 to 5.24338922,2.898653367 to 5.32317358,2.891307368 to 5.40782284,2.879193767 to 5.48906667,2.865280153 "locators+" at 4.722990867,2.97975125 linethick = 1; spline -> from 4.004931627,1.9800143 to 4.004931627,1.9800143 to 4.071288863,1.968241242 to 4.138667728,1.956565482 to 4.202738461,1.94596 to 4.664028279,1.86958107 to 4.828753793,2.006917197 to 5.24338922,1.790575094 to 5.51825607,1.647011895 to 5.74398743,1.350301644 to 5.85588013,1.182803137 "logical_switch" at 4.722990867,2.00677125 linethick = 1; spline -> from 4.005369468,2.087333994 to 4.005369468,2.087333994 to 4.4319239,2.11039362 to 5.0254417,2.156902064 to 5.24338922,2.243254039 to 5.47155303,2.333789828 to 5.68852757,2.522693895 to 5.81598795,2.648013719 "locator" at 4.722990867,2.304065289 linethick = 1; spline -> from 3.745827053,2.515591141 to 3.745827053,2.515591141 to 3.876449618,2.552029242 to 4.047985992,2.595618746 to 4.202738461,2.621645961 to 4.636687541,2.694570812 to 5.13830738,2.732662979 to 5.48906667,2.751927983 "remote" at 4.722990867,2.790555289 linethick = 1; spline -> from 3.744610828,2.428898623 to 3.744610828,2.428898623 to 4.070267234,2.398006508 to 4.713455663,2.360303533 to 5.24338922,2.472974617 to 5.40636337,2.507710003 to 5.57858083,2.581997026 to 5.71041962,2.647673176 "local" at 4.722990867,2.533785867 linethick = 1; spline -> from 0.4072018598,0.528668683 to 0.4072018598,0.528668683 to 0.626842365,0.559512149 to 0.982369257,0.609377374 to 1.26438751,0.648929011 "switches*" at 0.783784039,0.675685961 linethick = 1; spline -> from 0.4063067182,0.4224873756 to 0.4063067182,0.4224873756 to 0.4458388956,0.4101986382 to 0.487317033,0.399165045 to 0.527014617,0.3918968844 to 0.834719542,0.3355613424 to 1.195208632,0.329888869 to 1.433637381,0.3343110631 "managers*" at 0.783784039,0.4527081344 linethick = 1; spline -> from 1.888456882,0.832189794 to 1.888456882,0.832189794 to 1.994609,0.904238963 to 2.125523459,1.000758579 to 2.229729617,1.101364711 to 2.557380632,1.41763186 to 2.644997481,1.506610881 to 2.864890961,1.905435383 to 2.943313149,2.04763641 to 2.872528854,2.134280279 to 2.986513461,2.25001625 to 3.07607627,2.34098988 to 3.210055616,2.391487542 to 3.323067243,2.419363419 "tunnels*" at 2.608121539,1.966246633 linethick = 1; spline -> from 2.126836982,0.598577296 to 2.126836982,0.598577296 to 2.443006833,0.517187519 to 2.867761252,0.4078975405 to 3.167585039,0.3307353616 "ports*" at 2.608121539,0.587825867 linethick = 1; spline -> from 3.898779509,0.2592602508 to 3.898779509,0.2592602508 to 4.327620444,0.2903177724 to 5.01036051,0.3544371544 to 5.24338922,0.4594606156 to 5.48809369,0.569777088 to 5.70993313,0.796530077 to 5.83252861,0.937904071 "vlan_bindings value*" at 4.722990867,0.520252406 linethick = 1; spline -> from 3.898828158,0.1669098541 to 3.898828158,0.1669098541 to 3.997099138,0.1510746046 to 4.103640448,0.1365285536 to 4.202738461,0.1283798461 to 4.590325044,0.0965001564 to 5.02836064,0.0951428493 to 5.36695768,0.1015888418 "vlan_stats value*" at 4.722990867,0.1891910961 linethick = 1; spline -> from 3.934050034,0.598431349 to 3.934050034,0.598431349 to 4.284614728,0.60470707 to 4.805110379,0.635696483 to 5.24338922,0.750021633 to 5.40733635,0.792735455 to 5.58101328,0.871352239 to 5.71285207,0.938779753 "switch_binding value*" at 4.722990867,0.810832883 linethick = 1; spline -> from 1.86228372,1.407220974 to 1.86228372,1.407220974 to 1.977192658,1.499167584 to 2.127226174,1.633195579 to 2.229729617,1.777050672 to 2.307811262,1.886559571 to 2.255562236,1.959727667 to 2.351352117,2.054058078 to 2.52780204,2.227832306 to 2.69661407,2.088598868 to 2.864890961,2.270302883 to 2.981016124,2.395720005 to 2.865620696,2.514277618 to 2.986513461,2.635170383 to 3.009183895,2.657840817 to 3.03472462,2.67764096 to 3.062065358,2.695057302 "locator_set" at 2.608121539,2.331114133 linethick = 1; spline -> from 2.171496764,1.181586912 to 2.171496764,1.181586912 to 2.414109327,1.134591978 to 2.714662849,1.084142965 to 2.986513461,1.060840094 to 3.892309192,0.983147641 to 4.96073853,1.01335867 to 5.52895885,1.039045342 "logical_switch" at 3.533814711,1.121651344 linethick = 1; spline -> from 3.881363167,1.57379515 to 3.881363167,1.57379515 to 3.949033926,1.545821975 to 4.018358751,1.514102827 to 4.081115961,1.479756633 to 4.139592059,1.447745591 to 4.14100288,1.417048072 to 4.202738461,1.391896539 to 4.63576321,1.215495265 to 4.784921044,1.328896084 to 5.24338922,1.236511633 to 5.33630881,1.21768447 to 5.43603926,1.19433295 to 5.52944534,1.170835483 "logical_switch" at 4.722990867,1.452707789 linethick = 1; spline -> from 4.061948255,1.620790084 to 4.061948255,1.620790084 to 4.488162144,1.570730263 to 5.04782024,1.532200255 to 5.24338922,1.64190375 to 5.63452718,1.861456687 to 5.83009616,2.40374709 to 5.90063721,2.647819123 "locator" at 4.722990867,1.702715 linethick = 1; spline -> from 4.081699749,3.677913049 to 4.081699749,3.677913049 to 4.429686046,3.651885834 to 4.88095417,3.582415062 to 5.24338922,3.40543 to 5.49344508,3.283272361 to 5.71674399,3.040903043 to 5.83788,2.893447924 "locator" at 4.722990867,3.723010672 linethick = 1; spline -> from 4.025412856,3.284439937 to 4.025412856,3.284439937 to 4.370966703,3.248245081 to 4.841451182,3.182325686 to 5.24338922,3.067611344 to 5.39760655,3.023583999 to 5.56252666,2.953237545 to 5.69241949,2.891988454 "locator" at 4.722990867,3.317569906

Global TABLE

Top-level configuration for a hardware VTEP. There must be exactly one record in the Global table.

    Summary:

switches
  set of Physical_Switchs
Database Configuration:
 
managers
  set of Managers

    Details:

switches: set of Physical_Switchs The physical switches managed by the VTEP.
Database Configuration:
These columns primarily configure the database server (ovsdb-server), not the hardware VTEP itself.
managers: set of Managers 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. See the Manager table for more information.

Manager TABLE

Configuration for a database connection to an Open vSwitch Database (OVSDB) client.

The database server can initiate and maintain active connections to remote clients. It can also listen for database connections.

    Summary:

Core Features:
 
target
  string (must be unique within table)
Client Failure Detection and Handling:
 
max_backoff
  optional integer, at least 1,000
inactivity_probe
  optional integer
Status:
 
is_connected
  boolean
status : last_error
  optional string
status : state
  optional string, one of ACTIVE, VOID, CONNECTING, IDLE, or BACKOFF
status : sec_since_connect
  optional string, containing an integer, at least 0
status : sec_since_disconnect
  optional string, containing an integer, at least 0
status : locks_held
  optional string
status : locks_waiting
  optional string
status : locks_lost
  optional string
status : n_connections
  optional string, containing an integer, at least 2
Connection Parameters:
 
other_config : dscp
  optional string, containing an integer

    Details:

Core Features:
target: string (must be unique within table) Connection method for managers.
The following connection methods are currently supported:
ssl:ip[:port]
  The specified SSL port (default: 6632) on the host at the given ip, which must be expressed as an IP address (not a DNS name).
SSL key and certificate configuration happens outside the database.
tcp:ip[:port]
  The specified TCP port (default: 6632) on the host at the given ip, which must be expressed as an IP address (not a DNS name).
pssl:[port][:ip]
  Listens for SSL connections on the specified TCP port (default: 6632). If ip, which must be expressed as an IP address (not a DNS name), is specified, then connections are restricted to the specified local IP address.
ptcp:[port][:ip]
  Listens for connections on the specified TCP port (default: 6632). If ip, which must be expressed as an IP address (not a DNS name), is specified, then connections are restricted to the specified local IP address.
  Client Failure Detection and Handling:
max_backoff: optional integer, at least 1,000 Maximum number of milliseconds to wait between connection attempts. Default is implementation-specific.
inactivity_probe: optional integer Maximum number of milliseconds of idle time on connection to the client before sending an inactivity probe message. If the Open vSwitch database does not communicate with the client for the specified number of seconds, it will send a probe. 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. Default is implementation-specific. A value of 0 disables inactivity probes.

Status:

is_connected: boolean true if currently connected to this manager, false otherwise.
status : last_error: optional string A human-readable description of the last error on the connection to the manager; i.e. strerror(errno). This key will exist only if an error has occurred.
status : state: optional string, one of ACTIVE, VOID, CONNECTING, IDLE, or BACKOFF The state of the connection to the manager:
VOID Connection is disabled.
BACKOFF
  Attempting to reconnect at an increasing period.
CONNECTING
  Attempting to connect.
ACTIVE Connected, remote host responsive.
IDLE Connection is idle. Waiting for response to keep-alive.
These values may change in the future. They are provided only for human consumption.
status : sec_since_connect: optional string, containing an integer, at least 0 The amount of time since this manager last successfully connected to the database (in seconds). Value is empty if manager has never successfully connected.
status : sec_since_disconnect: optional string, containing an integer, at least 0 The amount of time since this manager last disconnected from the database (in seconds). Value is empty if manager has never disconnected.
status : locks_held: optional string Space-separated list of the names of OVSDB locks that the connection holds. Omitted if the connection does not hold any locks.
status : locks_waiting: optional string Space-separated list of the names of OVSDB locks that the connection is currently waiting to acquire. Omitted if the connection is not waiting for any locks.
status : locks_lost: optional string Space-separated list of the names of OVSDB locks that the connection has had stolen by another OVSDB client. Omitted if no locks have been stolen from this connection.
status : n_connections: optional string, containing an integer, at least 2 When target specifies a connection method that listens for inbound connections (e.g. ptcp: or pssl:) and more than one connection is actually active, the value is the number of active connections. Otherwise, this key-value pair is omitted.
When multiple connections are active, status columns and key-value pairs (other than this one) report the status of one arbitrarily chosen connection.

Connection Parameters: Additional configuration for a connection between the manager and the database server.

other_config : dscp: 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. DSCP provides a mechanism to classify the network traffic and provide Quality of Service (QoS) on IP networks. The DSCP value specified here is used when establishing the connection between the manager and the database server. If no value is specified, a default value of 48 is chosen. Valid DSCP values must be in the range 0 to 63.

Physical_Switch TABLE

A physical switch that implements a VTEP.

    Summary:

ports
  set of Physical_Ports
tunnels
  set of Tunnels
Network Status:
 
management_ips
  set of strings
tunnel_ips
  set of strings
Identification:
 
name
  string (must be unique within table)
description
  string
Error Notification:
 
switch_fault_status : mac_table_exhaustion
  none
switch_fault_status : tunnel_exhaustion
  none
switch_fault_status : unspecified_fault
  none

    Details:

ports: set of Physical_Ports The physical ports within the switch.
tunnels: set of Tunnels Tunnels created by this switch as instructed by the NVC.
  Network Status:
management_ips: set of strings IPv4 or IPv6 addresses at which the switch may be contacted for management purposes.
tunnel_ips: set of strings IPv4 or IPv6 addresses on which the switch may originate or terminate tunnels.
This column is intended to allow a Manager to determine the Physical_Switch that terminates the tunnel represented by a Physical_Locator.

Identification:

name: string (must be unique within table) Symbolic name for the switch, such as its hostname.
description: string An extended description for the switch, such as its switch login banner.

Error Notification: An entry in this column indicates to the NVC that this switch has encountered a fault. The switch must clear this column when the fault has been cleared.

switch_fault_status : mac_table_exhaustion: none Indicates that the switch has been unable to process MAC entries requested by the NVC due to lack of table resources.
switch_fault_status : tunnel_exhaustion: none Indicates that the switch has been unable to create tunnels requested by the NVC due to lack of resources.
switch_fault_status : unspecified_fault: none Indicates that an error has occurred in the switch but that no more specific information is available.

Tunnel TABLE

A tunnel created by a Physical_Switch.

    Summary:

local
  Physical_Locator
remote
  Physical_Locator
Bidirectional Forwarding Detection (BFD):
 
BFD Local Configuration:
 
bfd_config_local : bfd_dst_mac
  optional string
bfd_config_local : bfd_dst_ip
  optional string
BFD Remote Configuration:
 
bfd_config_remote : bfd_dst_mac
  optional string
bfd_config_remote : bfd_dst_ip
  optional string
BFD Parameters:
 
bfd_params : enable
  optional string, either true or false
bfd_params : min_rx
  optional string, containing an integer, at least 1
bfd_params : min_tx
  optional string, containing an integer, at least 1
bfd_params : decay_min_rx
  optional string, containing an integer
bfd_params : forwarding_if_rx
  optional string, either true or false
bfd_params : cpath_down
  optional string, either true or false
bfd_params : check_tnl_key
  optional string, either true or false
BFD Status:
 
bfd_status : state
  optional string, one of down, init, up, or admin_down
bfd_status : forwarding
  optional string, either true or false
bfd_status : diagnostic
  optional string
bfd_status : remote_state
  optional string, one of down, init, up, or admin_down
bfd_status : remote_diagnostic
  optional string

    Details:

local: Physical_Locator Tunnel end-point local to the physical switch.
remote: Physical_Locator Tunnel end-point remote to the physical switch.
Bidirectional Forwarding Detection (BFD):
BFD, defined in RFC 5880, allows point to point detection of connectivity failures by occasional transmission of BFD control messages. VTEPs are expected to implement BFD.

BFD operates by regularly transmitting BFD control messages at a rate negotiated independently in each direction. Each endpoint specifies the rate at which it expects to receive control messages, and the rate at which it\(cqs willing to transmit them. An endpoint which fails to receive BFD control messages for a period of three times the expected reception rate will signal a connectivity fault. 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.

A hardware VTEP is expected to use BFD to determine reachability of devices at the end of the tunnels with which it exchanges data. This can enable the VTEP to choose a functioning service node among a set of service nodes providing high availability. It also enables the NVC to report the health status of tunnels.

In most cases the BFD peer of a hardware VTEP will be an Open vSwitch instance. The Open vSwitch implementation of BFD aims to comply faithfully with the requirements put forth in RFC 5880. Open vSwitch does not implement the optional Authentication or ‘‘Echo Mode\(cq\(cq features.

BFD Local Configuration:
The HSC writes the key-value pairs in the bfd_config_local column to specifiy the local configurations to be used for BFD sessions on this tunnel.
bfd_config_local : bfd_dst_mac: optional string Set to an Ethernet address in the form xx:xx:xx:xx:xx:xx to set the MAC expected as destination for received BFD packets.
bfd_config_local : bfd_dst_ip: optional string Set to an IPv4 address to set the IP address that is expected as destination for received BFD packets. The default is 169.254.1.0.
  BFD Remote Configuration: The bfd_config_remote column is the remote counterpart of the bfd_config_local column. The NVC writes the key-value pairs in this column.
bfd_config_remote : bfd_dst_mac: optional string Set to an Ethernet address in the form xx:xx:xx:xx:xx:xx to set the destination MAC to be used for transmitted BFD packets. The default is 00:23:20:00:00:01.
bfd_config_remote : bfd_dst_ip: optional string Set to an IPv4 address to set the IP address used as destination for transmitted BFD packets. The default is 169.254.1.1.

BFD Parameters: The NVC sets up key-value pairs in the bfd_params column to enable and configure BFD.

bfd_params : enable: optional string, either true or false True to enable BFD on this tunnel.
bfd_params : min_rx: optional string, containing an integer, at least 1 The shortest interval, in milliseconds, at which this BFD session offers to receive BFD control messages. The remote endpoint may choose to send messages at a slower rate. Defaults to 1000.
bfd_params : min_tx: 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. Messages will actually be transmitted at a slower rate if the remote endpoint is not willing to receive as quickly as specified. Defaults to 100.
bfd_params : decay_min_rx: optional string, containing an integer An alternate receive interval, in milliseconds, that must be greater than or equal to bfd:min_rx. The implementation switches from bfd:min_rx to bfd:decay_min_rx when there is no obvious incoming data traffic at the interface, to reduce the CPU and bandwidth cost of monitoring an idle interface. This feature may be disabled by setting a value of 0. This feature is reset whenever bfd:decay_min_rx or bfd:min_rx changes.
bfd_params : forwarding_if_rx: optional string, either true or false True to consider the interface capable of packet I/O as long as it continues to receive any packets (not just BFD packets). This prevents link congestion that causes consecutive BFD control packets to be lost from marking the interface down.
bfd_params : cpath_down: optional string, either true or false Set to true to notify the remote endpoint that traffic should not be forwarded to this system for some reason other than a connectivty failure on the interface being monitored. The typical underlying reason is ‘‘concatenated path down,\(cq\(cq that is, that connectivity beyond the local system is down. Defaults to false.
bfd_params : check_tnl_key: optional string, either true or false Set to true to make BFD accept only control messages with a tunnel key of zero. By default, BFD accepts control messages with any tunnel key.

BFD Status: The VTEP sets key-value pairs in the bfd_status column to report the status of BFD on this tunnel. When BFD is not enabled, with bfd_params:enable, the HSC clears all key-value pairs from bfd_status.

bfd_status : state: optional string, one of down, init, up, or admin_down Reports the state of the BFD session. The BFD session is fully healthy and negotiated if UP.
bfd_status : forwarding: optional string, either true or false Reports whether the BFD session believes this tunnel may be used to forward traffic. Typically this means the local session is signaling UP, and the remote system isn\(cqt signaling a problem such as concatenated path down.
bfd_status : diagnostic: optional string In case of a problem, set to an error message that reports what the local BFD session thinks is wrong. The error messages are defined in section 4.1 of [RFC 5880].
bfd_status : remote_state: optional string, one of down, init, up, or admin_down Reports the state of the remote endpoint\(cqs BFD session.
bfd_status : remote_diagnostic: optional string In case of a problem, set to an error message that reports what the remote endpoint\(cqs BFD session thinks is wrong. The error messages are defined in section 4.1 of [RFC 5880].

Physical_Port TABLE

A port within a Physical_Switch.

    Summary:

vlan_bindings
  map of integer-Logical_Switch pairs, key in range 0 to 4,095
vlan_stats
  map of integer-Logical_Binding_Stats pairs, key in range 0 to 4,095
Identification:
 
name
  string
description
  string
Error Notification:
 
port_fault_status : invalid_vlan_map
  none
port_fault_status : unspecified_fault
  none

    Details:

vlan_bindings: map of integer-Logical_Switch pairs, key in range 0 to 4,095 Identifies how VLANs on the physical port are bound to logical switches. 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.
vlan_stats: map of integer-Logical_Binding_Stats pairs, key in range 0 to 4,095 Statistics for VLANs bound to logical switches on the physical port. An implementation that fully supports such statistics would populate this column with a mapping for every VLAN that is bound in vlan_bindings. An implementation that does not support such statistics or only partially supports them would not populate this column or partially populate it, respectively.
  Identification:
name: string Symbolic name for the port. The name ought to be unique within a given Physical_Switch, but the database is not capable of enforcing this.
description: string An extended description for the port.

Error Notification: An entry in this column indicates to the NVC that the physical port has encountered a fault. The switch must clear this column when the errror has been cleared.

port_fault_status : invalid_vlan_map: 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.
port_fault_status : unspecified_fault: none Indicates that an error has occurred on the port but that no more specific information is available.

Logical_Binding_Stats TABLE

Reports statistics for the Logical_Switch with which a VLAN on a Physical_Port is associated.

    Summary:

Statistics:
 
packets_from_local
  integer
bytes_from_local
  integer
packets_to_local
  integer
bytes_to_local
  integer

    Details:

Statistics:
These statistics count only packets to which the binding applies.
packets_from_local: integer Number of packets sent by the Physical_Switch.
bytes_from_local: integer Number of bytes in packets sent by the Physical_Switch.
packets_to_local: integer Number of packets received by the Physical_Switch.
bytes_to_local: integer Number of bytes in packets received by the Physical_Switch.

Logical_Switch TABLE

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.

    Summary:

Per Logical-Switch Tunnel Key:
 
tunnel_key
  optional integer
Identification:
 
name
  string (must be unique within table)
description
  string

    Details:

Per Logical-Switch Tunnel Key:
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. We call these generically ‘‘tunnel keys.\(cq\(cq Given that one needs to use a tunnel key at all, there are at least two reasonable ways to assign their values:
o Per Logical_Switch+Physical_Locator pair. That is, each logical switch may be assigned a different tunnel key on every Physical_Locator. This model is especially flexible.
In this model, Physical_Locator carries the tunnel key. Therefore, one Physical_Locator record will exist for each logical switch carried at a given IP destination.
o Per Logical_Switch. That is, every tunnel associated with a particular logical switch carries the same tunnel key, regardless of the Physical_Locator to which the tunnel is addressed. This model may ease switch implementation because it imposes fewer requirements on the hardware datapath.
In this model, Logical_Switch carries the tunnel key. Therefore, one Physical_Locator record will exist for each IP destination.
tunnel_key: optional integer This column is used only in the tunnel key per Logical_Switch model (see above), because only in that model is there a tunnel key associated with a logical switch.
For vxlan_over_ipv4 encapsulation, this column is the VXLAN VNI that identifies a logical switch. It must be in the range 0 to 16,777,215.
  Identification:
name: string (must be unique within table) Symbolic name for the logical switch.
description: string An extended description for the logical switch, such as its switch login banner.

Ucast_Macs_Local TABLE

Mapping of unicast MAC addresses to tunnels (physical locators). This table is written by the HSC, so it contains the MAC addresses that have been learned on physical ports by a VTEP.

    Summary:

MAC string
logical_switch
  Logical_Switch
locator
  Physical_Locator
ipaddr
  string

    Details:

MAC: string A MAC address that has been learned by the VTEP.
logical_switch: Logical_Switch The Logical switch to which this mapping applies.
locator: Physical_Locator The physical locator to be used to reach this MAC address. In this table, the physical locator will be one of the tunnel IP addresses of the appropriate VTEP.
ipaddr: string The IP address to which this MAC corresponds. Optional field for the purpose of ARP supression.

Ucast_Macs_Remote TABLE

Mapping of unicast MAC addresses to tunnels (physical locators). This table is written by the NVC, so it contains the MAC addresses that the NVC has learned. These include VM MAC addresses, in which case the physical locators will be hypervisor IP addresses. 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.

    Summary:

MAC string
logical_switch
  Logical_Switch
locator
  Physical_Locator
ipaddr
  string

    Details:

MAC: string A MAC address that has been learned by the NVC.
logical_switch: Logical_Switch The Logical switch to which this mapping applies.
locator: Physical_Locator The physical locator to be used to reach this MAC address. In this table, the physical locator will be either a hypervisor IP address or a tunnel IP addresses of another VTEP.
ipaddr: string The IP address to which this MAC corresponds. Optional field for the purpose of ARP supression.

Mcast_Macs_Local TABLE

Mapping of multicast MAC addresses to tunnels (physical locators). This table is written by the HSC, so it contains the MAC addresses that have been learned on physical ports by a VTEP. These may be learned by IGMP snooping, for example. This table also specifies how to handle unknown unicast and broadcast packets.

    Summary:

MAC string
logical_switch
  Logical_Switch
locator_set
  Physical_Locator_Set

    Details:

MAC: string A MAC address that has been learned by the VTEP.
The keyword unknown-dst 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 Ucast_Macs_Local (for unicast addresses) or Mcast_Macs_Local (for multicast addresses) should be sent.
logical_switch: Logical_Switch The Logical switch to which this mapping applies.
locator_set: Physical_Locator_Set The physical locator set to be used to reach this MAC address. In this table, the physical locator set will be contain one or more tunnel IP addresses of the appropriate VTEP(s).

Mcast_Macs_Remote TABLE

Mapping of multicast MAC addresses to tunnels (physical locators). This table is written by the NVC, so it contains the MAC addresses that the NVC has learned. This table also specifies how to handle unknown unicast and broadcast packets.

Multicast packet replication may be handled by a service node, in which case the physical locators will be IP addresses of service nodes. If the VTEP supports replication onto multiple tunnels, then this may be used to replicate directly onto VTEP-hyperisor tunnels.

    Summary:

MAC string
logical_switch
  Logical_Switch
locator_set
  Physical_Locator_Set
ipaddr
  string

    Details:

MAC: string A MAC address that has been learned by the NVC.
The keyword unknown-dst 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 Ucast_Macs_Remote (for unicast addresses) or Mcast_Macs_Remote (for multicast addresses) should be sent.
logical_switch: Logical_Switch The Logical switch to which this mapping applies.
locator_set: Physical_Locator_Set The physical locator set to be used to reach this MAC address. In this table, the physical locator set will be either a service node IP address or a set of tunnel IP addresses of hypervisors (and potentially other VTEPs).
ipaddr: string The IP address to which this MAC corresponds. Optional field for the purpose of ARP supression.

Logical_Router TABLE

A logical router, or VRF. A logical router may be connected to one or more logical switches. Subnet addresses and interface addresses may be configured on the interfaces.

    Summary:

switch_binding
  map of string-Logical_Switch pairs
static_routes
  map of string-string pairs
Identification:
 
name
  string (must be unique within table)
description
  string

    Details:

switch_binding: map of string-Logical_Switch pairs Maps from an IPv4 or IPv6 address prefix in CIDR notation to a logical switch. Multiple prefixes may map to the same switch. 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. For example, 192.68.1.1/24 creates a /24 subnet for the logical switch attached to the interface and assigns the address 192.68.1.1 to the router interface.
static_routes: map of string-string pairs One or more static routes, mapping IP prefixes to next hop IP addresses.
  Identification:
name: string (must be unique within table) Symbolic name for the logical router.
description: string An extended description for the logical router.

Arp_Sources_Local TABLE

MAC address to be used when a VTEP issues ARP requests on behalf of a logical router.

A distributed logical router is implemented by a set of VTEPs (both hardware VTEPs and vswitches). 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. A single per-VTEP MAC can be re-used across all logical networks. This table contains the MACs that are used by the VTEPs of a given HSC. 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.

    Summary:

src_mac
  string
locator
  Physical_Locator

    Details:

src_mac: string The source MAC to be used by a given VTEP.
locator: Physical_Locator The Physical_Locator to use for replies to ARP requests from this MAC address.

Arp_Sources_Remote TABLE

MAC address to be used when a remote VTEP issues ARP requests on behalf of a logical router.

This table is the remote counterpart of Arp_sources_local. 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.

    Summary:

src_mac
  string
locator
  Physical_Locator

    Details:

src_mac: string The source MAC to be used by a given VTEP.
locator: Physical_Locator The Physical_Locator to use for replies to ARP requests from this MAC address.

Physical_Locator_Set TABLE

A set of one or more Physical_Locators.

This table exists only because OVSDB does not have a way to express the type ‘‘map from string to one or more Physical_Locator records.\(cq\(cq

    Summary:

locators
  immutable set of 1 or more Physical_Locators

    Details:

locators: immutable set of 1 or more Physical_Locators

Physical_Locator TABLE

Identifies an endpoint to which logical switch traffic may be encapsulated and forwarded.

For the vxlan_over_ipv4 encapsulation, the only encapsulation defined so far, all endpoints associated with a given Logical_Switch must use a common tunnel key, which is carried in the tunnel_key column of Logical_Switch.

For some encapsulations yet to be defined, we expect Physical_Locator to identify both an endpoint and a tunnel key. When the first such encapsulation is defined, we expect to add a ‘‘tunnel_key\(cq\(cq column to Physical_Locator to allow the tunnel key to be defined.

See the ‘‘Per Logical-Switch Tunnel Key\(cq\(cq section in the Logical_Switch table for further discussion of the model.

    Summary:

encapsulation_type
  immutable string, must be vxlan_over_ipv4
dst_ip
  immutable string

    Details:

encapsulation_type: immutable string, must be vxlan_over_ipv4 The type of tunneling encapsulation.
dst_ip: immutable string For vxlan_over_ipv4 encapsulation, the IPv4 address of the VXLAN tunnel endpoint.
We expect that this column could be used for IPv4 or IPv6 addresses in encapsulations to be introduced later.
Search for    or go to Top of page |  Section 5 |  Main Index


Open vSwitch 2.3.2 VTEP (5) DB Schema 1.3.0

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.