RFC 8049
YANG Data Model for L3VPN Service Delivery
RFC 8049: YANG Data Model for L3VPN Service Delivery 💖
okay bestie, this is RFC 8049 🎀 It's an IETF Standards Track doc, published February 2017 (ISSN 2070-1721). The authors are S. Litkowski from Orange Business Services, L. Tomotaki from Verizon, and K. Ogaki from KDDI Corporation 🫶 The title block doesn't list anything it obsoletes or updates, so it's not replacing or patching any earlier RFC ✨
Abstract 🦋
okay so this doc defines a YANG data model 💅 It's meant for chatting between customers and network operators, and for delivering a Layer 3 provider-provisioned VPN service. It only covers BGP PE-based VPNs, the kind described in RFCs 4026, 4110, and 4364 🌸
The model is supposed to live at the management system and deliver the whole service end to end. It's not a config model you push straight onto network elements 🙅♀️ It's an abstracted view of the Layer 3 IP VPN service config bits. The management system takes this model as input and then uses specific config models to set up the different network elements. How the network elements actually get configured is out of scope for this doc, so don't go looking for it here 💀
Status of This Memo 🌈
this is an Internet Standards Track document ✨
it's a product of the Internet Engineering Task Force (IETF), so it represents the consensus of the IETF community. It went through public review and got approved for publication by the Internet Engineering Steering Group (IESG) 👑 If you want more on Internet Standards, check out Section 2 of RFC 7841 🧚
you can find the current status, any errata, and how to send feedback at http://www.rfc-editor.org/info/rfc8049 💜
Copyright Notice 🔥
the copyright is held by the IETF Trust and the people listed as authors, copyright 2017, all rights reserved 💅
this doc is covered by BCP 78 and the IETF Trust's Legal Provisions Relating to IETF Documents (http://trustee.ietf.org/license-info), as they stood on the publication date. Please actually read those, because they spell out your rights and restrictions for this doc 🙈 Any Code Components you pull out of this doc have to include the Simplified BSD License text, as described in Section 4.e of the Trust Legal Provisions, and they come with no warranty, same as that license says 🍓
Table of Contents 🧚
1. Introduction ....................................................4
1.1. Terminology ................................................4
1.2. Requirements Language ......................................5
1.3. Tree Diagrams ..............................................5
2. Acronyms ........................................................5
3. Definitions .....................................................7
4. Layer 3 IP VPN Service Model ....................................8
5. Service Data Model Usage ........................................9
6. Design of the Data Model .......................................10
6.1. Features and Augmentation .................................18
6.2. VPN Service Overview ......................................18
6.2.1. VPN Service Topology ...............................18
6.2.1.1. Route Target Allocation ...................19
6.2.1.2. Any-to-Any ................................20
6.2.1.3. Hub and Spoke .............................20
6.2.1.4. Hub and Spoke Disjoint ....................21
6.2.2. Cloud Access .......................................22
6.2.3. Multicast Service ..................................24
6.2.4. Extranet VPNs ......................................26
6.3. Site Overview .............................................27
6.3.1. Devices and Locations ..............................29
6.3.2. Site Network Accesses ..............................30
6.3.2.1. Bearer ....................................30
6.3.2.2. Connection ................................31
6.3.2.3. Inheritance of Parameters Defined at
Site Level and Site Network Access Level ..32
6.4. Site Role .................................................32
6.5. Site Belonging to Multiple VPNs ...........................33
6.5.1. Site VPN Flavor ....................................33
6.5.1.1. Single VPN Attachment:
site-vpn-flavor-single ....................33
6.5.1.2. MultiVPN Attachment:
site-vpn-flavor-multi .....................33
6.5.1.3. SubVPN Attachment: site-vpn-flavor-sub ....34
6.5.1.4. NNI: site-vpn-flavor-nni ..................36
6.5.2. Attaching a Site to a VPN ..........................37
6.5.2.1. Referencing a VPN .........................37
6.5.2.2. VPN Policy ................................38
6.6. Deciding Where to Connect the Site ........................40
6.6.1. Constraint: Device .................................41
6.6.2. Constraint/Parameter: Site Location ................41
6.6.3. Constraint/Parameter: Access Type ..................42
6.6.4. Constraint: Access Diversity .......................43
6.6.5. Infeasible Access Placement ........................49
6.6.6. Examples of Access Placement .......................50
6.6.6.1. Multihoming ...............................50
6.6.6.2. Site Offload ..............................53
6.6.6.3. Parallel Links ............................59
6.6.6.4. SubVPN with Multihoming ...................60
6.6.7. Route Distinguisher and VRF Allocation .............64
6.7. Site Network Access Availability ..........................64
6.8. Traffic Protection ........................................66
6.9. Security ..................................................66
6.9.1. Authentication .....................................67
6.9.2. Encryption .........................................67
6.10. Management ...............................................68
6.11. Routing Protocols ........................................68
6.11.1. Handling of Dual Stack ............................69
6.11.2. LAN Directly Connected to SP Network ..............70
6.11.3. LAN Directly Connected to SP Network with
Redundancy ........................................70
6.11.4. Static Routing ....................................70
6.11.5. RIP Routing .......................................71
6.11.6. OSPF Routing ......................................71
6.11.7. BGP Routing .......................................73
6.12. Service ..................................................75
6.12.1. Bandwidth .........................................75
6.12.2. QoS ...............................................75
6.12.2.1. QoS Classification .......................75
6.12.2.2. QoS Profile ..............................78
6.12.3. Multicast .........................................81
6.13. Enhanced VPN Features ....................................82
6.13.1. Carriers' Carriers ................................82
6.14. External ID References ...................................83
6.15. Defining NNIs ............................................83
6.15.1. Defining an NNI with the Option A Flavor ..........85
6.15.2. Defining an NNI with the Option B Flavor ..........88
6.15.3. Defining an NNI with the Option C Flavor ..........91
7. Service Model Usage Example ....................................92
8. Interaction with Other YANG Modules ............................98
9. YANG Module ...................................................102
10. Security Considerations ......................................154
11. IANA Considerations ..........................................155
12. References ...................................................155
12.1. Normative References ....................................155
12.2. Informative References ..................................157
Acknowledgements .................................................157
Contributors .....................................................157
Authors' Addresses ...............................................1571. Introduction ✨
this doc defines a Layer 3 VPN service data model written in YANG 💖 The model spells out service config elements that can be used in communication protocols between customers and network operators. Those same elements can also be fed in as input to automated control and config apps 🤖
1.1. Terminology 📚
these terms are defined in [RFC6241] and aren't redefined here:
- client
- configuration data
- server
- state data
these terms are defined in [RFC7950] and also aren't redefined here:
- augment
- data model
- data node
the terminology for describing YANG data models lives in [RFC7950] 🧠
this doc also shows some config examples using XML representation 🎀
1.2. Requirements Language 🫶
the key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this doc are to be interpreted as described in [RFC2119] 🔥
1.3. Tree Diagrams 🌳
we get a simplified graphical picture of the data model in Section 6 🦋
here's what the symbols in those diagrams mean:
- Brackets
[and]wrap list keys. - Curly braces
{and}hold the names of optional features that make the matching node conditional. - Prefixes before data node names:
rwmeans configuration data (read-write), andromeans state data (read-only). - Suffixes after data node names:
?means an optional node, and*marks alistorleaf-list. - Parentheses wrap choice and case nodes, and case nodes also get a colon (
:). - An ellipsis (
...) stands in for subtrees that aren't shown.
2. Acronyms ✨
okay bestie, here's the acronym cheat sheet 🎀 every single one of these is gonna pop up as we go, so screenshot it 📸
- AAA: Authentication, Authorization, and Accounting.
- ACL: Access Control List.
- ADSL: Asymmetric DSL.
- AH: Authentication Header.
- AS: Autonomous System.
- ASBR: Autonomous System Border Router.
- ASM: Any-Source Multicast.
- BAS: Broadband Access Switch.
- BFD: Bidirectional Forwarding Detection.
- BGP: Border Gateway Protocol.
- BSR: Bootstrap Router.
- CE: Customer Edge.
- CLI: Command Line Interface.
- CsC: Carriers' Carriers.
- CSP: Cloud Service Provider.
- DHCP: Dynamic Host Configuration Protocol.
- DSLAM: Digital Subscriber Line Access Multiplexer.
- ESP: Encapsulating Security Payload.
- GRE: Generic Routing Encapsulation.
- IGMP: Internet Group Management Protocol.
- LAN: Local Area Network.
- MLD: Multicast Listener Discovery.
- MTU: Maximum Transmission Unit.
- NAT: Network Address Translation.
- NETCONF: Network Configuration Protocol.
- NNI: Network-to-Network Interface.
- OAM: Operations, Administration, and Maintenance.
- OSPF: Open Shortest Path First.
- OSS: Operations Support System.
- PE: Provider Edge.
- PIM: Protocol Independent Multicast.
- POP: Point of Presence.
- QoS: Quality of Service.
- RD: Route Distinguisher.
- RIP: Routing Information Protocol.
- RP: Rendezvous Point.
- RT: Route Target.
- SFTP: Secure FTP.
- SLA: Service Level Agreement.
- SLAAC: Stateless Address Autoconfiguration.
- SP: Service Provider.
- SPT: Shortest Path Tree.
- SSM: Source-Specific Multicast.
- VM: Virtual Machine.
- VPN: Virtual Private Network.
- VRF: VPN Routing and Forwarding.
- VRRP: Virtual Router Redundancy Protocol.
3. Definitions 💅
these are the key terms, so let's get them locked in 🔒
3.1. Hmm, no subsections here
ignore that line, I got ahead of myself 🙈 there are no subsections in this part, just the definitions below 💖
Customer Edge (CE) Device: a CE is equipment dedicated to one particular customer 🎀. It's directly connected (at Layer 3) to one or more PE devices through attachment circuits. A CE usually lives at the customer premises and is usually dedicated to a single VPN 🏠. Lowkey though, it can support multiple VPNs, but only if each VPN has its own separate attachment circuits 🔀.
Provider Edge (PE) Device: a PE is equipment managed by the SP 🛠️. It can support multiple VPNs for different customers at once, and it's directly connected (at Layer 3) to one or more CE devices via attachment circuits. PEs usually sit at an SP point of presence (POP) and are managed by the SP ✨.
PE-Based VPNs: the PE devices know which traffic is VPN traffic 👀. They forward it through tunnels based on the destination IP address of the packet and, optionally, on other information in the packet's IP header 🧭. The PE devices are the tunnel endpoints themselves 🌊. The tunnels can use different encapsulations to carry traffic across the SP network, like GRE, IP-in-IP, IPsec, or MPLS tunnels, and that list is not the whole menu 🍓.
4. Layer 3 IP VPN Service Model 🦋
okay so a Layer 3 IP VPN service is basically a bunch of sites that are allowed to talk to each other over a shared IP infrastructure 🫶. This model is all about giving everyone a shared understanding of how that IP VPN gets deployed over the shared infrastructure 🌸. And it's limited to BGP PE-based VPNs as described in [RFC4026], [RFC4110], and [RFC4364] 📚. No cap, it's a very specific lane 💜.
5. Service Data Model Usage 🧚
so here's the big picture diagram, bestie 👑
l3vpn-svc |
Model |
|
+------------------+ +-----+
| Orchestration | < --- > | OSS |
+------------------+ +-----+
| |
+----------------+ |
| Config manager | |
+----------------+ |
| |
| NETCONF/CLI ...
| |
+------------------------------------------------+
Network
+++++++
+ AAA +
+++++++
++++++++ Bearer ++++++++ ++++++++ ++++++++
+ CE A + ----------- + PE A + + PE B + ---- + CE B +
++++++++ Connection ++++++++ ++++++++ ++++++++
Site A Site Bthe whole point of the L3 IP VPN service model is to give you an abstracted interface between customers and network operators, so you can manage the configuration of the parts of an L3VPN service 💖. The usual move is to feed this model into an orchestration layer 🎯. That layer then translates it into an orchestrated configuration for the network elements that are part of the service 🪄. Those elements can be routers, but they can also be servers (like AAA), and the network's configuration isn't limited to just those examples 🙈.
Configuring the network elements can be done with the CLI, or with NETCONF/RESTCONF [RFC6241] [RFC8040] paired with YANG data models for a specific configuration (BGP, VRF, BFD, etc.) 🌈. It can also be some other technique, whatever the operator prefers ✨.
The service model isn't limited to this example, though 💅. Any component of the management system can use it, but network elements can't use it directly 🫣.
6. Design of the Data Model 🍓
the YANG module is split into two main containers: vpn-services and sites 🎀.
The vpn-service list under the vpn-services container defines the global parameters for a specific customer's VPN service 👑.
A site has at least one site-network-access. If it's multihomed, it can have multiple site-network-access points 🌸. The site-network-access attachment is done through a bearer with an ip-connection on top 🔗. The bearer covers the properties of the attachment below Layer 3, and the ip-connection covers the properties that are about the Layer 3 protocol 🧠. The SP can allocate the bearer dynamically, and the customer can offer some constraints or parameters to help decide where the access goes 🧭.
Authorization of traffic exchange is handled by what we call a VPN policy, or a VPN service topology, which defines the routing exchange rules between sites 🦋.
The figure below shows the overall structure of the YANG module 🧚♀️
okay bestie, this is the whole family tree of the L3VPN service model 🌳✨ it's giving organized chaos but every branch has a job 💅
module: ietf-l3vpn-svc
+--rw l3vpn-svc
+--rw vpn-services
| +--rw vpn-service* [vpn-id]
| +--rw vpn-id svc-id
| +--rw customer-name? string
| +--rw vpn-service-topology? identityref
| +--rw cloud-accesses {cloud-access}?
| | +--rw cloud-access* [cloud-identifier]
| | +--rw cloud-identifier string
| | +--rw (list-flavor)?
| | | +--:(permit-any)
| | | | +--rw permit-any? empty
| | | +--:(deny-any-except)
| | | | +--rw permit-site* leafref
| | | +--:(permit-any-except)
| | | +--rw deny-site* leafref
| | +--rw authorized-sites
| | | +--rw authorized-site* [site-id]
| | | +--rw site-id leafref
| | +--rw denied-sites
| | | +--rw denied-site* [site-id]
| | | +--rw site-id leafref
| | +--rw address-translation
| | +--rw nat44
| | +--rw enabled? boolean
| | +--rw nat44-customer-address? inet:ipv4-address
| +--rw multicast {multicast}?
| | +--rw enabled? boolean
| | +--rw customer-tree-flavors
| | | +--rw tree-flavor* identityref
| | +--rw rp
| | +--rw rp-group-mappings
| | | +--rw rp-group-mapping* [id]
| | | +--rw id uint16
| | | +--rw provider-managed
| | | | +--rw enabled? boolean
| | | | +--rw rp-redundancy? boolean
| | | | +--rw optimal-traffic-delivery? boolean
| | | +--rw rp-address? inet:ip-address
| | | +--rw groups
| | | +--rw group* [id]
| | | +--rw id uint16
| | | +--rw (group-format)?
| | | +--:(startend)
| | | | +--rw group-start? inet:ip-address
| | | | +--rw group-end? inet:ip-address
| | | +--:(singleaddress)
| | | +--rw group-address? inet:ip-address
| | +--rw rp-discovery
| | +--rw rp-discovery-type? identityref
| | +--rw bsr-candidates
| | +--rw bsr-candidate-address* inet:ip-address
| +--rw carrierscarrier? boolean {carrierscarrier}?
| +--rw extranet-vpns {extranet-vpn}?
| +--rw extranet-vpn* [vpn-id]
| +--rw vpn-id svc-id
| +--rw local-sites-role? identityref
+--rw sites
+--rw site* [site-id]
+--rw site-id svc-id
+--rw requested-site-start? yang:date-and-time
+--rw requested-site-stop? yang:date-and-time
+--rw locations
| +--rw location* [location-id]
| +--rw location-id svc-id
| +--rw address? string
| +--rw postal-code? string
| +--rw state? string
| +--rw city? string
| +--rw country-code? string
+--rw devices
| +--rw device* [device-id]
| +--rw device-id svc-id
| +--rw location? leafref
| +--rw management
| +--rw address-family? address-family
| +--rw address? inet:ip-address
+--rw site-diversity {site-diversity}?
| +--rw groups
| +--rw group* [group-id]
| +--rw group-id string
+--rw management
| +--rw type? identityref
+--rw vpn-policies
| +--rw vpn-policy* [vpn-policy-id]
| +--rw vpn-policy-id svc-id
| +--rw entries* [id]
| +--rw id svc-id
| +--rw filter
| | +--rw (lan)?
| | +--:(prefixes)
| | | +--rw ipv4-lan-prefix* inet:ipv4-prefix {ipv4}?
| | | +--rw ipv6-lan-prefix* inet:ipv6-prefix {ipv6}?
| | +--:(lan-tag)
| | +--rw lan-tag* string
| +--rw vpn
| +--rw vpn-id leafref
| +--rw site-role? identityref
+--rw site-vpn-flavor? identityref
+--rw maximum-routes
| +--rw address-family* [af]
| +--rw af address-family
| +--rw maximum-routes? uint32
+--rw security
| +--rw authentication
| +--rw encryption {encryption}?
| +--rw enabled? boolean
| +--rw layer enumeration
| +--rw encryption-profile
| +--rw (profile)?
| +--:(provider-profile)
| | +--rw profile-name? string
| +--:(customer-profile)
| +--rw algorithm? string
| +--rw (key-type)?
| +--:(psk)
| | +--rw preshared-key? string
| +--:(pki)
+--rw service
| +--rw qos {qos}?
| | +--rw qos-classification-policy
| | | +--rw rule* [id]
| | | +--rw id uint16
| | | +--rw (match-type)?
| | | | +--:(match-flow)
| | | | | +--rw match-flow
| | | | | +--rw dscp? inet:dscp
| | | | | +--rw dot1p? uint8
| | | | | +--rw ipv4-src-prefix? inet:ipv4-prefix
| | | | | +--rw ipv6-src-prefix? inet:ipv6-prefix
| | | | | +--rw ipv4-dst-prefix? inet:ipv4-prefix
| | | | | +--rw ipv6-dst-prefix? inet:ipv6-prefix
| | | | | +--rw l4-src-port? inet:port-number
| | | | | +--rw target-sites* svc-id
| | | | | +--rw l4-src-port-range
| | | | | | +--rw lower-port? inet:port-number
| | | | | | +--rw upper-port? inet:port-number
| | | | | +--rw l4-dst-port? inet:port-number
| | | | | +--rw l4-dst-port-range
| | | | | | +--rw lower-port? inet:port-number
| | | | | | +--rw upper-port? inet:port-number
| | | | | +--rw protocol-field? union
| | | | +--:(match-application)
| | | | +--rw match-application? identityref
| | | +--rw target-class-id? string
| | +--rw qos-profile
| | +--rw (qos-profile)?
| | +--:(standard)
| | | +--rw profile? string
| | +--:(custom)
| | +--rw classes {qos-custom}?
| | +--rw class* [class-id]
| | +--rw class-id string
| | +--rw rate-limit? uint8
| | +--rw latency
| | | +--rw (flavor)?
| | | ...
| | +--rw jitter
| | | +--rw (flavor)?
| | | ...
| | +--rw bandwidth
| | +--rw guaranteed-bw-percent? uint8
| | +--rw end-to-end? empty
| +--rw carrierscarrier {carrierscarrier}?
| | +--rw signalling-type? enumeration
| +--rw multicast {multicast}?
| +--rw multicast-site-type? enumeration
| +--rw multicast-address-family
| | +--rw ipv4? boolean {ipv4}?
| | +--rw ipv6? boolean {ipv6}?
| +--rw protocol-type? enumeration
+--rw traffic-protection {fast-reroute}?
| +--rw enabled? boolean
+--rw routing-protocols
| +--rw routing-protocol* [type]
| +--rw type identityref
| +--rw ospf {rtg-ospf}?
| | +--rw address-family* address-family
| | +--rw area-address? yang:dotted-quad
| | +--rw metric? uint16
| | +--rw sham-links {rtg-ospf-sham-link}?
| | +--rw sham-link* [target-site]
| | +--rw target-site svc-id
| | +--rw metric? uint16
| +--rw bgp {rtg-bgp}?
| | +--rw autonomous-system? uint32
| | +--rw address-family* address-family
| +--rw static
| | +--rw cascaded-lan-prefixes
| | +--rw ipv4-lan-prefixes* [lan next-hop] {ipv4}?
| | | +--rw lan inet:ipv4-prefix
| | | +--rw lan-tag? string
| | | +--rw next-hop inet:ipv4-address
| | +--rw ipv6-lan-prefixes* [lan next-hop] {ipv6}?
| | +--rw lan inet:ipv6-prefix
| | +--rw lan-tag? string
| | +--rw next-hop inet:ipv6-address
| +--rw rip {rtg-rip}?
| | +--rw address-family* address-family
| +--rw vrrp {rtg-vrrp}?
| +--rw address-family* address-family
+--ro actual-site-start? yang:date-and-time
+--ro actual-site-stop? yang:date-and-time
+--rw site-network-accesses
+--rw site-network-access* [site-network-access-id]
+--rw site-network-access-id svc-id
+--rw site-network-access-type? identityref
+--rw (location-flavor)
| +--:(location)
| | +--rw location-reference? leafref
| +--:(device)
| +--rw device-reference? leafref
+--rw access-diversity {site-diversity}?
| +--rw groups
| | +--rw group* [group-id]
| | +--rw group-id string
| +--rw constraints
| +--rw constraint* [constraint-type]
| +--rw constraint-type identityref
| +--rw target
| +--rw (target-flavor)?
| +--:(id)
| | +--rw group* [group-id]
| | ...
| +--:(all-accesses)
| | +--rw all-other-accesses? empty
| +--:(all-groups)
| +--rw all-other-groups? empty
+--rw bearer
| +--rw requested-type {requested-type}?
| | +--rw requested-type? string
| | +--rw strict? boolean
| +--rw always-on? boolean {always-on}?
| +--rw bearer-reference? string {bearer-reference}?
+--rw ip-connection
| +--rw ipv4 {ipv4}?
| | +--rw address-allocation-type? identityref
| | +--rw number-of-dynamic-address? uint8
| | +--rw dhcp-relay
| | | +--rw customer-dhcp-servers
| | | +--rw server-ip-address* inet:ipv4-address
| | +--rw addresses
| | +--rw provider-address? inet:ipv4-address
| | +--rw customer-address? inet:ipv4-address
| | +--rw mask? uint8
| +--rw ipv6 {ipv6}?
| | +--rw address-allocation-type? identityref
| | +--rw number-of-dynamic-address? uint8
| | +--rw dhcp-relay
| | | +--rw customer-dhcp-servers
| | | +--rw server-ip-address* inet:ipv6-address
| | +--rw addresses
| | +--rw provider-address? inet:ipv6-address
| | +--rw customer-address? inet:ipv6-address
| | +--rw mask? uint8
| +--rw oam
| +--rw bfd {bfd}?
| +--rw enabled? boolean
| +--rw (holdtime)?
| +--:(profile)
| | +--rw profile-name? string
| +--:(fixed)
| +--rw fixed-value? uint32
+--rw security
| +--rw authentication
| +--rw encryption {encryption}?
| +--rw enabled? boolean
| +--rw layer enumeration
| +--rw encryption-profile
| +--rw (profile)?
| +--:(provider-profile)
| | +--rw profile-name? string
| +--:(customer-profile)
| +--rw algorithm? string
| +--rw (key-type)?
| +--:(psk)
| | ... | +--:(pki)
+--rw service
| +--rw svc-input-bandwidth? uint32
| +--rw svc-output-bandwidth? uint32
| +--rw svc-mtu? uint16
| +--rw qos {qos}?
| | +--rw qos-classification-policy
| | | +--rw rule* [id]
| | | +--rw id uint16
| | | +--rw (match-type)?
| | | | +--:(match-flow)
| | | | | +--rw match-flow
| | | | | ...
| | | | +--:(match-application)
| | | | +--rw match-application? identityref
| | | +--rw target-class-id? string
| | +--rw qos-profile
| | +--rw (qos-profile)?
| | +--:(standard)
| | | +--rw profile? string
| | +--:(custom)
| | +--rw classes {qos-custom}?
| | +--rw class* [class-id]
| | ...
| +--rw carrierscarrier {carrierscarrier}?
| | +--rw signalling-type? enumeration
| +--rw multicast {multicast}?
| +--rw multicast-site-type? enumeration
| +--rw multicast-address-family
| | +--rw ipv4? boolean {ipv4}?
| | +--rw ipv6? boolean {ipv6}?
| +--rw protocol-type? enumeration
+--rw routing-protocols
| +--rw routing-protocol* [type]
| +--rw type identityref
| +--rw ospf {rtg-ospf}?
| | +--rw address-family* address-family
| | +--rw area-address? yang:dotted-quad
| | +--rw metric? uint16
| | +--rw sham-links {rtg-ospf-sham-link}?
| | +--rw sham-link* [target-site]
| | +--rw target-site svc-id
| | +--rw metric? uint16
| +--rw bgp {rtg-bgp}?
| | +--rw autonomous-system? uint32
| | +--rw address-family* address-family
| +--rw static
| | +--rw cascaded-lan-prefixes
| | +--rw ipv4-lan-prefixes* [lan next-hop] {ipv4}?
| | | +--rw lan inet:ipv4-prefix
| | | +--rw lan-tag? string
| | | +--rw next-hop inet:ipv4-address
| | +--rw ipv6-lan-prefixes* [lan next-hop] {ipv6}?
| | +--rw lan inet:ipv6-prefix
| | +--rw lan-tag? string
| | +--rw next-hop inet:ipv6-address
| +--rw rip {rtg-rip}?
| | +--rw address-family* address-family
| +--rw vrrp {rtg-vrrp}?
| +--rw address-family* address-family
+--rw availability
| +--rw access-priority? uint32
+--rw vpn-attachment
+--rw (attachment-flavor)
+--:(vpn-policy-id)
| +--rw vpn-policy-id? leafref
+--:(vpn-id)
+--rw vpn-id? leafref
+--rw site-role? identityref6.1. Features and Augmentation ✨
Okay bestie, this model is built like a LEGO set 🧱 with lots of little feature pieces, so each implementation can snap together only the bits it supports 🧩. For example, an implementation might support only IPv4 VPNs (IPv4 feature 🌸), only IPv6 VPNs (IPv6 feature 🌈), or both (by advertising both features 💖). The routing protocols offered to the customer can also be switched on through features ⭐. There are some features for the fancier stuff too: extranet VPNs (Section 6.2.4 🦋), site diversity (Section 6.6 🍓), and QoS (Section 6.12.2 💅).
And since this is YANG, the whole model can be augmented to add new behaviors or specific features 🔥. Like, this model offers different options for IP address assignments, but if those don't cover everything you need, you can add new options through augmentation 🫶.
6.2. VPN Service Overview 🎀
Every vpn-service list item is basically the generic info card for the VPN service 🪪. The "vpn-id" in the vpn-service list is an internal reference for this VPN service 🔐, while the customer name is the more-explicit way to point at the customer 👑. Heads up: this identifier is purely internal to the organization responsible for the VPN service 🙈.
6.2.1. VPN Service Topology 🗺️
The type of VPN service topology is required for configuration 📝. Our model supports any-to-any, Hub and Spoke (where Hubs can exchange traffic 🤝), and "Hub and Spoke disjoint" (where Hubs cannot exchange traffic 🚫). New topologies can be added via augmentation 🧩. By default, the any-to-any topology is used 💜.
6.2.1.1. Route Target Allocation 🎯
A Layer 3 PE-based VPN is built using route targets (RTs) as described in [RFC4364] 📚. The management system is expected to automatically allocate a set of RTs when it receives a VPN service creation request ✨. How the management system allocates RTs is out of scope for this document 🙅, but there are multiple ways it could be envisaged, as described below 👀.
Management system
<------------------------------------------------->
Request RT
+-----------------------+ Topo a2a +----------+
RESTCONF | | -----> | |
User ------------- | Service Orchestration | | Network |
l3vpn-svc | | <----- | OSS |
Model +-----------------------+ Response +----------+
RT1, RT2In the example above, a service orchestration, which owns the instantiation of this service model, requests RTs from the network OSS 📨. Based on the requested VPN service topology, the network OSS replies with one or multiple RTs 🔁. The interface between this service orchestration and the network OSS is out of scope for this document 🙃.
+---------------------------+
RESTCONF | |
User ------------- | Service Orchestration |
l3vpn-svc | |
Model | |
| RT pool: 10:1->10:10000 |
| RT pool: 20:50->20:5000 |
+---------------------------+In this second example, the service orchestration (the one that owns the instantiation of this service model 🧠) owns one or more pools of RTs, specified by the SP, that can be allocated 🏊. Based on the requested VPN service topology, it allocates one or multiple RTs from the pool 🎟️.
The mechanisms shown above are just examples and should not be considered an exhaustive list of solutions 🌈.
6.2.1.2. Any-to-Any 🌐
+------------------------------------------------------------+
| VPN1_Site1 ------ PE1 PE2 ------ VPN1_Site2 |
| |
| VPN1_Site3 ------ PE3 PE4 ------ VPN1_Site4 |
+------------------------------------------------------------+
Any-to-Any VPN Service TopologyIn the any-to-any topology, all VPN sites can communicate with each other without any restrictions 💬. The management system that receives an any-to-any IP VPN service request through this model is expected to assign and then configure the VRF and RTs on the appropriate PEs 🛠️. In the any-to-any case, a single RT is generally required, and every VRF imports and exports this RT 🔄.
6.2.1.3. Hub and Spoke 🕸️
+-------------------------------------------------------------+
| Hub_Site1 ------ PE1 PE2 ------ Spoke_Site1 |
| +----------------------------------+
| |
| +----------------------------------+
| Hub_Site2 ------ PE3 PE4 ------ Spoke_Site2 |
+-------------------------------------------------------------+
Hub-and-Spoke VPN Service TopologyIn the Hub-and-Spoke topology, all Spoke sites can communicate only with Hub sites, not with each other, and Hubs can also communicate with each other 🤝. The management system that owns an any-to-any IP VPN service request through this model is expected to assign and then configure the VRF and RTs on the appropriate PEs 🛠️. In the Hub-and-Spoke case, two RTs are generally required, one for Hub routes and one for Spoke routes 🎀. A Hub VRF that connects Hub sites will export Hub routes with the Hub RT and will import Spoke routes through the Spoke RT ✨. It will also import the Hub RT to allow Hub-to-Hub communication 👯. A Spoke VRF that connects Spoke sites will export Spoke routes with the Spoke RT and will import Hub routes through the Hub RT 🦋.
The management system MUST take into account constraints on Hub-and-Spoke connections 🚨. For example, if a management system decides to mesh a Spoke site and a Hub site on the same PE, it needs to mesh connections in different VRFs, as shown in the figure below 👀.
Hub_Site ------- (VRF_Hub) PE1
(VRF_Spoke)
/ |
Spoke_Site1 -------------------+ |
|
Spoke_Site2 -----------------------+6.2.1.4. Hub and Spoke Disjoint 💔
+-------------------------------------------------------------+
| Hub_Site1 ------ PE1 PE2 ------ Spoke_Site1 |
+--------------------------+ +-------------------------------+
| |
+--------------------------+ +-------------------------------+
| Hub_Site2 ------ PE3 PE4 ------ Spoke_Site2 |
+-------------------------------------------------------------+
Hub and Spoke Disjoint VPN Service TopologyIn the Hub and Spoke disjoint topology, all Spoke sites can communicate only with Hub sites, not with each other, and Hubs cannot communicate with each other 🙅♀️. The management system that owns an any-to-any IP VPN service request through this model is expected to assign and then configure the VRF and RTs on the appropriate PEs 🛠️. In the Hub-and-Spoke case, two RTs are required, one for Hub routes and one for Spoke routes 🎀. A Hub VRF that connects Hub sites will export Hub routes with the Hub RT and will import Spoke routes through the Spoke RT 💜. A Spoke VRF that connects Spoke sites will export Spoke routes with the Spoke RT and will import Hub routes through the Hub RT 🌸.
The management system MUST take into account constraints on Hub-and-Spoke connections, as in the previous case 🚨.
Hub and Spoke disjoint can also be seen as multiple Hub-and-Spoke VPNs (one per Hub) that share a common set of Spoke sites 👑.
6.2.2. Cloud Access ✨
okay so the model gives you cloud access config through the cloud-accesses container 💅 and it's targeted at the public cloud ☁️ (the Internet counts as a public cloud access service too, iykyk 🌐). The cloud-accesses container holds the parameters for network address translation and authorization rules 🎀
If you need private cloud access, that goes through NNIs instead, as covered in Section 6.15 🔗
Each cloud gets a cloud-identifier to reference the target service, and that identifier is local to each administration 🆔
The model lets you do source address translation before you touch the cloud 🔄 IPv4-to-IPv4 translation (NAT44) is the only supported option right now, but other options can be added through augmentation 🧩 If you need IP source address translation to reach the cloud, the enabled leaf MUST be set to true in the nat44 container 🫶 You can drop an IP address into the customer-address leaf if the customer is the one providing that address 📍 If the SP is providing it, you don't need customer-address at all, because the SP can grab one from a pool of SPs 🏊
By default, every site in the IP VPN MUST be authorized to access the cloud 💖 If you need restrictions, a user MAY configure the permit-site or deny-site leaf-list 🚦 The permit-site leaf-list lists the sites that are authorized for cloud access ✅ The deny-site leaf-list lists the sites that are denied cloud access 🙅♀️ The model supports both deny-any-except and permit-any-except authorization 🌸
How those restrictions actually get configured on network elements is out of scope for this document 🙈
IP VPN
++++++++++++++++++++++++++++++++ ++++++++++++
+ Site 3 + --- + Cloud 1 +
+ Site 1 + ++++++++++++
+ +
+ Site 2 + --- ++++++++++++
+ + + Internet +
+ Site 4 + ++++++++++++
++++++++++++++++++++++++++++++++
|
+++++++++++
+ Cloud 2 +
+++++++++++In the example above, we set up the global VPN to reach the Internet by creating a cloud-access that points at the cloud identifier for the Internet service 🌍 No authorized sites get configured here, because all sites are required to access the Internet 💯 The address-translation/nat44/enabled leaf gets set to true 🔥
<vpn-service>
<vpn-id>123456487</vpn-id>
<cloud-accesses>
<cloud-access>
<cloud-identifier>INTERNET</cloud-identifier>
<address-translation>
<nat44>
<enabled>true</enabled>
</nat44>
</address-translation>
</cloud-access>
</cloud-accesses>
</vpn-service>If Site 1 and Site 2 need access to Cloud 1, we create a new cloud-access pointing at the cloud identifier of Cloud 1 🎯 Then the permit-site leaf-list gets filled with references to Site 1 and Site 2 👯♀️
<vpn-service>
<vpn-id>123456487</vpn-id>
<cloud-accesses>
<cloud-access>
<cloud-identifier>Cloud1</cloud-identifier>
<permit-site>site1</permit-site>
<permit-site>site2</permit-site>
</cloud-access>
</cloud-accesses>
</vpn-service>If every site except Site 1 needs access to Cloud 2, we create a new cloud-access pointing at the cloud identifier of Cloud 2 🌷 The deny-site leaf-list gets filled with a reference to Site 1 🚫
<vpn-service>
<vpn-id>123456487</vpn-id>
<cloud-accesses>
<cloud-access>
<cloud-identifier>Cloud2</cloud-identifier>
<deny-site>site1</deny-site>
</cloud-access>
</cloud-accesses>
</vpn-service>6.2.3. Multicast Service 📡
Multicast in IP VPNs is described in [RFC6513] 🎶
If an IP VPN needs multicast support, there are some global multicast parameters that are required as input for the service request 📝
People using this model have to tell it which flavors of trees customers in the IP VPN will use (the customer tree) 🌳 The model supports bidirectional, shared, and source-based trees, and you can augment it for more 🧩 You can run multiple flavors of trees at the same time 🎪
Operator network
______________
/ \
| |
(SSM tree) |
Recv (IGMPv3) -- Site2 ------- PE2 |
| PE1 --- Site1 --- Source1
| | \
| | -- Source2
| |
(ASM tree) |
Recv (IGMPv2) -- Site3 ------- PE3 |
| |
(SSM tree) |
Recv (IGMPv3) -- Site4 ------- PE4 |
| / |
Recv (IGMPv2) -- Site5 -------- |
(ASM tree) |
| |
\_______________/When you request an ASM flavor, this model requires that the rp and rp-discovery parameters get filled in 🙌 You can create multiple RP-to-group mappings with the rp-group-mappings container 🗺️ For each mapping, the SP can manage the RP service by setting the provider-managed/enabled leaf to true 🫧 With a provider-managed RP, the user can ask for RP redundancy and/or optimal traffic delivery 🛡️ Those parameters help the SP pick the right technology or architecture for the customer's needs 🎯 For example, if someone asks for optimal traffic delivery, the SP might use Anycast-RP or RP-tree-to-SPT switchover architectures 🚀
With a customer-managed RP, the RP address has to be filled in the RP-to-group mappings using the rp-address leaf 📬 That leaf isn't needed for a provider-managed RP 🙅♀️
Users can pick a specific mechanism for RP discovery, like the auto-rp, static-rp, or bsr-rp modes 🔍 By default, the model uses static-rp if ASM is requested 📌 Only a single rp-discovery mechanism is allowed for the VPN 💜 The rp-discovery container works for both provider-managed and customer-managed RPs 🤝 With a provider-managed RP, if the user wants bsr-rp as the discovery protocol, an SP should consider the provider-managed rp-group-mappings for the bsr-rp configuration 🧠 The SP then configures its selected RPs to be bsr-rp-candidates 🏆 With a customer-managed RP and a bsr-rp discovery mechanism, the rp-address provided becomes the bsr-rp candidate 🫶
6.2.4. Extranet VPNs 🌉
Sometimes a particular VPN needs access to resources (servers, hosts, etc.) that live outside of it 🖥️ Those resources might be located in another VPN 👀
+-----------+ +-----------+
/ \ / \
Site A -- | VPN A | --- | VPN B | --- Site B
\ / \ / (Shared
+-----------+ +-----------+ resources)In the figure above, VPN B has some resources on Site B that need to be available to some customers/partners 🤝 VPN A has to be able to reach those VPN B resources 💌
This kind of VPN connection can be done with a VPN policy, as defined in Section 6.5.2.2 📜 But for simple cases where a particular VPN (VPN A) needs access to all resources in another VPN (VPN B), the model gives you an easier way using the extranet-vpns container 🎉
The extranet-vpns container defines a list of VPNs that a particular VPN wants to access 📋 The extranet-vpns container must be used on customer VPNs that access extranet resources in another VPN 🧚 In the figure above, to give VPN A access to VPN B, the extranet-vpns container needs to be configured under VPN A with an entry for VPN B 🪄 There is no service configuration requirement on VPN B 🙌
Readers should note that even if VPN B has no configuration requirement, if VPN A lists VPN B as an extranet, all sites in VPN B will gain access to all sites in VPN A 👑 That's a big deal, bestie 😭
The site-role leaf defines the role of the local VPN sites in the target extranet VPN service topology 🎭 Site roles are defined in Section 6.4 📖 Based on that, the requirements described in Section 6.4 regarding the site-role leaf also apply here 💅
In the example below, VPN A accesses VPN B resources through an extranet connection 🌈 A Spoke role is required for VPN A sites, since sites from VPN A must not be able to communicate with each other through the extranet VPN connection 🙅♀️💔
<vpn-service>
<vpn-id>VPNB</vpn-id>
<vpn-service-topology>hub-spoke</vpn-service-topology>
</vpn-service>
<vpn-service>
<vpn-id>VPNA</vpn-id>
<vpn-service-topology>any-to-any</vpn-service-topology>
<extranet-vpns>
<extranet-vpn>
<vpn-id>VPNB</vpn-id>
<site-role>spoke-role</site-role>
</extranet-vpn>
</extranet-vpns>
</vpn-service>This model does not define how the extranet configuration gets achieved 🛠️
Any more complex VPN interconnection scenario (e.g., only certain parts of sites on VPN A accessing only certain parts of sites on VPN B) needs to be achieved using a VPN attachment as defined in Section 6.5.2, and especially a VPN policy as defined in Section 6.5.2.2 🧩💖
6.3. Site Overview
okay bestie, so a site is basically a customer's office hooking up to one or more VPN services 🏢💖 like the New York Office in this pic is giving VPN1 AND VPN2 at the same time, iconic 🗽✨
+-------------+
/ \
+------------------+ +-----| VPN1 |
| | | \ /
| New York Office |------ (site) -----+ +-------------+
| | | +-------------+
+------------------+ | / \
+-----| VPN2 |
\ /
+-------------+A site has a few main characteristics 💅
- Unique identifier (
site-id): this is what makes the site unique across the whole network infrastructure 🆔 It's just a string, so it can use any encoding the VPN service's local admin picks 🫶 - Locations (
locations): site location info so it's easy to grab stuff from the nearest available resources 📍 A site can be made up of multiple locations. - Devices (
devices): lets the customer ask the SP for one or more customer premises equipment entities (CEs) for a particular site 📦 - Management (
management): sets the management type for the site, like co-managed, customer-managed, or provider-managed 🛠️ See Section 6.10. - Site network accesses (
site-network-accesses): the list of network accesses tied to the site, plus their properties, especially bearer, connection, and service parameters 🔌
A site-network-access is an IP logical connection of a site, and a site can have multiple of them 🧵 Check this vibe:
+------------------+ Site
| |-----------------------------------
| |****** (site-network-access#1) ******
| New York Office |
| |****** (site-network-access#2) ******
| |-----------------------------------
+------------------+Multihoming is the big example of why you'd use multiple site-network-accesses 🙌 but other meshing cases can include multiple ones too 🕸️
The site config is treated as one big global thing 🌍 It's mostly the management system's job to split the parameters between the different elements in the network. Like, for site-network-access config, the management system has to divide the overall parameters between the PE configuration and the CE configuration 🍰
6.3.1. Devices and Locations
A site can be made up of multiple locations, and all of them need to be configured inside the "locations" container and list 📍 A super classic example is a headquarters in a city made of multiple buildings 🏙️ Those buildings might be spread across different parts of the city and linked by intra-city fibers (customer metropolitan area network) 🧵 When connecting to a VPN service in that case, the customer may ask for multihoming based on those distributed locations.
New York Site
+------------------+ Site
| +--------------+ |-----------------------------------
| | Manhattan | |****** (site-network-access#1) ******
| +--------------+ |
| +--------------+ |
| | Brooklyn | |****** (site-network-access#2) ******
| +--------------+ |
| |-----------------------------------
+------------------+A customer can also request some premises equipment entities (CEs) from the SP through the "devices" container 📦 Requesting a CE means a provider-managed or co-managed model 🤝 A particular device has to be ordered to a particular already-configured location, which helps the SP send it to the right postal address 📮 In a multi-location site, a customer might request a CE for each location where multihoming needs to happen. In the figure above, one device could be requested for Manhattan and another one for Brooklyn 🗽
By playing with devices and locations, the user can shape the multihoming setup they want: single CE, dual CE, etc. 💅
6.3.2. Site Network Accesses
As mentioned earlier, a site may be multihomed 🙌 Each IP network access for a site is defined in the "site-network-accesses" container. The site-network-access parameter defines how the site is connected to the network, and it's split into three main classes of parameters:
bearer: defines requirements of the attachment (below Layer 3).connection: defines Layer 3 protocol parameters of the attachment.availability: defines the site's availability policy. The availability parameters are defined in Section 6.7.
The site-network-access has a specific type (site-network-access-type). This document defines two types:
point-to-point: describes a point-to-point connection between the SP and the customer.multipoint: describes a multipoint connection between the SP and the customer.
The access type can change which parameters the customer gets, e.g., an SP might not offer encryption on multipoint accesses 🔐 Which parameters are supported for point-to-point and/or multipoint is up to the provider, and that topic is out of scope for this doc 🙅 Some containers in the model may need extensions to work properly for multipoint accesses.
6.3.2.1. Bearer
The bearer container defines the requirements for the site attachment to the provider network that are below Layer 3 🔗
The bearer parameters help determine which access media gets used. This is further described in Section 6.6.3.
6.3.2.2. Connection
The "ip-connection" container defines the protocol parameters of the attachment (IPv4 and IPv6) 🌐 Depending on the management mode, it refers to PE-CE addressing or CE-to-customer-LAN addressing. In any case, it describes the responsibility boundary between the provider and the customer. For a customer-managed site, it refers to the PE-CE connection. For a provider-managed site, it refers to the CE-to-LAN connection.
6.3.2.2.1. IP Addressing
An IP subnet can be configured for either IPv4 or IPv6 Layer 3 protocols. For a dual-stack connection, two subnets will be provided, one for each address family ✌️
The "address-allocation-type" determines how the address allocation needs to be done. The current model proposes five ways to perform IP address allocation:
provider-dhcp: The provider will provide DHCP service for customer equipment; this is applicable to either theIPv4container or theIPv6container.provider-dhcp-relay: The provider will provide DHCP relay service for customer equipment; this is applicable to both IPv4 and IPv6 addressing. The customer needs to populate the DHCP server list to be used.static-address: Addresses will be assigned manually; this is applicable to both IPv4 and IPv6 addressing.slaac: This parameter enables stateless address autoconfiguration [RFC4862]. This is applicable to IPv6 only.provider-dhcp-slaac: The provider will provide DHCP service for customer equipment, as well as stateless address autoconfiguration. This is applicable to IPv6 only.
In the dynamic addressing mechanism, the SP is expected to provide at least the IP address, mask, and default gateway information 🎀
6.3.2.2.2. OAM
A customer may require a specific IP connectivity fault detection mechanism on the IP connection 🩺 The model supports BFD as a fault detection mechanism. This can be extended with other mechanisms via augmentation. The provider can propose some profiles to the customer, depending on the service level the customer wants to achieve. Profile names have to be communicated to the customer, but that communication is out of scope for this document. Some fixed values for the holdtime period may also be imposed by the customer, if the provider allows the customer this function.
The "oam" container can easily be augmented by other mechanisms. In particular, work done by the LIME Working Group (https://datatracker.ietf.org/wg/lime/charter/) may be reused in applicable scenarios 🦋
6.3.2.3. Inheritance of Parameters Defined at Site Level and Site Network Access Level
Some parameters can be configured at both the site level and the site-network-access level, e.g., routing, services, security. Inheritance applies when parameters are defined at the site level. If a parameter is configured at both the site level and the access level, the access-level parameter MUST override the site-level parameter. Those parameters will be described later in this document 👑
In terms of provisioning impact, it's up to the implementation to decide on the appropriate behavior when modifying existing configurations. But the SP will need to tell the user about the impact of using inheritance 📣 For example, say a site has already provisioned three site-network-accesses. What happens if a customer changes a service parameter at the site level? An implementation of this model may update the service parameters of all already-provisioned site-network-accesses (with potential impact on live traffic), or it may take into account this new parameter only for the new sites 🤔
6.4. Site Role
A VPN has a particular service topology, as described in Section 6.2.1. As a consequence, each site belonging to a VPN is assigned a particular role in that topology 🎭 The site-role leaf defines the role of the site in a particular VPN topology.
In the any-to-any VPN service topology, all sites MUST have the same role, which will be "any-to-any-role" 🫶
In the Hub-and-Spoke VPN service topology or the Hub and Spoke disjoint VPN service topology, sites MUST have a Hub role or a Spoke role 🌸
6.5. Site Belonging to Multiple VPNs
6.5.1. Site VPN Flavor
A site may be part of one or multiple VPNs. The "site-vpn-flavor" defines the way the VPN multiplexing is done. The current version of the model supports four flavors:
site-vpn-flavor-single: The site belongs to only one VPN.site-vpn-flavor-multi: The site belongs to multiple VPNs, and all the logical accesses of the sites belong to the same set of VPNs.site-vpn-flavor-sub: The site belongs to multiple VPNs with multiple logical accesses. Each logical access may map to different VPNs (one or many).site-vpn-flavor-nni: The site represents an option A NNI.
6.5.1.1. Single VPN Attachment: site-vpn-flavor-single
The figure below describes a single VPN attachment. The site connects to only one VPN 🌈
+--------+
+------------------+ Site / \
| |-----------------------------| |
| |***(site-network-access#1)***| VPN1 |
| New York Office | | |
| |***(site-network-access#2)***| |
| |-----------------------------| |
+------------------+ \ /
+--------+6.5.1.2. MultiVPN Attachment: site-vpn-flavor-multi ✨
okay so this one is about a site hooked up to multiple VPNs at once 🌈 the diagram is literally giving main character energy 💅
+---------+
+---/----+ \
+------------------+ Site / | \ |
| |--------------------------------- | |VPN B|
| |***(site-network-access#1)******* | | |
| New York Office | | | | |
| |***(site-network-access#2)******* \ | /
| |-----------------------------| VPN A+-----|---+
+------------------+ \ /
+--------+so in this example the New York office is multihomed 🏙️ both logical accesses follow the same VPN attachment rules, and both of them are connected to VPN A and VPN B 💜
reaching VPN A or VPN B from the NY office happens through destination-based routing 🛣️ and ngl, if the same destination is reachable from both VPNs, that can cause routing troubles 💀 so the customer admin has to make sure each prefix is mapped correctly in each VPN. that's their job, bestie 🫶
6.5.1.3. SubVPN Attachment: site-vpn-flavor-sub
this is the subVPN glow-up 🦋 the site connects to multiple VPNs, but each logical access only gets attached to a specific set of them. the classic use case is a customer site shared by multiple affiliates, where each affiliate has private resources that can't be shared (and the affiliates are not allowed to talk to each other 🙈). it's kinda like having separate sites, except the customer still wants to share some physical stuff while keeping strong communication isolation between the affiliates 🔐
in this example, site-network-access#1 is attached to VPN B, and site-network-access#2 is attached to VPN A ✨
+------------------+ Site +--------+
| |----------------------------------/ \
| |****(site-network-access#1)******| VPN B |
| New York Office | \ /
| | +--------+
| | +--------+
| | / \
| |****(site-network-access#2)******| VPN A |
| | \ /
| | +--------+
| |-----------------------------------
+------------------+okay and now it gets even more iconic 👑 a multiVPN can be layered on top of a subVPN, so each site-network-access can reach multiple VPNs. in the example below, site-network-access#1 is mapped to VPN B and VPN C, while site-network-access#2 is mapped to VPN A and VPN D 🌸
+-----------------+ Site +------+
| |--------------------------------/ +-----+
| |****(site-network-access#1)****| VPN B / \
| New York Office | \ | VPN C |
| | +-----\ /
| | +-----+
| |
| | +-------+
| | / +-----+
| |****(site-network-access#2)****| VPN A / \
| | \ | VPN D |
| | +------\ /
| |--------------------------------- +-----+
+-----------------+multihoming works with subVPNs too 🧚 in this case the site-network-accesses get grouped, and a particular group has access to the same set of VPNs. in the example below, site-network-access#1 and site-network-access#2 are in the same group (multihomed together) and map to VPN B and VPN C. then site-network-access#3 and site-network-access#4 are in another group (also multihomed together) and map to VPN A and VPN D 🍓
+-----------------+ Site +------+
| |---------------------------------/ +-----+
| |****(site-network-access#1)*****| VPN B / \
| New York Office |****(site-network-access#2)***** \ | VPN C |
| | +-----\ /
| | +-----+
| |
| | +------+
| | / +-----+
| |****(site-network-access#3)*****| VPN A / \
| |****(site-network-access#4)***** \ | VPN D |
| | +-----\ /
| |---------------------------------- +-----+
+-----------------+and for the service config part 🎀 a subVPN can be achieved by asking that the site-network-access use the same bearer (see Sections 6.6.4 and 6.6.6.4 for more details). no cap, that's the whole trick 😭
6.5.1.4. NNI: site-vpn-flavor-nni
a Network-to-Network Interface (NNI) can be modeled using the sites container (see Section 6.15.1) 🌈 but using sites to model an NNI is only one possible option, so check Section 6.15 for the others. this option is called "option A" because it refers to the option A NNI defined in [RFC4364] 🦋
it's really helpful for the SP to say "hey, this requested VPN connection isn't a regular site, it's an NNI" 💖 because specific default device config parameters may be applied to NNIs (for example, ACLs and routing policies) 🔥
SP A SP B
------------------- -------------------
/ \ / \
| | | |
| ++++++++ Inter-AS link ++++++++ |
| + +_______________+ + |
| + (VRF1)---(VPN1)----(VRF1) + |
| + ASBR + + ASBR + |
| + (VRF2)---(VPN2)----(VRF2) + |
| + +_______________+ + |
| ++++++++ ++++++++ |
| | | |
| | | |
| | | |
| ++++++++ Inter-AS link ++++++++ |
| + +_______________+ + |
| + (VRF1)---(VPN1)----(VRF1) + |
| + ASBR + + ASBR + |
| + (VRF2)---(VPN2)----(VRF2) + |
| + +_______________+ + |
| ++++++++ ++++++++ |
| | | |
| | | |
\ / \ /
------------------- -------------------so the figure above is an option A NNI scenario that can be modeled with the sites container 🧚 to connect its customer VPNs (VPN1 and VPN2) in SP B, SP A may ask for some site-network-accesses to SP B. the site-vpn-flavor-nni is how SP B learns that this is an NNI and not a regular customer site 💅 and yes, it can be multihomed and multiVPN too ✨
6.5.2. Attaching a Site to a VPN
okay so because there are multiple site-vpn flavors, attaching a site to an IP VPN happens at the site-network-access (logical access) level, using the "vpn-attachment" container 🎀 that container is mandatory, no skipping it 🙈 the model gives you two ways to attach a site to a VPN:
- By referencing the target VPN directly.
- By referencing a VPN policy for attachments that are more complex.
there's a choice in the model so you can pick whichever flavor fits best 💖
6.5.2.1. Referencing a VPN
referencing a vpn-id is the easy way to attach a particular logical access to a VPN 🦋 it's the best option for a single VPN attachment, or for a subVPN where each logical access has just one VPN attachment. when you reference a vpn-id, you also have to add the site-role setting to express the role of the site in the target VPN service topology 🌸
<site>
<site-id>SITE1</site-id>
<site-network-accesses>
<site-network-access>
<site-network-access-id>LA1</site-network-access-id>
<vpn-attachment>
<vpn-id>VPNA</vpn-id>
<site-role>spoke-role</site-role>
</vpn-attachment>
</site-network-access>
<site-network-access>
<site-network-access-id>LA2</site-network-access-id>
<vpn-attachment>
<vpn-id>VPNB</vpn-id>
<site-role>spoke-role</site-role>
</vpn-attachment>
</site-network-access>
</site-network-accesses>
</site>the example above is a subVPN case where a site (SITE1) has two logical accesses (LA1 and LA2), with LA1 attached to VPNA and LA2 attached to VPNB 🫶✨
6.5.2.2. VPN Policy ✨
okay so the vpn-policy list is how you describe a multiVPN situation, where one logical access belongs to more than one VPN at the same time 🫶. If you have the subVPN case, where each logical access is part of a different set of VPNs, you can create multiple VPN policies to handle it 💅.
Since a site can belong to multiple VPNs, the vpn-policy list can have multiple entries 🦋. You can also add a filter so that only some LANs of the site end up in a particular VPN 🎀. And every time a site (or LAN) gets attached to a VPN, you have to describe its exact role (site-role) within that target VPN service topology 👑. No skipping this part, bestie!
Here's a diagram of the setup:
+--------------------------------------------------------------+
| Site1 ------ PE7 |
+-------------------------+ [VPN2] |
| |
+-------------------------+ |
| Site2 ------ PE3 PE4 ------ Site3 |
+----------------------------------+ |
| |
+------------------------------------------------------------+ |
| Site4 ------ PE5 | PE6 ------ Site5 | |
| | |
| [VPN3] | |
+------------------------------------------------------------+ |
| |
+---------------------------+In this example, Site5 is in two VPNs: VPN3 and VPN2 💖. It plays a Hub role in VPN2 and an any-to-any role in VPN3. Here's how you'd write that multiVPN scenario:
<site>
<site-id>Site5</site-id>
<vpn-policies>
<vpn-policy>
<vpn-policy-id>POLICY1</vpn-policy-id>
<entries>
<id>ENTRY1</id>
<vpn>
<vpn-id>VPN2</vpn-id>
<site-role>hub-role</site-role>
</vpn>
</entries>
<entries>
<id>ENTRY2</id>
<vpn>
<vpn-id>VPN3</vpn-id>
<site-role>any-to-any-role</site-role>
</vpn>
</entries>
</vpn-policy>
</vpn-policies>
<site-network-accesses>
<site-network-access>
<site-network-access-id>LA1</site-network-access-id>
<vpn-attachment>
<vpn-policy-id>POLICY1</vpn-policy-id>
</vpn-attachment>
</site-network-access>
</site-network-accesses>
</site>Now, if you need something more granular, filtering is your friend 🔍. Say LAN1 from Site5 has to attach to VPN2 as a Hub, and LAN2 has to attach to VPN3. Then you'd do this:
<site>
<site-id>Site5</site-id>
<vpn-policies>
<vpn-policy>
<vpn-policy-id>POLICY1</vpn-policy-id>
<entries>
<id>ENTRY1</id>
<filter>
<lan-tag>LAN1</lan-tag>
</filter>
<vpn>
<vpn-id>VPN2</vpn-id>
<site-role>hub-role</site-role>
</vpn>
</entries>
<entries>
<id>ENTRY2</id>
<filter>
<lan-tag>LAN2</lan-tag>
</filter>
<vpn>
<vpn-id>VPN3</vpn-id>
<site-role>any-to-any-role</site-role>
</vpn>
</entries>
</vpn-policy>
</vpn-policies>
<site-network-accesses>
<site-network-access>
<site-network-access-id>LA1</site-network-access-id>
<vpn-attachment>
<vpn-policy-id>POLICY1</vpn-policy-id>
</vpn-attachment>
</site-network-access>
</site-network-accesses>
</site>6.6. Deciding Where to Connect the Site 🌸
The management system is the one figuring out where to connect each site-network-access of a particular site to the provider network (like a PE or an aggregation switch) 🧚.
The model gives you parameters and constraints that can nudge how the site-network-access gets meshed 💜.
The management system SHOULD honor any customer constraints 🙏. If a constraint is too strict and can't be fulfilled, the management system MUST NOT provision the site and SHOULD provide relevant information to the user 😭. How that information gets delivered is out of scope for this document. Whether to relax the constraint is then up to the user 🍓.
Parameters are only hints. They're not orders! 💅
Parameters are just hints for the management system when it's choosing a spot for the service 🌈.
On top of parameters and constraints, the management system MAY base its decision on other internal constraints the SP gets to set, like least load and distance, and so on ⭐.
6.6.1. Constraint: Device 💻
When the provider is managing things or it's co-managed, the customer may have already ordered one or more devices 🛒. The customer may force a particular site-network-access onto a particular device they ordered 🎯.
New York Site
+------------------+ Site
| +--------------+ |-----------------------------------
| | Manhattan | |
| | CE1********* (site-network-access#1) ******
| +--------------+ |
| +--------------+ |
| | Brooklyn CE2********* (site-network-access#2) ******
| +--------------+ |
| |-----------------------------------
+------------------+In this picture, site-network-access#1 is tied to CE1 in the service request, and the SP must make sure that connection gets provisioned 😤.
6.6.2. Constraint/Parameter: Site Location 📍
The location info in this model MAY be used by a management system to figure out the target PE to mesh the site on (SP side). Every site network access must have a particular location associated with it when it's configured. The SP MUST honor the termination of the access on the location tied to the site network access (customer side). The country-code in the site location SHOULD be expressed as an ISO ALPHA-2 code 🌍.
The location-flavor decides where the site-network-access location comes from 🗺️. For provider-managed or co-managed sites, the user is expected to set up a device-reference (the device case) that binds the site-network-access to a particular device the customer ordered 🔗. Since each device is already associated with a location, the location info gets pulled from the device's location 📦. For customer-managed sites, the user is expected to set up a location-reference (the location case). This points at an existing configured location and helps with placement 📌.
POP#1 (New York)
+---------+
| PE1 |
Site #1 ---... | PE2 |
(Atlantic City) | PE3 |
+---------+
POP#2 (Washington)
+---------+
| PE4 |
| PE5 |
| PE6 |
+---------+
POP#3 (Philadelphia)
+---------+
| PE7 |
Site #2 CE#1---... | PE8 |
(Reston) | PE9 |
+---------+Here, Site #1 is customer-managed with a location L1, while Site #2 is provider-managed with a CE (CE#1) that was ordered. Site #2 is configured with L2 as its location. When you configure a site-network-access for Site #1, you need to reference L1 so the management system knows the access has to terminate on that location 🧭. Then, for distance reasons, the management system may mesh Site #1 on a PE in the Philadelphia POP. It can also look at the resources available on PEs to pick the exact target PE (e.g., least loaded) 🤓.
For Site #2, you're expected to configure the site-network-access with a device-reference to CE#1. That way the system knows the access must terminate on the location of CE#1 and must be connected to CE#1 💁. For placing the SP side of the access connection, if the nearest PE is used, the system may mesh Site #2 on the Washington POP 🌸.
6.6.3. Constraint/Parameter: Access Type 📡
The management system needs to elect the access media for connecting the site to the customer (for example, xDSL, leased line, or Ethernet backhaul) 🔌. The customer may provide some parameters or constraints that act as hints for the management system.
The bearer container information SHOULD be the first piece of information considered when making this decision:
- The
requested-typeparameter tells the system which media type the customer would like to use. If thestrictleaf is equal totrue, this MUST be considered a strict constraint, so the management system can't connect the site with another media type 🚫. If thestrictleaf is equal tofalse(default) and the requested media type can't be fulfilled, the management system can select another media type. The supported media types SHOULD be communicated by the SP to the customer through a mechanism that's out of scope for this document 📣. - The
always-onleaf defines a strict constraint. If it's set totrue, the management system MUST elect a media type that is "always-on" (so, no dial access type) ⚡. - The
bearer-referenceparameter is for when the customer has already ordered a network connection to the SP, apart from the IP VPN site, and wants to reuse it 🔁. The string is an internal reference from the SP that describes the already-available connection. This is also a strict requirement that can't be relaxed. How the reference reaches the customer is out of scope for this document. As a pure example, once the customer orders the bearer (through a process that's out of scope for this model), the SP may provide the bearer reference to use for provisioning services on top 🎁.
Any other internal parameters from the SP can also be used. The management system MAY use other parameters, such as the requested svc-input-bandwidth and svc-output-bandwidth, to help decide which access type to use 💜.
6.6.4. Constraint: Access Diversity 🎀
okay so every site-network-access can have one or more constraints that decide where it gets placed 🗺️. By default the model just assumes there are no constraints (chill 😌), but every site-network-access is expected to get its own unique bearer 💅.
To help with all the different placement scenarios, a site-network-access can be tagged with one or multiple group identifiers 🏷️. A group identifier is a string, so it can be something explicit like "multihomed-set1" or "subVPN", or a numbered one like 12345678. Both are totally valid 🫶. What a group-id means is local to each customer administrator, and the management system MUST ensure that different customers can use the same group-ids 🌸.
Group-ids can also be defined at the site level. When that happens, all site-network-accesses under the site MUST inherit the group-ids of the site they belong to 🌳. If there are site-level group-ids AND some group-ids on the site-network-access itself, the management system MUST consider the union of all groups (site level and site-network-access level) for that particular site-network-access. Union just means everything combined, no drama ✨.
For an already-configured site-network-access, each constraint MUST be expressed against a targeted set of site-network-accesses. That site-network-access MUST never be taken into account in the targeted set 🙅♀️. For example: "My site-network-access S must not be connected on the same POP as the site-network-accesses that are part of Group 10." The targeted set can be written as a list of groups, as "all-other-accesses", or as "all-other-groups". The all-other-accesses option means the current constraint MUST be evaluated against all the other site-network-accesses belonging to the current site 👯. The all-other-groups option means the constraint MUST be evaluated against all groups that the current site-network-access does not belong to 🧩.
The current model has multiple constraint-types 💜:
pe-diverse: the current site-network-access MUST NOT be connected to the same PE as the targeted site-network-accesses.pop-diverse: the current site-network-access MUST NOT be connected to the same POP as the targeted site-network-accesses.linecard-diverse: the current site-network-access MUST NOT be connected to the same linecard as the targeted site-network-accesses.bearer-diverse: the current site-network-access MUST NOT use common bearer components compared to bearers used by the targeted site-network-accesses.bearer-diversegives some level of diversity at the access level 🦋. As an example, two bearer-diverse site-network-accesses must not use the same DSLAM, BAS, or Layer 2 switch 🍓.same-pe: the current site-network-access MUST be connected to the same PE as the targeted site-network-accesses.same-bearer: the current site-network-access MUST be connected using the same bearer as the targeted site-network-accesses.
These constraint-types can be extended through augmentation 🧚.
Each constraint is written as "The site-network-access S must be <constraint-type> (e.g., pe-diverse, pop-diverse) from these <target> site-network-accesses." 📝
The group-id used to target some site-network-accesses may be the same as the one used by the current site-network-access. This makes life easier when a group of site-network-access points has a constraint between the access points inside that group 💅. For example, if we want a set of sites (Site#1 to Site#5) to be connected on different PEs, we can tag them all with the same group-id and express a pe-diverse constraint for that group-id 🎀.
<site>
<site-id>SITE1</site-id>
<site-network-accesses>
<site-network-access>
<site-network-access-id>1</site-network-access-id>
<access-diversity>
<groups>
<group>
<group-id>10</group-id>
</group>
</groups>
<constraints>
<constraint>
<constraint-type>pe-diverse</constraint-type>
<target>
<group>
<group-id>10</group-id>
</group>
</target>
</constraint>
</constraints>
</access-diversity>
<vpn-attachment>
<vpn-id>VPNA</vpn-id>
<site-role>spoke-role</site-role>
</vpn-attachment>
</site-network-access>
</site-network-accesses>
</site>
<site>
<site-id>SITE2</site-id>
<site-network-accesses>
<site-network-access>
<site-network-access-id>1</site-network-access-id>
<access-diversity>
<groups>
<group>
<group-id>10</group-id>
</group>
</groups>
<constraints>
<constraint>
<constraint-type>pe-diverse</constraint-type>
<target>
<group>
<group-id>10</group-id>
</group>
</target>
</constraint>
</constraints>
</access-diversity>
<vpn-attachment>
<vpn-id>VPNA</vpn-id>
<site-role>spoke-role</site-role>
</vpn-attachment>
</site-network-access>
</site-network-accesses>
</site>
...
<site>
<site-id>SITE5</site-id>
<site-network-accesses>
<site-network-access>
<site-network-access-id>1</site-network-access-id>
<access-diversity>
<groups>
<group>
<group-id>10</group-id>
</group>
</groups>
<constraints>
<constraint>
<constraint-type>pe-diverse</constraint-type>
<target>
<group>
<group-id>10</group-id>
</group>
</target>
</constraint>
</constraints>
</access-diversity>
<vpn-attachment>
<vpn-id>VPNA</vpn-id>
<site-role>spoke-role</site-role>
</vpn-attachment>
</site-network-access>
</site-network-accesses>
</site>The group-id used to target some site-network-accesses may also be different from the one used by the current site-network-access 🔀. This is handy for saying that a group of sites has some constraints against another group of sites, while there is no constraint within the group 💜. For example, we have a set of six sites and two groups, and we want to make sure that a site in the first group must be pop-diverse from a site in the second group 🧁:
<site>
<site-id>SITE1</site-id>
<site-network-accesses>
<site-network-access>
<site-network-access-id>1</site-network-access-id>
<access-diversity>
<groups>
<group>
<group-id>10</group-id>
</group>
</groups>
<constraints>
<constraint>
<constraint-type>pop-diverse</constraint-type>
<target>
<group>
<group-id>20</group-id>
</group>
</target>
</constraint>
</constraints>
</access-diversity>
<vpn-attachment>
<vpn-id>VPNA</vpn-id>
<site-role>spoke-role</site-role>
</vpn-attachment>
</site-network-access>
</site-network-accesses>
</site>
<site>
<site-id>SITE2</site-id>
<site-network-accesses>
<site-network-access>
<site-network-access-id>1</site-network-access-id>
<access-diversity>
<groups>
<group>
<group-id>10</group-id>
</group>
</groups>
<constraints>
<constraint>
<constraint-type>pop-diverse</constraint-type>
<target>
<group>
<group-id>20</group-id>
</group>
</target>
</constraint>
</constraints>
</access-diversity>
<vpn-attachment>
<vpn-id>VPNA</vpn-id>
<site-role>spoke-role</site-role>
</vpn-attachment>
</site-network-access>
</site-network-accesses>
</site>
...
<site>
<site-id>SITE5</site-id>
<site-network-accesses>
<site-network-access>
<site-network-access-id>1</site-network-access-id>
<access-diversity>
<groups>
<group>
<group-id>20</group-id>
</group>
</groups>
<constraints>
<constraint>
<constraint-type>pop-diverse</constraint-type>
<target>
<group>
<group-id>10</group-id>
</group>
</target>
</constraint>
</constraints>
</access-diversity>
<vpn-attachment>
<vpn-id>VPNA</vpn-id>
<site-role>spoke-role</site-role>
</vpn-attachment>
</site-network-access>
</site-network-accesses>
</site>
<site>
<site-id>SITE6</site-id>
<site-network-accesses>
<site-network-access>
<site-network-access-id>1</site-network-access-id>
<access-diversity>
<groups>
<group>
<group-id>20</group-id>
</group>
</groups>
<constraints>
<constraint>
<constraint-type>pop-diverse</constraint-type>
<target>
<group>
<group-id>10</group-id>
</group>
</target>
</constraint>
</constraints>
</access-diversity>
<vpn-attachment>
<vpn-id>VPNA</vpn-id>
<site-role>spoke-role</site-role>
</vpn-attachment>
</site-network-access>
</site-network-accesses>
</site>6.6.5. Infeasible Access Placement 🙃
Some infeasible access placement scenarios could be created with the proposed configuration framework 😬. These could come from constraints that are too restrictive, which leads to infeasible access placement in the network, or from conflicting constraints, which also lead to infeasible access placement. An example of conflicting rules would be asking for site-network-access#1 to be pe-diverse from site-network-access#2 while also asking for site-network-access#2 to be on the same PE as site-network-access#1 💀. When the management system cannot determine the placement of a site-network-access, it SHOULD return an error message indicating that placement was not possible.
6.6.6. Examples of Access Placement 🧚♀️
6.6.6.1. Multihoming
okay so the customer wants a multihomed site 🦋 two site-network-accesses, and for resiliency they want both of them meshed on different POPs. the diagram is literally giving two POPs, each with its own cluster of PEs, and site#1 hooked up to both accesses 💅
this scenario can be written like this:
<site>
<site-id>SITE1</site-id>
<site-network-accesses>
<site-network-access>
<site-network-access-id>1</site-network-access-id>
<access-diversity>
<groups>
<group>
<group-id>10</group-id>
</group>
</groups>
<constraints>
<constraint>
<constraint-type>pop-diverse</constraint-type>
<target>
<group>
<group-id>20</group-id>
</group>
</target>
</constraint>
</constraints>
</access-diversity>
<vpn-attachment>
<vpn-id>VPNA</vpn-id>
<site-role>spoke-role</site-role>
</vpn-attachment>
</site-network-access>
<site-network-access>
<site-network-access-id>2</site-network-access-id>
<access-diversity>
<groups>
<group>
<group-id>20</group-id>
</group>
</groups>
<constraints>
<constraint>
<constraint-type>pop-diverse</constraint-type>
<target>
<group>
<group-id>10</group-id>
</group>
</target>
</constraint>
</constraints>
</access-diversity>
<vpn-attachment>
<vpn-id>VPNA</vpn-id>
<site-role>spoke-role</site-role>
</vpn-attachment>
</site-network-access>
</site-network-accesses>
</site>But it can also be written like this ✨
<site>
<site-id>SITE1</site-id>
<site-network-accesses>
<site-network-access>
<site-network-access-id>1</site-network-access-id>
<access-diversity>
<constraints>
<constraint>
<constraint-type>pop-diverse</constraint-type>
<target>
<all-other-accesses/>
</target>
</constraint>
</constraints>
</access-diversity>
<vpn-attachment>
<vpn-id>VPNA</vpn-id>
<site-role>spoke-role</site-role>
</vpn-attachment>
</site-network-access>
<site-network-access>
<site-network-access-id>2</site-network-access-id>
<access-diversity>
<constraints>
<constraint>
<constraint-type>pop-diverse</constraint-type>
<target>
<all-other-accesses/>
</target>
</constraint>
</constraints>
</access-diversity>
<vpn-attachment>
<vpn-id>VPNA</vpn-id>
<site-role>spoke-role</site-role>
</vpn-attachment>
</site-network-access>
</site-network-accesses>
</site>6.6.6.2. Site Offload
ngl this one is a whole vibe 🌈 the customer has six branch offices in one region and doesn't want them all chilling on the same PE 💀 so they want:
- three of them NOT on the same linecard
- the other three on a different POP, and those three also can't share a linecard 🙈
the layout is giving POP#1 with PE1 to PE4, and POP#2 with PE5 to PE7 🧚
okay so here's the deal, the rules are:
- we make two groups of sites: Group#10 is Office#1, Office#2, and Office#3, and Group#20 is Office#4, Office#5, and Office#6 🍓
- sites in Group#10 must be pop-diverse from sites in Group#20, and vice versa 👑
- sites in Group#10 must be linecard-diverse from other sites in Group#10 (same for Group#20) 💜
and here is how each office gets written 💅
<site>
<site-id>Office1</site-id>
<site-network-accesses>
<site-network-access>
<site-network-access-id>1</site-network-access-id>
<access-diversity>
<groups>
<group>
<group-id>10</group-id>
</group>
</groups>
<constraints>
<constraint>
<constraint-type>pop-diverse</constraint-type>
<target>
<group>
<group-id>20</group-id>
</group>
</target>
</constraint>
<constraint>
<constraint-type>linecard-diverse</constraint-type>
<target>
<group>
<group-id>10</group-id>
</group>
</target>
</constraint>
</constraints>
</access-diversity>
<vpn-attachment>
<vpn-id>VPNA</vpn-id>
<site-role>spoke-role</site-role>
</vpn-attachment>
</site-network-access>
</site-network-accesses>
</site>
<site>
<site-id>Office2</site-id>
<site-network-accesses>
<site-network-access>
<site-network-access-id>1</site-network-access-id>
<access-diversity>
<groups>
<group>
<group-id>10</group-id>
</group>
</groups>
<constraints>
<constraint>
<constraint-type>pop-diverse</constraint-type>
<target>
<group>
<group-id>20</group-id>
</group>
</target>
</constraint>
<constraint>
<constraint-type>linecard-diverse</constraint-type>
<target>
<group>
<group-id>10</group-id>
</group>
</target>
</constraint>
</constraints>
</access-diversity>
<vpn-attachment>
<vpn-id>VPNA</vpn-id>
<site-role>spoke-role</site-role>
</vpn-attachment>
</site-network-access>
</site-network-accesses>
</site>
<site>
<site-id>Office3</site-id>
<site-network-accesses>
<site-network-access>
<site-network-access-id>1</site-network-access-id>
<access-diversity>
<groups>
<group>
<group-id>10</group-id>
</group>
</groups>
<constraints>
<constraint>
<constraint-type>pop-diverse</constraint-type>
<target>
<group>
<group-id>20</group-id>
</group>
</target>
</constraint>
<constraint>
<constraint-type>linecard-diverse</constraint-type>
<target>
<group>
<group-id>10</group-id>
</group>
</target>
</constraint>
</constraints>
</access-diversity>
<vpn-attachment>
<vpn-id>VPNA</vpn-id>
<site-role>spoke-role</site-role>
</vpn-attachment>
</site-network-access>
</site-network-accesses>
</site>
<site>
<site-id>Office4</site-id>
<site-network-accesses>
<site-network-access>
<site-network-access-id>1</site-network-access-id>
<access-diversity>
<groups>
<group>
<group-id>20</group-id>
</group>
</groups>
<constraints>
<constraint>
<constraint-type>pop-diverse</constraint-type>
<target>
<group>
<group-id>10</group-id>
</group>
</target>
</constraint>
<constraint>
<constraint-type>linecard-diverse</constraint-type>
<target>
<group>
<group-id>20</group-id>
</group>
</target>
</constraint>
</constraints>
</access-diversity>
<vpn-attachment>
<vpn-id>VPNA</vpn-id>
<site-role>spoke-role</site-role>
</vpn-attachment>
</site-network-access>
</site-network-accesses>
</site>
<site>
<site-id>Office5</site-id>
<site-network-accesses>
<site-network-access>
<site-network-access-id>1</site-network-access-id>
<access-diversity>
<groups>
<group>
<group-id>20</group-id>
</group>
</groups>
<constraints>
<constraint>
<constraint-type>pop-diverse</constraint-type>
<target>
<group>
<group-id>10</group-id>
</group>
</target>
</constraint>
<constraint>
<constraint-type>linecard-diverse</constraint-type>
<target>
<group>
<group-id>20</group-id>
</group>
</target>
</constraint>
</constraints>
</access-diversity>
<vpn-attachment>
<vpn-id>VPNA</vpn-id>
<site-role>spoke-role</site-role>
</vpn-attachment>
</site-network-access>
</site-network-accesses>
</site>
<site>
<site-id>Office6</site-id>
<site-network-accesses>
<site-network-access>
<site-network-access-id>1</site-network-access-id>
<access-diversity>
<groups>
<group>
<group-id>20</group-id>
</group>
</groups>
<constraints>
<constraint>
<constraint-type>pop-diverse</constraint-type>
<target>
<group>
<group-id>10</group-id>
</group>
</target>
</constraint>
<constraint>
<constraint-type>linecard-diverse</constraint-type>
<target>
<group>
<group-id>20</group-id>
</group>
</target>
</constraint>
</constraints>
</access-diversity>
<vpn-attachment>
<vpn-id>VPNA</vpn-id>
<site-role>spoke-role</site-role>
</vpn-attachment>
</site-network-access>
</site-network-accesses>
</site>6.6.6.3. Parallel Links 🎀
okay so bestie, a customer wants more site bandwidth but doesn't want to pay for a fancy upgrade 💸. the move? order two parallel site-network-accesses that both land on the same PE. literally two pipes, one destination, zero drama 🫶
*******site-network-access#1**********
Site 1 *******site-network-access#2********** PE1this is how you write it up in XML 💖
<site>
<site-id>SITE1</site-id>
<site-network-accesses>
<site-network-access>
<site-network-access-id>1</site-network-access-id>
<access-diversity>
<groups>
<group>
<group-id>PE-linkgrp-1</group-id>
</group>
</groups>
<constraints>
<constraint>
<constraint-type>same-pe</constraint-type>
<target>
<group>
<group-id>PE-linkgrp-1</group-id>
</group>
</target>
</constraint>
</constraints>
</access-diversity>
<vpn-attachment>
<vpn-id>VPNB</vpn-id>
<site-role>spoke-role</site-role>
</vpn-attachment>
</site-network-access>
<site-network-access>
<site-network-access-id>2</site-network-access-id>
<access-diversity>
<groups>
<group>
<group-id>PE-linkgrp-1</group-id>
</group>
</groups>
<constraints>
<constraint>
<constraint-type>same-pe</constraint-type>
<target>
<group>
<group-id>PE-linkgrp-1</group-id>
</group>
</target>
</constraint>
</constraints>
</access-diversity>
<vpn-attachment>
<vpn-id>VPNB</vpn-id>
<site-role>spoke-role</site-role>
</vpn-attachment>
</site-network-access>
</site-network-accesses>
</site>6.6.6.4. SubVPN with Multihoming 🌸
okay this one is giving main character energy 👑. picture a customer with a site that's dual-homed, and the two homing links have to land on two different PEs. on top of that, they want two subVPNs running over those multihomed accesses. iykyk 💅
+-----------------+ Site +------+
| |---------------------------------/ +-----+
| |****(site-network-access#1)*****| VPN B / \
| New York Office |****(site-network-access#2)************| VPN C |
| | +-----\ /
| | +-----+
| |
| | +------+
| | / +-----+
| |****(site-network-access#3)*****| VPN B / \
| |****(site-network-access#4)************| VPN C |
| | +-----\ /
| |----------------------------------- +-----+
+-----------------+so here's the breakdown ✨
- the site ends up with four site network accesses (two subVPNs, coupled through dual-homing) 🦋
- site-network-access#1 and site-network-access#3 are the multihoming pair for subVPN B. they need a PE-diverse constraint between them 💜
- site-network-access#2 and site-network-access#4 are the multihoming pair for subVPN C. same deal, PE-diverse constraint between them 🍓
- to keep the bearer situation sane 🧚, site-network-access#1 and site-network-access#2 MUST share the same bearer as site-network-access#3 and site-network-access#4
here's the XML 🎀
<site>
<site-id>SITE1</site-id>
<site-network-accesses>
<site-network-access>
<site-network-access-id>1</site-network-access-id>
<access-diversity>
<groups>
<group>
<group-id>dualhomed-1</group-id>
</group>
</groups>
<constraints>
<constraint>
<constraint-type>pe-diverse</constraint-type>
<target>
<group>
<group-id>dualhomed-2</group-id>
</group>
</target>
</constraint>
<constraint>
<constraint-type>same-bearer</constraint-type>
<target>
<group>
<group-id>dualhomed-1</group-id>
</group>
</target>
</constraint>
</constraints>
</access-diversity>
<vpn-attachment>
<vpn-id>VPNB</vpn-id>
<site-role>spoke-role</site-role>
</vpn-attachment>
</site-network-access>
<site-network-access>
<site-network-access-id>2</site-network-access-id>
<access-diversity>
<groups>
<group>
<group-id>dualhomed-1</group-id>
</group>
</groups>
<constraints>
<constraint>
<constraint-type>pe-diverse</constraint-type>
<target>
<group>
<group-id>dualhomed-2</group-id>
</group>
</target>
</constraint>
<constraint>
<constraint-type>same-bearer</constraint-type>
<target>
<group>
<group-id>dualhomed-1</group-id>
</group>
</target>
</constraint>
</constraints>
</access-diversity>
<vpn-attachment>
<vpn-id>VPNC</vpn-id>
<site-role>spoke-role</site-role>
</vpn-attachment>
</site-network-access>
<site-network-access>
<site-network-access-id>3</site-network-access-id>
<access-diversity>
<groups>
<group>
<group-id>dualhomed-2</group-id>
</group>
</groups>
<constraints>
<constraint>
<constraint-type>pe-diverse</constraint-type>
<target>
<group>
<group-id>dualhomed-1</group-id>
</group>
</target>
</constraint>
<constraint>
<constraint-type>same-bearer</constraint-type>
<target>
<group>
<group-id>dualhomed-2</group-id>
</group>
</target>
</constraint>
</constraints>
</access-diversity>
<vpn-attachment>
<vpn-id>VPNB</vpn-id>
<site-role>spoke-role</site-role>
</vpn-attachment>
</site-network-access>
<site-network-access>
<site-network-access-id>4</site-network-access-id>
<access-diversity>
<groups>
<group>
<group-id>dualhomed-2</group-id>
</group>
</groups>
<constraints>
<constraint>
<constraint-type>pe-diverse</constraint-type>
<target>
<group>
<group-id>dualhomed-1</group-id>
</group>
</target>
</constraint>
<constraint>
<constraint-type>same-bearer</constraint-type>
<target>
<group>
<group-id>dualhomed-2</group-id>
</group>
</target>
</constraint>
</constraints>
</access-diversity>
<vpn-attachment>
<vpn-id>VPNC</vpn-id>
<site-role>spoke-role</site-role>
</vpn-attachment>
</site-network-access>
</site-network-accesses>
</site>6.6.7. Route Distinguisher and VRF Allocation 🦋
okay so the route distinguisher (RD) is a critical parameter for PE-based L3VPNs, as described in [RFC4364] 👑. its whole job is letting common addressing plans live happily in different VPNs without bumping into each other 💅. like route targets (RTs), a management system is expected to allocate a VRF on the target PE and an RD for that VRF 🎀
now let's talk about when you can reuse stuff 🫶
- if a VRF already exists on the target PE and it fulfills the connectivity constraints for the site, there's no need to recreate it, and the site MAY be meshed within that existing VRF ✨. how the management system checks that an existing VRF fulfills those constraints is out of scope for this document 🙈
- if no such VRF exists on the target PE, the management system has to initiate creating a new VRF there and has to allocate a new RD for it 🌈
RD allocation policy is the SP's call 💖. the management system MAY apply a per-VPN or per-VRF allocation policy for the RD, depending on the SP's policy. in a per-VPN policy, all VRFs (spread across multiple PEs) within a VPN share the same RD value 🧚. in a per-VRF model, all VRFs should always have a unique RD value 💜. some other allocation policies are possible too, and this document doesn't restrict which ones get used 🍓
the allocation of RDs MAY be done the same way as RTs. the examples in Section 6.2.1.1 could be reused in this scenario 🦋
one more thing ⭐: an SP MAY configure a target PE for automated allocation of RDs. in that case, there's no need for any backend system to allocate an RD value 🫶
6.7. Site Network Access Availability 🌸
okay so a site can be multihomed, which just means it has multiple site-network-access points 🎀. the placement constraints from earlier sections help make sure they're physically diverse 💅
once the site-network-accesses are placed on the network, a customer may want a particular routing policy on those accesses 🧚
the "site-network-access/availability" container defines parameters for site redundancy 👑. the "access-priority" leaf defines a preference for a particular access ✨. that preference is used to model load-balancing or primary/backup setups, and the higher the access-priority value, the higher the preference 🦋
here's a picture of how access-priority works 💖
Hub#1 LAN (Primary/backup) Hub#2 LAN (Load-sharing)
| |
| access-priority 1 access-priority 1 |
|--- CE1 ------- PE1 PE3 --------- CE3 --- |
| |
| |
|--- CE2 ------- PE2 PE4 --------- CE4 --- |
| access-priority 2 access-priority 1 |
PE5
|
|
|
CE5
|
Spoke#1 site (Single-homed)so in this picture 🙈: Hub#2 needs load-sharing, which means all of its site-network-accesses MUST use the same access-priority value. Hub#1 needs a primary and a backup site-network-access, so the primary gets a higher access-priority setting 💜
okay but it can get way more complex 🍓. imagine a Hub site with five accesses (A1, A2, A3, A4, A5). the customer wants to load-share traffic on A1 and A2 in the nominal situation 🌈. if A1 and A2 fail, they want to load-share on A3 and A4 🧚. and if A1 through A4 are all down, they want to use A5 💅. you can model that with access-priority values A1=100, A2=100, A3=50, A4=50, A5=10 ✨
now the limitations 😭: an access-priority setup like that with five accesses isn't achievable if you also need traffic load-shared between A3 and A4 when A1 OR A2 is down 💀. but the authors believe access-priority covers most deployment use cases, and the model can still be extended via augmentation for more use cases 🫶
6.8. Traffic Protection 🦋
Okay bestie, traffic protection is the feature that keeps your traffic alive when a link dies 💀. The service model lets you protect traffic for a site, which gives you a better level of availability in multihoming setups, for example by using local-repair techniques when something fails. The service level guarantee that comes with it is based on an agreement between the customer and the SP, and that agreement is out of scope for this document 💅.
Site#1 Site#2
CE1 ----- PE1 -- P1 P3 -- PE3 ---- CE3
| | |
| | |
CE2 ----- PE2 -- P2 P4 -- PE4 ---- CE4
/
/
CE5 ----+
Site#3Picture an IP VPN service with three sites, and two of them are dual-homed (Site#1 and Site#2) 🌸. For dual-homed sites, we treat PE1-CE1 and PE3-CE3 as the primary, and PE2-CE2,PE4-CE4 as the backup for this example, even though protection also works for load-sharing scenarios.
To protect Site#2 against a failure, a user can set the traffic-protection/enabled leaf to true for Site#2 ✨. How the protection actually gets implemented is out of scope for this document. Still, let's look at traffic coming from a remote site (Site#1 or Site#3), where the primary path uses PE3 as the egress PE. PE3 may have a backup forwarding entry preprogrammed that points at the backup path (through PE4-CE4) for all prefixes going through the PE3-CE3 link. How that backup path is computed is also out of scope. When the PE3-CE3 link fails, traffic still gets received by PE3, but PE3 automatically switches over to the backup entry 🔁. So the path becomes PE1-P1-(...)-P3-PE3-PE4-CE4 until the remote PEs reconverge and use PE4 as the egress PE 🦋.
6.9. Security 🔐
The security container defines customer-specific security parameters for the site. The security options in the model are limited, but they can be extended via augmentation.
6.9.1. Authentication 🙈
Right now the model doesn't support any authentication parameters for the site connection. Such parameters may be added to the authentication container through augmentation.
6.9.2. Encryption 💜
Traffic encryption can be requested on the connection. It can be performed at Layer 2 or Layer 3, depending on which enumeration you pick in the layer leaf. For example, an SP may use IPsec when a customer requests Layer 3 encryption. The encryption profile can be SP defined or customer specific.
When an SP profile is used and the provider allocates a key (like a pre-shared key) for the customer to use, the SP should provide a way to communicate that key to the customer in a secured way 🔑.
When a customer profile is used, the model supports only a pre-shared key for authentication, and that key is provided through the NETCONF or RESTCONF request. A secure channel must be used so the pre-shared key cannot be intercepted 🚨.
For security reasons, the customer may need to change the pre-shared key on a regular basis 🔄. To do a key change, the user can ask the SP to change the pre-shared key by submitting a new pre-shared key for the site configuration, as shown below. This mechanism might not be hitless 😭.
<site>
<site-id>SITE1</site-id>
<site-network-accesses>
<site-network-access>
<site-network-access-id>1</site-network-access-id>
<security>
<encryption-profile>
<preshared-key>MY_NEW_KEY</preshared-key>
</encryption-profile>
</security>
</site-network-access>
</site-network-accesses>
</site>A hitless key-change mechanism may be added through augmentation ✨.
Other key-management methodologies may be added through augmentation too. There's an empty pki container that was created to help with support of PKI through augmentation 🧚.
6.10. Management 🎀
The model proposes three common management options:
- provider-managed: The CE router is managed only by the provider. In this model, the responsibility boundary between the SP and the customer is between the CE and the customer network.
- customer-managed: The CE router is managed only by the customer. In this model, the responsibility boundary between the SP and the customer is between the PE and the CE.
- co-managed: The CE router is primarily managed by the provider. In addition, the SP allows customers to access the CE for configuration/monitoring purposes. In the co-managed mode, the responsibility boundary is the same as the responsibility boundary for the provider-managed model.
Based on the management model, different security options MAY be derived 💅.
In the co-managed case, the model proposes some options to define the management address family (IPv4 or IPv6) and the associated management address 🌈.
6.11. Routing Protocols 🛣️
routing-protocol defines which routing protocol must be activated between the provider and the customer router. The current model supports the following settings: bgp, rip, ospf, static, direct, and vrrp.
The routing protocol defined applies at the provider-to-customer boundary. Depending on how the management model is administered, it may apply to the PE-CE boundary or the CE-to-customer boundary. In the case of a customer-managed site, the routing protocol defined will be activated between the PE and the CE router managed by the customer. In the case of a provider-managed site, the routing protocol defined will be activated between the CE managed by the SP and the router or LAN belonging to the customer. In this case, we expect the PE-CE routing to be configured based on the SP's rules, since both are managed by the same entity 🫶.
Rtg protocol
192.0.2.0/24 ----- CE ----------------- PE1
Customer-managed site
Rtg protocol
Customer router ----- CE ----------------- PE1
Provider-managed siteAll the examples below will refer to a scenario for a customer-managed site 🙈.
6.11.1. Handling of Dual Stack 👑
All routing protocol types support dual stack by using the address-family leaf-list ✨.
Example of dual stack using the same routing protocol:
<routing-protocols>
<routing-protocol>
<type>static</type>
<static>
<address-family>ipv4</address-family>
<address-family>ipv6</address-family>
</static>
</routing-protocol>
</routing-protocols>Example of dual stack using two different routing protocols:
<routing-protocols>
<routing-protocol>
<type>rip</type>
<rip>
<address-family>ipv4</address-family>
</rip>
</routing-protocol>
<routing-protocol>
<type>ospf</type>
<ospf>
<address-family>ipv6</address-family>
</ospf>
</routing-protocol>
</routing-protocols>6.11.2. LAN Directly Connected to SP Network 🦋
The routing protocol type direct SHOULD be used when a customer LAN is directly connected to the provider network and must be advertised in the IP VPN 🌸.
LAN attached directly to provider network:
192.0.2.0/24 ----- PE1In this case, the customer has a default route to the PE address.
6.11.3. LAN Directly Connected to SP Network with Redundancy 🔥
The routing protocol type vrrp SHOULD be used and advertised in the IP VPN when:
- the customer LAN is directly connected to the provider network, and
- LAN redundancy is expected.
LAN attached directly to provider network with LAN redundancy:
192.0.2.0/24 ------ PE1
|
+--- PE2In this case, the customer has a default route to the SP network.
6.11.4. Static Routing 🧚
The routing protocol type static MAY be used when a customer LAN is connected to the provider network through a CE router and must be advertised in the IP VPN. In this case, the static routes give next hops (nh) to the CE and to the PE. The customer has a default route to the SP network.
Static rtg
192.0.2.0/24 ------ CE -------------- PE
| |
| Static route 192.0.2.0/24 nh CE
Static route 0.0.0.0/0 nh PE6.11.5. RIP Routing 🌈
The routing protocol type rip MAY be used when a customer LAN is connected to the provider network through a CE router and must be advertised in the IP VPN. For IPv4, the model assumes that RIP version 2 is used.
In the case of dual-stack routing requested through this model, the management system will be responsible for configuring RIP (including the correct version number) and associated address families on network elements 💖.
RIP rtg
192.0.2.0/24 ------ CE -------------- PE6.11.6. OSPF Routing 🦋
okay so the routing protocol type "ospf" MAY be used when a customer LAN is connected to the provider network through a CE router and must be advertised in the IP VPN. ✨
It can be used to extend an existing OSPF network and interconnect different areas. See [RFC4577] for more details. 💅
+---------------------+
| |
OSPF | | OSPF
area 1 | | area 2
(OSPF | | (OSPF
area 1) --- CE ---------- PE PE ----- CE --- area 2)
| |
+---------------------+so the model also proposes an option to create an OSPF sham link between two sites sharing the same area and having a backdoor link. 🙈 The sham link gets created by referencing the target site that shares the same OSPF area. The management system is in charge of checking whether a sham link is already configured for this VPN and area between the same pair of PEs. If there's no existing sham link, the management system will provision one. This sham link MAY be reused by other sites. 🧚
+------------------------+
| |
| |
| PE (--sham link--)PE |
| | | |
+----|----------------|--+
| OSPF area 1 | OSPF area 1
| |
CE1 CE2
| |
(OSPF area 1) (OSPF area 1)
| |
+----------------+regarding dual-stack support, the user MAY specify both IPv4 and IPv6 address families, if both protocols should be routed through OSPF. 🌈 OSPF uses separate protocol instances for IPv4 and IPv6, so the management system will need to configure both OSPF version 2 and OSPF version 3 on the PE-CE link. bestie, that's a lot of config 😭
example of OSPF routing parameters in the service model:
<routing-protocols>
<routing-protocol>
<type>ospf</type>
<ospf>
<area-address>0.0.0.1</area-address>
<address-family>ipv4</address-family>
<address-family>ipv6</address-family>
</ospf>
</routing-protocol>
</routing-protocols>example of PE configuration done by the management system:
router ospf 10
area 0.0.0.1
interface Ethernet0/0
!
router ospfv3 10
area 0.0.0.1
interface Ethernet0/0
!6.11.7. BGP Routing 🎀
okay the routing protocol type "bgp" MAY be used when a customer LAN is connected to the provider network through a CE router and must be advertised in the IP VPN. 💖
BGP rtg
192.0.2.0/24 ------ CE -------------- PEthe session addressing will be derived from connection parameters as well as the SP's knowledge of the addressing plan that is in use. 🧠
in the case of dual-stack access, the user MAY request BGP routing for both IPv4 and IPv6 by specifying both address families. It'll be up to the SP and management system to determine how to decline the configuration (two BGP sessions, single, multi-session, etc.). not me trying to figure out which one to pick 💀
the service configuration below activates BGP on the PE-CE link for both IPv4 and IPv6. 🫶
BGP activation requires the SP to know the address of the customer peer. The static-address allocation type for the IP connection MUST be used. 👑
<routing-protocols>
<routing-protocol>
<type>bgp</type>
<bgp>
<autonomous-system>65000</autonomous-system>
<address-family>ipv4</address-family>
<address-family>ipv6</address-family>
</bgp>
</routing-protocol>
</routing-protocols>Depending on the SP flavor, a management system can divide this service configuration into different flavors, as shown by the following examples. ✨
example of PE configuration done by the management system (single IPv4 transport session):
router bgp 100
neighbor 203.0.113.2 remote-as 65000
address-family ipv4 vrf Cust1
neighbor 203.0.113.2 activate
address-family ipv6 vrf Cust1
neighbor 203.0.113.2 activate
neighbor 203.0.113.2 route-map SET-NH-IPV6 outexample of PE configuration done by the management system (two sessions):
router bgp 100
neighbor 203.0.113.2 remote-as 65000
neighbor 2001::2 remote-as 65000
address-family ipv4 vrf Cust1
neighbor 203.0.113.2 activate
address-family ipv6 vrf Cust1
neighbor 2001::2 activateexample of PE configuration done by the management system (multi-session):
router bgp 100
neighbor 203.0.113.2 remote-as 65000
neighbor 203.0.113.2 multisession per-af
address-family ipv4 vrf Cust1
neighbor 203.0.113.2 activate
address-family ipv6 vrf Cust1
neighbor 203.0.113.2 activate
neighbor 203.0.113.2 route-map SET-NH-IPV6 out6.12. Service 🍓
the service defines service parameters associated with the site. 💜
6.12.1. Bandwidth 🌸
the service bandwidth is the bandwidth requirement between the PE and the CE, aka the WAN link bandwidth. The requested bandwidth gets expressed as svc-input-bandwidth and svc-output-bandwidth in bits per second. The input/output direction uses the customer site as a reference: "input bandwidth" means download bandwidth for the site, and "output bandwidth" means upload bandwidth for the site. ⭐
the service bandwidth is only configurable at the site-network-access level. 🙅♀️
Using a different input and output bandwidth lets the SP figure out if the customer allows for asymmetric bandwidth access, such as ADSL. It can also be used to set rate-limiting in a different way for uploading and downloading on a symmetric bandwidth access. Smart, right? 🧚
the bandwidth is a service bandwidth expressed primarily as IP bandwidth, but if the customer enables MPLS for Carriers' Carriers (CsC), it becomes MPLS bandwidth. 🌈
6.12.2. QoS 🦋
the model proposes to define QoS parameters in an abstracted way:
qos-classification-policy: policy that defines a set of ordered rules to classify customer traffic.qos-profile: QoS scheduling profile to be applied.
6.12.2.1. QoS Classification 💅
okay this part is the main character 👑 QoS classification rules are handled by the "qos-classification-policy" container. The qos-classification-policy container is an ordered list of rules that match a flow or application and set the appropriate target class of service (target-class-id). The user can define the match using an application reference or a flow definition that is more specific (e.g., based on Layer 3 source and destination addresses, Layer 4 ports, and Layer 4 protocol). When a flow definition is used, the user can employ a "target-sites" leaf-list to identify the destination of a flow rather than using destination IP addresses. In that case, an association between the site abstraction and the IP addresses used by this site must be done dynamically. How this association is done is out of scope for this document; an implementation might not support this criterion and should advertise a deviation in this case. A rule that doesn't have a match statement is considered a match-all rule. An SP may implement a default terminal classification rule if the customer doesn't provide it. It'll be up to the SP to determine its default target class. 🎀
The current model defines some applications, but new application identities may be added through augmentation. The exact meaning of each application identity is up to the SP, so it'll be necessary for the SP to advise the customer on the usage of application matching. 🤓
Where the classification happens depends on the SP's implementation of the service, but classification concerns the flow coming from the customer site and entering the network. 🌊
Provider network
+-----------------------+
192.0.2.0/24
198.51.100.0/24 ---- CE --------- PE
Traffic flow
---------->in the figure above, the management system should implement the classification rule:
- in the ingress direction on the PE interface, if the CE is customer-managed.
- in the ingress direction on the CE interface connected to the customer LAN, if the CE is provider-managed.
the figure below describes a sample service description of QoS classification for a site: 🍭
<service>
<qos>
<qos-classification-policy>
<rule>
<id>1</id>
<match-flow>
<ipv4-src-prefix>192.0.2.0/24</ipv4-src-prefix>
<ipv4-dst-prefix>203.0.113.1/32</ipv4-dst-prefix>
<l4-dst-port>80</l4-dst-port>
<l4-protocol>tcp</l4-protocol>
</match-flow>
<target-class-id>DATA2</target-class-id>
</rule>
<rule>
<id>2</id>
<match-flow>
<ipv4-src-prefix>192.0.2.0/24</ipv4-src-prefix>
<ipv4-dst-prefix>203.0.113.1/32</ipv4-dst-prefix>
<l4-dst-port>21</l4-dst-port>
<l4-protocol>tcp</l4-protocol>
</match-flow>
<target-class-id>DATA2</target-class-id>
</rule>
<rule>
<id>3</id>
<match-application>p2p</match-application>
<target-class-id>DATA3</target-class-id>
</rule>
<rule>
<id>4</id>
<target-class-id>DATA1</target-class-id>
</rule>
</qos-classification-policy>
</qos>
</service>in the example above:
- HTTP traffic from the 192.0.2.0/24 LAN destined for 203.0.113.1/32 will be classified in DATA2.
- FTP traffic from the 192.0.2.0/24 LAN destined for 203.0.113.1/32 will be classified in DATA2.
- Peer-to-peer traffic will be classified in DATA3.
- All other traffic will be classified in DATA1.
the order of rules is very important 😭 The management system responsible for translating those rules in network element configuration MUST keep the same processing order in network element configuration. The order of rules is defined by the "id" leaf. The lowest id MUST be processed first. 🔥
6.12.2.2. QoS Profile 💖
okay so the user gets to pick either a standard profile from the operator or a custom one 🎀 and the qos-profile container is where the traffic-scheduling policy lives. it's giving main character energy ✨
Provider network
+-----------------------+
192.0.2.0/24
198.51.100.0/24 ---- CE --------- PE
\ /
qos-profilefor a provider-managed or co-managed connection, the provider should make sure scheduling follows the requested policy in both directions (SP to customer and customer to SP) 🦋 one example is a device-scheduling policy on both the PE side and the CE side of the WAN link. for a customer-managed connection, the provider is only responsible for scheduling from the SP network to the customer site 💅 so a device-scheduling policy might live only on the PE side of the WAN link toward the customer.
a custom QoS profile is a list of classes of service plus their properties 🌸 the properties are:
rate-limit: used to rate-limit the class of service. the value is a percentage of the global service bandwidth. when theqos-profilecontainer is on the CE side,svc-output-bandwidthis the reference. when it's on the PE side,svc-input-bandwidthis used.latency: used to set the latency constraint of the class. it can be the lowest possible latency or a latency boundary in milliseconds. how that gets fulfilled is up to the SP's service implementation 🧚 a strict priority queuing might be used on the access and in the core, and/or a low-latency routing configuration might be made for that traffic class.jitter: used to set the jitter constraint of the class. it can be the lowest possible jitter or a jitter boundary in microseconds. again the SP decides how to meet it, like strict priority queuing on the access and in the core, and/or a jitter-aware routing configuration for that class 🔥bandwidth: used to set a guaranteed amount of bandwidth for the class, expressed as a percentage. theguaranteed-bw-percentparameter uses available bandwidth as its reference. on the CE side,svc-output-bandwidthis the reference. on the PE side, it'ssvc-input-bandwidth. by default the reservation is only guaranteed at the access level 🥺 but the user can use theend-to-endleaf to ask for an end-to-end reservation, which includes the MPLS transport network. (basically the SP will activate something in the MPLS core so the customer's request gets honored there too 👑) how that's done (RSVP reservation, controller reservation, etc.) is out of scope for this document.
some constraints might not be offered by an SP. in that case a deviation should be advertised 💀 and because of network conditions, some constraints might not be completely fulfilled. then the SP should tell the customer about the limitations. how that communication happens is also out of scope for this document 🙈
here's a standard QoS profile example:
<site-network-access>
<site-network-access-id>1245HRTFGJGJ154654</site-network-access-id>
<service>
<svc-input-bandwidth>100000000</svc-input-bandwidth>
<svc-output-bandwidth>100000000</svc-output-bandwidth>
<qos>
<qos-profile>
<profile>PLATINUM</profile>
</qos-profile>
</qos>
</service>
</site-network-access>
<site-network-access>
<site-network-access-id>555555AAAA2344</site-network-access-id>
<service>
<svc-input-bandwidth>2000000</svc-input-bandwidth>
<svc-output-bandwidth>2000000</svc-output-bandwidth>
<qos>
<qos-profile>
<profile>GOLD</profile>
</qos-profile>
</qos>
</service>
</site-network-access>and a custom QoS profile example:
<site-network-access>
<site-network-access-id>Site1</site-network-access-id>
<service>
<svc-input-bandwidth>100000000</svc-input-bandwidth>
<svc-output-bandwidth>100000000</svc-output-bandwidth>
<qos>
<qos-profile>
<classes>
<class>
<class-id>REAL_TIME</class-id>
<rate-limit>10</rate-limit>
<latency>
<use-lowest-latency/>
</latency>
</class>
<class>
<class-id>DATA1</class-id>
<latency>
<latency-boundary>70</latency-boundary>
</latency>
<bandwidth>
<guaranteed-bw-percent>80</guaranteed-bw-percent>
</bandwidth>
</class>
<class>
<class-id>DATA2</class-id>
<latency>
<latency-boundary>200</latency-boundary>
</latency>
<bandwidth>
<guaranteed-bw-percent>5</guaranteed-bw-percent>
<end-to-end/>
</bandwidth>
</class>
</classes>
</qos-profile>
</qos>
</service>
</site-network-access>so for Site1 the custom profile is:
- a REAL_TIME class with a latency constraint of the lowest possible latency
- two data classes, DATA1 and DATA2, which both have a latency boundary plus a bandwidth reservation
the REAL_TIME class is rate-limited to 10% of the service bandwidth (10% of 100 Mbps = 10 Mbps) 🎀 when there's congestion, REAL_TIME traffic can go up to 10 Mbps (let's assume only 5 Mbps is actually being used). DATA1 and DATA2 then share the remaining bandwidth (95 Mbps) according to their percentages. so DATA1 gets at least 76 Mbps, and DATA2 gets at least 4.75 Mbps 😭 the latency boundary info on the data classes can help the SP pick a specific buffer tuning or a specific routing inside the network 🌈 the maximum percentage to be used isn't limited by this model, but it MUST be limited by the management system according to the policies the SP has authorized 🫶
6.12.3. Multicast 🦋
the multicast container says what kind of site this is in the customer's multicast service topology: source, receiver, or both 💜 these parameters help the management system optimize the multicast service. users can also say what type of multicast relationship they have with the customer: router (which needs a protocol like PIM), host (IGMP or MLD), or both. an address family (IPv4, IPv6, or both) can be defined too ✨
6.13. Enhanced VPN Features 👑
6.13.1. Carriers' Carriers 🌸
in the case of CsC [RFC4364], a customer may want to build an MPLS service using an IP VPN to carry its traffic 🧚
LAN customer1
|
|
CE1
|
| -------------
(vrf_cust1)
CE1_ISP1
| ISP1 POP
| MPLS link
| -------------
|
(vrf ISP1)
PE1
(...) Provider backbone
PE2
(vrf ISP1)
|
| ------------
|
| MPLS link
| ISP1 POP
CE2_ISP1
(vrf_cust1)
| ------------
|
CE2
|
LAN customer1in the figure above, ISP1 resells an IP VPN service but doesn't have any core network infrastructure between its POPs. so ISP1 uses an IP VPN as the core network infrastructure between its POPs, and that IP VPN belongs to another provider 💅
to support CsC, the VPN service has to show MPLS support by setting the carrierscarrier leaf to true in the vpn-service list. the link between CE1_ISP1/PE1 and CE2_ISP1/PE2 must also run an MPLS signalling protocol 🙈 this configuration happens at the site level.
in the proposed model, LDP or BGP can be used as the MPLS signalling protocol. with LDP, an IGP routing protocol MUST also be activated. with BGP signalling, BGP MUST also be configured as the routing protocol 🔥
if CsC is enabled, the requested svc-mtu leaf refers to the MPLS MTU, not the IP MTU 🥺
6.14. External ID References 🫶
the service model sometimes points to external information through identifiers 💖 for example, to order cloud-access to a particular cloud service provider (CSP), the model uses an identifier to refer to the targeted CSP. if a customer is using this service model directly as an API (through REST or NETCONF, for instance) to order a particular service, the SP should provide a list of authorized identifiers. for cloud-access, the SP will provide the associated identifiers for each available CSP. the same goes for other identifiers, like std-qos-profile, OAM profile-name, and provider-profile for encryption ✨
how an SP tells the customer what those identifiers mean is out of scope for this document 🌈
6.15. Defining NNIs 🌸
Okay so an autonomous system (AS) is a single network, or a group of networks, that's controlled by one common system administration group and uses one clearly defined routing protocol. 💅 Sometimes VPNs need to stretch across different ASes in different geographic areas, or across different SPs. The SPs set up the connection between the ASes, and it's seamless for the customer. ✨ Examples include:
- a partnership between SPs (e.g., carrier, cloud) to extend their VPN service seamlessly. 🤝
- an internal administrative boundary within a single SP (e.g., backhaul versus core versus data center). 🏢
NNIs (network-to-network interfaces) have to be defined so the VPNs can extend across multiple ASes. 🦋
[RFC4364] defines multiple flavors of VPN NNI implementations. Each one has pros and cons, but that topic is outside the scope of this document. 💜 For example, in an Inter-AS option A, autonomous system border router (ASBR) peers are connected by multiple interfaces. At least one of those interfaces spans the two ASes while being present in the same VPN. So these ASBRs can signal unlabeled IP prefixes, they associate each interface with a VPN routing and forwarding (VRF) instance and a Border Gateway Protocol (BGP) session. 🔥 The result is that traffic between the back-to-back VRFs is IP. The VPNs stay isolated from each other, and since the traffic is IP, QoS mechanisms that operate on IP traffic can be applied to achieve customer service level agreements (SLAs). 👑
-------- -------------- -----------
/ \ / \ / \
| Cloud | | | | |
| Provider |-----NNI-----| |----NNI---| Data Center |
| #1 | | | | |
\ / | | \ /
-------- | | -----------
| |
-------- | My network | -----------
/ \ | | / \
| Cloud | | | | |
| Provider |-----NNI-----| |---NNI---| L3VPN |
| #2 | | | | Partner |
\ / | | | |
-------- | | | |
\ / | |
-------------- \ /
| -----------
|
NNI
|
|
-------------------
/ \
| |
| |
| |
| L3VPN Partner |
| |
\ /
-------------------The figure above shows an SP network called "My network" with several NNIs. 🌈 This network uses NNIs to:
- increase its footprint by relying on L3VPN partners. 🌍
- connect its own data center services to the customer IP VPN. 💻
- enable the customer to access its private resources located in a private cloud owned by some CSPs. 🔐
6.15.1. Defining an NNI with the Option A Flavor
AS A AS B
------------------- -------------------
/ \ / \
| | | |
| ++++++++ Inter-AS link ++++++++ |
| + +_______________+ + |
| + (VRF1)---(VPN1)----(VRF1) + |
| + ASBR + + ASBR + |
| + (VRF2)---(VPN2)----(VRF2) + |
| + +_______________+ + |
| ++++++++ ++++++++ |
| | | |
| | | |
| | | |
| ++++++++ Inter-AS link ++++++++ |
| + +_______________+ + |
| + (VRF1)---(VPN1)----(VRF1) + |
| + ASBR + + ASBR + |
| + (VRF2)---(VPN2)----(VRF2) + |
| + +_______________+ + |
| ++++++++ ++++++++ |
| | | |
| | | |
\ / \ /
------------------- -------------------Okay, so in option A, the two ASes are connected to each other with physical links on the ASBRs. 🫶 For resiliency, there may be multiple physical connections between the ASes. A VPN connection (physical, or logical on top of physical) gets created for each VPN that needs to cross the AS boundary, which gives you a back-to-back VRF model. 💖
From a service model's perspective, this VPN connection can be seen as a site. 🦋 Let's say AS B wants to extend some VPN connections for VPN C on AS A. The administrator of AS B can use this service model to order a site on AS A. All connection scenarios could be realized using the features of the current model. As an example, the figure above shows two physical connections with logical connections per VPN overlaid on them. 🎀 This could be seen as a dual-homed subVPN scenario. Also, the administrator of AS B gets to choose the appropriate routing protocol (e.g., E-BGP) to dynamically exchange routes between ASes. ✨
This document assumes that the option A NNI flavor SHOULD reuse the existing VPN site modeling. 🧚
Example: a customer wants its CSP A to attach its virtual network N to an existing IP VPN (VPN1) that he has from L3VPN SP B. 🌸
CSP A L3VPN SP B
----------------- -------------------
/ \ / \
| | | | |
| VM --| ++++++++ NNI ++++++++ |--- VPN1
| | + +_________+ + | Site#1
| |--------(VRF1)---(VPN1)--(VRF1)+ |
| | + ASBR + + ASBR + |
| | + +_________+ + |
| | ++++++++ ++++++++ |
| VM --| | | |--- VPN1
| |Virtual | | | Site#2
| |Network | | |
| VM --| | | |--- VPN1
| | | | | Site#3
\ / \ /
----------------- -------------------
|
|
VPN1
Site#4To create the VPN connectivity, the CSP or the customer may use the L3VPN service model that SP B exposes. 🍓 We could consider that, since the NNI is shared, the physical connection (bearer) between CSP A and SP B already exists. CSP A may request, through a service model, the creation of a new site with a single site-network-access (single-homing is used in the figure). 💜 As a placement constraint, CSP A may use the existing bearer reference it has from SP A to force the placement of the VPN NNI on the existing link. The XML below illustrates a possible configuration request to SP B: 🫶
<site>
<site-id>CSP_A_attachment</site-id>
<location>
<city>NY</city>
<country-code>US</country-code>
</location>
<site-vpn-flavor>site-vpn-flavor-nni</site-vpn-flavor>
<routing-protocols>
<routing-protocol>
<type>bgp</type>
<bgp>
<autonomous-system>500</autonomous-system>
<address-family>ipv4</address-family>
</bgp>
</routing-protocol>
</routing-protocols>
<site-network-accesses>
<site-network-access>
<site-network-access-id>CSP_A_VN1</site-network-access-id>
<ip-connection>
<ipv4>
<address-allocation-type>
static-address
</address-allocation-type>
<addresses>
<provider-address>203.0.113.1</provider-address>
<customer-address>203.0.113.2</customer-address>
<mask>30</mask>
</addresses>
</ipv4>
</ip-connection>
<service>
<svc-input-bandwidth>450000000</svc-input-bandwidth>
<svc-output-bandwidth>450000000</svc-output-bandwidth>
</service>
<vpn-attachment>
<vpn-id>VPN1</vpn-id>
<site-role>any-to-any-role</site-role>
</vpn-attachment>
</site-network-access>
</site-network-accesses>
<management>
<type>customer-managed</type>
</management>
</site>The case described above is different from a scenario using the cloud-accesses container, because the cloud-access provides a public cloud access, while this example enables access to private resources located in a CSP network. 🙈
6.15.2. Defining an NNI with the Option B Flavor 🦋
AS A AS B
------------------- -------------------
/ \ / \
| | | |
| ++++++++ Inter-AS link ++++++++ |
| + +_______________+ + |
| + + + + |
| + ASBR +<---MP-BGP---->+ ASBR + |
| + + + + |
| + +_______________+ + |
| ++++++++ ++++++++ |
| | | |
| | | |
| | | |
| ++++++++ Inter-AS link ++++++++ |
| + +_______________+ + |
| + + + + |
| + ASBR +<---MP-BGP---->+ ASBR + |
| + + + + |
| + +_______________+ + |
| ++++++++ ++++++++ |
| | | |
| | | |
\ / \ /
------------------- -------------------Okay so in option B, the two ASes hook up to each other with physical links that run through their ASBRs 🔌. For resiliency (aka nothing falls over if one link dies 🙈), there may be multiple physical connections between the ASes. The VPN "connection" between the ASes happens by swapping VPN routes over MP-BGP [RFC4760] 💅
There are multiple flavors of this NNI, and they're giving very different vibes ✨ For example:
- The NNI lives inside the provider and sits between a backbone and a data center 🏢 The domains trust each other enough to not filter the VPN routes, so all the VPN routes get exchanged. RT filtering may be used to save some unnecessary route state 🧹
- The NNI is used between providers that agreed to exchange VPN routes for specific RTs only 🤝 Each provider is authorized to use the RT values from the other provider.
- The NNI is used between providers that agreed to exchange VPN routes for specific RTs only 🤝 But here each provider has its own RT scheme, so a customer spanning both networks will have different RTs in each network for the same VPN 🌈
Case 1 doesn't need any service modeling, because the protocol handles the dynamic exchange of the VPN routes it needs all on its own 🙌
Case 2 requires that an RT-filtering policy be maintained on the ASBRs 🛡️ From a service modeling point of view, the providers need to agree on the list of RTs to authorize.
In Case 3, both ASes need to agree on which VPN RT to exchange 💜 They also need to figure out how to map a VPN RT from AS A to the matching RT in AS B (and the other way around too) 🔁
Those modelings are currently out of scope for this document 🙈
CSP A L3VPN SP B
----------------- ------------------
/ \ / \
| | | | |
| VM --| ++++++++ NNI ++++++++ |--- VPN1
| | + +__________+ + | Site#1
| |-------+ + + + |
| | + ASBR +<-MP-BGP->+ ASBR + |
| | + +__________+ + |
| | ++++++++ ++++++++ |
| VM --| | | |--- VPN1
| |Virtual | | | Site#2
| |Network | | |
| VM --| | | |--- VPN1
| | | | | Site#3
\ / | |
----------------- | |
\ /
------------------
|
|
VPN1
Site#4This example shows an NNI connection between CSP A and SP network B 🌸 Both SPs do not trust themselves, and they use a different RT allocation policy. So, in terms of implementation, the customer VPN has a different RT in each network (RT A in CSP A and RT B in SP network B) 🎀 To connect the customer virtual network in CSP A to the customer IP VPN (VPN1) in SP network B, CSP A should request that SP network B open the customer VPN on the NNI (accept the appropriate RT). Who does the RT translation depends on the agreement between the two SPs. SP B may permit CSP A to request VPN (RT) translation 🔄
6.15.3. Defining an NNI with the Option C Flavor 🧚
AS A AS B
------------------- -------------------
/ \ / \
| | | |
| | | |
| | | |
| ++++++++ Multihop E-BGP ++++++++ |
| + + + + |
| + + + + |
| + RGW +<----MP-BGP---->+ RGW + |
| + + + + |
| + + + + |
| ++++++++ ++++++++ |
| | | |
| | | |
| | | |
| | | |
| | | |
| ++++++++ Inter-AS link ++++++++ |
| + +_______________+ + |
| + + + + |
| + ASBR + + ASBR + |
| + + + + |
| + +_______________+ + |
| ++++++++ ++++++++ |
| | | |
| | | |
| | | |
| ++++++++ Inter-AS link ++++++++ |
| + +_______________+ + |
| + + + + |
| + ASBR + + ASBR + |
| + + + + |
| + +_______________+ + |
| ++++++++ ++++++++ |
| | | |
| | | |
\ / \ /
------------------- -------------------From a VPN service's perspective, the option C NNI is very similar to option B 👯 An MP-BGP session is used to exchange VPN routes between the ASes. The difference is that the forwarding plane and the control plane live on different nodes, so the MP-BGP session is multihop between routing gateway (RGW) nodes 🌈
From a VPN service's point of view, modeling options B and C will be identical ✨💖
7. Service Model Usage Example ✨
okay so bestie, the service model is NOT meant to be poked directly on network elements 🙅♀️. It's meant to live up at the management layer, like the boss of the whole setup 👑. The management system is the central spot where the whole service gets configured, and it's giving main character energy 💅.
Let's walk through how a management system can use this model to set up an IP VPN service on network elements 🦋.
In our example, we want to provision a VPN service for three sites using a Hub-and-Spoke VPN service topology 🌸. One of the sites is going to be dual-homed, and load-sharing is expected ✨. Picture it like this:
+-------------------------------------------------------------+
| Hub_Site ------ PE1 PE2 ------ Spoke_Site1 |
| | +----------------------------------+
| | |
| | +----------------------------------+
| Hub_Site ------ PE3 PE4 ------ Spoke_Site2 |
+-------------------------------------------------------------+Here's the overall simplified service configuration for this VPN. It's the big picture, iykyk 🧚:
<vpn-service>
<vpn-id>12456487</vpn-id>
<vpn-service-topology>hub-spoke</vpn-service-topology>
</vpn-service>When the request to provision the VPN service comes in, the management system will internally (or by talking to another OSS component) allocate VPN RTs 🎀. In this specific case, two RTs get allocated: 100:1 for the Hub and 100:2 for the Spoke 💖. The output below describes the configuration of Spoke_Site1 👑.
<site>
<site-id>Spoke_Site1</site-id>
<location>
<city>NY</city>
<country-code>US</country-code>
</location>
<routing-protocols>
<routing-protocol>
<type>bgp</type>
<bgp>
<autonomous-system>500</autonomous-system>
<address-family>ipv4</address-family>
<address-family>ipv6</address-family>
</bgp>
</routing-protocol>
</routing-protocols>
<site-network-accesses>
<site-network-access>
<site-network-access-id>Spoke_Site1</site-network-access-id>
<access-diversity>
<groups>
<group>
<group-id>20</group-id>
</group>
</groups>
<constraints>
<constraint>
<constraint-type>pe-diverse</constraint-type>
<target>
<group>
<group-id>10</group-id>
</group>
</target>
</constraint>
</constraints>
</access-diversity>
<ip-connection>
<ipv4>
<address-allocation-type>
static-address
</address-allocation-type>
<addresses>
<provider-address>203.0.113.254</provider-address>
<customer-address>203.0.113.2</customer-address>
<mask>24</mask>
</addresses>
</ipv4>
<ipv6>
<address-allocation-type>
static-address
</address-allocation-type>
<addresses>
<provider-address>2001:db8::1</provider-address>
<customer-address>2001:db8::2</customer-address>
<mask>64</mask>
</addresses>
</ipv6>
</ip-connection>
<service>
<svc-input-bandwidth>450000000</svc-input-bandwidth>
<svc-output-bandwidth>450000000</svc-output-bandwidth>
</service>
<vpn-attachment>
<vpn-id>12456487</vpn-id>
<site-role>spoke-role</site-role>
</vpn-attachment>
</site-network-access>
</site-network-accesses>
<management>
<type>provider-managed</type>
</management>
</site>When the request to provision Spoke_Site1 arrives, the management system MUST allocate network resources for this site 🫶. It MUST first figure out the target network elements for provisioning the access, especially the PE router (and maybe an aggregation switch too) 🔍. As covered in Section 6.6, the management system SHOULD use the location information and SHOULD use the access-diversity constraint to find the right PE 📍. In this case, Spoke_Site1 needs PE diversity with the Hub, and the management system allocates PEs based on the least distance 🌈. So based on the location info, it finds the available PEs in the area nearest the customer and picks one that fits the access-diversity constraint 💅.
Once the PE is chosen, the management system needs to allocate interface resources on the node 🍓. One interface gets selected from the pool of available PEs ✨. The management system can start provisioning the chosen PE node using whatever means it prefers (e.g., NETCONF, CLI) 🧚. Next, it checks whether a VRF that fits its needs is already there 👀. If not, it provisions the VRF: the RD gets derived from the internal allocation policy model, and the RTs get derived from the VPN policy configuration of the site (the management system allocated some RTs for the VPN) 💜. Since the site is a Spoke site (site-role), the management system knows which RTs must be imported and exported 🎀. And because the site is provider-managed, some management RTs may also get added (100:5000) 🔥. Standard provider VPN policies MAY also be added to the configuration 💖.
Example of generated PE configuration:
ip vrf Customer1
export-map STD-CUSTOMER-EXPORT <---- Standard SP configuration
route-distinguisher 100:3123234324
route-target import 100:1
route-target import 100:5000 <---- Standard SP configuration
route-target export 100:2 for provider-managed CE
!Once the VRF is provisioned, the management system can start configuring the access on the PE using the allocated interface info 🦋. IP addressing is chosen by the management system: one address comes from an allocated subnet for the PE, and another goes to the CE config 🌸. Routing protocols also get configured between the PE and CE, and because this model is provider-managed, the choices are left up to the SP 👑. BGP was picked for this example 💅. That choice is independent of whatever routing protocol the customer uses 🫶. BGP gets used to configure the CE-to-LAN connection, as requested in the service model 🌈. Peering addresses are derived from those of the connection ✨. And since the CE is provider-managed, the CE's AS number can be automatically allocated by the management system 🧚. Standard configuration templates provided by the SP may also be added 🎀.
Example of generated PE configuration:
interface Ethernet1/1/0.10
encapsulation dot1q 10
ip vrf forwarding Customer1
ip address 198.51.100.1 255.255.255.252 <---- Comes from
automated allocation
ipv6 address 2001:db8::10:1/64
ip access-group STD-PROTECT-IN <---- Standard SP config
!
router bgp 100
address-family ipv4 vrf Customer1
neighbor 198.51.100.2 remote-as 65000 <---- Comes from
automated allocation
neighbor 198.51.100.2 route-map STD in <---- Standard SP config
neighbor 198.51.100.2 filter-list 10 in <---- Standard SP config
!
address-family ipv6 vrf Customer1
neighbor 2001:db8::0a10:2 remote-as 65000 <---- Comes from
automated allocation
neighbor 2001:db8::0a10:2 route-map STD in <---- Standard SP
config
neighbor 2001:db8::0a10:2 filter-list 10 in <---- Standard SP
config
!
ip route vrf Customer1 192.0.2.1 255.255.255.255 198.51.100.2
! Static route for provider administration of CE
!Heads up 🙈: the CE router isn't reachable at this stage, so the management system can produce a complete CE configuration that gets manually uploaded to the node before the CE config is sent to the customer premises 💀.
Here's the tea 🫖: the CE config gets built the same way the PE would be configured 💖. Based on the CE type (vendor/model) allocated to the customer, plus the bearer info, the management system knows which interface needs configuring on the CE ✨. PE-CE link configuration is expected to be handled automatically through the SP OSS, since both resources are managed internally 🔥. CE-to-LAN-interface parameters like IP addressing are derived from the ip-connection container, taking into account how the management system splits addresses between the PE and CE within the subnet 🌈. This is what makes a plug-and-play configuration for the CE possible 🦋.
Example of generated CE configuration:
interface Loopback10
description "Administration"
ip address 192.0.2.1 255.255.255.255
!
interface FastEthernet10
description "WAN"
ip address 198.51.100.2 255.255.255.252 <---- Comes from
automated allocation
ipv6 address 2001:db8::0a10:2/64
!
interface FastEthernet11
description "LAN"
ip address 203.0.113.254 255.255.255.0 <---- Comes from the
ip-connection container
ipv6 address 2001:db8::1/64
!
router bgp 65000
address-family ipv4
redistribute static route-map STATIC2BGP <---- Standard SP
configuration
neighbor 198.51.100.1 remote-as 100 <---- Comes from
automated allocation
neighbor 203.0.113.2 remote-as 500 <---- Comes from the
ip-connection container
address-family ipv6
redistribute static route-map STATIC2BGP <---- Standard SP
configuration
neighbor 2001:db8::0a10:1 remote-as 100 <---- Comes from
automated allocation
neighbor 2001:db8::2 remote-as 500 <---- Comes from the
ip-connection container
!
route-map STATIC2BGP permit 10
match tag 10
!8. Interaction with Other YANG Modules 🦋
okay so, as we covered in Section 5, this service model is meant to live in a management system, NOT directly on the network elements 💅
the management system's whole job is to configure the network elements 🫶 it can also be modular, so the part that runs the service model (let's call it "service component" 🧚) and the part that handles configuring the network elements (let's call it "configuration component" 🎀) might be two different things.
l3vpn-svc |
Model |
|
+---------------------+
| Service component | Service datastore
+---------------------+
|
|
+---------------------+
+----| Config component |------+
/ +---------------------+ \ Network
/ / \ \ Configuration
/ / \ \ models
/ / \ \
++++++++ ++++++++ ++++++++ ++++++++
+ CE A + ------- + PE A + + PE B + ----- + CE B + Config
++++++++ ++++++++ ++++++++ ++++++++ datastore
Site A Site Bin the earlier sections we showed some examples of turning service provisioning requests into router configuration lines ✨ in the NETCONF/YANG ecosystem, the plan is for NETCONF/YANG to sit between the configuration component and the network elements, so the requested services get configured on those elements 💜
so in this framework, specs are expected to give specific YANG modeling of service components on network elements 🌈 and there's gonna be a super strong relationship between the abstracted view this service model gives and the detailed configuration view that the specific configuration models for network elements provide 😭🫶
the authors of this doc are anticipating YANG models for the network elements listed below 💖 (and yes, the list isn't exhaustive, so don't @ me 💅)
- VRF definition, including VPN policy expression.
- Physical interface.
- IP layer (IPv4, IPv6).
- QoS: classification, profiles, etc.
- Routing protocols: support of configuration of all protocols listed in the document, as well as routing policies associated with those protocols.
- Multicast VPN.
- Network address translation.
here's an example of a VPN site request at the service level, using this model 🌸
<site>
<site-id>Site A</site-id>
<site-network-accesses>
<site-network-access>
<ip-connection>
<ipv4>
<address-allocation-type>
static-address
</address-allocation-type>
<addresses>
<provider-address>203.0.113.254</provider-address>
<customer-address>203.0.113.2</customer-address>
<mask>24</mask>
</addresses>
</ipv4>
</ip-connection>
<vpn-attachment>
<vpn-policy-id>VPNPOL1</vpn-policy-id>
</vpn-attachment>
</site-network-access>
</site-network-accesses>
<routing-protocols>
<routing-protocol>
<type>static</type>
<static>
<cascaded-lan-prefixes>
<ipv4-lan-prefixes>
<lan>198.51.100.0/30</lan>
<next-hop>203.0.113.2</next-hop>
</ipv4-lan-prefixes>
</cascaded-lan-prefixes>
</static>
</routing-protocol>
</routing-protocols>
<management>
<type>customer-managed</type>
</management>
<vpn-policies>
<vpn-policy>
<vpn-policy-id>VPNPOL1</vpn-policy-id>
<entries>
<id>1</id>
<vpn>
<vpn-id>VPN1</vpn-id>
<site-role>any-to-any-role</site-role>
</vpn>
</entries>
</vpn-policy>
</vpn-policies>
</site>so in that service example, the service component asks the configuration component of the management system to set up the configuration of the service elements 🎀 if the service component picked a PE (PE A) as the target PE for the site, then the configuration component needs to push the config to PE A 🫣 it's gonna use several YANG data models to define what gets applied to PE A, and the XML config for PE A might look like this 👑
<if:interfaces>
<if:interface>
<if:name>eth0</if:name>
<if:type>ianaift:ethernetCsmacd</if:type>
<if:description>
Link to CE A.
</if:description>
<ip:ipv4>
<ip:address>
<ip:ip>203.0.113.254</ip:ip>
<ip:prefix-length>24</ip:prefix-length>
</ip:address>
<ip:forwarding>true</ip:forwarding>
</ip:ipv4>
</if:interface>
</if:interfaces>
<rt:routing>
<rt:routing-instance>
<rt:name>VRF_CustA</rt:name>
<rt:type>l3vpn-network:vrf</rt:type>
<rt:description>VRF for Customer A</rt:description>
<l3vpn-network:route-distinguisher>
100:1546542343
</l3vpn-network:route-distinguisher>
<l3vpn-network:import-rt>100:1</l3vpn-network:import-rt>
<l3vpn-network:export-rt>100:1</l3vpn-network:export-rt>
<rt:interfaces>
<rt:interface>
<rt:name>eth0</rt:name>
</rt:interface>
</rt:interfaces>
<rt:routing-protocols>
<rt:routing-protocol>
<rt:type>rt:static</rt:type>
<rt:name>st0</rt:name>
<rt:static-routes>
<v4ur:ipv4>
<v4ur:route>
<v4ur:destination-prefix>
198.51.100.0/30
</v4ur:destination-prefix>
<v4ur:next-hop>
<v4ur:next-hop-address>
203.0.113.2
</v4ur:next-hop-address>
</v4ur:next-hop>
</v4ur:route>
</v4ur:ipv4>
</rt:static-routes>
</rt:routing-protocol>
</rt:routing-protocols>
</rt:routing-instance>
</rt:routing>9. YANG Module 💜
<CODE BEGINS>
file "ietf-l3vpn-svc@2017-01-27.yang"
module ietf-l3vpn-svc {
namespace "urn:ietf:params:xml:ns:yang:ietf-l3vpn-svc";
prefix l3vpn-svc;
import ietf-inet-types {
prefix inet;
}
import ietf-yang-types {
prefix yang;
}
organization
"IETF L3SM Working Group";
contact
"WG List: <mailto:l3sm@ietf.org>
Editor:
L3SM WG
Chairs:
Adrian Farrel, Qin Wu
";
description
"This YANG module defines a generic service configuration
model for Layer 3 VPNs. This model is common across all
vendor implementations.";
revision 2017-01-27 {
description
"Initial document.";
reference
"RFC 8049.";
}
/* Features */
feature cloud-access {
description
"Allows the VPN to connect to a CSP.";
}
feature multicast {
description
"Enables multicast capabilities in a VPN.";
}
feature ipv4 {
description
"Enables IPv4 support in a VPN.";
}
feature ipv6 {
description
"Enables IPv6 support in a VPN.";
}
feature carrierscarrier {
description
"Enables support of CsC.";
}
feature extranet-vpn {
description
"Enables support of extranet VPNs.";
}
feature site-diversity {
description
"Enables support of site diversity constraints.";
}
feature encryption {
description
"Enables support of encryption.";
}
feature qos {
description
"Enables support of classes of services.";
}
feature qos-custom {
description
"Enables support of the custom QoS profile.";
}
feature rtg-bgp {
description
"Enables support of the BGP routing protocol.";
}
feature rtg-rip {
description
"Enables support of the RIP routing protocol.";
}
feature rtg-ospf {
description
"Enables support of the OSPF routing protocol.";
}
feature rtg-ospf-sham-link {
description
"Enables support of OSPF sham links.";
}
feature rtg-vrrp {
description
"Enables support of the VRRP routing protocol.";
}
feature fast-reroute {
description
"Enables support of Fast Reroute.";
}
feature bfd {
description
"Enables support of BFD.";
}
feature always-on {
description
"Enables support of the 'always-on' access constraint.";
}
feature requested-type {
description
"Enables support of the 'requested-type' access constraint.";
}
feature bearer-reference {
description
"Enables support of the 'bearer-reference' access constraint.";
}
/* Typedefs */
typedef svc-id {
type string;
description
"Defines a type of service component identifier.";
}
typedef template-id {
type string;
description
"Defines a type of service template identifier.";
}
typedef address-family {
type enumeration {
enum ipv4 {
description
"IPv4 address family.";
}
enum ipv6 {
description
"IPv6 address family.";
}
}
description
"Defines a type for the address family.";
}
/* Identities */okay so the YANG module keeps going and this part is all about identities, bestie 🦋 each one is a little named label that the module can point to, and the groupings start showing up at the end 💅
identity site-network-access-type {
description
"Base identity for site-network-access type.";
}
identity point-to-point {
base site-network-access-type;
description
"Identity for point-to-point connection.";
}
identity multipoint {
base site-network-access-type;
description
"Identity for multipoint connection.
Example: Ethernet broadcast segment.";
}
identity placement-diversity {
description
"Base identity for site placement constraints.";
}
identity bearer-diverse {
base placement-diversity;
description
"Identity for bearer diversity.
The bearers should not use common elements.";
}
identity pe-diverse {
base placement-diversity;
description
"Identity for PE diversity.";
}
identity pop-diverse {
base placement-diversity;
description
"Identity for POP diversity.";
}
identity linecard-diverse {
base placement-diversity;
description
"Identity for linecard diversity.";
}
identity same-pe {
base placement-diversity;
description
"Identity for having sites connected on the same PE.";
}
identity same-bearer {
base placement-diversity;
description
"Identity for having sites connected using the same bearer.";
}
identity customer-application {
description
"Base identity for customer application.";
}
identity web {
base customer-application;
description
"Identity for Web application (e.g., HTTP, HTTPS).";
}
identity mail {
base customer-application;
description
"Identity for mail application.";
}
identity file-transfer {
base customer-application;
description
"Identity for file transfer application (e.g., FTP, SFTP).";
}
identity database {
base customer-application;
description
"Identity for database application.";
}
identity social {
base customer-application;
description
"Identity for social-network application.";
}
identity games {
base customer-application;
description
"Identity for gaming application.";
}
identity p2p {
base customer-application;
description
"Identity for peer-to-peer application.";
}
identity network-management {
base customer-application;
description
"Identity for management application
(e.g., Telnet, syslog, SNMP).";
}
identity voice {
base customer-application;
description
"Identity for voice application.";
}
identity video {
base customer-application;
description
"Identity for video conference application.";
}
identity site-vpn-flavor {
description
"Base identity for the site VPN service flavor.";
}
identity site-vpn-flavor-single {
base site-vpn-flavor;
description
"Base identity for the site VPN service flavor.
Used when the site belongs to only one VPN.";
}
identity site-vpn-flavor-multi {
base site-vpn-flavor;
description
"Base identity for the site VPN service flavor.
Used when a logical connection of a site
belongs to multiple VPNs.";
}
identity site-vpn-flavor-sub {
base site-vpn-flavor;
description
"Base identity for the site VPN service flavor.
Used when a site has multiple logical connections.
Each connection may belong to different multiple VPNs.";
}
identity site-vpn-flavor-nni {
base site-vpn-flavor;
description
"Base identity for the site VPN service flavor.
Used to describe an NNI option A connection.";
}
identity management {
description
"Base identity for site management scheme.";
}
identity co-managed {
base management;
description
"Base identity for co-managed site.";
}
identity customer-managed {
base management;
description
"Base identity for customer-managed site.";
}
identity provider-managed {
base management;
description
"Base identity for provider-managed site.";
}
identity address-allocation-type {
description
"Base identity for address-allocation-type for PE-CE link.";
}
identity provider-dhcp {
base address-allocation-type;
description
"Provider network provides DHCP service to customer.";
}
identity provider-dhcp-relay {
base address-allocation-type;
description
"Provider network provides DHCP relay service to customer.";
}
identity provider-dhcp-slaac {
base address-allocation-type;
description
"Provider network provides DHCP service to customer,
as well as SLAAC.";
}
identity static-address {
base address-allocation-type;
description
"Provider-to-customer addressing is static.";
}
identity slaac {
base address-allocation-type;
description
"Use IPv6 SLAAC.";
}
identity site-role {
description
"Base identity for site type.";
}
identity any-to-any-role {
base site-role;
description
"Site in an any-to-any IP VPN.";
}
identity spoke-role {
base site-role;
description
"Spoke site in a Hub-and-Spoke IP VPN.";
}
identity hub-role {
base site-role;
description
"Hub site in a Hub-and-Spoke IP VPN.";
}
identity vpn-topology {
description
"Base identity for VPN topology.";
}
identity any-to-any {
base vpn-topology;
description
"Identity for any-to-any VPN topology.";
}
identity hub-spoke {
base vpn-topology;
description
"Identity for Hub-and-Spoke VPN topology.";
}
identity hub-spoke-disjoint {
base vpn-topology;
description
"Identity for Hub-and-Spoke VPN topology
where Hubs cannot communicate with each other.";
}
identity multicast-tree-type {
description
"Base identity for multicast tree type.";
}
identity ssm-tree-type {
base multicast-tree-type;
description
"Identity for SSM tree type.";
}
identity asm-tree-type {
base multicast-tree-type;
description
"Identity for ASM tree type.";
}
identity bidir-tree-type {
base multicast-tree-type;
description
"Identity for bidirectional tree type.";
}
identity multicast-rp-discovery-type {
description
"Base identity for RP discovery type.";
}
identity auto-rp {
base multicast-rp-discovery-type;
description
"Base identity for Auto-RP discovery type.";
}
identity static-rp {
base multicast-rp-discovery-type;
description
"Base identity for static type.";
}
identity bsr-rp {
base multicast-rp-discovery-type;
description
"Base identity for BSR discovery type.";
}
identity routing-protocol-type {
description
"Base identity for routing protocol type.";
}
identity ospf {
base routing-protocol-type;
description
"Identity for OSPF protocol type.";
}
identity bgp {
base routing-protocol-type;
description
"Identity for BGP protocol type.";
}
identity static {
base routing-protocol-type;
description
"Identity for static routing protocol type.";
}
identity rip {
base routing-protocol-type;
description
"Identity for RIP protocol type.";
}
identity vrrp {
base routing-protocol-type;
description
"Identity for VRRP protocol type.
This is to be used when LANs are directly connected
to PE routers.";
}
identity direct {
base routing-protocol-type;
description
"Identity for direct protocol type.";
}
identity protocol-type {
description
"Base identity for protocol field type.";
}
identity tcp {
base protocol-type;
description
"TCP protocol type.";
}
identity udp {
base protocol-type;
description
"UDP protocol type.";
}
identity icmp {
base protocol-type;
description
"ICMP protocol type.";
}
identity icmp6 {
base protocol-type;
description
"ICMPv6 protocol type.";
}
identity gre {
base protocol-type;
description
"GRE protocol type.";
}
identity ipip {
base protocol-type;
description
"IP-in-IP protocol type.";
}
identity hop-by-hop {
base protocol-type;
description
"Hop-by-Hop IPv6 header type.";
}
identity routing {
base protocol-type;
description
"Routing IPv6 header type.";
}
identity esp {
base protocol-type;
description
"ESP header type.";
}
identity ah {
base protocol-type;
description
"AH header type.";
}
/* Groupings */
grouping vpn-service-cloud-access {
container cloud-accesses {
if-feature cloud-access;
list cloud-access {
key cloud-identifier;
leaf cloud-identifier {
type string;
description
"Identification of cloud service.
Local administration meaning.";
}
choice list-flavor {
case permit-any {
leaf permit-any {
type empty;
description
"Allows all sites.";
}
}
case deny-any-except {
leaf-list permit-site {
type leafref {
path "/l3vpn-svc/sites/site/site-id";
}
description
"Site ID to be authorized.";
}
}
case permit-any-except {
leaf-list deny-site {
type leafref {
path "/l3vpn-svc/sites/site/site-id";
}
description
"Site ID to be denied.";
}
}
description
"Choice for cloud access policy.";
}
container authorized-sites {
list authorized-site {
key site-id;
leaf site-id {
type leafref {
path "/l3vpn-svc/sites/site/site-id";
}
description
"Site ID.";
}
description
"List of authorized sites.";
}
description
"Configuration of authorized sites.";
}
container denied-sites {
list denied-site {
key site-id;Okay, bestie, we're still inside the denied sites list 🎀 and then the NAT44 stuff shows up, which is giving main character energy 💅
leaf site-id {
type leafref {
path "/l3vpn-svc/sites/site/site-id";
}
description
"Site ID.";
}
description
"List of denied sites.";
}
description
"Configuration of denied sites.";
}
container address-translation {
container nat44 {
leaf enabled {
type boolean;
default false;
description
"Controls whether or not address translation is required.";
}
leaf nat44-customer-address {
type inet:ipv4-address;
must "../enabled = 'true'" {
description
"Applicable only if address translation is enabled.";
}
description
"Address to be used for translation.
This is to be used if the customer is
providing the address.";
}
description
"IPv4-to-IPv4 translation.";
}
description
"Container for NAT.";
}
description
"Cloud access configuration.";
}
description
"Container for cloud access configurations.";
}
description
"Grouping for VPN cloud definition.";
}
grouping multicast-rp-group-cfg {
choice group-format {
case startend {
leaf group-start {
type inet:ip-address;
description
"First group address.";
}
leaf group-end {
type inet:ip-address;
description
"Last group address.";
}
}
case singleaddress {
leaf group-address {
type inet:ip-address;
description
"Group address.";
}
}
description
"Choice for group format.";
}
description
"Definition of groups for RP-to-group mapping.";
}
grouping vpn-service-multicast {
container multicast {
if-feature multicast;
leaf enabled {
type boolean;
default false;
description
"Enables multicast.";
}
container customer-tree-flavors {
leaf-list tree-flavor {
type identityref {
base multicast-tree-type;
}
description
"Type of tree to be used.";
}
description
"Type of trees used by customer.";
}
container rp {
container rp-group-mappings {
list rp-group-mapping {
key id;
leaf id {
type uint16;
description
"Unique identifier for the mapping.";
}
container provider-managed {
leaf enabled {
type boolean;
default false;
description
"Set to true if the RP must be a provider-managed node.
Set to false if it is a customer-managed node.";
}
leaf rp-redundancy {
when "../enabled = 'true'" {
description
"Relevant when the RP is provider-managed.";
}
type boolean;
default false;
description
"If true, a redundancy mechanism for the RP is required.";
}
leaf optimal-traffic-delivery {
when "../enabled = 'true'" {
description
"Relevant when the RP is provider-managed.";
}
type boolean;
default false;
description
"If true, the SP must ensure that
traffic uses an optimal path.";
}
description
"Parameters for a provider-managed RP.";
}
leaf rp-address {
when "../provider-managed/enabled = 'false'" {
description
"Relevant when the RP is provider-managed.";
}
type inet:ip-address;
description
"Defines the address of the RP.
Used if the RP is customer-managed.";
}
container groups {
list group {
key id;
leaf id {
type uint16;
description
"Identifier for the group.";
}
uses multicast-rp-group-cfg;
description
"List of groups.";
}
description
"Multicast groups associated with the RP.";
}
description
"List of RP-to-group mappings.";
}
description
"RP-to-group mappings.";
}
container rp-discovery {
leaf rp-discovery-type {
type identityref {
base multicast-rp-discovery-type;
}
default static-rp;
description
"Type of RP discovery used.";
}
container bsr-candidates {
when "../rp-discovery-type = 'bsr-rp'" {
description
"Only applicable if discovery type is BSR-RP.";
}
leaf-list bsr-candidate-address {
type inet:ip-address;
description
"Address of BSR candidate.";
}
description
"Customer BSR candidate's address.";
}
description
"RP discovery parameters.";
}
description
"RP parameters.";
}
description
"Multicast global parameters for the VPN service.";
}
description
"Grouping for multicast VPN definition.";
}
grouping vpn-service-mpls {
leaf carrierscarrier {
if-feature carrierscarrier;
type boolean;
default false;
description
"The VPN is using CsC, and so MPLS is required.";
}
description
"Grouping for MPLS CsC definition.";
}
grouping customer-location-info {
container locations {
list location {
key location-id;
leaf location-id {
type svc-id;
description
"Identifier for a particular location.";
}
leaf address {
type string;
description
"Address (number and street) of the site.";
}
leaf postal-code {
type string;
description
"Postal code of the site.";
}
leaf state {
type string;
description
"State of the site. This leaf can also be used to describe
a region for a country that does not have states.";
}
leaf city {
type string;
description
"City of the site.";
}
leaf country-code {
type string {
pattern '[A-Z]{2}';
}
description
"Country of the site.
Expressed as ISO ALPHA-2 code.";
}
description
"Location of the site.";
}
description
"List of locations for the site.";
}
description
"This grouping defines customer location parameters.";
}
grouping site-group {
container groups {
list group {
key group-id;
leaf group-id {
type string;
description
"Group-id the site belongs to.";
}
description
"List of group-ids.";
}
description
"Groups the site or site-network-access belongs to.";
}
description
"Grouping definition to assign
group-ids to site or site-network-access.";
}
grouping site-diversity {
container site-diversity {
if-feature site-diversity;
uses site-group;
description
"Diversity constraint type.
All site-network-accesses will inherit the group values
defined here.";
}
description
"This grouping defines site diversity parameters.";
}
grouping access-diversity {
container access-diversity {
if-feature site-diversity;
uses site-group;
container constraints {
list constraint {
key constraint-type;
leaf constraint-type {
type identityref {
base placement-diversity;
}
description
"Diversity constraint type.";
}
container target {
choice target-flavor {
case id {
list group {
key group-id;
leaf group-id {
type string;
description
"The constraint will be applied against
this particular group-id.";
}
description
"List of groups.";
}
}
case all-accesses {
leaf all-other-accesses {
type empty;
description
"The constraint will be applied against
all other site network accesses of this site.";
}
}
case all-groups {
leaf all-other-groups {
type empty;
description
"The constraint will be applied against
all other groups managed by the customer.";
}
}
description
"Choice for the group definition.";
}
description
"The constraint will be applied against
this list of groups.";
}
description
"List of constraints.";
}
description
"Placement constraints for this site network access.";
}
description
"Diversity parameters.";
}
description
"This grouping defines access diversity parameters.";
}
grouping operational-requirements {
leaf requested-site-start {
type yang:date-and-time;
description
"Optional leaf indicating requested date and time when the
service at a particular site is expected to start.";
}
leaf requested-site-stop {
type yang:date-and-time;
description
"Optional leaf indicating requested date and time when the
service at a particular site is expected to stop.";
}
description
"This grouping defines some operational parameters.";
}
grouping operational-requirements-ops {
leaf actual-site-start {
type yang:date-and-time;
config false;
description
"Optional leaf indicating actual date and time when the
service at a particular site actually started.";
}
leaf actual-site-stop {
type yang:date-and-time;
config false;
description
"Optional leaf indicating actual date and time when the
service at a particular site actually stopped.";
}
description
"This grouping defines some operational parameters.";
}grouping flow-definition { container match-flow { leaf dscp { type inet:dscp; description "DSCP value."; } leaf dot1p { type uint8 { range "0..7"; } description "802.1p matching."; } leaf ipv4-src-prefix { type inet:ipv4-prefix; description "Match on IPv4 src address."; } leaf ipv6-src-prefix { type inet:ipv6-prefix; description "Match on IPv6 src address."; } leaf ipv4-dst-prefix { type inet:ipv4-prefix; description "Match on IPv4 dst address."; } leaf ipv6-dst-prefix { type inet:ipv6-prefix; description "Match on IPv6 dst address."; } leaf l4-src-port { type inet:port-number; description "Match on Layer 4 src port."; } leaf-list target-sites { type svc-id; description "Identify a site as traffic destination."; } container l4-src-port-range { leaf lower-port { type inet:port-number; description "Lower boundary for port."; } leaf upper-port { type inet:port-number; must ". >= ../lower-port" { description "Upper boundary must be higher than lower boundary."; } description "Upper boundary for port."; } description "Match on Layer 4 src port range."; } leaf l4-dst-port { type inet:port-number; description "Match on Layer 4 dst port."; } container l4-dst-port-range { leaf lower-port { type inet:port-number; description "Lower boundary for port."; } leaf upper-port { type inet:port-number; must ". >= ../lower-port" { description "Upper boundary must be higher than lower boundary."; } description "Upper boundary for port."; } description "Match on Layer 4 dst port range."; } leaf protocol-field { type union { type uint8; type identityref { base protocol-type; } } description "Match on IPv4 protocol or IPv6 Next Header field."; }
description "Describes flow-matching criteria."; } description "Flow definition based on criteria."; } grouping site-service-basic { leaf svc-input-bandwidth { type uint32; units bps; description "From the PE's perspective, the service input bandwidth of the connection."; } leaf svc-output-bandwidth { type uint32; units bps; description "From the PE's perspective, the service output bandwidth of the connection."; } leaf svc-mtu { type uint16; units bytes; description "MTU at service level. If the service is IP, it refers to the IP MTU."; } description "Defines basic service parameters for a site."; } grouping site-protection { container traffic-protection { if-feature fast-reroute; leaf enabled { type boolean; default false; description "Enables traffic protection of access link."; } description "Fast Reroute service parameters for the site."; } description "Defines protection service parameters for a site."; } grouping site-service-mpls { container carrierscarrier { if-feature carrierscarrier; leaf signalling-type { type enumeration { enum "ldp" { description "Use LDP as the signalling protocol between the PE and the CE."; } enum "bgp" { description "Use BGP (as per RFC 3107) as the signalling protocol between the PE and the CE. In this case, BGP must also be configured as the routing protocol."; } } description "MPLS signalling type."; } description "This container is used when the customer provides MPLS-based services. This is used in the case of CsC."; } description "Defines MPLS service parameters for a site."; } grouping site-service-qos-profile { container qos { if-feature qos; container qos-classification-policy { list rule { key id; ordered-by user;
leaf id { type uint16; description "ID of the rule."; }
choice match-type { case match-flow { uses flow-definition; } case match-application { leaf match-application { type identityref { base customer-application; } description "Defines the application to match."; } } description "Choice for classification."; }
leaf target-class-id { type string; description "Identification of the class of service. This identifier is internal to the administration."; }
description "List of marking rules."; } description "Configuration of the traffic classification policy."; } container qos-profile {
choice qos-profile { description "Choice for QoS profile. Can be standard profile or custom."; case standard { leaf profile { type string; description "QoS profile to be used."; } } case custom { container classes { if-feature qos-custom; list class { key class-id;
leaf class-id { type string; description "Identification of the class of service. This identifier is internal to the administration."; } leaf rate-limit { type uint8; units percent; description "To be used if the class must be rate-limited. Expressed as percentage of the service bandwidth."; } container latency { choice flavor { case lowest { leaf use-lowest-latency { type empty; description "The traffic class should use the path with the lowest latency."; } } case boundary { leaf latency-boundary { type uint16; units msec; description "The traffic class should use a path with a defined maximum latency."; } } description "Latency constraint on the traffic class."; } description "Latency constraint on the traffic class."; } container jitter { choice flavor { case lowest { leaf use-lowest-jitter { type empty; description "The traffic class should use the path with the lowest jitter."; } } case boundary { leaf latency-boundary { type uint32; units usec; description "The traffic class should use a path with a defined maximum jitter."; } } description "Jitter constraint on the traffic class."; } description "Jitter constraint on the traffic class."; } container bandwidth { leaf guaranteed-bw-percent { type uint8; units percent; description "To be used to define the guaranteed bandwidth as a percentage of the available service bandwidth."; } leaf end-to-end { type empty; description "Used if the bandwidth reservation must be done on the MPLS network too."; } description "Bandwidth constraint on the traffic class."; } description "List of classes of services."; } description "Container for list of classes of services."; }
}
} description "QoS profile configuration."; } description "QoS configuration."; } description "This grouping defines QoS parameters for a site."; }
grouping site-security-authentication { container authentication { description "Authentication parameters."; } description "This grouping defines authentication parameters for a site.";
} grouping site-security-encryption { container encryption { if-feature encryption; leaf enabled { type boolean; default false; description "If true, access encryption is required."; } leaf layer { type enumeration { enum layer2 { description "Encryption will occur at Layer 2."; } enum layer3 { description "Encryption will occur at Layer 3. For example, IPsec may be used."; } } mandatory true; description "Layer on which encryption is applied."; } container encryption-profile { choice profile { case provider-profile { leaf profile-name { type string; description "Name of the SP profile to be applied."; } } case customer-profile { leaf algorithm { type string; description "Encryption algorithm to be used."; } choice key-type { case psk { leaf preshared-key { type string; description "Key coming from customer."; } } case pki {
} description "Type of keys to be used."; } } description "Choice of profile."; } description "Profile of encryption to be applied."; } description "Encryption parameters."; } description "This grouping defines encryption parameters for a site."; }
grouping site-attachment-bearer { container bearer { container requested-type { if-feature requested-type; leaf requested-type { type string; description "Type of requested bearer: Ethernet, DSL, Wireless, etc. Operator specific."; } leaf strict { type boolean; default false; description "Defines whether requested-type is a preference or a strict requirement."; } description "Container for requested-type."; } leaf always-on { if-feature always-on; type boolean; default true; description "Request for an always-on access type. For example, this could mean no dial access type."; } leaf bearer-reference { if-feature bearer-reference; type string; description "This is an internal reference for the SP."; } description "Bearer-specific parameters. To be augmented."; } description "Defines physical properties of a site attachment."; }
grouping site-routing { container routing-protocols { list routing-protocol { key type;
okay bestie, we're still deep in the YANG module and the routing protocol containers are giving main character energy 💅🎀
leaf type {
type identityref {
base routing-protocol-type;
}
description
"Type of routing protocol.";
}
container ospf {
when "../type = 'ospf'" {
description
"Only applies when protocol is OSPF.";
}
if-feature rtg-ospf;
leaf-list address-family {
type address-family;
description
"Address family to be activated.";
}
leaf area-address {
type yang:dotted-quad;
description
"Area address.";
}
leaf metric {
type uint16;
description
"Metric of the PE-CE link.";
}
container sham-links {
if-feature rtg-ospf-sham-link;
list sham-link {
key target-site;
leaf target-site {
type svc-id;
description
"Target site for the sham link connection.
The site is referred to by its ID.";
}
leaf metric {
type uint16;
description
"Metric of the sham link.";
}
description
"Creates a sham link with another site.";
}
description
"List of sham links.";
}
description
"OSPF-specific configuration.";
}
container bgp {
when "../type = 'bgp'" {
description
"Only applies when protocol is BGP.";
}
if-feature rtg-bgp;
leaf autonomous-system {
type uint32;
description
"AS number.";
}
leaf-list address-family {
type address-family;
description
"Address family to be activated.";
}
description
"BGP-specific configuration.";
}
container static {
when "../type = 'static'" {
description
"Only applies when protocol is static.";
}
container cascaded-lan-prefixes {
list ipv4-lan-prefixes {
if-feature ipv4;
key "lan next-hop";
leaf lan {
type inet:ipv4-prefix;
description
"LAN prefixes.";
}
leaf lan-tag {
type string;
description
"Internal tag to be used in VPN policies.";
}
leaf next-hop {
type inet:ipv4-address;
description
"Next-hop address to use on the customer side.";
}
description
"List of LAN prefixes for the site.";
}
list ipv6-lan-prefixes {
if-feature ipv6;
key "lan next-hop";
leaf lan {
type inet:ipv6-prefix;
description
"LAN prefixes.";
}
leaf lan-tag {
type string;
description
"Internal tag to be used in VPN policies.";
}
leaf next-hop {
type inet:ipv6-address;
description
"Next-hop address to use on the customer side.";
}
description
"List of LAN prefixes for the site.";
}
description
"LAN prefixes from the customer.";
}
description
"Configuration specific to static routing.";
}
container rip {
when "../type = 'rip'" {
description
"Only applies when protocol is RIP.";
}
if-feature rtg-rip;
leaf-list address-family {
type address-family;
description
"Address family to be activated.";
}
description
"Configuration specific to RIP routing.";
}
container vrrp {
when "../type = 'vrrp'" {
description
"Only applies when protocol is VRRP.";
}
if-feature rtg-vrrp;
leaf-list address-family {
type address-family;
description
"Address family to be activated.";
}
description
"Configuration specific to VRRP routing.";
}
description
"List of routing protocols used on
the site. This list can be augmented.";
}
description
"Defines routing protocols.";
}
description
"Grouping for routing protocols.";
}
grouping site-attachment-ip-connection {
container ip-connection {
container ipv4 {
if-feature ipv4;
leaf address-allocation-type {
type identityref {
base address-allocation-type;
}
default "static-address";
description
"Defines how addresses are allocated.";
}
leaf number-of-dynamic-address {
when "../address-allocation-type = 'provider-dhcp'" {
description
"Only applies when addresses are allocated by DHCP.";
}
type uint8;
default 1;
description
"Describes the number of IP addresses the customer requires.";
}
container dhcp-relay {
when "../address-allocation-type = 'provider-dhcp-relay'" {
description
"Only applies when provider is required to implement
DHCP relay function.";
}
container customer-dhcp-servers {
leaf-list server-ip-address {
type inet:ipv4-address;
description
"IP address of customer DHCP server.";
}
description
"Container for list of customer DHCP servers.";
}
description
"DHCP relay provided by operator.";
}
container addresses {
when "../address-allocation-type = 'static-address'" {
description
"Only applies when protocol allocation type is static.";
}
leaf provider-address {
type inet:ipv4-address;
description
"Address of provider side.";
}
leaf customer-address {
type inet:ipv4-address;
description
"Address of customer side.";
}
leaf mask {
type uint8 {
range "0..31";
}
description
"Subnet mask expressed in bits.";
}
description
"Describes IP addresses used.";
}
description
"IPv4-specific parameters.";
}
container ipv6 {
if-feature ipv6;
leaf address-allocation-type {
type identityref {
base address-allocation-type;
}
default "static-address";
description
"Defines how addresses are allocated.";
}
leaf number-of-dynamic-address {
when
"../address-allocation-type = 'provider-dhcp' "+
"or ../address-allocation-type "+
"= 'provider-dhcp-slaac'" {
description
"Only applies when addresses are allocated by DHCP.";
}
type uint8;
default 1;
description
"Describes the number of IP addresses the customer requires.";
}
container dhcp-relay {
when "../address-allocation-type = 'provider-dhcp-relay'" {
description
"Only applies when provider is required to implement
DHCP relay function.";
}
container customer-dhcp-servers {
leaf-list server-ip-address {
type inet:ipv6-address;
description
"IP address of customer DHCP server.";
}
description
"Container for list of customer DHCP servers.";
}
description
"DHCP relay provided by operator.";
}
container addresses {
when "../address-allocation-type = 'static-address'" {
description
"Only applies when protocol allocation type is static.";
}
leaf provider-address {
type inet:ipv6-address;
description
"Address of provider side.";
}
leaf customer-address {
type inet:ipv6-address;
description
"Address of customer side.";
}
leaf mask {
type uint8 {
range "0..127";
}
description
"Subnet mask expressed in bits.";
}
description
"Describes IP addresses used.";
}
description
"IPv6-specific parameters.";
}
container oam {
container bfd {
if-feature bfd;
leaf enabled {
type boolean;
default false;
description
"BFD activation.";
}
choice holdtime {
case profile {
leaf profile-name {
type string;
description
"Well-known SP profile.";
}
description
"Well-known SP profile.";
}
case fixed {
leaf fixed-value {
type uint32;
units msec;
description
"Expected holdtime expressed in msec.";
}
}
description
"Choice for holdtime flavor.";
}
description
"Container for BFD.";
}
description
"Defines the OAM mechanisms used on the connection.";
}
description
"Defines connection parameters.";
}
description
"This grouping defines IP connection parameters.";
}
grouping site-service-multicast {
container multicast {
if-feature multicast;
leaf multicast-site-type {
type enumeration {
enum receiver-only {
description
"The site only has receivers.";
}
enum source-only {
description
"The site only has sources.";
}
enum source-receiver {
description
"The site has both sources and receivers.";
}
}
default "source-receiver";
description
"Type of multicast site.";
}
container multicast-address-family {
leaf ipv4 {
if-feature ipv4;
type boolean;
default true;
description
"Enables IPv4 multicast.";
}
leaf ipv6 {
if-feature ipv6;
type boolean;
default false;
description
"Enables IPv6 multicast.";
}
description
"Defines protocol to carry multicast.";
}
leaf protocol-type {
type enumeration {
enum host {
description
"Hosts are directly connected to the provider network.
Host protocols such as IGMP or MLD are required.";
}
enum router {
description
"Hosts are behind a customer router.
PIM will be implemented.";
}
enum both {
description
"Some hosts are behind a customer router, and some others
are directly connected to the provider network.
Both host and routing protocols must be used.
Typically, IGMP and PIM will be implemented.";
}
}
default "both";
description
"Multicast protocol type to be used with the customer site.";
}
description
"Multicast parameters for the site.";
}
description
"Multicast parameters for the site.";
}that's the whole routing, IP connection, and multicast chunk 💜 the protocol containers each have their own little "only applies when" check, and the address stuff splits neatly into v4 and v6 🌸
grouping site-management { container management { leaf type { type identityref { base management; } description "Management type of the connection."; } description "Management configuration."; } description "Management parameters for the site."; } grouping site-devices { container devices { must "/l3vpn-svc/sites/site/management/type = "+ "'provider-managed' or "+ "/l3vpn-svc/sites/site/management/type = "+ "'co-managed'" { description "Applicable only for provider-managed or co-managed device."; } list device { key device-id;
leaf device-id { type svc-id; description "Identifier for the device."; } leaf location { type leafref { path "/l3vpn-svc/sites/site/locations/"+ "location/location-id"; } description "Location of the device."; } container management { must "/l3vpn-svc/sites/site/management/type"+ "= 'co-managed'" { description "Applicable only for co-managed device."; } leaf address-family { type address-family;
description "Address family used for management."; } leaf address { type inet:ip-address; description "Management address."; } description "Management configuration. Applicable only for co-managed device."; } description "Device configuration."; } description "List of devices requested by customer."; } description "Grouping for device allocation."; } grouping site-vpn-flavor { leaf site-vpn-flavor { type identityref { base site-vpn-flavor; } default site-vpn-flavor-single; description "Defines whether the site is, for example, a single VPN site or a multiVPN."; } description "Grouping for site VPN flavor."; }
grouping site-vpn-policy { container vpn-policies { list vpn-policy { key vpn-policy-id;
leaf vpn-policy-id { type svc-id; description "Unique identifier for the VPN policy."; }
list entries { key id;
leaf id { type svc-id; description "Unique identifier for the policy entry."; } container filter { choice lan { case prefixes { leaf-list ipv4-lan-prefix { if-feature ipv4; type inet:ipv4-prefix; description "List of IPv4 prefixes to be matched."; } leaf-list ipv6-lan-prefix { if-feature ipv6; type inet:ipv6-prefix; description "List of IPv6 prefixes to be matched."; } } case lan-tag { leaf-list lan-tag { type string; description "List of 'lan-tag' items to be matched."; } } description "Choice of ways to do LAN matching."; } description "If used, it permits the splitting of site LANs among multiple VPNs. If no filter is used, all the LANs will be part of the same VPNs with the same role."; } container vpn { leaf vpn-id { type leafref { path "/l3vpn-svc/vpn-services/"+ "vpn-service/vpn-id"; } mandatory true; description "Reference to an IP VPN."; } leaf site-role { type identityref { base site-role; } default any-to-any-role; description "Role of the site in the IP VPN."; } description "List of VPNs the LAN is associated with."; } description "List of entries for export policy."; } description "List of VPN policies."; } description "VPN policy."; } description "VPN policy parameters for the site."; }
grouping site-maximum-routes { container maximum-routes { list address-family { key af;
leaf af { type address-family;
description "Address family."; } leaf maximum-routes { type uint32; description "Maximum prefixes the VRF can accept for this address family."; } description "List of address families."; }
description "Defines 'maximum-routes' for the VRF."; } description "Defines 'maximum-routes' for the site."; }
grouping site-security { container security { uses site-security-authentication; uses site-security-encryption;
description "Site-specific security parameters."; } description "Grouping for security parameters."; }
grouping site-service { container service { uses site-service-qos-profile; uses site-service-mpls; uses site-service-multicast;
description "Service parameters on the attachment."; } description "Grouping for service parameters."; }
grouping site-network-access-service { container service { uses site-service-basic; uses site-service-qos-profile; uses site-service-mpls; uses site-service-multicast;
description "Service parameters on the attachment."; } description "Grouping for service parameters."; } grouping vpn-extranet { container extranet-vpns { if-feature extranet-vpn; list extranet-vpn { key vpn-id;
leaf vpn-id { type svc-id; description "Identifies the target VPN."; } leaf local-sites-role { type identityref { base site-role;
} default any-to-any-role; description "This describes the role of the local sites in the target VPN topology."; } description "List of extranet VPNs the local VPN is attached to."; } description "Container for extranet VPN configuration."; } description "Grouping for extranet VPN configuration. This provides an easy way to interconnect all sites from two VPNs."; }
grouping site-attachment-availability { container availability { leaf access-priority { type uint32; default 1; description "Defines the priority for the access. The higher the access-priority value, the higher the preference of the access will be."; } description "Availability parameters (used for multihoming)."; } description "Defines availability parameters for a site."; }
grouping access-vpn-policy { container vpn-attachment {
choice attachment-flavor { case vpn-policy-id { leaf vpn-policy-id { type leafref { path "/l3vpn-svc/sites/site/"+ "vpn-policies/vpn-policy/"+ "vpn-policy-id"; } description "Reference to a VPN policy."; } } case vpn-id { leaf vpn-id { type leafref { path "/l3vpn-svc/vpn-services"+ "/vpn-service/vpn-id"; } description "Reference to a VPN."; } leaf site-role { type identityref { base site-role; } default any-to-any-role; description "Role of the site in the IP VPN."; } } mandatory true; description "Choice for VPN attachment flavor."; } description "Defines VPN attachment of a site."; } description "Defines the VPN attachment rules for a site's logical access."; } grouping vpn-svc-cfg { leaf vpn-id { type svc-id; description "VPN identifier. Local administration meaning."; } leaf customer-name { type string; description "Name of the customer."; } leaf vpn-service-topology { type identityref { base vpn-topology; } default "any-to-any"; description "VPN service topology."; }
uses vpn-service-cloud-access; uses vpn-service-multicast; uses vpn-service-mpls; uses vpn-extranet;
description "Grouping for VPN service configuration."; }
grouping site-top-level-cfg { uses operational-requirements; uses customer-location-info; uses site-devices; uses site-diversity; uses site-management; uses site-vpn-policy; uses site-vpn-flavor; uses site-maximum-routes; uses site-security; uses site-service; uses site-protection; uses site-routing;
description "Grouping for site top-level configuration."; } grouping site-network-access-top-level-cfg { leaf site-network-access-type { type identityref { base site-network-access-type; } default "point-to-point"; description "Describes the type of connection, e.g., point-to-point or multipoint."; }
choice location-flavor { case location { when "/l3vpn-svc/sites/site/management/type = "+ "'customer-managed'" { description "Applicable only for customer-managed device."; } leaf location-reference { type leafref { path "/l3vpn-svc/sites/site/locations/"+ "location/location-id"; } description "Location of the site-network-access."; } } case device { when "/l3vpn-svc/sites/site/management/type = "+ "'provider-managed' or "+ "/l3vpn-svc/sites/site/management/type = "+ "'co-managed'" { description "Applicable only for provider-managed or co-managed device."; } leaf device-reference { type leafref { path "/l3vpn-svc/sites/site/devices/"+ "device/device-id"; } description "Identifier of CE to use."; } } mandatory true; description "Choice of how to describe the site's location."; } uses access-diversity; uses site-attachment-bearer; uses site-attachment-ip-connection; uses site-security; uses site-network-access-service; uses site-routing; uses site-attachment-availability; uses access-vpn-policy;
description "Grouping for site network access top-level configuration."; }
/* Main blocks */
container l3vpn-svc { container vpn-services { list vpn-service { key vpn-id;
uses vpn-svc-cfg;
description "List of VPN services."; } description "Top-level container for the VPN services."; }
container sites { list site { key site-id;
leaf site-id { type svc-id; description "Identifier of the site."; }
uses site-top-level-cfg; uses operational-requirements-ops; container site-network-accesses { list site-network-access { key site-network-access-id;
leaf site-network-access-id { type svc-id; description "Identifier for the access."; } uses site-network-access-top-level-cfg;
description "List of accesses for a site."; } description "List of accesses for a site."; }
Hmm, that environment block and the "untrusted data" note ended up in my request, and I don't see a real task for a shell or any files here. The RFC excerpt you pasted is the only thing I'm rewriting, so I'll just continue with that.
The excerpt picks up mid-way through the YANG module, so I'll carry on from the closing <CODE ENDS> without repeating any headings from earlier parts.
Okay so this is the tail end of the YANG module, and it's giving "module wrap-up" 💅✨
description
"List of sites.";
}
description
"Container for sites.";
}
description
"Main container for L3VPN service configuration.";
}
}
<CODE ENDS>10. Security Considerations 🔒🫶
Bestie, this is the serious part, so listen up 😭
The YANG module in this document MAY be accessed over the RESTCONF protocol [RFC8040] or the NETCONF protocol [RFC6241]. The lowest RESTCONF or NETCONF layer REQUIRES the transport layer to provide both data integrity and confidentiality, see Section 2 in [RFC8040] and Section 2 in [RFC6241]. The client MUST carefully check the certificate the server shows, to make sure it's what the client expects 🧐, and the server MUST authenticate client access to any protected resource. The client identity from whatever authentication mechanism is used is subject to the NETCONF Access Control Model (NACM) [RFC6536]. Other protocols that access this YANG module also REQUIRE similar security mechanisms 🔐.
The data nodes in the "ietf-l3vpn-svc" YANG module MUST be carefully created, read, updated, or deleted as appropriate. The entries in the lists below hold customer-proprietary or confidential information, so access to that info MUST be limited to authorized clients, and other clients MUST NOT be permitted to access it. No bestie, not even a little peek 🙅♀️💀
/l3vpn-svc/vpn-services/vpn-service/l3vpn-svc/sites/site
The data model proposes some security parameters that can be extended via augmentation as part of the customer service request. Those parameters are described in Section 6.9 🦋.
11. IANA Considerations 🌸
IANA has assigned a new URI from the "IETF XML Registry" [RFC3688] 🎀.
URI: urn:ietf:params:xml:ns:yang:ietf-l3vpn-svc
Registrant Contact: The IESG
XML: N/A; the requested URI is an XML namespace.This document adds a new YANG module name in the "YANG Module Names" registry [RFC6020] 💜.
Name: ietf-l3vpn-svc
Namespace: urn:ietf:params:xml:ns:yang:ietf-l3vpn-svc
Prefix: l3vpn-svc
Reference: RFC 804912. References 📚
12.1. Normative References
[RFC2119] Bradner, S., "Key words for use in RFCs to Indicate
Requirement Levels", BCP 14, RFC 2119,
DOI 10.17487/RFC2119, March 1997,
<http://www.rfc-editor.org/info/rfc2119>.
[RFC3688] Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688,
DOI 10.17487/RFC3688, January 2004,
<http://www.rfc-editor.org/info/rfc3688>.
[RFC4026] Andersson, L. and T. Madsen, "Provider Provisioned Virtual
Private Network (VPN) Terminology", RFC 4026,
DOI 10.17487/RFC4026, March 2005,
<http://www.rfc-editor.org/info/rfc4026>.
[RFC4364] Rosen, E. and Y. Rekhter, "BGP/MPLS IP Virtual Private
Networks (VPNs)", RFC 4364, DOI 10.17487/RFC4364,
February 2006, <http://www.rfc-editor.org/info/rfc4364>.
[RFC4577] Rosen, E., Psenak, P., and P. Pillay-Esnault, "OSPF as the
Provider/Customer Edge Protocol for BGP/MPLS IP Virtual
Private Networks (VPNs)", RFC 4577, DOI 10.17487/RFC4577,
June 2006, <http://www.rfc-editor.org/info/rfc4577>.
[RFC4862] Thomson, S., Narten, T., and T. Jinmei, "IPv6 Stateless
Address Autoconfiguration", RFC 4862,
DOI 10.17487/RFC4862, September 2007,
<http://www.rfc-editor.org/info/rfc4862>.
[RFC6020] Bjorklund, M., Ed., "YANG - A Data Modeling Language for
the Network Configuration Protocol (NETCONF)", RFC 6020,
DOI 10.17487/RFC6020, October 2010,
<http://www.rfc-editor.org/info/rfc6020>.
[RFC6241] Enns, R., Ed., Bjorklund, M., Ed., Schoenwaelder, J., Ed.,
and A. Bierman, Ed., "Network Configuration Protocol
(NETCONF)", RFC 6241, DOI 10.17487/RFC6241, June 2011,
<http://www.rfc-editor.org/info/rfc6241>.
[RFC6513] Rosen, E., Ed., and R. Aggarwal, Ed., "Multicast in
MPLS/BGP IP VPNs", RFC 6513, DOI 10.17487/RFC6513,
February 2012, <http://www.rfc-editor.org/info/rfc6513>.
[RFC6536] Bierman, A. and M. Bjorklund, "Network Configuration
Protocol (NETCONF) Access Control Model", RFC 6536,
DOI 10.17487/RFC6536, March 2012,
<http://www.rfc-editor.org/info/rfc6536>.
[RFC7950] Bjorklund, M., Ed., "The YANG 1.1 Data Modeling Language",
RFC 7950, DOI 10.17487/RFC7950, August 2016,
<http://www.rfc-editor.org/info/rfc7950>.
[RFC8040] Bierman, A., Bjorklund, M., and K. Watsen, "RESTCONF
Protocol", RFC 8040, DOI 10.17487/RFC8040, January 2017,
<http://www.rfc-editor.org/info/rfc8040>.12.2. Informative References
[RFC4110] Callon, R. and M. Suzuki, "A Framework for Layer 3
Provider-Provisioned Virtual Private Networks (PPVPNs)",
RFC 4110, DOI 10.17487/RFC4110, July 2005,
<http://www.rfc-editor.org/info/rfc4110>.
[RFC4760] Bates, T., Chandra, R., Katz, D., and Y. Rekhter,
"Multiprotocol Extensions for BGP-4", RFC 4760,
DOI 10.17487/RFC4760, January 2007,
<http://www.rfc-editor.org/info/rfc4760>.Acknowledgements 💖
Thanks to Qin Wu, Maxim Klyus, Luis Miguel Contreras, Gregory Mirsky, Zitao Wang, Jing Zhao, Kireeti Kompella, Eric Rosen, Aijun Wang, Michael Scharf, Xufeng Liu, David Ball, Lucy Yong, Jean-Philippe Landry, and Andrew Leu for their contributions to this document 🙌.
Contributors 🧚
The authors would like to thank Rob Shakir for his major contributions to the initial modeling and use cases 🌈.
Authors' Addresses 🍓
Stephane Litkowski
Orange Business Services
Email: stephane.litkowski@orange.com
Luis Tomotaki
Verizon
Email: luis.tomotaki@verizon.com
Kenichi Ogaki
KDDI Corporation
Email: ke-oogaki@kddi.comThat's the whole spec, babe! 🌈👑 Every requirement, every reference, every email is exactly where it belongs, no cap 💅✨
📦 where this page comes from
- ietf: rfc8049 2017-02
- 💖 girlified by claude-haiku-5-5 on : a language model's rewrite of the original, under its terms