1Local_Config(5) Open vSwitch Manual Local_Config(5)
2
6 Local_Config - Local_Config database schema
7 This database is for local configuration of an ovsdb-server. The data‐
9 base is meant to be unique, even among multiple clustered db servers,
10 so that configuration that is local to that server can be configured
11 separately (e.g. Connection information).
12
14 The following list summarizes the purpose of each of the tables in the
15 Local_Config database. Each table is described in more detail on a
16 later page.
17 Table Purpose
19 Config ovsdb-server configuration
20 Connection
21 OVSDB client connections.
22
24 The root local configuration table for an ovsdb-server. This table must
25 have exactly one row.
26 Summary:
28 Connection Options:
29 connections set of Connections
30 Details:
32 Connection Options:
33 connections: set of Connections
35 Database clients to which the Open vSwitch database server
36 should connect or on which it should listen, along with options
37 for how these connections should be configured. See the Connec‐
38 tion table for more information.
39
41 Configuration for a database connection to an Open vSwitch database
42 (OVSDB) client.
43 This table primarily configures the Open vSwitch database server
45 (ovsdb-server).
46 The Open vSwitch database server can initiate and maintain active con‐
48 nections to remote clients. It can also listen for database connec‐
49 tions.
50 Summary:
52 Core Features:
53 target string (must be unique within table)
54 read_only boolean
55 role string
56 Client Failure Detection and Handling:
57 max_backoff optional integer, at least 1,000
58 inactivity_probe optional integer
59 Status:
60 is_connected boolean
61 status : last_error optional string
62 status : state optional string, one of ACTIVE, BACKOFF,
63 CONNECTING, IDLE, or VOID
64 status : sec_since_connect optional string, containing an integer,
65 at least 0
66 status : sec_since_disconnect
67 optional string, containing an integer,
68 at least 0
69 status : locks_held optional string
70 status : locks_waiting optional string
71 status : locks_lost optional string
72 status : n_connections optional string, containing an integer,
73 at least 2
74 status : bound_port optional string, containing an integer
75 Connection Parameters:
76 other_config : dscp optional string, containing an integer
77 Configuration:
78 external_ids map of string-string pairs
79 Details:
81 Core Features:
82 target: string (must be unique within table)
84 Connection methods for clients.
85 The following connection methods are currently supported:
87 ssl:host[:port]
89 The specified SSL port on the host at the given host,
90 which can either be a DNS name (if built with unbound li‐
91 brary) or an IP address. A valid SSL configuration must
92 be provided when this form is used, this configuration
93 can be specified via command-line options or the SSL ta‐
94 ble.
95 If port is not specified, it defaults to 6640.
97 SSL support is an optional feature that is not always
99 built as part of Open vSwitch.
100 tcp:host[:port]
102 The specified TCP port on the host at the given host,
103 which can either be a DNS name (if built with unbound li‐
104 brary) or an IP address. If host is an IPv6 address, wrap
105 it in square brackets, e.g. tcp:[::1]:6640.
106 If port is not specified, it defaults to 6640.
108 pssl:[port][:host]
110 Listens for SSL connections on the specified TCP port.
111 Specify 0 for port to have the kernel automatically
112 choose an available port. If host, which can either be a
113 DNS name (if built with unbound library) or an IP ad‐
114 dress, is specified, then connections are restricted to
115 the resolved or specified local IPaddress (either IPv4 or
116 IPv6 address). If host is an IPv6 address, wrap in square
117 brackets, e.g. pssl:6640:[::1]. If host is not specified
118 then it listens only on IPv4 (but not IPv6) addresses. A
119 valid SSL configuration must be provided when this form
120 is used, this can be specified either via command-line
121 options or the SSL table.
122 If port is not specified, it defaults to 6640.
124 SSL support is an optional feature that is not always
126 built as part of Open vSwitch.
127 ptcp:[port][:host]
129 Listens for connections on the specified TCP port. Spec‐
130 ify 0 for port to have the kernel automatically choose an
131 available port. If host, which can either be a DNS name
132 (if built with unbound library) or an IP address, is
133 specified, then connections are restricted to the re‐
134 solved or specified local IP address (either IPv4 or IPv6
135 address). If host is an IPv6 address, wrap it in square
136 brackets, e.g. ptcp:6640:[::1]. If host is not specified
137 then it listens only on IPv4 addresses.
138 If port is not specified, it defaults to 6640.
140 When multiple clients are configured, the target values must be
142 unique. Duplicate target values yield unspecified results.
143 read_only: boolean
145 true to restrict these connections to read-only transactions,
146 false to allow them to modify the database.
147 role: string
149 String containing role name for this connection entry.
150 Client Failure Detection and Handling:
152 max_backoff: optional integer, at least 1,000
154 Maximum number of milliseconds to wait between connection at‐
155 tempts. Default is implementation-specific.
156 inactivity_probe: optional integer
158 Maximum number of milliseconds of idle time on connection to the
159 client before sending an inactivity probe message. If Open
160 vSwitch does not communicate with the client for the specified
161 number of seconds, it will send a probe. If a response is not
162 received for the same additional amount of time, Open vSwitch
163 assumes the connection has been broken and attempts to recon‐
164 nect. Default is implementation-specific. A value of 0 disables
165 inactivity probes.
166 Status:
168 Key-value pair of is_connected is always updated. Other key-value pairs
170 in the status columns may be updated depends on the target type.
171 When target specifies a connection method that listens for inbound con‐
173 nections (e.g. ptcp: or punix:), both n_connections and is_connected
174 may also be updated while the remaining key-value pairs are omitted.
175 On the other hand, when target specifies an outbound connection, all
177 key-value pairs may be updated, except the above-mentioned two key-
178 value pairs associated with inbound connection targets. They are omit‐
179 ted.
180 is_connected: boolean
182 true if currently connected to this client, false otherwise.
183 status : last_error: optional string
185 A human-readable description of the last error on the connection
186 to the manager; i.e. strerror(errno). This key will exist only
187 if an error has occurred.
188 status : state: optional string, one of ACTIVE, BACKOFF, CONNECTING,
190 IDLE, or VOID
191 The state of the connection to the manager:
192 VOID Connection is disabled.
194 BACKOFF
196 Attempting to reconnect at an increasing period.
197 CONNECTING
199 Attempting to connect.
200 ACTIVE Connected, remote host responsive.
202 IDLE Connection is idle. Waiting for response to keep-alive.
204 These values may change in the future. They are provided only
206 for human consumption.
207 status : sec_since_connect: optional string, containing an integer, at
209 least 0
210 The amount of time since this client last successfully connected
211 to the database (in seconds). Value is empty if client has never
212 successfully been connected.
213 status : sec_since_disconnect: optional string, containing an integer,
215 at least 0
216 The amount of time since this client last disconnected from the
217 database (in seconds). Value is empty if client has never dis‐
218 connected.
219 status : locks_held: optional string
221 Space-separated list of the names of OVSDB locks that the con‐
222 nection holds. Omitted if the connection does not hold any
223 locks.
224 status : locks_waiting: optional string
226 Space-separated list of the names of OVSDB locks that the con‐
227 nection is currently waiting to acquire. Omitted if the connec‐
228 tion is not waiting for any locks.
229 status : locks_lost: optional string
231 Space-separated list of the names of OVSDB locks that the con‐
232 nection has had stolen by another OVSDB client. Omitted if no
233 locks have been stolen from this connection.
234 status : n_connections: optional string, containing an integer, at
236 least 2
237 When target specifies a connection method that listens for in‐
238 bound connections (e.g. ptcp: or pssl:) and more than one con‐
239 nection is actually active, the value is the number of active
240 connections. Otherwise, this key-value pair is omitted.
241 status : bound_port: optional string, containing an integer
243 When target is ptcp: or pssl:, this is the TCP port on which the
244 OVSDB server is listening. (This is particularly useful when
245 target specifies a port of 0, allowing the kernel to choose any
246 available port.)
247 Connection Parameters:
249 other_config : dscp: optional string, containing an integer
251 The Differentiated Service Code Point (DSCP) is specified using
252 6 bits in the Type of Service (TOS) field in the IP header. DSCP
253 provides a mechanism to classify the network traffic and provide
254 Quality of Service (QoS) on IP networks. The DSCP value speci‐
255 fied here is used when establishing the connection between the
256 manager and the Open vSwitch. If no value is specified, a de‐
257 fault value of 48 is chosen. Valid DSCP values must be in the
258 range 0 to 63.
259 Configuration:
261 External configuration options
263 external_ids: map of string-string pairs
265 External client-defined key-value pairs
266Open vSwitch 3.1.1 DB Schema 1.0.0 Local_Config(5)