7 This chapter describes how to use :abbr:`VNC (Virtual Network Control)`
8 services, including :abbr:`NVA (Network Virtualization Authority)` and
9 :abbr:`VNC-GW (VNC Gateway)` functions. Background information on NVAs,
10 :abbr:`NVE (Network Virtualization Edge)` s, :abbr:`UN (Underlay Network)` s,
11 and :abbr:`VN (Virtual Network)` is available from the
12 `IETF <https://datatracker.ietf.org/wg/nvo3>`_. :abbr:`VNC-GW (VNC Gateway)` s
13 support the import/export of routing information between VNC and :abbr:`CE
14 (customer edge)` routers operating within a VN. Both IP/Layer 3 (L3) VNs, and
15 IP with Ethernet/Layer 2 (L2) VNs are supported.
17 BGP, with IP VPNs and Tunnel Encapsulation, is used to distribute VN
18 information between NVAs. BGP based IP VPN support is defined in :rfc:`4364`,
19 and :rfc:`4659`. Encapsulation information is provided via the Tunnel
20 Encapsulation Attribute, :rfc:`5512`.
22 The protocol that is used to communicate routing and Ethernet / Layer 2 (L2)
23 forwarding information between NVAs and NVEs is referred to as the Remote
24 Forwarder Protocol (RFP). `OpenFlow` is an example RFP. Specific RFP
25 implementations may choose to implement either a `hard-state` or `soft-state`
26 prefix and address registration model. To support a `soft-state` refresh model,
27 a `lifetime` in seconds is associated with all registrations and responses.
29 The chapter also provides sample configurations for basic example scenarios.
36 Virtual Network Control (:abbr:`VNC`) service configuration commands appear in
37 the `router bgp` section of the BGPD configuration file
38 (:ref:`bgp-configuration-examples`). The commands are broken down into the
41 - :dfn:`General VNC` configuration applies to general VNC operation and is
42 primarily used to control the method used to advertise tunnel information.
44 - :dfn:`Remote Forwarder Protocol (RFP)` configuration relates to the protocol
45 used between NVAs and NVEs.
47 - :dfn:`VNC Defaults` provides default parameters for registered NVEs.
49 - :dfn:`VNC NVE Group` provides for configuration of a specific set of
50 registered NVEs and overrides default parameters.
52 - :dfn:`Redistribution` and :dfn:`Export` control VNC-GW operation, i.e., the
53 import/export of routing information between VNC and customer edge routers
54 (:abbr:`CE` s) operating within a VN.
57 .. _general-vnc-configuration:
59 General VNC Configuration
60 -------------------------
62 .. _rfp-related-configuration:
64 RFP Related Configuration
65 -------------------------
67 The protocol that is used to communicate routing and Ethernet / L2 forwarding
68 information between NVAs and NVEs is referred to as the Remote Forwarder
69 Protocol (RFP). Currently, only a simple example RFP is included in FRR.
70 Developers may use this example as a starting point to integrate FRR with an
71 RFP of their choosing, e.g., `OpenFlow`. The example code includes the
72 following sample configuration:
74 .. clicmd:: rfp example-config-value VALUE
76 This is a simple example configuration parameter included as part of the RFP
77 example code. VALUE must be in the range of 0 to 4294967295.
79 .. _vnc-defaults-configuration:
81 VNC Defaults Configuration
82 --------------------------
84 The VNC Defaults section allows the user to specify default values for
85 configuration parameters for all registered NVEs.
86 Default values are overridden by :ref:`vnc-nve-group-configuration`.
88 .. clicmd:: vnc defaults
90 Enter VNC configuration mode for specifying VNC default behaviors. Use
91 `exit-vnc` to leave VNC configuration mode. `vnc defaults` is optional.
96 ... various VNC defaults
100 These are the statements that can appear between ``vnc defaults`` and
101 ``exit-vnc``. Documentation for these statements is given in
102 :ref:`vnc-nve-group-configuration`.
104 - :clicmd:`rt import RT-LIST`
105 - :clicmd:`rt export RT-LIST`
106 - :clicmd:`rt both RT-LIST`
107 - :clicmd:`rd ROUTE-DISTINGUISHER`
108 - :clicmd:`l2rd NVE-ID-VALUE`
109 - :clicmd:`response-lifetime LIFETIME|infinite`
110 - :clicmd:`export bgp|zebra route-map MAP-NAME`
111 - :clicmd:`export bgp|zebra no route-map`
115 Exit VNC configuration mode.
117 .. _vnc-nve-group-configuration:
119 VNC NVE Group Configuration
120 ---------------------------
122 A NVE Group corresponds to a specific set of NVEs. A Client NVE is
123 assigned to an NVE Group based on whether there is a match for either
124 its virtual or underlay network address against the VN and/or UN address
125 prefixes specified in the NVE Group definition. When an NVE Group
126 definition specifies both VN and UN address prefixes, then an NVE must
127 match both prefixes in order to be assigned to the NVE Group. In the
128 event that multiple NVE Groups match based on VN and/or UN addresses,
129 the NVE is assigned to the first NVE Group listed in the configuration.
130 If an NVE is not assigned to an NVE Group, its messages will be ignored.
132 Configuration values specified for an NVE group apply to all
133 member NVEs and override configuration values specified in the VNC
136 **At least one `nve-group` is mandatory for useful VNC operation.**
138 .. clicmd:: vnc nve-group NAME
140 Enter VNC configuration mode for defining the NVE group `name`.
141 Use `exit` or `exit-vnc` to exit group configuration mode.
146 ... configuration commands
150 The following statements are valid in an NVE group definition:
152 .. clicmd:: l2rd NVE-ID-VALUE
154 Set the value used to distinguish NVEs connected to the same physical
155 Ethernet segment (i.e., at the same location) [#]_.
157 The nve-id subfield may be specified as either a literal value in the range
158 1-255, or it may be specified as `auto:vn`, which means to use the
159 least-significant octet of the originating NVE's VN address.
161 .. clicmd:: prefix vn|un A.B.C.D/M|X:X::X:X/M
163 Specify the matching prefix for this NVE group by either virtual-network
164 address (`vn`) or underlay-network address (`un`). Either or both
165 virtual-network and underlay-network prefixes may be specified. Subsequent
166 virtual-network or underlay-network values within a `vnc nve-group`
167 `exit-vnc` block override their respective previous values.
169 These prefixes are used only for determining assignments of NVEs to NVE
172 .. clicmd:: rd ROUTE-DISTINGUISHER
174 Specify the route distinguisher for routes advertised via BGP
175 VPNs. The route distinguisher must be in one of these forms:
177 - ``IPv4-address:two-byte-integer``
178 - ``four-byte-autonomous-system-number:two-byte-integer``
179 - ``two-byte-autonomous-system-number:four-byte-integer``
180 - ``auto:vn:two-byte-integer``
182 Routes originated by NVEs in the NVE group will use the group's specified
183 `route-distinguisher` when they are advertised via BGP. If the `auto` form
184 is specified, it means that a matching NVE has its RD set to
185 ``rd_type=IP=1:IPv4-address=VN-address:two-byte-integer``, for IPv4 VN
187 ``rd_type=IP=1:IPv4-address=Last-four-bytes-of-VN-address:two-byte-integer``,
188 for IPv6 VN addresses.
190 If the NVE group definition does not specify a `route-distinguisher`, then
191 the default `route-distinguisher` is used. If neither a group nor a default
192 `route-distinguisher` is configured, then the advertised RD is set to
193 ``two-byte-autonomous-system-number=0:four-byte-integer=0``.
195 .. clicmd:: response-lifetime LIFETIME|infinite
197 Specify the response lifetime, in seconds, to be included in RFP response
198 messages sent to NVEs. If the value 'infinite' is given, an infinite
199 lifetime will be used.
201 Note that this parameter is not the same as the lifetime supplied by NVEs in
202 RFP registration messages. This parameter does not affect the lifetime value
203 attached to routes sent by this server via BGP.
205 If the NVE group definition does not specify a `response-lifetime`, the
206 default `response-lifetime` will be used. If neither a group nor a default
207 `response-lifetime` is configured, the value 3600 will be used. The maximum
208 response lifetime is 2147483647.
210 .. clicmd:: rt export RT-LIST
212 .. clicmd:: rt import RT-LIST
214 .. clicmd:: rt both RT-LIST
216 Specify route target import and export lists. `rt-list` is a
217 space-separated list of route targets, each element of which is
218 in one of the following forms:
220 - ``IPv4-address:two-byte-integer``
221 - ``four-byte-autonomous-system-number:two-byte-integer``
222 - ``two-byte-autonomous-system-number:four-byte-integer``
224 The first form, `rt export`, specifies an `export rt-list`. The `export
225 rt-list` will be attached to routes originated by NVEs in the NVE group
226 when they are advertised via BGP. If the NVE group definition does not
227 specify an `export rt-list`, then the default `export rt-list` is used.
228 If neither a group nor a default `export rt-list` is configured, then no
229 RT list will be sent; in turn, these routes will probably not be
230 processed by receiving NVAs.
232 The second form, `rt import` specifies an `import rt-list`, which is a
233 filter for incoming routes. In order to be made available to NVEs in the
234 group, incoming BGP VPN routes must have RT lists that have at least one
235 route target in common with the group's `import rt-list`.
237 If the NVE group definition does not specify an import filter, then the
238 default `import rt-list` is used. If neither a group nor a default
239 `import rt-list` is configured, there can be no RT intersections when
240 receiving BGP routes and therefore no incoming BGP routes will be
241 processed for the group.
243 The third, `rt both`, is a shorthand way of specifying both lists
244 simultaneously, and is equivalent to `rt export `rt-list`` followed by
245 `rt import `rt-list``.
247 .. clicmd:: export bgp|zebra route-map MAP-NAME
249 Specify that the named route-map should be applied to routes being exported
250 to bgp or zebra. This parameter is used in conjunction with
251 :ref:`configuring-export-of-routes-to-other-routing-protocols`. This item
254 .. clicmd:: export bgp|zebra no route-map
256 Specify that no route-map should be applied to routes being exported to bgp
257 or zebra. This parameter is used in conjunction with
258 :ref:`configuring-export-of-routes-to-other-routing-protocols`. This item
261 .. clicmd:: export bgp|zebra ipv4|ipv6 prefix-list LIST-NAME
263 Specify that the named prefix-list filter should be applied to routes being
264 exported to bgp or zebra. Prefix-lists for ipv4 and ipv6 are independent of
265 each other. This parameter is used in conjunction with
266 :ref:`configuring-export-of-routes-to-other-routing-protocols`. This item
269 .. clicmd:: export bgp|zebra no ipv4|ipv6 prefix-list
271 Specify that no prefix-list filter should be applied to routes being
272 exported to bgp or zebra. This parameter is used in conjunction with
273 :ref:`configuring-export-of-routes-to-other-routing-protocols`. This item
276 .. _vnc-l2-group-configuration:
278 VNC L2 Group Configuration
279 --------------------------
281 The route targets advertised with prefixes and addresses registered by an NVE
282 are determined based on the NVE's associated VNC NVE Group Configuration,
283 :ref:`vnc-nve-group-configuration`. Layer 2 (L2) Groups are used to override
284 the route targets for an NVE's Ethernet registrations based on the Logical
285 Network Identifier and label value. A Logical Network Identifier is used to
286 uniquely identify a logical Ethernet segment and is conceptually similar to the
287 Ethernet Segment Identifier defined in :rfc:`7432`. Both the Logical Network
288 Identifier and Label are passed to VNC via RFP prefix and address registration.
290 Note that a corresponding NVE group configuration must be present, and that
291 other NVE associated configuration information, notably RD, is not impacted by
292 L2 Group Configuration.
294 .. clicmd:: vnc l2-group NAME
296 Enter VNC configuration mode for defining the L2 group `name`.
297 Use `exit` or `exit-vnc` to exit group configuration mode.
302 ... configuration commands
307 Delete the L2 group named `name`.
309 The following statements are valid in a L2 group definition:
311 .. clicmd:: logical-network-id VALUE
313 Define the Logical Network Identifier with a value in the range of
314 0-4294967295 that identifies the logical Ethernet segment.
316 .. clicmd:: labels LABEL-LIST
319 Add or remove labels associated with the group. `label-list` is a
320 space separated list of label values in the range of 0-1048575.
322 .. clicmd:: rt import RT-TARGET
324 .. clicmd:: rt export RT-TARGET
326 .. clicmd:: rt both RT-TARGET
328 Specify the route target import and export value associated with the group.
329 A complete definition of these parameters is given above,
330 :ref:`vnc-nve-group-configuration`.
332 .. _configuring-redistribution-of-routes-from-other-routing-protocols:
334 Configuring Redistribution of Routes from Other Routing Protocols
335 -----------------------------------------------------------------
337 Routes from other protocols (including BGP) can be provided to VNC (both for
338 RFP and for redistribution via BGP) from three sources: the zebra kernel
339 routing process; directly from the main (default) unicast BGP RIB; or directly
340 from a designated BGP unicast exterior routing RIB instance.
342 The protocol named in the `vnc redistribute` command indicates the route
343 source: `bgp-direct` routes come directly from the main (default) unicast BGP
344 RIB and are available for RFP and are redistributed via BGP;
345 `bgp-direct-to-nve-groups` routes come directly from a designated BGP unicast
346 routing RIB and are made available only to RFP; and routes from other protocols
347 come from the zebra kernel routing process.
348 Note that the zebra process does not need to be active if
349 only `bgp-direct` or `bgp-direct-to-nve-groups` routes are used.
354 Routes originating from protocols other than BGP must be obtained
355 via the zebra routing process.
356 Redistribution of these routes into VNC does not support policy mechanisms
357 such as prefix-lists or route-maps.
362 `bgp-direct` redistribution supports policy via
363 prefix lists and route-maps. This policy is applied to incoming
364 original unicast routes before the redistribution translations
365 (described below) are performed.
367 Redistribution of `bgp-direct` routes is performed in one of three
368 possible modes: `plain`, `nve-group`, or `resolve-nve`.
369 The default mode is `plain`.
370 These modes indicate the kind of translations applied to routes before
371 they are added to the VNC RIB.
373 In `plain` mode, the route's next hop is unchanged and the RD is set
374 based on the next hop.
375 For `bgp-direct` redistribution, the following translations are performed:
377 - The VN address is set to the original unicast route's next hop address.
378 - The UN address is NOT set. (VN->UN mapping will occur via
379 ENCAP route or attribute, based on `vnc advertise-un-method`
380 setting, generated by the RFP registration of the actual NVE)
381 - The RD is set to as if auto:vn:0 were specified (i.e.,
382 `rd_type=IP=1`:`IPv4-address=VN-address`:`two-byte-integer=0`)
383 - The RT list is included in the extended community list copied from the
384 original unicast route (i.e., it must be set in the original unicast route).
386 In `nve-group` mode, routes are registered with VNC as if they came from an NVE
387 in the nve-group designated in the `vnc redistribute nve-group` command. The
388 following translations are performed:
390 - The next hop/VN address is set to the VN prefix configured for the
391 redistribute nve-group.
392 - The UN address is set to the UN prefix configured for the redistribute
394 - The RD is set to the RD configured for the redistribute nve-group.
395 - The RT list is set to the RT list configured for the redistribute nve-group.
396 If `bgp-direct` routes are being redistributed, any extended communities
397 present in the original unicast route will also be included.
399 In `resolve-nve` mode, the next hop of the original BGP route is typically the
400 address of an NVE connected router (CE) connected by one or more NVEs.
401 Each of the connected NVEs will register, via RFP, a VNC host route to the CE.
402 This mode may be though of as a mechanism to proxy RFP registrations of BGP
403 unicast routes on behalf of registering NVEs.
405 Multiple copies of the BGP route, one per matching NVE host route, will be
406 added to VNC. In other words, for a given BGP unicast route, each instance of
407 a RFP-registered host route to the unicast route's next hop will result in an
408 instance of an imported VNC route. Each such imported VNC route will have a
409 prefix equal to the original BGP unicast route's prefix, and a next hop equal
410 to the next hop of the matching RFP-registered host route. If there is no
411 RFP-registered host route to the next hop of the BGP unicast route, no
412 corresponding VNC route will be imported.
414 The following translations are applied:
416 - The Next Hop is set to the next hop of the NVE route (i.e., the
417 VN address of the NVE).
419 - The extended community list in the new route is set to the
422 - Any extended communities in the original BGP route
424 - Any extended communities in the NVE route
425 - An added route-origin extended community with the next hop of the
427 is added to the new route.
428 The value of the local administrator field defaults 5226 but may
429 be configured by the user via the `roo-ec-local-admin` parameter.
431 - The Tunnel Encapsulation attribute is set to the value of the Tunnel
432 Encapsulation attribute of the NVE route, if any.
435 bgp-direct-to-nve-groups routes
436 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
438 Unicast routes from the main or a designated instance of BGP may be
439 redistributed to VNC as bgp-direct-to-nve-groups routes. These routes are NOT
440 announced via BGP, but they are made available for local RFP lookup in response
441 to queries from NVEs.
443 A non-main/default BGP instance is configured using the
444 `router bgp AS view NAME` command as described elsewhere in this document.
446 In order for a route in the unicast BGP RIB to be made available to a querying
447 NVE, there must already be, available to that NVE, an (interior) VNC route
448 matching the next hop address of the unicast route. When the unicast route is
449 provided to the NVE, its next hop is replaced by the next hop of the
450 corresponding NVE. If there are multiple longest-prefix-match VNC routes, the
451 unicast route will be replicated for each.
453 There is currently no policy (prefix-list or route-map) support for
454 `bgp-direct-to-nve-groups` routes.
456 Redistribution Command Syntax
457 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
459 .. clicmd:: vnc redistribute ipv4|ipv6 bgp|bgp-direct|ipv6 bgp-direct-to-nve-groups|connected|kernel|ospf|rip|static
461 .. clicmd:: vnc redistribute ipv4|ipv6 bgp-direct-to-nve-groups view VIEWNAME
464 Import (or do not import) prefixes from another routing protocols. Specify
465 both the address family to import (`ipv4` or `ipv6`) and the protocol
466 (`bgp`, `bgp-direct`, `bgp-direct-to-nve-groups`, `connected`, `kernel`,
467 `ospf`, `rip`, or `static`). Repeat this statement as needed for each
468 combination of address family and routing protocol. Prefixes from protocol
469 `bgp-direct` are imported from unicast BGP in the same bgpd process.
470 Prefixes from all other protocols (including `bgp`) are imported via the
471 `zebra` kernel routing process.
473 .. clicmd:: vnc redistribute mode plain|nve-group|resolve-nve
475 Redistribute routes from other protocols into VNC using the specified mode.
476 Not all combinations of modes and protocols are supported.
478 .. clicmd:: vnc redistribute nve-group GROUP-NAME
481 When using `nve-group` mode, assign (or do not assign) the NVE group
482 `group-name` to routes redistributed from another routing protocol.
483 `group-name` must be configured using `vnc nve-group`.
485 The VN and UN prefixes of the nve-group must both be configured, and each
486 prefix must be specified as a full-length (/32 for IPv4, /128 for IPv6)
489 .. clicmd:: vnc redistribute lifetime LIFETIME|infinite
491 Assign a registration lifetime, either `lifetime` seconds or `infinite`, to
492 prefixes redistributed from other routing protocols as if they had been
493 received via RFP registration messages from an NVE. `lifetime` can be any
494 integer between 1 and 4294967295, inclusive.
496 .. clicmd:: vnc redistribute resolve-nve roo-ec-local-admin 0-65536
498 Assign a value to the local-administrator subfield used in the
499 Route Origin extended community that is assigned to routes exported
500 under the `resolve-nve` mode. The default value is `5226`.
502 The following four `prefix-list` and `route-map` commands may be specified
503 in the context of an nve-group or not. If they are specified in the context
504 of an nve-group, they apply only if the redistribution mode is `nve-group`,
505 and then only for routes being redistributed from `bgp-direct`. If they are
506 specified outside the context of an nve-group, then they apply only for
507 redistribution modes `plain` and `resolve-nve`, and then only for routes
508 being redistributed from `bgp-direct`.
510 .. clicmd:: vnc redistribute bgp-direct (ipv4|ipv6) prefix-list LIST-NAME
512 When redistributing `bgp-direct` routes,
513 specifies that the named prefix-list should be applied.
515 .. clicmd:: vnc redistribute bgp-direct no (ipv4|ipv6) prefix-list
517 When redistributing `bgp-direct` routes,
518 specifies that no prefix-list should be applied.
520 .. clicmd:: vnc redistribute bgp-direct route-map MAP-NAME
522 When redistributing `bgp-direct` routes,
523 specifies that the named route-map should be applied.
525 .. clicmd:: vnc redistribute bgp-direct no route-map
527 When redistributing `bgp-direct` routes,
528 specifies that no route-map should be applied.
530 .. _configuring-export-of-routes-to-other-routing-protocols:
532 Configuring Export of Routes to Other Routing Protocols
533 -------------------------------------------------------
535 Routes from VNC (both for RFP and for redistribution via BGP) can be provided
536 to other protocols, either via zebra or directly to BGP.
538 It is important to note that when exporting routes to other protocols, the
539 downstream protocol must also be configured to import the routes. For example,
540 when VNC routes are exported to unicast BGP, the BGP configuration must include
541 a corresponding `redistribute vnc-direct` statement.
543 .. clicmd:: export bgp|zebra mode none|group-nve|registering-nve|ce
545 Specify how routes should be exported to bgp or zebra. If the mode is
546 `none`, routes are not exported. If the mode is `group-nve`, routes are
547 exported according to nve-group or vrf-policy group configuration
548 (:ref:`vnc-nve-group-configuration`): if a group is configured to allow
549 export, then each prefix visible to the group is exported with next hops set
550 to the currently-registered NVEs. If the mode is `registering-nve`, then all
551 VNC routes are exported with their original next hops. If the mode is `ce`,
552 only VNC routes that have an NVE connected CE Router encoded in a Route
553 Origin Extended Community are exported. This extended community must have an
554 administrative value that matches the configured `roo-ec-local-admin` value.
555 The next hop of the exported route is set to the encoded NVE connected CE
558 The default for both bgp and zebra is mode `none`.
560 .. clicmd:: vnc export bgp|zebra group-nve group GROUP-NAME
562 .. clicmd:: vnc export bgp|zebra group-nve no group GROUP-NAME
564 When export mode is `group-nve`, export (or do not export) prefixes from the
565 specified nve-group or vrf-policy group to unicast BGP or to zebra. Repeat
566 this statement as needed for each nve-group to be exported. Each VNC prefix
567 that is exported will result in N exported routes to the prefix, each with a
568 next hop corresponding to one of the N NVEs currently associated with the
571 Some commands have a special meaning under certain export modes.
573 :clicmd:`export bgp|zebra ipv4|ipv6 prefix-list LIST-NAME`
574 When export mode is `ce` or `registering-nve`,
575 specifies that the named prefix-list should be applied to routes
576 being exported to bgp or zebra.
577 Prefix-lists for ipv4 and ipv6 are independent of each other.
579 :clicmd:`export bgp|zebra no ipv4|ipv6 prefix-list`
580 When export mode is `ce` or `registering-nve`,
581 specifies that no prefix-list should be applied to routes
582 being exported to bgp or zebra.
584 :clicmd:`export bgp|zebra route-map MAP-NAME`
585 When export mode is `ce` or `registering-nve`, specifies that the named
586 route-map should be applied to routes being exported to bgp or zebra.
588 :clicmd:`export bgp|zebra no route-map`
589 When export mode is `ce` or `registering-nve`, specifies that no route-map
590 should be applied to routes being exported to bgp or zebra.
592 When the export mode is `group-nve`, policy for exported routes is specified
593 per-NVE-group or vrf-policy group inside a `nve-group` `RFG-NAME` block via
594 the following commands(:ref:`vnc-nve-group-configuration`):
596 :clicmd:`export bgp|zebra route-map MAP-NAME`
597 This command is valid inside a `nve-group` `RFG-NAME` block. It specifies
598 that the named route-map should be applied to routes being exported to bgp
601 :clicmd:`export bgp|zebra no route-map`
602 This command is valid inside a `nve-group` `RFG-NAME` block. It specifies
603 that no route-map should be applied to routes being exported to bgp or
606 :clicmd:`export bgp|zebra ipv4|ipv6 prefix-list LIST-NAME`
607 This command is valid inside a `nve-group` `RFG-NAME` block. It specifies
608 that the named prefix-list filter should be applied to routes being exported
609 to bgp or zebra. Prefix-lists for ipv4 and ipv6 are independent of each
612 :clicmd:`export bgp|zebra no ipv4|ipv6 prefix-list`
613 This command is valid inside a `nve-group` `RFG-NAME` block. It specifies
614 that no prefix-list filter should be applied to routes being exported to
617 .. _manual-address-control:
619 Manual Address Control
620 ======================
622 The commands in this section can be used to augment normal dynamic VNC. The
623 `add vnc` commands can be used to manually add IP prefix or Ethernet MAC
624 address forwarding information. The `clear vnc` commands can be used to remove
625 manually and dynamically added information.
627 .. clicmd:: add vnc prefix (A.B.C.D/M|X:X::X:X/M) vn (A.B.C.D|X:X::X:X) un (A.B.C.D|X:X::X:X) [cost (0-255)] [lifetime (infinite|(1-4294967295))] [local-next-hop (A.B.C.D|X:X::X:X) [local-cost (0-255)]]
629 Register an IP prefix on behalf of the NVE identified by the VN and UN
630 addresses. The `cost` parameter provides the administrative preference of
631 the forwarding information for remote advertisement. If omitted, it defaults
632 to 255 (lowest preference). The `lifetime` parameter identifies the period,
633 in seconds, that the information remains valid. If omitted, it defaults to
634 `infinite`. The optional `local-next-hop` parameter is used to configure a
635 nexthop to be used by an NVE to reach the prefix via a locally connected CE
636 router. This information remains local to the NVA, i.e., not passed to other
637 NVAs, and is only passed to registered NVEs. When specified, it is also
638 possible to provide a `local-cost` parameter to provide a forwarding
639 preference. If omitted, it defaults to 255 (lowest preference).
641 .. clicmd:: add vnc mac xx:xx:xx:xx:xx:xx virtual-network-identifier (1-4294967295) vn (A.B.C.D|X:X::X:X) un (A.B.C.D|X:X::X:X) [prefix (A.B.C.D/M|X:X::X:X/M)] [cost (0-255)] [lifetime (infinite|(1-4294967295))]
643 Register a MAC address for a logical Ethernet (L2VPN) on behalf of the NVE
644 identified by the VN and UN addresses. The optional `prefix` parameter is to
645 support enable IP address mediation for the given prefix. The `cost`
646 parameter provides the administrative preference of the forwarding
647 information. If omitted, it defaults to 255. The `lifetime` parameter
648 identifies the period, in seconds, that the information remains valid. If
649 omitted, it defaults to `infinite`.
651 .. clicmd:: clear vnc prefix (\*|A.B.C.D/M|X:X::X:X/M) (\*|[(vn|un) (A.B.C.D|X:X::X:X|\*) [(un|vn) (A.B.C.D|X:X::X:X|\*)] [mac xx:xx:xx:xx:xx:xx] [local-next-hop (A.B.C.D|X:X::X:X)])
653 Delete the information identified by prefix, VN address, and UN address.
654 Any or all of these parameters may be wildcarded to (potentially) match more
655 than one registration. The optional `mac` parameter specifies a layer-2 MAC
656 address that must match the registration(s) to be deleted. The optional
657 `local-next-hop` parameter is used to delete specific local nexthop
660 .. clicmd:: clear vnc mac (\*|xx:xx:xx:xx:xx:xx) virtual-network-identifier (\*|(1-4294967295)) (\*|[(vn|un) (A.B.C.D|X:X::X:X|\*) [(un|vn) (A.B.C.D|X:X::X:X|\*)] [prefix (\*|A.B.C.D/M|X:X::X:X/M)])
662 Delete mac forwarding information. Any or all of these parameters may be
663 wildcarded to (potentially) match more than one registration. The default
664 value for the `prefix` parameter is the wildcard value `*`.
666 .. clicmd:: clear vnc nve (\*|((vn|un) (A.B.C.D|X:X::X:X) [(un|vn) (A.B.C.D|X:X::X:X)]))
668 Delete prefixes associated with the NVE specified by the given VN and UN
669 addresses. It is permissible to specify only one of VN or UN, in which case
670 any matching registration will be deleted. It is also permissible to specify
671 `*` in lieu of any VN or UN address, in which case all registrations will
674 .. _other-vnc-related-commands:
676 Other VNC-Related Commands
677 ==========================
679 Note: VNC-Related configuration can be obtained via the `show
680 running-configuration` command when in `enable` mode.
682 The following commands are used to clear and display Virtual Network Control
685 .. clicmd:: clear vnc counters
687 Reset the counter values stored by the NVA. Counter
688 values can be seen using the `show vnc` commands listed above. This
689 command is only available in `enable` mode.
691 .. clicmd:: show vnc summary
693 Print counter values and other general information
694 about the NVA. Counter values can be reset
695 using the `clear vnc counters` command listed below.
697 .. clicmd:: show vnc nves
699 .. clicmd:: show vnc nves vn|un ADDRESS
701 Display the NVA's current clients. Specifying `address` limits the output to
702 the NVEs whose addresses match `address`. The time since the NVA last
703 communicated with the NVE, per-NVE summary counters and each NVE's addresses
706 .. clicmd:: show vnc queries
708 .. clicmd:: show vnc queries PREFIX
710 Display active Query information. Queries remain valid for the default
711 Response Lifetime (:ref:`vnc-defaults-configuration`) or NVE-group Response
712 Lifetime (:ref:`vnc-nve-group-configuration`). Specifying `prefix` limits
713 the output to Query Targets that fall within `prefix`.
715 Query information is provided for each querying NVE, and includes the Query
716 Target and the time remaining before the information is removed.
718 .. clicmd:: show vnc registrations [all|local|remote|holddown|imported]
720 .. clicmd:: show vnc registrations [all|local|remote|holddown|imported] PREFIX
722 Display local, remote, holddown, and/or imported registration information.
723 Local registrations are routes received via RFP, which are present in the
724 NVA Registrations Cache. Remote registrations are routes received via BGP
725 (VPN SAFIs), which are present in the NVE-group import tables. Holddown
726 registrations are local and remote routes that have been withdrawn but whose
727 holddown timeouts have not yet elapsed. Imported information represents
728 routes that are imported into NVA and are made available to querying NVEs.
729 Depending on configuration, imported routes may also be advertised via BGP.
730 Specifying `prefix` limits the output to the registered prefixes that fall
733 Registration information includes the registered prefix, the registering NVE
734 addresses, the registered administrative cost, the registration lifetime and
735 the time since the information was registered or, in the case of Holddown
736 registrations, the amount of time remaining before the information is
739 .. clicmd:: show vnc responses [active|removed]
741 .. clicmd:: show vnc responses [active|removed] PREFIX
743 Display all, active and/or removed response information which are
744 present in the NVA Responses Cache. Responses remain valid for the
745 default Response Lifetime (:ref:`vnc-defaults-configuration`) or
746 NVE-group Response Lifetime (:ref:`vnc-nve-group-configuration`.)
747 When Removal Responses are enabled (:ref:`general-vnc-configuration`),
748 such responses are listed for the Response Lifetime. Specifying
749 `prefix` limits the output to the addresses that fall within
752 Response information is provided for each querying NVE, and includes
753 the response prefix, the prefix-associated registering NVE addresses,
754 the administrative cost, the provided response lifetime and the time
755 remaining before the information is to be removed or will become inactive.
757 .. clicmd:: show memory vnc
759 Print the number of memory items allocated by the NVA.
761 .. _example-vnc-and-vnc-gw-configurations:
763 Example VNC and VNC-GW Configurations
764 =====================================
766 .. _vnc-mesh-nva-config:
768 Mesh NVA Configuration
769 ----------------------
771 This example includes three NVAs, nine NVEs, and two NVE groups. Note that
772 while not shown, a single physical device may support multiple logical NVEs.
773 :ref:`vnc-fig-vnc-mesh` shows ``code NVA-1`` (192.168.1.100), ``NVA 2``
774 (192.168.1.101), and ``NVA 3`` (192.168.1.102), which are connected in a full
775 mesh. Each is a member of the autonomous system 64512. Each NVA provides VNC
776 services to three NVE clients in the 172.16.0.0/16 virtual-network address
777 range. The 172.16.0.0/16 address range is partitioned into two NVE groups,
778 ``group1`` (172.16.0.0/17) and ``group2`` (172.16.128.0/17).
780 Each NVE belongs to either NVE group ``group1`` or NVE group ``group2``. The
781 NVEs ``NVE 1``, ``NVE 2``, ``NVE 4``, ``NVE 7``, and ``NVE 8`` are members of
782 the NVE group ``group1``. The NVEs ``NVE 3``, ``NVE 5``, ``NVE 6``, and ``NVE
783 9`` are members of the NVE group ``group2``.
785 Each NVA advertises NVE underlay-network IP addresses using the
786 Tunnel Encapsulation Attribute.
788 .. _vnc-fig-vnc-mesh:
790 .. figure:: ../figures/fig-vnc-mesh.png
794 A three-way full mesh with three NVEs per NVA.
796 :file:`bgpd.conf` for ``NVA 1`` (192.168.1.100):
802 bgp router-id 192.168.1.100
804 neighbor 192.168.1.101 remote-as 64512
805 neighbor 192.168.1.102 remote-as 64512
807 address-family ipv4 vpn
808 neighbor 192.168.1.101 activate
809 neighbor 192.168.1.102 activate
814 response-lifetime 200
815 rt both 1000:1 1000:2
819 prefix vn 172.16.0.0/17
824 prefix vn 172.16.128.0/17
830 :file:`bgpd.conf` for ``NVA 2`` (192.168.1.101):
836 bgp router-id 192.168.1.101
838 neighbor 192.168.1.100 remote-as 64512
839 neighbor 192.168.1.102 remote-as 64512
841 address-family ipv4 vpn
842 neighbor 192.168.1.100 activate
843 neighbor 192.168.1.102 activate
847 prefix vn 172.16.0.0/17
849 response-lifetime 200
850 rt both 1000:1 1000:2
854 :file:`bgpd.conf` for ``NVA 3`` (192.168.1.102):
860 bgp router-id 192.168.1.102
862 neighbor 192.168.1.101 remote-as 64512
863 neighbor 192.168.1.102 remote-as 64512
865 address-family ipv4 vpn
866 neighbor 192.168.1.100 activate
867 neighbor 192.168.1.101 activate
872 response-lifetime 200
873 rt both 1000:1 1000:2
877 prefix vn 172.16.128.0/17
882 Mesh NVA and VNC-GW Configuration
883 ---------------------------------
885 This example includes two NVAs, each with two associated NVEs, and two VNC-GWs,
886 each supporting two CE routers physically attached to the four NVEs. Note that
887 this example is showing a more complex configuration where VNC-GW is separated
888 from normal NVA functions; it is equally possible to simplify the configuration
889 and combine NVA and VNC-GW functions in a single FRR instance.
892 .. figure:: ../figures/fig-vnc-gw.png
894 :alt: FRR VNC Gateway
896 Meshed NVEs and VNC-GWs
898 As shown in :ref:`vnc-fig-vnc-gw`, NVAs and VNC-GWs are connected in a full iBGP
899 mesh. The VNC-GWs each have two CEs configured as route-reflector clients.
900 Each client provides BGP updates with unicast routes that the VNC-GW reflects
901 to the other client. The VNC-GW also imports these unicast routes into VPN
902 routes to be shared with the other VNC-GW and the two NVAs. This route
903 importation is controlled with the ``vnc redistribute`` statements shown in the
904 configuration. Similarly, registrations sent by NVEs via RFP to the NVAs are
905 exported by the VNC-GWs to the route-reflector clients as unicast routes. RFP
906 registrations exported this way have a next-hop address of the CE behind the
907 connected (registering) NVE. Exporting VNC routes as IPv4 unicast is enabled
908 with the ``vnc export`` command below.
910 The configuration for ``VNC-GW 1`` is shown below.
915 bgp router-id 192.168.1.101
916 bgp cluster-id 1.2.3.4
917 neighbor 192.168.1.102 remote-as 64512
918 neighbor 192.168.1.103 remote-as 64512
919 neighbor 192.168.1.104 remote-as 64512
920 neighbor 172.16.1.2 remote-as 64512
921 neighbor 172.16.2.2 remote-as 64512
923 address-family ipv4 unicast
924 redistribute vnc-direct
925 no neighbor 192.168.1.102 activate
926 no neighbor 192.168.1.103 activate
927 no neighbor 192.168.1.104 activate
928 neighbor 172.16.1.2 route-reflector-client
929 neighbor 172.16.2.2 route-reflector-client
932 address-family ipv4 vpn
933 neighbor 192.168.1.102 activate
934 neighbor 192.168.1.103 activate
935 neighbor 192.168.1.104 activate
937 vnc export bgp mode ce
938 vnc redistribute mode resolve-nve
939 vnc redistribute ipv4 bgp-direct
942 Note that in the VNC-GW configuration, the neighboring VNC-GW and NVAs each
943 have a statement disabling the IPv4 unicast address family. IPv4 unicast is on
944 by default and this prevents the other VNC-GW and NVAs from learning unicast
945 routes advertised by the route-reflector clients.
947 Configuration for ``NVA 2``:
952 bgp router-id 192.168.1.104
953 neighbor 192.168.1.101 remote-as 64512
954 neighbor 192.168.1.102 remote-as 64512
955 neighbor 192.168.1.103 remote-as 64512
957 address-family ipv4 unicast
958 no neighbor 192.168.1.101 activate
959 no neighbor 192.168.1.102 activate
960 no neighbor 192.168.1.103 activate
963 address-family ipv4 vpn
964 neighbor 192.168.1.101 activate
965 neighbor 192.168.1.102 activate
966 neighbor 192.168.1.103 activate
970 response-lifetime 3600
973 prefix vn 172.16.1.1/32
974 response-lifetime 3600
975 rt both 1000:1 1000:2
978 prefix vn 172.16.2.1/32
979 response-lifetime 3600
980 rt both 1000:1 1000:2
984 .. TBD make this its own example:
986 .. @float Figure,fig:fig-vnc-gw-rr
987 .. @center @image{fig-vnc-gw-rr,400pt,,FRR VNC Gateway with RR}
989 .. An NVA can also import unicast routes from BGP without advertising the
990 .. imported routes as VPN routes. Such imported routes, while not
991 .. distributed to other NVAs or VNC-GWs, are are available to NVEs via
992 .. RFP query messages sent to the NVA. @ref{fig:fig-vnc-gw-rr}
993 .. shows an example topology where unicast routes are imported into NVAs
994 .. from a Route Reflector. (@pxref{Route Reflector} for route reflector
995 .. configuration details.) The following three lines can be added to the
996 .. ``NVA 1`` and ``NVA 2`` configurations to import routes into VNC
997 .. for local VNC use:
1000 .. neighbor 192.168.1.105 remote-as 64512
1001 .. vnc redistribute mode plain
1002 .. vnc redistribute ipv4 bgp-direct-to-nve-groups
1005 .. _vnc-with-frr-route-reflector-config:
1007 VNC with FRR Route Reflector Configuration
1008 ------------------------------------------
1010 A route reflector eliminates the need for a fully meshed NVA network by acting
1011 as the hub between NVAs. :ref:`vnc-fig-vnc-frr-route-reflector` shows BGP
1012 route reflector ``BGP Route Reflector 1`` (192.168.1.100) as a route reflector
1013 for NVAs ``NVA 2``(192.168.1.101) and ``NVA 3`` (192.168.1.102).
1015 .. _vnc-fig-vnc-frr-route-reflector:
1016 .. figure:: ../figures/fig-vnc-frr-route-reflector.png
1018 :alt: FRR Route Reflector
1020 Two NVAs and a BGP Route Reflector
1022 ``NVA 2`` and ``NVA 3`` advertise NVE underlay-network IP addresses using the
1023 Tunnel Encapsulation Attribute. ``BGP Route Reflector 1`` ``reflects''
1024 advertisements from ``NVA 2`` to ``NVA 3`` and vice versa.
1026 As in the example of :ref:`vnc-mesh-nva-config`, there are two NVE groups. The
1027 172.16.0.0/16 address range is partitioned into two NVE groups, ``group1``
1028 (172.16.0.0/17) and ``group2`` (172.16.128.0/17). The NVE ``NVE 4``, ``NVE
1029 7``, and ``NVE 8`` are members of the NVE group ``group1``. The NVEs ``NVE
1030 5``, ``NVE 6``, and ``NVE 9`` are members of the NVE group ``group2``.
1032 :file:`bgpd.conf` for ``BGP Route Reflector 1`` on 192.168.1.100:
1038 bgp router-id 192.168.1.100
1040 neighbor 192.168.1.101 remote-as 64512
1041 neighbor 192.168.1.101 port 7179
1042 neighbor 192.168.1.101 description iBGP-client-192-168-1-101
1044 neighbor 192.168.1.102 remote-as 64512
1045 neighbor 192.168.1.102 port 7179
1046 neighbor 192.168.1.102 description iBGP-client-192-168-1-102
1048 address-family ipv4 unicast
1049 neighbor 192.168.1.101 route-reflector-client
1050 neighbor 192.168.1.102 route-reflector-client
1053 address-family ipv4 vpn
1054 neighbor 192.168.1.101 activate
1055 neighbor 192.168.1.102 activate
1057 neighbor 192.168.1.101 route-reflector-client
1058 neighbor 192.168.1.102 route-reflector-client
1063 :file:`bgpd.conf` for ``NVA 2`` on 192.168.1.101:
1069 bgp router-id 192.168.1.101
1071 neighbor 192.168.1.100 remote-as 64512
1073 address-family ipv4 vpn
1074 neighbor 192.168.1.100 activate
1077 vnc nve-group group1
1078 prefix vn 172.16.0.0/17
1080 response-lifetime 200
1081 rt both 1000:1 1000:2
1085 :file:`bgpd.conf` for ``NVA 2`` on 192.168.1.102:
1091 bgp router-id 192.168.1.102
1093 neighbor 192.168.1.100 remote-as 64512
1095 address-family ipv4 vpn
1096 neighbor 192.168.1.100 activate
1101 response-lifetime 200
1102 rt both 1000:1 1000:2
1105 vnc nve-group group1
1106 prefix vn 172.16.128.0/17
1110 While not shown, an NVA can also be configured as a route reflector.
1112 .. _vnc-with-commercial-route-reflector-config:
1114 VNC with Commercial Route Reflector Configuration
1115 -------------------------------------------------
1117 This example is identical to :ref:`vnc-with-frr-route-reflector-config`
1118 with the exception that the route reflector is a commercial router. Only the
1119 VNC-relevant configuration is provided.
1121 .. figure:: ../figures/fig-vnc-commercial-route-reflector.png
1123 :alt: Commercial Route Reflector
1125 Two NVAs with a commercial route reflector
1127 :file:`bgpd.conf` for BGP route reflector ``Commercial Router`` on 192.168.1.104:::
1133 route 172.16.0.0/16 next-hop 192.168.1.104;
1136 autonomous-system 64512;
1139 resolution-ribs inet.0;
1142 resolution-ribs inet.0;
1163 cluster 192.168.1.104;
1164 neighbor 192.168.1.101;
1165 neighbor 192.168.1.102;
1170 policy-statement h {
1173 as-path-prepend 64512;
1179 :file:`bgpd.conf` for ``NVA 2`` on 192.168.1.101:
1185 bgp router-id 192.168.1.101
1187 neighbor 192.168.1.100 remote-as 64512
1189 address-family ipv4 vpn
1190 neighbor 192.168.1.100 activate
1193 vnc nve-group group1
1194 prefix vn 172.16.0.0/17
1196 response-lifetime 200
1197 rt both 1000:1 1000:2
1201 :file:`bgpd.conf` for ``NVA 3`` on 192.168.1.102:
1207 bgp router-id 192.168.1.102
1209 neighbor 192.168.1.100 remote-as 64512
1211 address-family ipv4 vpn
1212 neighbor 192.168.1.100 activate
1217 response-lifetime 200
1218 rt both 1000:1 1000:2
1221 vnc nve-group group1
1222 prefix vn 172.16.128.0/17
1226 VNC with Redundant Route Reflectors Configuration
1227 -------------------------------------------------
1229 This example combines the previous two
1230 (:ref:`vnc-with-frr-route-reflector-config` and
1231 :ref:`vnc-with-commercial-route-reflector-config`) into a redundant route
1232 reflector configuration. BGP route reflectors ``BGP Route Reflector 1`` and
1233 ``Commercial Router`` are the route reflectors for NVAs ``NVA 2`` and ``NVA
1234 3``. The two NVAs have connections to both route reflectors.
1236 .. figure:: ../figures/fig-vnc-redundant-route-reflectors.png
1238 :alt: Redundant Route Reflectors
1240 FRR-based NVA with redundant route reflectors
1242 :file:`bgpd.conf` for ``BPGD Route Reflector 1`` on 192.168.1.100:
1248 bgp router-id 192.168.1.100
1249 bgp cluster-id 192.168.1.100
1251 neighbor 192.168.1.104 remote-as 64512
1253 neighbor 192.168.1.101 remote-as 64512
1254 neighbor 192.168.1.101 description iBGP-client-192-168-1-101
1255 neighbor 192.168.1.101 route-reflector-client
1257 neighbor 192.168.1.102 remote-as 64512
1258 neighbor 192.168.1.102 description iBGP-client-192-168-1-102
1259 neighbor 192.168.1.102 route-reflector-client
1261 address-family ipv4 vpn
1262 neighbor 192.168.1.101 activate
1263 neighbor 192.168.1.102 activate
1264 neighbor 192.168.1.104 activate
1266 neighbor 192.168.1.101 route-reflector-client
1267 neighbor 192.168.1.102 route-reflector-client
1271 :file:`bgpd.conf` for ``NVA 2`` on 192.168.1.101:
1277 bgp router-id 192.168.1.101
1279 neighbor 192.168.1.100 remote-as 64512
1280 neighbor 192.168.1.104 remote-as 64512
1282 address-family ipv4 vpn
1283 neighbor 192.168.1.100 activate
1284 neighbor 192.168.1.104 activate
1287 vnc nve-group group1
1288 prefix vn 172.16.0.0/17
1290 response-lifetime 200
1291 rt both 1000:1 1000:2
1295 :file:`bgpd.conf` for ``NVA 3`` on 192.168.1.102:
1301 bgp router-id 192.168.1.102
1303 neighbor 192.168.1.100 remote-as 64512
1304 neighbor 192.168.1.104 remote-as 64512
1306 address-family ipv4 vpn
1307 neighbor 192.168.1.100 activate
1308 neighbor 192.168.1.104 activate
1313 response-lifetime 200
1314 rt both 1000:1 1000:2
1317 vnc nve-group group1
1318 prefix vn 172.16.128.0/17
1322 :file:`bgpd.conf` for the Commercial Router route reflector on 192.168.1.104:::
1327 route 172.16.0.0/16 next-hop 192.168.1.104;
1330 autonomous-system 64512;
1333 resolution-ribs inet.0;
1336 resolution-ribs inet.0;
1357 cluster 192.168.1.104;
1358 neighbor 192.168.1.101;
1359 neighbor 192.168.1.102;
1373 neighbor 192.168.1.100;
1379 policy-statement h {
1382 as-path-prepend 64512;
1388 .. [#] The nve-id is carried in the route distinguisher. It is the second octet
1389 of the eight-octet route distinguisher generated for Ethernet / L2
1390 advertisements. The first octet is a constant 0xFF, and the third
1391 through eighth octets are set to the L2
1392 ethernet address being advertised.