INTERNET-DRAFT S. Thoria Intended Status: Informational S. Mahadevan Expires: December 15, 2023 P. Radhakrishnan Cisco Systems July 31, 2023 Overlay Management Protocol draft-sthoria-omp-00 Abstract This document describes Cisco's Overlay Management Protocol (OMP). OMP is a routing information management and distribution protocol that enables overlay networks by separating service from transport. OMP is closely modeled and related to BGP. Primary usage for OMP is in Software Defined Networks, where all the routers are in the same administrative domain. OMP is used as the routing protocol in Cisco's Software Defined WAN (SD-WAN) solution. Status of this Memo This Internet-Draft is submitted to IETF in full conformance with the provisions of BCP 78 and BCP 79. Internet-Drafts are working documents of the Internet Engineering Task Force (IETF), its areas, and its working groups. Note that other groups may also distribute working documents as Internet-Drafts. Internet-Drafts are draft documents valid for a maximum of six months and may be updated, replaced, or obsoleted by other documents at any time. It is inappropriate to use Internet-Drafts as reference material or to cite them other than as "work in progress." The list of current Internet-Drafts can be accessed at http://www.ietf.org/1id-abstracts.html The list of Internet-Draft Shadow Directories can be accessed at http://www.ietf.org/shadow.html Copyright and License Notice Thoria, et al. Expires December 15, 2023 [Page 1] INTERNET DRAFT Overlay Management Protocol July 31, 2023 Copyright (c) 2023 IETF Trust and the persons identified as the document authors. All rights reserved. This document is subject to BCP 78 and the IETF Trust's Legal Provisions Relating to IETF Documents (http://trustee.ietf.org/license-info) in effect on the date of publication of this document. Please review these documents carefully, as they describe your rights and restrictions with respect to this document. Code Components extracted from this document must include Simplified BSD License text as described in Section 4.e of the Trust Legal Provisions and are provided without warranty as described in the Simplified BSD License. Table of Contents 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . . 3 1.1 Requirements Language . . . . . . . . . . . . . . . . . . . 3 2. OMP elements . . . . . . . . . . . . . . . . . . . . . . . . . 4 3. OMP operation . . . . . . . . . . . . . . . . . . . . . . . . . 4 3.1 OMP Route Distribution . . . . . . . . . . . . . . . . . . . 4 3.1. OMP Path Selection Process . . . . . . . . . . . . . . . . 5 3.1. OMP Graceful restart . . . . . . . . . . . . . . . . . . . 6 3.1. OMP message format . . . . . . . . . . . . . . . . . . . . 6 3.1.1 Message Header Format . . . . . . . . . . . . . . . . . 6 3.1.2 HANDSHAKE Message Format . . . . . . . . . . . . . . . 7 3.1.2.1 MP Capability Format . . . . . . . . . . . . . . . . 8 3.1.2.2 IDENTITY Capability Format . . . . . . . . . . . . . 9 3.1.2.3 GRACEFUL RESTART Capability Format . . . . . . . . . 9 3.1.2.4 REFRESH Capability Format . . . . . . . . . . . . . 10 3.1.2.5 OVERLAY_ID Capability Format . . . . . . . . . . . 10 3.1.2.6 SECURITY Capability Format . . . . . . . . . . . . 10 3.1.3 UPDATE Message Format . . . . . . . . . . . . . . . . . 10 3.1.3.1 ATTR_TYPE_TLOC Format . . . . . . . . . . . . . . . 12 3.1.3.2 ATTR_TYPE_TLOC_V4_PRIVATE Format . . . . . . . . . . 13 3.1.3.3 ATTR_TYPE_TLOC_V4_PUBLIC Format . . . . . . . . . . 13 3.1.3.3 ATTR_TYPE_TLOC_ENCP Format . . . . . . . . . . . . . 13 3.1.3.4 ATTR_TYPE_PREF Format . . . . . . . . . . . . . . . 15 3.1.3.5 ATTR_TYPE_WEIGHT Format . . . . . . . . . . . . . . 15 3.1.3.6 ATTR_TYPE_TAG Format . . . . . . . . . . . . . . . . 15 3.1.3.7 ATTR_TYPE_DOMAIN Format . . . . . . . . . . . . . . 16 3.1.3.8 ATTR_TYPE_SITE_ID Format . . . . . . . . . . . . . . 16 3.1.3.8 ATTR_TYPE_QUERY Format . . . . . . . . . . . . . . . 16 3.1.3.9 ATTR_TYPE_ORIGIN Format . . . . . . . . . . . . . . 16 3.1.3.10 ATTR_TYPE_ORIGINATOR Format . . . . . . . . . . . . 16 3.1.3.11 ATTR_TYPE_SRCVPN Format . . . . . . . . . . . . . . 17 3.1.3.12 ATTR_TYPE_REACHABLES and ATTR_TYPE_UNREACHABLES . . 17 3.1.3.13 ATTR_TYPE_STALE . . . . . . . . . . . . . . . . . . 20 3.1.3.14 ATTR_TYPE_CARRIER . . . . . . . . . . . . . . . . . 20 Thoria, et al. Expires December 15, 2023 [Page 2] INTERNET DRAFT Overlay Management Protocol July 31, 2023 3.1.3.15 ATTR_TYPE_VERSION . . . . . . . . . . . . . . . . . 20 3.1.3.16 ATTR_TYPE_GROUP . . . . . . . . . . . . . . . . . . 20 3.1.3.17 ATTR_TYPE_RESTRICT . . . . . . . . . . . . . . . . 21 3.1.3.18 ATTR_TYPE_SECURITY . . . . . . . . . . . . . . . . 21 3.1.3.19 ATTR_TYPE_BORDER . . . . . . . . . . . . . . . . . 26 3.1.3.20 ATTR_TYPE_ASPATH . . . . . . . . . . . . . . . . . 26 3.1.3.21 ATTR_TYPE_ASPATH . . . . . . . . . . . . . . . . . 26 3.1.3.22 ATTR_TYPE_COMMUNITY . . . . . . . . . . . . . . . . 27 3.1.3.23 ATTR_TYPE_ON_DEMAND . . . . . . . . . . . . . . . . 27 3.1.3.24 ATTR_TYPE_ADAPT_QOS . . . . . . . . . . . . . . . . 27 3.1.4 ALERT Message Format . . . . . . . . . . . . . . . . . 28 3.1.5 HELLO Message Format . . . . . . . . . . . . . . . . . 29 3.1.6 QUERY Message Format . . . . . . . . . . . . . . . . . 29 3.1.7 POLICY Message Format . . . . . . . . . . . . . . . . . 30 3.1.7 INFORM Message Format . . . . . . . . . . . . . . . . . 30 6. Security Considerations . . . . . . . . . . . . . . . . . . . 31 7. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 31 8. References . . . . . . . . . . . . . . . . . . . . . . . . . . 31 10. Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . 32 1. Introduction OMP is designed for software defined networks, and enables centralized control and distributed intelligent edge routers. It provides scalable and secure distribution of routing information. OMP operates by distributing overlay prefixes and decouples those from the underlay transport details. OMP provides L3VPN service similar to BGP L3VPN for Unicast and Multicast IP traffic as described in [RFC4364] [RFC6513]. OMP leverages heavily concepts/encoding/procedures from BGP [RFC4271] and multi-protocol BGP [RFC4760], when possible but is significantly simplified to leverage the network being operated by single administrative domain and under a software defined management and control plane. 1.1 Requirements Language The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in BCP Thoria, et al. Expires December 15, 2023 [Page 3] INTERNET DRAFT Overlay Management Protocol July 31, 2023 14 [RFC2119] [RFC8174] when, and only when, they appear in all capitals, as shown here. 2. OMP elements Routing Controller: Centralized routing and policy distribution controller. Peers with all SDN routers in the network via OMP. SDN Routers: A router that is managed by an SDN controller infrastructure, peers with Routing controller with OMP. It learns locally attached networks and prefixes via traditional routing mechanisms and advertises to Routing Controller via OMP. OMP Routes: Reachability information distributed by OMP. Semantics of each route is determined by its route type. vRoute : A VPN route advertised in OMP. A VPN route consists of a IPv4 or IPv6 prefix in addition to a VPN discriminator. TLOC: Transport locator. Serves as the next hop for the OMP routes. Ties overlay routes to underlay reachability information. A TLOC can be directly reachable via an entry in the routing table of the underlay network or be represented by a prefix residing on the outside of a NAT device, also present in the underlay routing table. VPN: Virtual Private Networks. Same definition as in [RFC4364]. 3. OMP operation OMP requires a reliable transport to distribute routing information. OMP runs on TCP. 3.1 OMP Route Distribution OMP automatically redistributes the following types of routes that are reachable locally, either directly or via a downstream router. - Connected - Static - OSPF Intra and Inter area routes - EIGRP To avoid the potential of routing loops and less than optimal routing, redistribution of following types of routes requires explicit configuration. Thoria, et al. Expires December 15, 2023 [Page 4] INTERNET DRAFT Overlay Management Protocol July 31, 2023 - BGP - OSPF external routes In order to avoid propagating excessive routing information to downstream routers attached to SDN Routers, routes learnt via OMP are not automatically redistributed to downstream routers, and can be enabled if desired. This allows for flexible routing design. 3.1. OMP Path Selection Process The OMP best-path algorithm selects paths that will be used by the routing controller and by the edges when multiple paths are available. This decision is taken based on attributes that are attached to both vRoutes and TLOCs as well as the result from OMP control policies that are applied. The following are the steps in the OMP best-path algorithm: 1. Check whether the OMP route is valid. If not, ignore it. 2. If the OMP route is valid and if it has been learned from the same device, select the OMP route with the lower administrative distance. 3. If the administrative distances are equal, select the OMP route with the higher OMP route preference value. 4. On SDN routers only, if the OMP route preference values are equal, select the OMP route with the higher TLOC preference value. 5. On SDN routers only, if the TLOC preference values are equal, compare the origin type, and select one in the following order (select the first match): a. Connected b. Static c. EBGP d. OSFP intra-area e. OSPF inter-area f. OSPF external g. IBGP h. Unknown 6. If the origin types are the same, select the OMP route the higher router ID. 7. If the router IDs are equal, SDN router selects the OMP route with the higher private IP address. If a vSmart controller receives the Thoria, et al. Expires December 15, 2023 [Page 5] INTERNET DRAFT Overlay Management Protocol July 31, 2023 same prefix from two different sites and if all attributes are equal, the routing controller chooses both of them. 3.1. OMP Graceful restart Graceful restart for OMP allows SDN routers to continue forwarding with last known routing information even when the OMP peering experiences an outage. The duration of the period (graceful restart duration) in which an SDN router operates in this mode is configurable and depends on the operator. If the graceful restart duration expires and the OMP peering is not re-established within this period, then the SDN Router considers the OMP peer as dead and purges all routes learnt from that period. In the case where the peering is re-established during graceful restart duration, then based on fresh routes learnt from the OMP peer, a mark and sweep of all routes is done. This procedure ensures that the network runs with potentially stale routing information for maximum of graceful restart duration and any transient failures in OMP peering does not result in to unnecessary route removal. 3.1. OMP message format This section describes message formats used by OMP. OMP messages are sent over TCP connections. All multi-octet fields are in network byte order. Minimum packet size 16 bytes, maximum packet size is 4096 bytes. 3.1.1 Message Header Format Each message has a fixed-size header. There may or may not be a data portion following the header, depending on the message type. The layout of these fields is shown below: 0 1 2 3 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | | + + | | + Marker + | | + + Thoria, et al. Expires December 15, 2023 [Page 6] INTERNET DRAFT Overlay Management Protocol July 31, 2023 | | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Length | Type | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ Marker : 16 bytes. MUST be set to all 1s. Length : 2 bytes. Packet length including header length of 19 bytes. Type : 1 byte. OMP packet type. INVALID = 0 HANDSHAKE = 1 UPDATE = 2 ALERT = 3 HELLO = 4 QUERY = 5 POLICY = 6 INFORM = 7 3.1.2 HANDSHAKE Message Format 0 1 2 3 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Version | Site ID | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | | Domain ID | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | | Holdtime |Peer Router ID | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | | Options Length| +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Option Type | Option Length | Options Data... | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ Version : 1 byte Site ID : 4 bytes Domain ID : 4 bytes Hold Time : 2 bytes Peer Router ID : 4 bytes Options Length : 1 byte If Options Length is not zero, then following options information MAY be included: Thoria, et al. Expires December 15, 2023 [Page 7] INTERNET DRAFT Overlay Management Protocol July 31, 2023 Options Type : 1 byte Types: Authentication = 1 Capabilities = 2 Options Length : 1 byte. Length of data excluding options type and length. i.e. 2 bytes Options Data : Variable. If the option is of type Capability, then the format of Capability is as following: 0 1 2 3 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Code | Length | Data... | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ Code : 1 byte MP = 1 IDENTITY = 2 GRACEFUL RESTART = 3 REFRESH = 4 SECURITY = 5 OVERLAY ID = 6 Length : 1 byte. Length of data excluding code and length field. i.e. 2 bytes Data : Variable Depending on the capability code the format of the data is as following: 3.1.2.1 MP Capability Format 0 1 2 3 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Code=1 | Length | AFI | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | SAFI VERSION | SAFI | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ Code : 1 byte. Value is 1. Length : 1 byte. Value is 4. AFI : 2 bytes. Types : Thoria, et al. Expires December 15, 2023 [Page 8] INTERNET DRAFT Overlay Management Protocol July 31, 2023 AFI_IPV4 = 1 AFI_IPv6 = 2 SAFI Version: 1 byte. Types: OMP_AFI_SAFI_DEFAULT_VERSION = 0 OMP_AFI_SAFI_VERSION_TWO = 2 SAFI : 1 byte. Types: SAFI_VROUTE = 1 SAFI_TLOC = 2 SAFI_SERVICE = 3 SAFI_MULTICASE = 4 SAFI_SECURITY = 5 SAFI_LINK = 6 SAFI_CXP = 7 3.1.2.2 IDENTITY Capability Format 0 1 2 3 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Code=2 | Length=4 | Peer Type | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ Code : 1 byte. Value is 2 Length : 1 byte. Value is 4 Peer Type : 4 bytes. Types: VIP_DEVICE_VDEDGE = 1 VIP_DEVICE_VHUB = 2 VIP_DEVICE_VSMART = 3 3.1.2.3 GRACEFUL RESTART Capability Format 0 1 2 3 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Code=3 | Length=4 | GR Interval | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ Code : 1 byte. Value is 3. Length : 1 byte. Value is 4 bytes. Thoria, et al. Expires December 15, 2023 [Page 9] INTERNET DRAFT Overlay Management Protocol July 31, 2023 GR Interval : 4 bytes 3.1.2.4 REFRESH Capability Format 0 1 2 3 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Code=4 | Length=0 | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ Code : 1 byte. Value is 4. Length : 1 byte. Value is 0. 3.1.2.5 OVERLAY_ID Capability Format 0 1 2 3 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Code=6 | Length=4 | Overlay ID | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ Code : 1 byte. Value is 6. Length : 1 byte. Value is 4. Overlay ID: 4 bytes. 3.1.2.6 SECURITY Capability Format 0 1 2 3 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Code=5 | Length=0 | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ Code : 1 byte. Value is 5. Length : 1 byte. Value is 0. 3.1.3 UPDATE Message Format 0 1 2 3 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Attributes Length | Data... | Thoria, et al. Expires December 15, 2023 [Page 10] INTERNET DRAFT Overlay Management Protocol July 31, 2023 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ Attributes Length : 2 bytes. Length of attributes excluding attributes length field. Data : Variable, depending on attributes present. Following is the general format for attributes. Attribute data format depends on the actual attribute type. 0 1 2 3 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Flags | Type |Length(1/2bytes based on flags)| +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Attribute Data... | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ Flags : 1 byte. Types: ATTR_EXTENDED = 0x10 ATTR_PARTIAL = 0x20 ATTR_OPTIONAL = 0x80 Type: 1 byte, Types ATTR_TYPE_TLOC 1 ATTR_TYPE_TLOC_V4_PRIVATE 2 ATTR_TYPE_TLOC_V4_PUBLIC 3 ATTR_TYPE_TLOC_ENCAP 4 ATTR_TYPE_PREF 5 ATTR_TYPE_WEIGHT 6 ATTR_TYPE_TAG 7 ATTR_TYPE_SITE_ID 9 ATTR_TYPE_QUERY 10 ATTR_TYPE_ORIGIN 11 ATTR_TYPE_ORIGINATOR 12 ATTR_TYPE_SRCVPN 13 ATTR_TYPE_REACHABLES 14 ATTR_TYPE_UNREACHABLES 15 ATTR_TYPE_STALE 16 ATTR_TYPE_CARRIER 17 ATTR_TYPE_MULTICAST 18 ATTR_TYPE_VERSION 19 ATTR_TYPE_TLOC_V6_PRIVATE 20 ATTR_TYPE_TLOC_V6_PUBLIC 21 ATTR_TYPE_GEN_ID 22 Thoria, et al. Expires December 15, 2023 [Page 11] INTERNET DRAFT Overlay Management Protocol July 31, 2023 ATTR_TYPE_GROUP 23 ATTR_TYPE_RESTRICT 24 ATTR_TYPE_SECURITY 25 ATTR_TYPE_BORDER 26 ATTR_TYPE_ULTIMATE_TLOC 27 ATTR_TYPE_SLA 28 ATTR_TYPE_OVERLAY_ID 29 ATTR_TYPE_ASPATH 30 ATTR_TYPE_BANDWIDTH 31 ATTR_TYPE_QOS_GROUP 32 ATTR_TYPE_CAP 33 ATTR_TYPE_TLOC_INSTALLED 34 ATTR_TYPE_COMMUNITY 35 ATTR_TYPE_EXT_COMMUNITY 36 ATTR_TYPE_ON_DEMAND 37 ATTR_TYPE_ADAPT_QOS 38 Format of the attribute data depends on the attribute type. Following sections describes attribute specific formats. 3.1.3.1 ATTR_TYPE_TLOC Format For IPv4: 0 1 2 3 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | IPv4 TLOC Address | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Color | Encap | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ For IPv6: 0 1 2 3 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | | + + | | + IPv6 TLOC Address + | | + + | | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Color | Encap | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ Thoria, et al. Expires December 15, 2023 [Page 12] INTERNET DRAFT Overlay Management Protocol July 31, 2023 3.1.3.2 ATTR_TYPE_TLOC_V4_PRIVATE Format 0 1 2 3 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | IPv4 TLOC Private Address | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Private Port | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ 3.1.3.3 ATTR_TYPE_TLOC_V4_PUBLIC Format 0 1 2 3 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | IPv4 TLOC Public Address | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Public Port | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ 3.1.3.3 ATTR_TYPE_TLOC_ENCP Format For IPsec: 0 1 2 3 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Encap Type=2 | Length=148 | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | PROTOCOL=7 | Length=2 | Proto Value(AH or ESP) | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | SPI=2 | Length=4 | IPsec SPI | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | | AUTH=3 | Lenth=1 | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Auth Type | AUTH_KEY=4 | Length=64 | | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + | | + + | | + + | | + + | | Thoria, et al. Expires December 15, 2023 [Page 13] INTERNET DRAFT Overlay Management Protocol July 31, 2023 + + | | + + | | + + | | + + | | + + | | + + | | + + | | + + | | + + | | + + | | + + | Authentication Key | + +-+-+-+-+-+-+-+-+ | | ENCRYPT=5 | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Length=1 | Encrypt Type | ENCRYPT_KEY=6 | Length=64 | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | | + + | | + + | | + + | | + + | | + + | | + + | | + + | | + Encryption Key + | | + + | | + + | | Thoria, et al. Expires December 15, 2023 [Page 14] INTERNET DRAFT Overlay Management Protocol July 31, 2023 + + | | + + | | + + | | + + | | + + | | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ For GRE: 0 1 2 3 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Encap Type=1 | Length=6 | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | GRE_KEY=1 | Length=4 | GRE Key Value | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ 3.1.3.4 ATTR_TYPE_PREF Format 0 1 2 3 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Preference | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ 3.1.3.5 ATTR_TYPE_WEIGHT Format 0 1 2 3 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Weight | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ 3.1.3.6 ATTR_TYPE_TAG Format 0 1 2 3 Thoria, et al. Expires December 15, 2023 [Page 15] INTERNET DRAFT Overlay Management Protocol July 31, 2023 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Tag | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ 3.1.3.7 ATTR_TYPE_DOMAIN Format 0 1 2 3 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Domain ID | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ 3.1.3.8 ATTR_TYPE_SITE_ID Format 0 1 2 3 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Site ID | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ 3.1.3.8 ATTR_TYPE_QUERY Format 0 1 2 3 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Query | +-+-+-+-+-+-+-+-+ 3.1.3.9 ATTR_TYPE_ORIGIN Format 0 1 2 3 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | PROTO=1 | Length=2 | Proto | Proto Subtype | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | METRIC=2 | Length=4 | Metric Value | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ 3.1.3.10 ATTR_TYPE_ORIGINATOR Format Thoria, et al. Expires December 15, 2023 [Page 16] INTERNET DRAFT Overlay Management Protocol July 31, 2023 0 1 2 3 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Originator | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ 3.1.3.11 ATTR_TYPE_SRCVPN Format 0 1 2 3 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | | + Source VPN ID + | | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ 3.1.3.12 ATTR_TYPE_REACHABLES and ATTR_TYPE_UNREACHABLES Both these attributes have same format. For OMP_AF_TLOC_IPV4: 0 1 2 3 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | AFI | SAFI | NLRI Length | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | | IPv4 Address | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | | Color | Encap | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ For OMP_AF_TLOC_IPv6: 0 1 2 3 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | AFI | SAFI | NLRI Length | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | | | +-+-+-+-+-+-+-+-+ + | | + + | | + + Thoria, et al. Expires December 15, 2023 [Page 17] INTERNET DRAFT Overlay Management Protocol July 31, 2023 | IPv6 Address | + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | | Color | Encap | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ For OMP_AF_VROUTE_IPv4: 0 1 2 3 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | AFI | SAFI | NLRI Length | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | | | +-+-+-+-+-+-+-+-+ + | VPN ID | + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | | Path ID | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | | Label | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Prefix | IPv4 Address | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | | +-+-+-+-+-+-+-+-+ For OMP_AF_VROUTE_IPv6: 0 1 2 3 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | AFI | SAFI | NLRI Length | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | | | +-+-+-+-+-+-+-+-+ + | VPN ID | + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | | Path ID | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | | Label | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Prefix | | +-+-+-+-+-+-+-+-+ + | | + + | | + + | IPv6 Address | Thoria, et al. Expires December 15, 2023 [Page 18] INTERNET DRAFT Overlay Management Protocol July 31, 2023 + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | | +-+-+-+-+-+-+-+-+ For OMP_AF_MCAST_TYPE_AD: 0 1 2 3 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | AFI | SAFI | NLRI Length | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | | MCAST_TYPE=1 | | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + | VPN ID | + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | | Label | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | | Source Originator Address | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | | +-+-+-+-+-+-+-+-+ For all other MCAST_TYPES: OMP_AF_MCAST_TYPE_JOIN_XG = 2 OMP_AF_MCAST_TYPE_JOIN_SG = 3 OMP_AF_MCAST_TYPE_SA = 4 0 1 2 3 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | AFI | SAFI | NLRI Length | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | | MCAST_TYPE | | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + | VPN ID | + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | | Source Originator | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | | Destination Originator | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | | SrcPrefix Len | | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | RP or Source Address(4 or 16 bytes) | GrpPrefix Len | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Group Address(4 for IPv4 or 16 for IPv6) | Thoria, et al. Expires December 15, 2023 [Page 19] INTERNET DRAFT Overlay Management Protocol July 31, 2023 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Prune Count |Src1 Prefix Len| | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Src1 Address | | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + | | + ... + | | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |SrcN Prefix Len| SrcN Address | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ 3.1.3.13 ATTR_TYPE_STALE 0 1 2 3 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Stale | +-+-+-+-+-+-+-+-+ 3.1.3.14 ATTR_TYPE_CARRIER 0 1 2 3 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Carrier | +-+-+-+-+-+-+-+-+ 3.1.3.15 ATTR_TYPE_VERSION 0 1 2 3 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Version | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ 3.1.3.16 ATTR_TYPE_GROUP 0 1 2 3 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 Thoria, et al. Expires December 15, 2023 [Page 20] INTERNET DRAFT Overlay Management Protocol July 31, 2023 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Group 1 | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Group 2 | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | ... | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Group n | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ 3.1.3.17 ATTR_TYPE_RESTRICT 0 1 2 3 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Restrict | +-+-+-+-+-+-+-+-+ 3.1.3.18 ATTR_TYPE_SECURITY 0 1 2 3 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | SA IDX=1 | Length=2 | Inbound SA index | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | SPI=2 | Length=4 | SPI | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | | FLAGS=3 | Length=1 | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Flags | PROTOCOL=4 | Length | Proto 1 | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Proto 2 | ... | ... | Proto n | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | ENCRYPT=5 | Length | Encrypt Type 1| Encrypt Type 2| +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | ... | ... | ... | Encrypt Type n| +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | INTEGRITY=6 | Length |Integrity Type1|Integrity Type2| +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | ... | ... | ... |Integrity TypeN| +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | AUTH=7 | Length | Key Type 1 | | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + | | + + | | + + | | Thoria, et al. Expires December 15, 2023 [Page 21] INTERNET DRAFT Overlay Management Protocol July 31, 2023 + + | | + + | | + + | | + + | | + + | | + + | | + + | | + + | | + + | | + + | | + + | | + + | Auth key | + +-+-+-+-+-+-+-+-+ | | Key Type 2 | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | | + + | | + + | | + + | | + + | | + + | | + + | | + + | | + Auth Key + | | + + | | + + | | Thoria, et al. Expires December 15, 2023 [Page 22] INTERNET DRAFT Overlay Management Protocol July 31, 2023 + + | | + + | | + + | | + + | | + + | | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | ... | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Key Type n | | +-+-+-+-+-+-+-+-+ + | | + + | | + + | | + + | | + + | | + + | | + + | | + + | | + + | | + + | | + + | | + + | | + + | | + + | | + + | Auth Key | + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | | ENCRYPT=8 | Key Type 1 | | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + | | Thoria, et al. Expires December 15, 2023 [Page 23] INTERNET DRAFT Overlay Management Protocol July 31, 2023 + + | | + + | | + + | | + + | | + + | | + + | | + + | | + + | | + + | | + + | | + + | | + + | | + + | | + + | Encrypt key | + +-+-+-+-+-+-+-+-+ | | Key Type 2 | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | | + + | | + + | | + + | | + + | | + + | | + + | | + + | | + Encrypt Key + | | Thoria, et al. Expires December 15, 2023 [Page 24] INTERNET DRAFT Overlay Management Protocol July 31, 2023 + + | | + + | | + + | | + + | | + + | | + + | | + + | | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | ... | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Key Type n | | +-+-+-+-+-+-+-+-+ + | | + + | | + + | | + + | | + + | | + + | | + + | | + + | | + + | | + + | | + + | | + + | | + + | | + + | | + + | Encrypt Key | Thoria, et al. Expires December 15, 2023 [Page 25] INTERNET DRAFT Overlay Management Protocol July 31, 2023 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ 3.1.3.19 ATTR_TYPE_BORDER 0 1 2 3 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Border | +-+-+-+-+-+-+-+-+ 3.1.3.20 ATTR_TYPE_ASPATH 0 1 2 3 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Number of Segments | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Type | Number of AS | | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | AS1 | | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | AS2 | ... | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | ASn | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | ... | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | ... | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Type | Number of AS | | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | AS1 | | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | AS2 | ... | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | ASn | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ 3.1.3.21 ATTR_TYPE_ASPATH 0 1 2 3 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ Thoria, et al. Expires December 15, 2023 [Page 26] INTERNET DRAFT Overlay Management Protocol July 31, 2023 | Bandwidth | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ 3.1.3.22 ATTR_TYPE_COMMUNITY 0 1 2 3 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Community1 | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Community2 | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | ... | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | ... | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | CommunityN | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ 3.1.3.23 ATTR_TYPE_ON_DEMAND 0 1 2 3 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | On-demand | +-+-+-+-+-+-+-+-+ 3.1.3.24 ATTR_TYPE_ADAPT_QOS 0 1 2 3 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Flags | Data... | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ Flags: 1 byte. Values: ATTR_FLAG_ADAPT_QOS_DOWNSTREAM_MIN 0x1 ATTR_FLAG_ADAPT_QOS_DOWNSTREAM 0x2 ATTR_FLAG_ADAPT_QOS_DOWNSTREAM_MAX 0x4 ATTR_FLAG_ADAPT_QOS_PERIOD 0x8 ATTR_FLAG_ADAPT_QOS_UP 0x10 Thoria, et al. Expires December 15, 2023 [Page 27] INTERNET DRAFT Overlay Management Protocol July 31, 2023 Data : Data is populated based on flags. For ATTR_FLAG_ADAPT_QOS_UP, data is 1 byte, for all other flags data is 4 bytes. 3.1.4 ALERT Message Format 0 1 2 3 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Code | SubCode | Data... | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ Code : 1 byte. Types: OMP_ERR_INV = 0, OMP_ERR_HEADER = 1, OMP_ERR_HANDSHAKE = 2, OMP_ERR_UPDATE = 3, OMP_ERR_HOLDTIME = 4, OMP_ERR_FSM = 5, OMP_ERR_OPER = 6, Subcode : 1 byte. Each code has different subtypes: HEADER: OMP_SUB_ERR_HEADER_UNSYNC = 1, OMP_SUB_ERR_HEADER_LENGTH = 2, OMP_SUB_ERR_HEADER_TYPE = 3, HANDSHAKE: OMP_SUB_ERR_HANDSHAKE_VERSION = 1, OMP_SUB_ERR_HANDSHAKE_OMPID = 2, OMP_SUB_ERR_HANDSHAKE_UNSUP_OPT = 3, OMP_SUB_ERR_HANDSHAKE_AUTH = 4, OMP_SUB_ERR_HANDSHAKE_HOLDTIME = 5, OMP_SUB_ERR_HANDSHAKE_UNSUP_CAP = 6, OMP_SUB_ERR_HANDSHAKE_PERSONALITY_MISMATCH = 7, OMP_SUB_ERR_HANDSHAKE_DOMAIN_MISMATCH = 8, UPDATE: OMP_SUB_ERR_UPDATE_ATTR_LIST = 1, OMP_SUB_ERR_UPDATE_UNKNOWN = 2, OMP_SUB_ERR_UPDATE_MISSING = 3, OMP_SUB_ERR_UPDATE_FLAGS = 4, OMP_SUB_ERR_UPDATE_LENGTH = 5, OMP_SUB_ERR_UPDATE_NEXTHOP = 6, OMP_SUB_ERR_UPDATE_OPT_ATTR = 7, OMP_SUB_ERR_UPDATE_BAD_NET = 8, Thoria, et al. Expires December 15, 2023 [Page 28] INTERNET DRAFT Overlay Management Protocol July 31, 2023 OPER: OMP_SUB_ERR_OPER_CLEAR = 1, OMP_SUB_ERR_OPER_SHUT = 2, OMP_SUB_ERR_OPER_HOLDTIME_EXP = 3, OMP_SUB_ERR_OPER_CFG_CHANGE = 4, OMP_SUB_ERR_OPER_TERM = 5, Subcode of 0 means OMP_SUB_ERR_NONE 3.1.5 HELLO Message Format 0 1 2 3 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Type | Length | Data... | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ Type: 1 byte. Types: OMP_PTK_HELLO_TLV_VSMARTS = 1 Length: 2 bytes. Data length excluding type and length, i.e. 3 bytes Data: Variable. 0 1 2 3 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Length | Data... | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ If Length is 4 bytes, data is 4 bytes and is the remote IPv4 address. If the Length is 16 bytes, the data is 16 bytes and is remote IPv6 address. 3.1.6 QUERY Message Format 0 1 2 3 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Attribute Length | Data... | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ Attribute Length : 2 bytes. Total length of data excluding attribute length field of 2 bytes. Data: Variable. Filled with ATTR_TYPE_UNREACHABLES and Thoria, et al. Expires December 15, 2023 [Page 29] INTERNET DRAFT Overlay Management Protocol July 31, 2023 ATTR_TYPE_REACHABLES. 3.1.7 POLICY Message Format Policy is sent in fragments if the size if larger than 4000 bytes. When the policy data is less than 3980 (4000-20 byes of header), type is set to OMP_PKT_POL_COMPLETE. When the policy data is more than that size, then the fragments are sent as following: First packet type is OMP_PKT_POL_START, next fragment type is OMP_PKT_POL_MORE, last fragment type is OMP_PKT_POL_END. When policy size is zero, type is OMP_PKT_POL_DEL. 0 1 2 3 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Type | Data... | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ Type: 1 byte. Types: OMP_PKT_POL_COMPLETE = 0, OMP_PKT_POL_START = 1, OMP_PKT_POL_MORE = 2, OMP_PKT_POL_END = 3, OMP_PKT_POL_DEL = 4, 3.1.7 INFORM Message Format 0 1 2 3 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | Type | Length | Data... | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ Type : 1 byte. Types: OMP_INFORM_EOR = 1 OMP_INFORM_REFRESH_REQUEST = 2 Length: 2 bytes. Data length excluding type and length. i.e. 3 bytes. Data: Thoria, et al. Expires December 15, 2023 [Page 30] INTERNET DRAFT Overlay Management Protocol July 31, 2023 0 1 2 3 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | AFI | SAFI | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ If Length is zero, AFI and SAFI entries will not be present. It is considered to be OMP_AF_MAX. 6. Security Considerations TBD. 7. IANA Considerations Not applicable. 8. References 8.1. Informative References [RFC4271] Rekhter, Y., Ed., Li, T., Ed., and S. Hares, Ed., "A Border Gateway Protocol 4 (BGP-4)", RFC 4271, DOI 10.17487/RFC4271, January 2006, . [RFC4760] Bates, T., Chandra, R., Katz, D., and Y. Rekhter, "Multiprotocol Extensions for BGP-4", RFC 4760, DOI 10.17487/RFC4760, January 2007, . [RFC4364] Rosen, E. and Y. Rekhter, "BGP/MPLS IP Virtual Private Networks (VPNs)", RFC 4364, DOI 10.17487/RFC4364, February 2006, . [RFC6513] Rosen, E., Ed., and R. Aggarwal, Ed., "Multicast in MPLS/BGP IP VPNs", RFC 6513, DOI 10.17487/RFC6513, February 2012, . [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate Requirement Levels", BCP 14, RFC 2119, DOI 10.17487/RFC2119, March 1997, . Thoria, et al. Expires December 15, 2023 [Page 31] INTERNET DRAFT Overlay Management Protocol July 31, 2023 [RFC4271] Rekhter, Y., Ed., Li, T., Ed., and S. Hares, Ed., "A Border Gateway Protocol 4 (BGP-4)", RFC 4271, DOI 10.17487/RFC4271, January 2006, . [RFC4760] Bates, T., Chandra, R., Katz, D., and Y. Rekhter, "Multiprotocol Extensions for BGP-4", RFC 4760, DOI 10.17487/RFC4760, January 2007, . [RFC4364] Rosen, E. and Y. Rekhter, "BGP/MPLS IP Virtual Private Networks (VPNs)", RFC 4364, DOI 10.17487/RFC4364, February 2006, . [RFC6513] Rosen, E., Ed., and R. Aggarwal, Ed., "Multicast in MPLS/BGP IP VPNs", RFC 6513, DOI 10.17487/RFC6513, February 2012, . [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate Requirement Levels", BCP 14, RFC 2119, DOI 10.17487/RFC2119, March 1997, . [RFC8174] Leiba, B., "Ambiguity of Uppercase vs Lowercase in RFC 2119 Key Words", BCP 14, RFC 8174, DOI 10.17487/RFC8174, May 2017, . Acknowledgements OMP was created by Viptela LLC before it was acquired by Cisco Systems Inc. The authors acknowledge the creators of the protocol. We would also like to thank Ram Singh, Vivek Agarwal and Adam Hill for reviewing and providing valuable feedback. 10. Authors' Addresses Samir Thoria Cisco Systems USA EMail: sthoria@cisco.com Satish Mahadevan Cisco Systems USA EMail: satishm@cisco.com Thoria, et al. Expires December 15, 2023 [Page 32] INTERNET DRAFT Overlay Management Protocol July 31, 2023 Prab Radhakrishnan Cisco Systems USA EMail: prab92@cisco.com Thoria, et al. Expires December 15, 2023 [Page 33]