This module defines a YANG data model for Routing Information Base (RIB) that aligns with the I2RS RIB information model. Copyr...
Version: 2018-09-13
module ietf-i2rs-rib { yang-version 1.1; namespace "urn:ietf:params:xml:ns:yang:ietf-i2rs-rib"; prefix iir; import ietf-inet-types { prefix inet; reference "RFC 6991"; } import ietf-interfaces { prefix if; reference "RFC 8344"; } import ietf-yang-types { prefix yang; reference "RFC 6991"; } organization "IETF I2RS (Interface to Routing System) Working Group"; contact "WG Web: <https://datatracker.ietf.org/wg/i2rs/> WG List: <mailto:i2rs@ietf.org> Editor: Lixing Wang <mailto:wang_little_star@sina.com> Editor: Mach(Guoyi) Chen <mailto:mach.chen@huawei.com> Editor: Amit Dass <mailto:dass.amit@gmail.com> Editor: Hariharan Ananthakrishnan <mailto:hari@netflix.com> Editor: Sriganesh Kini <mailto:sriganeshkini@gmail.com> Editor: Nitin Bahadur <mailto:nitin_bahadur@yahoo.com>"; description "This module defines a YANG data model for Routing Information Base (RIB) that aligns with the I2RS RIB information model. Copyright (c) 2018 IETF Trust and the persons identified as authors of the code. All rights reserved. Redistribution and use in source and binary forms, with or without modification, is permitted pursuant to, and subject to the license terms contained in, the Simplified BSD License set forth in Section 4.c of the IETF Trust's Legal Provisions Relating to IETF Documents (http://trustee.ietf.org/license-info). This version of this YANG module is part of RFC 8341; see the RFC itself for full legal notices."; revision "2018-09-13" { description "initial revision"; reference "RFC 8431"; } feature nexthop-tunnel { description "This feature means that a node supports tunnel nexthop capability."; } feature nexthop-chain { description "This feature means that a node supports chain nexthop capability."; } feature nexthop-protection { description "This feature means that a node supports protection nexthop capability."; } feature nexthop-replicate { description "This feature means that a node supports replicate nexthop capability."; } feature nexthop-load-balance { description "This feature means that a node supports load-balance nexthop capability."; } feature ipv4-tunnel { description "This feature means that a node supports IPv4 tunnel encapsulation capability."; } feature ipv6-tunnel { description "This feature means that a node supports IPv6 tunnel encapsulation capability."; } feature mpls-tunnel { description "This feature means that a node supports MPLS tunnel encapsulation capability."; } feature vxlan-tunnel { description "This feature means that a node supports Virtual eXtensible Local Area Network (VXLAN) tunnel encapsulation capability."; reference "RFC 7348"; } feature gre-tunnel { description "This feature means that a node supports GRE tunnel encapsulation capability."; reference "RFC 2784"; } feature nvgre-tunnel { description "This feature means that a node supports Network Virtualization Using GRE (NVGRE) tunnel encapsulation capability."; reference "RFC 7637"; } feature route-vendor-attributes { description "This feature means that a node supports route vendor attributes."; } identity mpls-label-action { description "Base identity from which all MPLS label operations are derived. The MPLS label stack operations include: push - to add a new label to a label stack pop - to pop the top label from a label stack swap - to exchange the top label of a label stack with a new label"; } identity label-push { base mpls-label-action; description "MPLS label stack operation: push."; } identity label-pop { base mpls-label-action; description "MPLS label stack operation: pop."; } identity label-swap { base mpls-label-action; description "MPLS label stack operation: swap."; } typedef mpls-label-action-definition { type identityref { base mpls-label-action; } description "MPLS label action definition."; } identity tunnel-decapsulation-action { description "Base identity from which all tunnel decapsulation actions are derived. Tunnel decapsulation actions include ipv4-decapsulation (to decapsulate an IPv4 tunnel) ipv6-decapsulation (to decapsulate an IPv6 tunnel)"; } identity ipv4-decapsulation { base tunnel-decapsulation-action; description "IPv4 tunnel decapsulation."; } identity ipv6-decapsulation { base tunnel-decapsulation-action; description "IPv6 tunnel decapsulation."; } typedef tunnel-decapsulation-action-definition { type identityref { base tunnel-decapsulation-action; } description "Tunnel decapsulation definition."; } identity ttl-action { description "Base identity from which all TTL actions are derived."; } identity no-action { base ttl-action; description "Do nothing regarding the TTL."; } identity copy-to-inner { base ttl-action; description "Copy the TTL of the outer header to the inner header."; } identity decrease-and-copy-to-inner { base ttl-action; description "Decrease TTL by one and copy the TTL to the inner header."; } identity decrease-and-copy-to-next { base ttl-action; description "Decrease TTL by one and copy the TTL to the next header; for example, when MPLS label swapping, decrease the TTL of the in_label and copy it to the out_label."; } typedef ttl-action-definition { type identityref { base ttl-action; } description "TTL action definition."; } identity hop-limit-action { description "Base identity from which all hop limit actions are derived."; } identity hop-limit-no-action { base hop-limit-action; description "Do nothing regarding the hop limit."; } identity hop-limit-copy-to-inner { base hop-limit-action; description "Copy the hop limit of the outer header to the inner header."; } typedef hop-limit-action-definition { type identityref { base hop-limit-action; } description "IPv6 hop limit action definition."; } identity special-nexthop { description "Base identity from which all special nexthops are derived."; } identity discard { base special-nexthop; description "This indicates that the network device should drop the packet and increment a drop counter."; } identity discard-with-error { base special-nexthop; description "This indicates that the network device should drop the packet, increment a drop counter, and send back an appropriate error message (like ICMP error)."; } identity receive { base special-nexthop; description "This indicates that the traffic is destined for the network device, e.g., protocol packets or Operations, Administration, and Maintenance (OAM) packets. All locally destined traffic SHOULD be throttled to avoid a denial-of-service attack on the router's control plane. An optional rate-limiter can be specified to indicate how to throttle traffic destined for the control plane."; } identity cos-value { base special-nexthop; description "Cos-value special nexthop."; } typedef special-nexthop-definition { type identityref { base special-nexthop; } description "Special nexthop definition."; } identity ip-route-match-type { description "Base identity from which all route match types are derived. The route match type could be: match source, or match destination, or match source and destination."; } identity match-ip-src { base ip-route-match-type; description "Source route match type."; } identity match-ip-dest { base ip-route-match-type; description "Destination route match type"; } identity match-ip-src-dest { base ip-route-match-type; description "Source and Destination route match type"; } typedef ip-route-match-type-definition { type identityref { base ip-route-match-type; } description "IP route match type definition."; } identity address-family { description "Base identity from which all RIB address families are derived."; } identity ipv4-address-family { base address-family; description "IPv4 RIB address family."; } identity ipv6-address-family { base address-family; description "IPv6 RIB address family."; } identity mpls-address-family { base address-family; description "MPLS RIB address family."; } identity ieee-mac-address-family { base address-family; description "MAC RIB address family."; } typedef address-family-definition { type identityref { base address-family; } description "RIB address family definition."; } identity route-type { description "Base identity from which all route types are derived."; } identity ipv4-route { base route-type; description "IPv4 route type."; } identity ipv6-route { base route-type; description "IPv6 route type."; } identity mpls-route { base route-type; description "MPLS route type."; } identity ieee-mac { base route-type; description "MAC route type."; } identity interface { base route-type; description "Interface route type."; } typedef route-type-definition { type identityref { base route-type; } description "Route type definition."; } identity tunnel-type { description "Base identity from which all tunnel types are derived."; } identity ipv4-tunnel { base tunnel-type; description "IPv4 tunnel type"; } identity ipv6-tunnel { base tunnel-type; description "IPv6 tunnel type"; } identity mpls-tunnel { base tunnel-type; description "MPLS tunnel type"; } identity gre-tunnel { base tunnel-type; description "GRE tunnel type"; } identity vxlan-tunnel { base tunnel-type; description "VXLAN tunnel type"; } identity nvgre-tunnel { base tunnel-type; description "NVGRE tunnel type"; } typedef tunnel-type-definition { type identityref { base tunnel-type; } description "Tunnel type definition."; } identity route-state { description "Base identity from which all route states are derived."; } identity active { base route-state; description "Active state."; } identity inactive { base route-state; description "Inactive state."; } typedef route-state-definition { type identityref { base route-state; } description "Route state definition."; } identity nexthop-state { description "Base identity from which all nexthop states are derived."; } identity resolved { base nexthop-state; description "Resolved nexthop state."; } identity unresolved { base nexthop-state; description "Unresolved nexthop state."; } typedef nexthop-state-definition { type identityref { base nexthop-state; } description "Nexthop state definition."; } identity route-installed-state { description "Base identity from which all route installed states are derived."; } identity uninstalled { base route-installed-state; description "Uninstalled state."; } identity installed { base route-installed-state; description "Installed state."; } typedef route-installed-state-definition { type identityref { base route-installed-state; } description "Route installed state definition."; } identity route-change-reason { description "Base identity from which all route change reasons are derived."; } identity lower-route-preference { base route-change-reason; description "This route was installed in the FIB because it had a lower route preference value (and thus was more preferred) than the route it replaced."; } identity higher-route-preference { base route-change-reason; description "This route was uninstalled from the FIB because it had a higher route preference value (and thus was less preferred) than the route that replaced it."; } identity resolved-nexthop { base route-change-reason; description "This route was made active because at least one of its nexthops was resolved."; } identity unresolved-nexthop { base route-change-reason; description "This route was made inactive because all of its nexthops are unresolved."; } typedef route-change-reason-definition { type identityref { base route-change-reason; } description "Route change reason definition."; } typedef nexthop-preference-definition { type uint8 { range "1..99"; } description "Nexthop-preference is used for protection schemes. It is an integer value between 1 and 99. Lower values are preferred. To download N nexthops to the FIB, the N nexthops with the lowest value are selected. If there are more than N nexthops that have the same preference, an implementation of the I2RS client should select N nexthops and download them. As for how to select the nexthops, this is left to the implementations."; } typedef nexthop-lb-weight-definition { type uint8 { range "1..99"; } description "Nexthop-lb-weight is used for load-balancing. Each list member SHOULD be assigned a weight between 1 and 99. The weight determines the proportion of traffic to be sent over a nexthop used for forwarding as a ratio of the weight of this nexthop divided by the sum of the weights of all the nexthops of this route that are used for forwarding. To perform equal load-balancing, one MAY specify a weight of 0 for all the member nexthops. The value 0 is reserved for equal load-balancing and, if applied, MUST be applied to all member nexthops. Note that the weight of 0 is special because of historical reasons. It's typically used in hardware devices to signify ECMP."; } typedef nexthop-ref { type leafref { path "/iir:routing-instance/iir:rib-list/iir:route-list/iir:nexthop/iir:nexthop-id"; } description "A nexthop reference that provides an indirection reference to a nexthop."; } container routing-instance { description "A routing instance, in the context of the RIB information model, is a collection of RIBs, interfaces, and routing parameters."; leaf name { type string; description "The name of the routing instance. This MUST be unique across all routing instances in a given network device."; } list interface-list { key "name"; description "This represents the list of interfaces associated with this routing instance. The interface list helps constrain the boundaries of packet forwarding. Packets coming on these interfaces are directly associated with the given routing instance. The interface list contains a list of identifiers with each identifier uniquely identifying an interface."; leaf name { type if:interface-ref; description "A reference to the name of a network-layer interface."; } } // list interface-list leaf router-id { type yang:dotted-quad; description "Router ID: The 32-bit number in the form of a dotted quad."; } leaf lookup-limit { type uint8; description "A limit on how many levels of a lookup can be performed."; } list rib-list { key "name"; description "A list of RIBs that are associated with the routing instance."; leaf name { type string; mandatory true; description "A reference to the name of each RIB."; } leaf address-family { type address-family-definition; mandatory true; description "The address family of a RIB."; } leaf ip-rpf-check { type boolean; description "Each RIB can be optionally associated with a ENABLE_IP_RPF_CHECK attribute that enables Reverse Path Forwarding (RPF) checks on all IP routes in that RIB. An RPF check is used to prevent spoofing and limit malicious traffic."; } list route-list { key "route-index"; description "A list of routes of a RIB."; leaf route-index { type uint64; mandatory true; description "Route index."; } container match { description "The match condition specifies the kind of route (IPv4, MPLS, etc.) and the set of fields to match on."; choice route-type { description "Route types: IPv4, IPv6, MPLS, MAC, etc."; case ipv4 { description "IPv4 route case."; container ipv4 { description "IPv4 route match."; choice ip-route-match-type { description "IP route match type options: match source, or match destination, or match source and destination."; leaf dest-ipv4-prefix { type inet:ipv4-prefix; mandatory true; description "An IPv4 destination address as the match."; } leaf src-ipv4-prefix { type inet:ipv4-prefix; mandatory true; description "An IPv4 source address as the match."; } container dest-src-ipv4-address { description "A combination of an IPv4 source and an IPv4 destination address as the match."; leaf dest-ipv4-prefix { type inet:ipv4-prefix; mandatory true; description "The IPv4 destination address of the match."; } leaf src-ipv4-prefix { type inet:ipv4-prefix; mandatory true; description "The IPv4 source address of the match."; } } // container dest-src-ipv4-address } // choice ip-route-match-type } // container ipv4 } // case ipv4 case ipv6 { description "IPv6 route case."; container ipv6 { description "IPv6 route match."; choice ip-route-match-type { description "IP route match type options: match source, match destination, or match source and destination."; leaf dest-ipv6-prefix { type inet:ipv6-prefix; mandatory true; description "An IPv6 destination address as the match."; } leaf src-ipv6-prefix { type inet:ipv6-prefix; mandatory true; description "An IPv6 source address as the match."; } container dest-src-ipv6-address { description "A combination of an IPv6 source and an IPv6 destination address as the match."; leaf dest-ipv6-prefix { type inet:ipv6-prefix; mandatory true; description "The IPv6 destination address of the match."; } leaf src-ipv6-prefix { type inet:ipv6-prefix; mandatory true; description "The IPv6 source address of the match."; } } // container dest-src-ipv6-address } // choice ip-route-match-type } // container ipv6 } // case ipv6 case mpls-route { description "MPLS route case."; leaf mpls-label { type uint32; mandatory true; description "The label used for matching."; } } // case mpls-route case mac-route { description "MAC route case."; leaf mac-address { type yang:mac-address; mandatory true; description "The MAC address used for matching."; } } // case mac-route case interface-route { description "Interface route case."; leaf interface-identifier { type if:interface-ref; mandatory true; description "The interface used for matching."; } } // case interface-route } // choice route-type } // container match container nexthop { description "The nexthop of the route."; leaf nexthop-id { type uint32; description "An identifier that refers to a nexthop."; } leaf sharing-flag { type boolean; description "To indicate whether a nexthop is sharable or non-sharable: true - sharable (which means the nexthop can be shared with other routes) false - non-sharable (which means the nexthop can not be shared with other routes)"; } choice nexthop-type { description "Nexthop type options."; container nexthop-base { description "The base nexthop."; choice nexthop-base-type { description "Nexthop base type options."; leaf special { type special-nexthop-definition; description "A special nexthop."; } leaf outgoing-interface { type if:interface-ref; mandatory true; description "The nexthop is an outgoing interface."; } leaf ipv4-address { type inet:ipv4-address; mandatory true; description "The nexthop is an IPv4 address."; } leaf ipv6-address { type inet:ipv6-address; mandatory true; description "The nexthop is an IPv6 address."; } container egress-interface-ipv4-address { description "The nexthop is an egress-interface and an IP address. This can be used in cases where, e.g., the IP address is a link-local address."; leaf outgoing-interface { type if:interface-ref; mandatory true; description "Name of the outgoing interface."; } leaf ipv4-address { type inet:ipv4-address; mandatory true; description "The nexthop points to an interface with an IPv4 address."; } } // container egress-interface-ipv4-address container egress-interface-ipv6-address { description "The nexthop is an egress-interface and an IP address. This can be used in cases where, e.g., the IP address is a link-local address."; leaf outgoing-interface { type if:interface-ref; mandatory true; description "Name of the outgoing interface."; } leaf ipv6-address { type inet:ipv6-address; mandatory true; description "The nexthop points to an interface with an IPv6 address."; } } // container egress-interface-ipv6-address container egress-interface-mac-address { description "The egress-interface must be an Ethernet interface. Address resolution is not required for this nexthop."; leaf outgoing-interface { type if:interface-ref; mandatory true; description "Name of the outgoing interface."; } leaf ieee-mac-address { type yang:mac-address; mandatory true; description "The nexthop points to an interface with a specific MAC address."; } } // container egress-interface-mac-address case tunnel-encapsulation-nexthop { if-feature nexthop-tunnel; container tunnel-encapsulation { description "This can be an encapsulation representing an IP tunnel, MPLS tunnel, or others as defined in the info model. An optional egress-interface can be chained to the tunnel encapsulation to indicate which interface to send the packet out on. The egress-interface is useful when the network device contains Ethernet interfaces and one needs to perform address resolution for the IP packet."; choice tunnel-type { description "Tunnel options for nexthops."; case ipv4 { if-feature ipv4-tunnel; container ipv4-header { description "IPv4 header."; leaf src-ipv4-address { type inet:ipv4-address; mandatory true; description "The source IP address of the header."; } leaf dest-ipv4-address { type inet:ipv4-address; mandatory true; description "The destination IP address of the header."; } leaf protocol { type uint8; mandatory true; description "The protocol id of the header."; } leaf ttl { type uint8; description "The TTL of the header."; } leaf dscp { type uint8; description "The Differentiated Services Code Point (DSCP) field of the header."; } } // container ipv4-header } // case ipv4 case ipv6 { if-feature ipv6-tunnel; container ipv6-header { description "IPv6 header."; leaf src-ipv6-address { type inet:ipv6-address; mandatory true; description "The source IP address of the header."; } leaf dest-ipv6-address { type inet:ipv6-address; mandatory true; description "The destination IP address of the header."; } leaf next-header { type uint8; mandatory true; description "The next header of the IPv6 header."; } leaf traffic-class { type uint8; description "The traffic class value of the header."; } leaf flow-label { type inet:ipv6-flow-label; description "The flow label of the header."; } leaf hop-limit { type uint8 { range "1..255"; } description "The hop limit of the header."; } } // container ipv6-header } // case ipv6 case mpls { if-feature mpls-tunnel; container mpls-header { description "MPLS header."; list label-operations { key "label-oper-id"; description "Label operations."; leaf label-oper-id { type uint32; description "An optional identifier that points to a label operation."; } choice label-actions { description "Label action options."; container label-push { description "Label push operation."; leaf label { type uint32; mandatory true; description "The label to be pushed."; } leaf s-bit { type boolean; description "The s-bit ('Bottom of Stack' bit) of the label to be pushed."; } leaf tc-value { type uint8; description "The traffic class value of the label to be pushed."; } leaf ttl-value { type uint8; description "The TTL value of the label to be pushed."; } } // container label-push container label-swap { description "Label swap operation."; leaf in-label { type uint32; mandatory true; description "The label to be swapped."; } leaf out-label { type uint32; mandatory true; description "The out MPLS label."; } leaf ttl-action { type ttl-action-definition; description "The label TTL actions: - No-action - Copy to inner label - Decrease (the in-label) by 1 and copy to the out-label"; } } // container label-swap } // choice label-actions } // list label-operations } // container mpls-header } // case mpls case gre { if-feature gre-tunnel; container gre-header { description "GRE header."; choice dest-address-type { description "GRE options: IPv4 and IPv6"; leaf ipv4-dest { type inet:ipv4-address; mandatory true; description "The destination IP address of the GRE header."; } leaf ipv6-dest { type inet:ipv6-address; mandatory true; description "The destination IP address of the GRE header."; } } // choice dest-address-type leaf protocol-type { type uint16; mandatory true; description "The protocol type of the GRE header."; } leaf key { type uint64; description "The GRE key of the GRE header."; } } // container gre-header } // case gre case nvgre { if-feature nvgre-tunnel; container nvgre-header { description "NVGRE header."; choice nvgre-type { description "NVGRE can use either an IPv4 or an IPv6 header for encapsulation."; case ipv4 { leaf src-ipv4-address { type inet:ipv4-address; mandatory true; description "The source IP address of the header."; } leaf dest-ipv4-address { type inet:ipv4-address; mandatory true; description "The destination IP address of the header."; } leaf protocol { type uint8; mandatory true; description "The protocol id of the header."; } leaf ttl { type uint8; description "The TTL of the header."; } leaf dscp { type uint8; description "The Differentiated Services Code Point (DSCP) field of the header."; } } // case ipv4 case ipv6 { leaf src-ipv6-address { type inet:ipv6-address; mandatory true; description "The source IP address of the header."; } leaf dest-ipv6-address { type inet:ipv6-address; mandatory true; description "The destination IP address of the header."; } leaf next-header { type uint8; mandatory true; description "The next header of the IPv6 header."; } leaf traffic-class { type uint8; description "The traffic class value of the header."; } leaf flow-label { type inet:ipv6-flow-label; description "The flow label of the header."; } leaf hop-limit { type uint8 { range "1..255"; } description "The hop limit of the header."; } } // case ipv6 } // choice nvgre-type leaf virtual-subnet-id { type uint32; mandatory true; description "The subnet identifier of the NVGRE header."; } leaf flow-id { type uint8; description "The flow identifier of the NVGRE header."; } } // container nvgre-header } // case nvgre case vxlan { if-feature vxlan-tunnel; container vxlan-header { description "VXLAN header."; choice vxlan-type { description "NVGRE can use either an IPv4 or an IPv6 header for encapsulation."; case ipv4 { leaf src-ipv4-address { type inet:ipv4-address; mandatory true; description "The source IP address of the header."; } leaf dest-ipv4-address { type inet:ipv4-address; mandatory true; description "The destination IP address of the header."; } leaf protocol { type uint8; mandatory true; description "The protocol id of the header."; } leaf ttl { type uint8; description "The TTL of the header."; } leaf dscp { type uint8; description "The Differentiated Services Code Point (DSCP) field of the header."; } } // case ipv4 case ipv6 { leaf src-ipv6-address { type inet:ipv6-address; mandatory true; description "The source IP address of the header."; } leaf dest-ipv6-address { type inet:ipv6-address; mandatory true; description "The destination IP address of the header."; } leaf next-header { type uint8; mandatory true; description "The next header of the IPv6 header."; } leaf traffic-class { type uint8; description "The traffic class value of the header."; } leaf flow-label { type inet:ipv6-flow-label; description "The flow label of the header."; } leaf hop-limit { type uint8 { range "1..255"; } description "The hop limit of the header."; } } // case ipv6 } // choice vxlan-type leaf vxlan-identifier { type uint32; mandatory true; description "The VXLAN identifier of the VXLAN header."; } } // container vxlan-header } // case vxlan } // choice tunnel-type } // container tunnel-encapsulation } // case tunnel-encapsulation-nexthop case tunnel-decapsulation-nexthop { if-feature nexthop-tunnel; container tunnel-decapsulation { description "This is to specify the decapsulation of a tunnel header."; choice tunnel-type { description "Nexthop tunnel type options."; case ipv4 { if-feature ipv4-tunnel; container ipv4-decapsulation { description "IPv4 decapsulation."; leaf ipv4-decapsulation { type tunnel-decapsulation-action-definition; mandatory true; description "IPv4 decapsulation operations."; } leaf ttl-action { type ttl-action-definition; description "The TTL actions: no-action or copy to inner header."; } } // container ipv4-decapsulation } // case ipv4 case ipv6 { if-feature ipv6-tunnel; container ipv6-decapsulation { description "IPv6 decapsulation."; leaf ipv6-decapsulation { type tunnel-decapsulation-action-definition; mandatory true; description "IPv6 decapsulation operations."; } leaf hop-limit-action { type hop-limit-action-definition; description "The hop limit actions: no-action or copy to inner header."; } } // container ipv6-decapsulation } // case ipv6 case mpls { if-feature mpls-tunnel; container label-pop { description "MPLS decapsulation."; leaf label-pop { type mpls-label-action-definition; mandatory true; description "Pop a label from the label stack."; } leaf ttl-action { type ttl-action-definition; description "The label TTL action."; } } // container label-pop } // case mpls } // choice tunnel-type } // container tunnel-decapsulation } // case tunnel-decapsulation-nexthop case logical-tunnel-nexthop { if-feature nexthop-tunnel; container logical-tunnel { description "This can be an MPLS Label Switched Path (LSP) or a GRE tunnel (or others as defined in this document) that is represented by a unique identifier (e.g., name)."; leaf tunnel-type { type tunnel-type-definition; mandatory true; description "A tunnel type."; } leaf tunnel-name { type string; mandatory true; description "A tunnel name that points to a logical tunnel."; } } // container logical-tunnel } // case logical-tunnel-nexthop leaf rib-name { type string; description "A nexthop pointing to a RIB indicates that the route lookup needs to continue in the specified RIB. This is a way to perform chained lookups."; } leaf nexthop-ref { type nexthop-ref; mandatory true; description "A nexthop reference that points to a nexthop."; } } // choice nexthop-base-type } // container nexthop-base case nexthop-chain { if-feature nexthop-chain; container nexthop-chain { description "A chain nexthop."; list nexthop-list { key "nexthop-member-id"; description "A list of nexthops."; leaf nexthop-member-id { type uint32; mandatory true; description "A nexthop identifier that points to a nexthop list member. A nexthop list member is a nexthop."; } } // list nexthop-list } // container nexthop-chain } // case nexthop-chain case nexthop-replicate { if-feature nexthop-replicate; container nexthop-replicate { description "A replicate nexthop."; list nexthop-list { key "nexthop-member-id"; description "A list of nexthops."; leaf nexthop-member-id { type uint32; mandatory true; description "A nexthop identifier that points to a nexthop list member. A nexthop list member is a nexthop."; } } // list nexthop-list } // container nexthop-replicate } // case nexthop-replicate case nexthop-protection { if-feature nexthop-protection; container nexthop-protection { description "A protection nexthop."; list nexthop-list { key "nexthop-member-id"; description "A list of nexthop."; leaf nexthop-member-id { type uint32; mandatory true; description "A nexthop identifier that points to a nexthop list member. A nexthop list member is a nexthop."; } leaf nexthop-preference { type nexthop-preference-definition; mandatory true; description "Nexthop-preference is used for protection schemes. It is an integer value between 1 and 99. Lower values are more preferred. To download a primary/standby/tertiary group to the FIB, the nexthops that are resolved and are most preferred are selected."; } } // list nexthop-list } // container nexthop-protection } // case nexthop-protection case nexthop-load-balance { if-feature nexthop-load-balance; container nexthop-lb { description "A load-balance nexthop."; list nexthop-list { key "nexthop-member-id"; description "A list of nexthop."; leaf nexthop-member-id { type uint32; mandatory true; description "A nexthop identifier that points to a nexthop list member. A nexthop list member is a nexthop."; } leaf nexthop-lb-weight { type nexthop-lb-weight-definition; mandatory true; description "The weight of a nexthop of the load-balance nexthops."; } } // list nexthop-list } // container nexthop-lb } // case nexthop-load-balance } // choice nexthop-type } // container nexthop container route-status { description "The status information of the route."; leaf route-state { type route-state-definition; config false; description "Indicate a route's state: active or inactive."; } leaf route-installed-state { type route-installed-state-definition; config false; description "Indicate that a route's installed states: installed or uninstalled."; } leaf route-reason { type route-change-reason-definition; config false; description "Indicate the reason that caused the route change."; } } // container route-status container route-attributes { description "Route attributes."; leaf route-preference { type uint32; mandatory true; description "ROUTE_PREFERENCE: This is a numerical value that allows for comparing routes from different protocols. Static configuration is also considered a protocol for the purpose of this field. It is also known as administrative-distance. The lower the value, the higher the preference."; } leaf local-only { type boolean; mandatory true; description "Indicate whether the attribute is local only."; } container address-family-route-attributes { description "Address-family-related route attributes."; choice route-type { description "Address-family-related route attributes. Future documents should specify these attributes by augmenting the cases in this choice."; case ip-route-attributes { } // case ip-route-attributes case mpls-route-attributes { } // case mpls-route-attributes case ethernet-route-attributes { } // case ethernet-route-attributes } // choice route-type } // container address-family-route-attributes } // container route-attributes container route-vendor-attributes { description "Route vendor attributes."; } // container route-vendor-attributes } // list route-list list nexthop-list { key "nexthop-member-id"; description "A list of nexthops."; leaf nexthop-member-id { type uint32; mandatory true; description "A nexthop identifier that points to a nexthop list member. A nexthop list member is a nexthop."; } } // list nexthop-list } // list rib-list } // container routing-instance rpc rib-add { description "To add a RIB to an instance"; input { leaf name { type string; mandatory true; description "A reference to the name of the RIB that is to be added."; } leaf address-family { type address-family-definition; mandatory true; description "The address family of the RIB."; } leaf ip-rpf-check { type boolean; description "Each RIB can be optionally associated with an ENABLE_IP_RPF_CHECK attribute that enables RPF checks on all IP routes in that RIB. An RPF check is used to prevent spoofing and limit malicious traffic."; } } output { leaf result { type boolean; mandatory true; description "Return the result of the rib-add operation. true - success; false - failed"; } leaf reason { type string; description "The specific reason that caused the failure."; } } } // rpc rib-add rpc rib-delete { description "To delete a RIB from a routing instance. After deleting the RIB, all routes installed in the RIB will be deleted as well."; input { leaf name { type string; mandatory true; description "A reference to the name of the RIB that is to be deleted."; } } output { leaf result { type boolean; mandatory true; description "Return the result of the rib-delete operation. true - success; false - failed"; } leaf reason { type string; description "The specific reason that caused failure."; } } } // rpc rib-delete rpc route-add { description "To add a route or a list of routes to a RIB"; input { leaf return-failure-detail { type boolean; default "false"; description "Whether to return the failure detail. true - return the failure detail false - do not return the failure detail The default is false."; } leaf rib-name { type string; mandatory true; description "A reference to the name of a RIB."; } container routes { description "The routes to be added to the RIB."; list route-list { key "route-index"; description "The list of routes to be added."; leaf route-index { type uint64; mandatory true; description "Route index."; } container match { description "The match condition specifies the kind of route (IPv4, MPLS, etc.) and the set of fields to match on."; choice route-type { description "Route types: IPv4, IPv6, MPLS, MAC, etc."; case ipv4 { description "IPv4 route case."; container ipv4 { description "IPv4 route match."; choice ip-route-match-type { description "IP route match type options: match source, or match destination, or match source and destination."; leaf dest-ipv4-prefix { type inet:ipv4-prefix; mandatory true; description "An IPv4 destination address as the match."; } leaf src-ipv4-prefix { type inet:ipv4-prefix; mandatory true; description "An IPv4 source address as the match."; } container dest-src-ipv4-address { description "A combination of an IPv4 source and an IPv4 destination address as the match."; leaf dest-ipv4-prefix { type inet:ipv4-prefix; mandatory true; description "The IPv4 destination address of the match."; } leaf src-ipv4-prefix { type inet:ipv4-prefix; mandatory true; description "The IPv4 source address of the match."; } } // container dest-src-ipv4-address } // choice ip-route-match-type } // container ipv4 } // case ipv4 case ipv6 { description "IPv6 route case."; container ipv6 { description "IPv6 route match."; choice ip-route-match-type { description "IP route match type options: match source, match destination, or match source and destination."; leaf dest-ipv6-prefix { type inet:ipv6-prefix; mandatory true; description "An IPv6 destination address as the match."; } leaf src-ipv6-prefix { type inet:ipv6-prefix; mandatory true; description "An IPv6 source address as the match."; } container dest-src-ipv6-address { description "A combination of an IPv6 source and an IPv6 destination address as the match."; leaf dest-ipv6-prefix { type inet:ipv6-prefix; mandatory true; description "The IPv6 destination address of the match."; } leaf src-ipv6-prefix { type inet:ipv6-prefix; mandatory true; description "The IPv6 source address of the match."; } } // container dest-src-ipv6-address } // choice ip-route-match-type } // container ipv6 } // case ipv6 case mpls-route { description "MPLS route case."; leaf mpls-label { type uint32; mandatory true; description "The label used for matching."; } } // case mpls-route case mac-route { description "MAC route case."; leaf mac-address { type yang:mac-address; mandatory true; description "The MAC address used for matching."; } } // case mac-route case interface-route { description "Interface route case."; leaf interface-identifier { type if:interface-ref; mandatory true; description "The interface used for matching."; } } // case interface-route } // choice route-type } // container match container route-attributes { description "The route attributes."; leaf route-preference { type uint32; mandatory true; description "ROUTE_PREFERENCE: This is a numerical value that allows for comparing routes from different protocols. Static configuration is also considered a protocol for the purpose of this field. It is also known as administrative-distance. The lower the value, the higher the preference."; } leaf local-only { type boolean; mandatory true; description "Indicate whether the attribute is local only."; } container address-family-route-attributes { description "Address-family-related route attributes."; choice route-type { description "Address-family-related route attributes. Future documents should specify these attributes by augmenting the cases in this choice."; case ip-route-attributes { } // case ip-route-attributes case mpls-route-attributes { } // case mpls-route-attributes case ethernet-route-attributes { } // case ethernet-route-attributes } // choice route-type } // container address-family-route-attributes } // container route-attributes container route-vendor-attributes { if-feature route-vendor-attributes; description "The route vendor attributes."; } // container route-vendor-attributes container nexthop { description "The nexthop of the added route."; leaf nexthop-id { type uint32; description "An identifier that refers to a nexthop."; } leaf sharing-flag { type boolean; description "To indicate whether a nexthop is sharable or non-sharable: true - sharable (which means the nexthop can be shared with other routes) false - non-sharable (which means the nexthop can not be shared with other routes)"; } choice nexthop-type { description "Nexthop type options."; container nexthop-base { description "The base nexthop."; choice nexthop-base-type { description "Nexthop base type options."; leaf special { type special-nexthop-definition; description "A special nexthop."; } leaf outgoing-interface { type if:interface-ref; mandatory true; description "The nexthop is an outgoing interface."; } leaf ipv4-address { type inet:ipv4-address; mandatory true; description "The nexthop is an IPv4 address."; } leaf ipv6-address { type inet:ipv6-address; mandatory true; description "The nexthop is an IPv6 address."; } container egress-interface-ipv4-address { description "The nexthop is an egress-interface and an IP address. This can be used in cases where, e.g., the IP address is a link-local address."; leaf outgoing-interface { type if:interface-ref; mandatory true; description "Name of the outgoing interface."; } leaf ipv4-address { type inet:ipv4-address; mandatory true; description "The nexthop points to an interface with an IPv4 address."; } } // container egress-interface-ipv4-address container egress-interface-ipv6-address { description "The nexthop is an egress-interface and an IP address. This can be used in cases where, e.g., the IP address is a link-local address."; leaf outgoing-interface { type if:interface-ref; mandatory true; description "Name of the outgoing interface."; } leaf ipv6-address { type inet:ipv6-address; mandatory true; description "The nexthop points to an interface with an IPv6 address."; } } // container egress-interface-ipv6-address container egress-interface-mac-address { description "The egress-interface must be an Ethernet interface. Address resolution is not required for this nexthop."; leaf outgoing-interface { type if:interface-ref; mandatory true; description "Name of the outgoing interface."; } leaf ieee-mac-address { type yang:mac-address; mandatory true; description "The nexthop points to an interface with a specific MAC address."; } } // container egress-interface-mac-address case tunnel-encapsulation-nexthop { if-feature nexthop-tunnel; container tunnel-encapsulation { description "This can be an encapsulation representing an IP tunnel, MPLS tunnel, or others as defined in the info model. An optional egress-interface can be chained to the tunnel encapsulation to indicate which interface to send the packet out on. The egress-interface is useful when the network device contains Ethernet interfaces and one needs to perform address resolution for the IP packet."; choice tunnel-type { description "Tunnel options for nexthops."; case ipv4 { if-feature ipv4-tunnel; container ipv4-header { description "IPv4 header."; leaf src-ipv4-address { type inet:ipv4-address; mandatory true; description "The source IP address of the header."; } leaf dest-ipv4-address { type inet:ipv4-address; mandatory true; description "The destination IP address of the header."; } leaf protocol { type uint8; mandatory true; description "The protocol id of the header."; } leaf ttl { type uint8; description "The TTL of the header."; } leaf dscp { type uint8; description "The Differentiated Services Code Point (DSCP) field of the header."; } } // container ipv4-header } // case ipv4 case ipv6 { if-feature ipv6-tunnel; container ipv6-header { description "IPv6 header."; leaf src-ipv6-address { type inet:ipv6-address; mandatory true; description "The source IP address of the header."; } leaf dest-ipv6-address { type inet:ipv6-address; mandatory true; description "The destination IP address of the header."; } leaf next-header { type uint8; mandatory true; description "The next header of the IPv6 header."; } leaf traffic-class { type uint8; description "The traffic class value of the header."; } leaf flow-label { type inet:ipv6-flow-label; description "The flow label of the header."; } leaf hop-limit { type uint8 { range "1..255"; } description "The hop limit of the header."; } } // container ipv6-header } // case ipv6 case mpls { if-feature mpls-tunnel; container mpls-header { description "MPLS header."; list label-operations { key "label-oper-id"; description "Label operations."; leaf label-oper-id { type uint32; description "An optional identifier that points to a label operation."; } choice label-actions { description "Label action options."; container label-push { description "Label push operation."; leaf label { type uint32; mandatory true; description "The label to be pushed."; } leaf s-bit { type boolean; description "The s-bit ('Bottom of Stack' bit) of the label to be pushed."; } leaf tc-value { type uint8; description "The traffic class value of the label to be pushed."; } leaf ttl-value { type uint8; description "The TTL value of the label to be pushed."; } } // container label-push container label-swap { description "Label swap operation."; leaf in-label { type uint32; mandatory true; description "The label to be swapped."; } leaf out-label { type uint32; mandatory true; description "The out MPLS label."; } leaf ttl-action { type ttl-action-definition; description "The label TTL actions: - No-action - Copy to inner label - Decrease (the in-label) by 1 and copy to the out-label"; } } // container label-swap } // choice label-actions } // list label-operations } // container mpls-header } // case mpls case gre { if-feature gre-tunnel; container gre-header { description "GRE header."; choice dest-address-type { description "GRE options: IPv4 and IPv6"; leaf ipv4-dest { type inet:ipv4-address; mandatory true; description "The destination IP address of the GRE header."; } leaf ipv6-dest { type inet:ipv6-address; mandatory true; description "The destination IP address of the GRE header."; } } // choice dest-address-type leaf protocol-type { type uint16; mandatory true; description "The protocol type of the GRE header."; } leaf key { type uint64; description "The GRE key of the GRE header."; } } // container gre-header } // case gre case nvgre { if-feature nvgre-tunnel; container nvgre-header { description "NVGRE header."; choice nvgre-type { description "NVGRE can use either an IPv4 or an IPv6 header for encapsulation."; case ipv4 { leaf src-ipv4-address { type inet:ipv4-address; mandatory true; description "The source IP address of the header."; } leaf dest-ipv4-address { type inet:ipv4-address; mandatory true; description "The destination IP address of the header."; } leaf protocol { type uint8; mandatory true; description "The protocol id of the header."; } leaf ttl { type uint8; description "The TTL of the header."; } leaf dscp { type uint8; description "The Differentiated Services Code Point (DSCP) field of the header."; } } // case ipv4 case ipv6 { leaf src-ipv6-address { type inet:ipv6-address; mandatory true; description "The source IP address of the header."; } leaf dest-ipv6-address { type inet:ipv6-address; mandatory true; description "The destination IP address of the header."; } leaf next-header { type uint8; mandatory true; description "The next header of the IPv6 header."; } leaf traffic-class { type uint8; description "The traffic class value of the header."; } leaf flow-label { type inet:ipv6-flow-label; description "The flow label of the header."; } leaf hop-limit { type uint8 { range "1..255"; } description "The hop limit of the header."; } } // case ipv6 } // choice nvgre-type leaf virtual-subnet-id { type uint32; mandatory true; description "The subnet identifier of the NVGRE header."; } leaf flow-id { type uint8; description "The flow identifier of the NVGRE header."; } } // container nvgre-header } // case nvgre case vxlan { if-feature vxlan-tunnel; container vxlan-header { description "VXLAN header."; choice vxlan-type { description "NVGRE can use either an IPv4 or an IPv6 header for encapsulation."; case ipv4 { leaf src-ipv4-address { type inet:ipv4-address; mandatory true; description "The source IP address of the header."; } leaf dest-ipv4-address { type inet:ipv4-address; mandatory true; description "The destination IP address of the header."; } leaf protocol { type uint8; mandatory true; description "The protocol id of the header."; } leaf ttl { type uint8; description "The TTL of the header."; } leaf dscp { type uint8; description "The Differentiated Services Code Point (DSCP) field of the header."; } } // case ipv4 case ipv6 { leaf src-ipv6-address { type inet:ipv6-address; mandatory true; description "The source IP address of the header."; } leaf dest-ipv6-address { type inet:ipv6-address; mandatory true; description "The destination IP address of the header."; } leaf next-header { type uint8; mandatory true; description "The next header of the IPv6 header."; } leaf traffic-class { type uint8; description "The traffic class value of the header."; } leaf flow-label { type inet:ipv6-flow-label; description "The flow label of the header."; } leaf hop-limit { type uint8 { range "1..255"; } description "The hop limit of the header."; } } // case ipv6 } // choice vxlan-type leaf vxlan-identifier { type uint32; mandatory true; description "The VXLAN identifier of the VXLAN header."; } } // container vxlan-header } // case vxlan } // choice tunnel-type } // container tunnel-encapsulation } // case tunnel-encapsulation-nexthop case tunnel-decapsulation-nexthop { if-feature nexthop-tunnel; container tunnel-decapsulation { description "This is to specify the decapsulation of a tunnel header."; choice tunnel-type { description "Nexthop tunnel type options."; case ipv4 { if-feature ipv4-tunnel; container ipv4-decapsulation { description "IPv4 decapsulation."; leaf ipv4-decapsulation { type tunnel-decapsulation-action-definition; mandatory true; description "IPv4 decapsulation operations."; } leaf ttl-action { type ttl-action-definition; description "The TTL actions: no-action or copy to inner header."; } } // container ipv4-decapsulation } // case ipv4 case ipv6 { if-feature ipv6-tunnel; container ipv6-decapsulation { description "IPv6 decapsulation."; leaf ipv6-decapsulation { type tunnel-decapsulation-action-definition; mandatory true; description "IPv6 decapsulation operations."; } leaf hop-limit-action { type hop-limit-action-definition; description "The hop limit actions: no-action or copy to inner header."; } } // container ipv6-decapsulation } // case ipv6 case mpls { if-feature mpls-tunnel; container label-pop { description "MPLS decapsulation."; leaf label-pop { type mpls-label-action-definition; mandatory true; description "Pop a label from the label stack."; } leaf ttl-action { type ttl-action-definition; description "The label TTL action."; } } // container label-pop } // case mpls } // choice tunnel-type } // container tunnel-decapsulation } // case tunnel-decapsulation-nexthop case logical-tunnel-nexthop { if-feature nexthop-tunnel; container logical-tunnel { description "This can be an MPLS Label Switched Path (LSP) or a GRE tunnel (or others as defined in this document) that is represented by a unique identifier (e.g., name)."; leaf tunnel-type { type tunnel-type-definition; mandatory true; description "A tunnel type."; } leaf tunnel-name { type string; mandatory true; description "A tunnel name that points to a logical tunnel."; } } // container logical-tunnel } // case logical-tunnel-nexthop leaf rib-name { type string; description "A nexthop pointing to a RIB indicates that the route lookup needs to continue in the specified RIB. This is a way to perform chained lookups."; } leaf nexthop-ref { type nexthop-ref; mandatory true; description "A nexthop reference that points to a nexthop."; } } // choice nexthop-base-type } // container nexthop-base case nexthop-chain { if-feature nexthop-chain; container nexthop-chain { description "A chain nexthop."; list nexthop-list { key "nexthop-member-id"; description "A list of nexthops."; leaf nexthop-member-id { type uint32; mandatory true; description "A nexthop identifier that points to a nexthop list member. A nexthop list member is a nexthop."; } } // list nexthop-list } // container nexthop-chain } // case nexthop-chain case nexthop-replicate { if-feature nexthop-replicate; container nexthop-replicate { description "A replicate nexthop."; list nexthop-list { key "nexthop-member-id"; description "A list of nexthops."; leaf nexthop-member-id { type uint32; mandatory true; description "A nexthop identifier that points to a nexthop list member. A nexthop list member is a nexthop."; } } // list nexthop-list } // container nexthop-replicate } // case nexthop-replicate case nexthop-protection { if-feature nexthop-protection; container nexthop-protection { description "A protection nexthop."; list nexthop-list { key "nexthop-member-id"; description "A list of nexthop."; leaf nexthop-member-id { type uint32; mandatory true; description "A nexthop identifier that points to a nexthop list member. A nexthop list member is a nexthop."; } leaf nexthop-preference { type nexthop-preference-definition; mandatory true; description "Nexthop-preference is used for protection schemes. It is an integer value between 1 and 99. Lower values are more preferred. To download a primary/standby/tertiary group to the FIB, the nexthops that are resolved and are most preferred are selected."; } } // list nexthop-list } // container nexthop-protection } // case nexthop-protection case nexthop-load-balance { if-feature nexthop-load-balance; container nexthop-lb { description "A load-balance nexthop."; list nexthop-list { key "nexthop-member-id"; description "A list of nexthop."; leaf nexthop-member-id { type uint32; mandatory true; description "A nexthop identifier that points to a nexthop list member. A nexthop list member is a nexthop."; } leaf nexthop-lb-weight { type nexthop-lb-weight-definition; mandatory true; description "The weight of a nexthop of the load-balance nexthops."; } } // list nexthop-list } // container nexthop-lb } // case nexthop-load-balance } // choice nexthop-type } // container nexthop } // list route-list } // container routes } output { leaf success-count { type uint32; mandatory true; description "The numbers of routes that are successfully added/deleted/updated."; } leaf failed-count { type uint32; mandatory true; description "The numbers of the routes that fail to be added/deleted/updated."; } container failure-detail { description "The failure detail reflects the reason why a route operation fails. It is an array that includes the route index and error code of the failed route."; list failed-routes { key "route-index"; description "The list of failed routes."; leaf route-index { type uint32; description "The route index of the failed route."; } leaf error-code { type uint32; description "The error code that reflects the failure reason. 0 - Reserved 1 - Trying to add a repeat route 2 - Trying to delete or update a route that does not exist 3 - Malformed route attributes"; } } // list failed-routes } // container failure-detail } } // rpc route-add rpc route-delete { description "To delete a route or a list of routes from a RIB"; input { leaf return-failure-detail { type boolean; default "false"; description "Whether to return the failure detail. true - return the failure detail false - do not return the failure detail The default is false."; } leaf rib-name { type string; mandatory true; description "A reference to the name of a RIB."; } container routes { description "The routes to be added to the RIB."; list route-list { key "route-index"; description "The list of routes to be deleted."; leaf route-index { type uint64; mandatory true; description "Route index."; } container match { description "The match condition specifies the kind of route (IPv4, MPLS, etc.) and the set of fields to match on."; choice route-type { description "Route types: IPv4, IPv6, MPLS, MAC, etc."; case ipv4 { description "IPv4 route case."; container ipv4 { description "IPv4 route match."; choice ip-route-match-type { description "IP route match type options: match source, or match destination, or match source and destination."; leaf dest-ipv4-prefix { type inet:ipv4-prefix; mandatory true; description "An IPv4 destination address as the match."; } leaf src-ipv4-prefix { type inet:ipv4-prefix; mandatory true; description "An IPv4 source address as the match."; } container dest-src-ipv4-address { description "A combination of an IPv4 source and an IPv4 destination address as the match."; leaf dest-ipv4-prefix { type inet:ipv4-prefix; mandatory true; description "The IPv4 destination address of the match."; } leaf src-ipv4-prefix { type inet:ipv4-prefix; mandatory true; description "The IPv4 source address of the match."; } } // container dest-src-ipv4-address } // choice ip-route-match-type } // container ipv4 } // case ipv4 case ipv6 { description "IPv6 route case."; container ipv6 { description "IPv6 route match."; choice ip-route-match-type { description "IP route match type options: match source, match destination, or match source and destination."; leaf dest-ipv6-prefix { type inet:ipv6-prefix; mandatory true; description "An IPv6 destination address as the match."; } leaf src-ipv6-prefix { type inet:ipv6-prefix; mandatory true; description "An IPv6 source address as the match."; } container dest-src-ipv6-address { description "A combination of an IPv6 source and an IPv6 destination address as the match."; leaf dest-ipv6-prefix { type inet:ipv6-prefix; mandatory true; description "The IPv6 destination address of the match."; } leaf src-ipv6-prefix { type inet:ipv6-prefix; mandatory true; description "The IPv6 source address of the match."; } } // container dest-src-ipv6-address } // choice ip-route-match-type } // container ipv6 } // case ipv6 case mpls-route { description "MPLS route case."; leaf mpls-label { type uint32; mandatory true; description "The label used for matching."; } } // case mpls-route case mac-route { description "MAC route case."; leaf mac-address { type yang:mac-address; mandatory true; description "The MAC address used for matching."; } } // case mac-route case interface-route { description "Interface route case."; leaf interface-identifier { type if:interface-ref; mandatory true; description "The interface used for matching."; } } // case interface-route } // choice route-type } // container match } // list route-list } // container routes } output { leaf success-count { type uint32; mandatory true; description "The numbers of routes that are successfully added/deleted/updated."; } leaf failed-count { type uint32; mandatory true; description "The numbers of the routes that fail to be added/deleted/updated."; } container failure-detail { description "The failure detail reflects the reason why a route operation fails. It is an array that includes the route index and error code of the failed route."; list failed-routes { key "route-index"; description "The list of failed routes."; leaf route-index { type uint32; description "The route index of the failed route."; } leaf error-code { type uint32; description "The error code that reflects the failure reason. 0 - Reserved 1 - Trying to add a repeat route 2 - Trying to delete or update a route that does not exist 3 - Malformed route attributes"; } } // list failed-routes } // container failure-detail } } // rpc route-delete rpc route-update { description "To update a route or a list of routes of a RIB. The inputs: 1. The match conditions, which could be: a. route prefix, b. route attributes, or c. nexthop. 2. The update parameters to be used: a. new nexthop, b. new route attributes, or c. nexthop. Actions: 1. update the nexthop 2. update the route attributes The outputs: success-count - the number of routes updated failed-count - the number of routes fail to update failure-detail - the detail failure info "; input { leaf return-failure-detail { type boolean; default "false"; description "Whether to return the failure detail. true - return the failure detail false - do not return the failure detail The default is false."; } leaf rib-name { type string; mandatory true; description "A reference to the name of a RIB."; } choice match-options { description "Match options."; case match-route-prefix { description "Update the routes that match the route prefix(es) condition."; container input-routes { description "The matched routes to be updated."; list route-list { key "route-index"; description "The list of routes to be updated."; leaf route-index { type uint64; mandatory true; description "Route index."; } container match { description "The match condition specifies the kind of route (IPv4, MPLS, etc.) and the set of fields to match on."; choice route-type { description "Route types: IPv4, IPv6, MPLS, MAC, etc."; case ipv4 { description "IPv4 route case."; container ipv4 { description "IPv4 route match."; choice ip-route-match-type { description "IP route match type options: match source, or match destination, or match source and destination."; leaf dest-ipv4-prefix { type inet:ipv4-prefix; mandatory true; description "An IPv4 destination address as the match."; } leaf src-ipv4-prefix { type inet:ipv4-prefix; mandatory true; description "An IPv4 source address as the match."; } container dest-src-ipv4-address { description "A combination of an IPv4 source and an IPv4 destination address as the match."; leaf dest-ipv4-prefix { type inet:ipv4-prefix; mandatory true; description "The IPv4 destination address of the match."; } leaf src-ipv4-prefix { type inet:ipv4-prefix; mandatory true; description "The IPv4 source address of the match."; } } // container dest-src-ipv4-address } // choice ip-route-match-type } // container ipv4 } // case ipv4 case ipv6 { description "IPv6 route case."; container ipv6 { description "IPv6 route match."; choice ip-route-match-type { description "IP route match type options: match source, match destination, or match source and destination."; leaf dest-ipv6-prefix { type inet:ipv6-prefix; mandatory true; description "An IPv6 destination address as the match."; } leaf src-ipv6-prefix { type inet:ipv6-prefix; mandatory true; description "An IPv6 source address as the match."; } container dest-src-ipv6-address { description "A combination of an IPv6 source and an IPv6 destination address as the match."; leaf dest-ipv6-prefix { type inet:ipv6-prefix; mandatory true; description "The IPv6 destination address of the match."; } leaf src-ipv6-prefix { type inet:ipv6-prefix; mandatory true; description "The IPv6 source address of the match."; } } // container dest-src-ipv6-address } // choice ip-route-match-type } // container ipv6 } // case ipv6 case mpls-route { description "MPLS route case."; leaf mpls-label { type uint32; mandatory true; description "The label used for matching."; } } // case mpls-route case mac-route { description "MAC route case."; leaf mac-address { type yang:mac-address; mandatory true; description "The MAC address used for matching."; } } // case mac-route case interface-route { description "Interface route case."; leaf interface-identifier { type if:interface-ref; mandatory true; description "The interface used for matching."; } } // case interface-route } // choice route-type } // container match choice update-options { description "Update options: 1. update the nexthop 2. update the route attributes 3. update the route-vendor-attributes"; container updated-nexthop { description "The nexthop used for updating."; leaf nexthop-id { type uint32; description "An identifier that refers to a nexthop."; } leaf sharing-flag { type boolean; description "To indicate whether a nexthop is sharable or non-sharable: true - sharable (which means the nexthop can be shared with other routes) false - non-sharable (which means the nexthop can not be shared with other routes)"; } choice nexthop-type { description "Nexthop type options."; container nexthop-base { description "The base nexthop."; choice nexthop-base-type { description "Nexthop base type options."; leaf special { type special-nexthop-definition; description "A special nexthop."; } leaf outgoing-interface { type if:interface-ref; mandatory true; description "The nexthop is an outgoing interface."; } leaf ipv4-address { type inet:ipv4-address; mandatory true; description "The nexthop is an IPv4 address."; } leaf ipv6-address { type inet:ipv6-address; mandatory true; description "The nexthop is an IPv6 address."; } container egress-interface-ipv4-address { description "The nexthop is an egress-interface and an IP address. This can be used in cases where, e.g., the IP address is a link-local address."; leaf outgoing-interface { type if:interface-ref; mandatory true; description "Name of the outgoing interface."; } leaf ipv4-address { type inet:ipv4-address; mandatory true; description "The nexthop points to an interface with an IPv4 address."; } } // container egress-interface-ipv4-address container egress-interface-ipv6-address { description "The nexthop is an egress-interface and an IP address. This can be used in cases where, e.g., the IP address is a link-local address."; leaf outgoing-interface { type if:interface-ref; mandatory true; description "Name of the outgoing interface."; } leaf ipv6-address { type inet:ipv6-address; mandatory true; description "The nexthop points to an interface with an IPv6 address."; } } // container egress-interface-ipv6-address container egress-interface-mac-address { description "The egress-interface must be an Ethernet interface. Address resolution is not required for this nexthop."; leaf outgoing-interface { type if:interface-ref; mandatory true; description "Name of the outgoing interface."; } leaf ieee-mac-address { type yang:mac-address; mandatory true; description "The nexthop points to an interface with a specific MAC address."; } } // container egress-interface-mac-address case tunnel-encapsulation-nexthop { if-feature nexthop-tunnel; container tunnel-encapsulation { description "This can be an encapsulation representing an IP tunnel, MPLS tunnel, or others as defined in the info model. An optional egress-interface can be chained to the tunnel encapsulation to indicate which interface to send the packet out on. The egress-interface is useful when the network device contains Ethernet interfaces and one needs to perform address resolution for the IP packet."; choice tunnel-type { description "Tunnel options for nexthops."; case ipv4 { if-feature ipv4-tunnel; container ipv4-header { description "IPv4 header."; leaf src-ipv4-address { type inet:ipv4-address; mandatory true; description "The source IP address of the header."; } leaf dest-ipv4-address { type inet:ipv4-address; mandatory true; description "The destination IP address of the header."; } leaf protocol { type uint8; mandatory true; description "The protocol id of the header."; } leaf ttl { type uint8; description "The TTL of the header."; } leaf dscp { type uint8; description "The Differentiated Services Code Point (DSCP) field of the header."; } } // container ipv4-header } // case ipv4 case ipv6 { if-feature ipv6-tunnel; container ipv6-header { description "IPv6 header."; leaf src-ipv6-address { type inet:ipv6-address; mandatory true; description "The source IP address of the header."; } leaf dest-ipv6-address { type inet:ipv6-address; mandatory true; description "The destination IP address of the header."; } leaf next-header { type uint8; mandatory true; description "The next header of the IPv6 header."; } leaf traffic-class { type uint8; description "The traffic class value of the header."; } leaf flow-label { type inet:ipv6-flow-label; description "The flow label of the header."; } leaf hop-limit { type uint8 { range "1..255"; } description "The hop limit of the header."; } } // container ipv6-header } // case ipv6 case mpls { if-feature mpls-tunnel; container mpls-header { description "MPLS header."; list label-operations { key "label-oper-id"; description "Label operations."; leaf label-oper-id { type uint32; description "An optional identifier that points to a label operation."; } choice label-actions { description "Label action options."; container label-push { description "Label push operation."; leaf label { type uint32; mandatory true; description "The label to be pushed."; } leaf s-bit { type boolean; description "The s-bit ('Bottom of Stack' bit) of the label to be pushed."; } leaf tc-value { type uint8; description "The traffic class value of the label to be pushed."; } leaf ttl-value { type uint8; description "The TTL value of the label to be pushed."; } } // container label-push container label-swap { description "Label swap operation."; leaf in-label { type uint32; mandatory true; description "The label to be swapped."; } leaf out-label { type uint32; mandatory true; description "The out MPLS label."; } leaf ttl-action { type ttl-action-definition; description "The label TTL actions: - No-action - Copy to inner label - Decrease (the in-label) by 1 and copy to the out-label"; } } // container label-swap } // choice label-actions } // list label-operations } // container mpls-header } // case mpls case gre { if-feature gre-tunnel; container gre-header { description "GRE header."; choice dest-address-type { description "GRE options: IPv4 and IPv6"; leaf ipv4-dest { type inet:ipv4-address; mandatory true; description "The destination IP address of the GRE header."; } leaf ipv6-dest { type inet:ipv6-address; mandatory true; description "The destination IP address of the GRE header."; } } // choice dest-address-type leaf protocol-type { type uint16; mandatory true; description "The protocol type of the GRE header."; } leaf key { type uint64; description "The GRE key of the GRE header."; } } // container gre-header } // case gre case nvgre { if-feature nvgre-tunnel; container nvgre-header { description "NVGRE header."; choice nvgre-type { description "NVGRE can use either an IPv4 or an IPv6 header for encapsulation."; case ipv4 { leaf src-ipv4-address { type inet:ipv4-address; mandatory true; description "The source IP address of the header."; } leaf dest-ipv4-address { type inet:ipv4-address; mandatory true; description "The destination IP address of the header."; } leaf protocol { type uint8; mandatory true; description "The protocol id of the header."; } leaf ttl { type uint8; description "The TTL of the header."; } leaf dscp { type uint8; description "The Differentiated Services Code Point (DSCP) field of the header."; } } // case ipv4 case ipv6 { leaf src-ipv6-address { type inet:ipv6-address; mandatory true; description "The source IP address of the header."; } leaf dest-ipv6-address { type inet:ipv6-address; mandatory true; description "The destination IP address of the header."; } leaf next-header { type uint8; mandatory true; description "The next header of the IPv6 header."; } leaf traffic-class { type uint8; description "The traffic class value of the header."; } leaf flow-label { type inet:ipv6-flow-label; description "The flow label of the header."; } leaf hop-limit { type uint8 { range "1..255"; } description "The hop limit of the header."; } } // case ipv6 } // choice nvgre-type leaf virtual-subnet-id { type uint32; mandatory true; description "The subnet identifier of the NVGRE header."; } leaf flow-id { type uint8; description "The flow identifier of the NVGRE header."; } } // container nvgre-header } // case nvgre case vxlan { if-feature vxlan-tunnel; container vxlan-header { description "VXLAN header."; choice vxlan-type { description "NVGRE can use either an IPv4 or an IPv6 header for encapsulation."; case ipv4 { leaf src-ipv4-address { type inet:ipv4-address; mandatory true; description "The source IP address of the header."; } leaf dest-ipv4-address { type inet:ipv4-address; mandatory true; description "The destination IP address of the header."; } leaf protocol { type uint8; mandatory true; description "The protocol id of the header."; } leaf ttl { type uint8; description "The TTL of the header."; } leaf dscp { type uint8; description "The Differentiated Services Code Point (DSCP) field of the header."; } } // case ipv4 case ipv6 { leaf src-ipv6-address { type inet:ipv6-address; mandatory true; description "The source IP address of the header."; } leaf dest-ipv6-address { type inet:ipv6-address; mandatory true; description "The destination IP address of the header."; } leaf next-header { type uint8; mandatory true; description "The next header of the IPv6 header."; } leaf traffic-class { type uint8; description "The traffic class value of the header."; } leaf flow-label { type inet:ipv6-flow-label; description "The flow label of the header."; } leaf hop-limit { type uint8 { range "1..255"; } description "The hop limit of the header."; } } // case ipv6 } // choice vxlan-type leaf vxlan-identifier { type uint32; mandatory true; description "The VXLAN identifier of the VXLAN header."; } } // container vxlan-header } // case vxlan } // choice tunnel-type } // container tunnel-encapsulation } // case tunnel-encapsulation-nexthop case tunnel-decapsulation-nexthop { if-feature nexthop-tunnel; container tunnel-decapsulation { description "This is to specify the decapsulation of a tunnel header."; choice tunnel-type { description "Nexthop tunnel type options."; case ipv4 { if-feature ipv4-tunnel; container ipv4-decapsulation { description "IPv4 decapsulation."; leaf ipv4-decapsulation { type tunnel-decapsulation-action-definition; mandatory true; description "IPv4 decapsulation operations."; } leaf ttl-action { type ttl-action-definition; description "The TTL actions: no-action or copy to inner header."; } } // container ipv4-decapsulation } // case ipv4 case ipv6 { if-feature ipv6-tunnel; container ipv6-decapsulation { description "IPv6 decapsulation."; leaf ipv6-decapsulation { type tunnel-decapsulation-action-definition; mandatory true; description "IPv6 decapsulation operations."; } leaf hop-limit-action { type hop-limit-action-definition; description "The hop limit actions: no-action or copy to inner header."; } } // container ipv6-decapsulation } // case ipv6 case mpls { if-feature mpls-tunnel; container label-pop { description "MPLS decapsulation."; leaf label-pop { type mpls-label-action-definition; mandatory true; description "Pop a label from the label stack."; } leaf ttl-action { type ttl-action-definition; description "The label TTL action."; } } // container label-pop } // case mpls } // choice tunnel-type } // container tunnel-decapsulation } // case tunnel-decapsulation-nexthop case logical-tunnel-nexthop { if-feature nexthop-tunnel; container logical-tunnel { description "This can be an MPLS Label Switched Path (LSP) or a GRE tunnel (or others as defined in this document) that is represented by a unique identifier (e.g., name)."; leaf tunnel-type { type tunnel-type-definition; mandatory true; description "A tunnel type."; } leaf tunnel-name { type string; mandatory true; description "A tunnel name that points to a logical tunnel."; } } // container logical-tunnel } // case logical-tunnel-nexthop leaf rib-name { type string; description "A nexthop pointing to a RIB indicates that the route lookup needs to continue in the specified RIB. This is a way to perform chained lookups."; } leaf nexthop-ref { type nexthop-ref; mandatory true; description "A nexthop reference that points to a nexthop."; } } // choice nexthop-base-type } // container nexthop-base case nexthop-chain { if-feature nexthop-chain; container nexthop-chain { description "A chain nexthop."; list nexthop-list { key "nexthop-member-id"; description "A list of nexthops."; leaf nexthop-member-id { type uint32; mandatory true; description "A nexthop identifier that points to a nexthop list member. A nexthop list member is a nexthop."; } } // list nexthop-list } // container nexthop-chain } // case nexthop-chain case nexthop-replicate { if-feature nexthop-replicate; container nexthop-replicate { description "A replicate nexthop."; list nexthop-list { key "nexthop-member-id"; description "A list of nexthops."; leaf nexthop-member-id { type uint32; mandatory true; description "A nexthop identifier that points to a nexthop list member. A nexthop list member is a nexthop."; } } // list nexthop-list } // container nexthop-replicate } // case nexthop-replicate case nexthop-protection { if-feature nexthop-protection; container nexthop-protection { description "A protection nexthop."; list nexthop-list { key "nexthop-member-id"; description "A list of nexthop."; leaf nexthop-member-id { type uint32; mandatory true; description "A nexthop identifier that points to a nexthop list member. A nexthop list member is a nexthop."; } leaf nexthop-preference { type nexthop-preference-definition; mandatory true; description "Nexthop-preference is used for protection schemes. It is an integer value between 1 and 99. Lower values are more preferred. To download a primary/standby/tertiary group to the FIB, the nexthops that are resolved and are most preferred are selected."; } } // list nexthop-list } // container nexthop-protection } // case nexthop-protection case nexthop-load-balance { if-feature nexthop-load-balance; container nexthop-lb { description "A load-balance nexthop."; list nexthop-list { key "nexthop-member-id"; description "A list of nexthop."; leaf nexthop-member-id { type uint32; mandatory true; description "A nexthop identifier that points to a nexthop list member. A nexthop list member is a nexthop."; } leaf nexthop-lb-weight { type nexthop-lb-weight-definition; mandatory true; description "The weight of a nexthop of the load-balance nexthops."; } } // list nexthop-list } // container nexthop-lb } // case nexthop-load-balance } // choice nexthop-type } // container updated-nexthop container updated-route-attr { description "The route attributes used for updating."; leaf route-preference { type uint32; mandatory true; description "ROUTE_PREFERENCE: This is a numerical value that allows for comparing routes from different protocols. Static configuration is also considered a protocol for the purpose of this field. It is also known as administrative-distance. The lower the value, the higher the preference."; } leaf local-only { type boolean; mandatory true; description "Indicate whether the attribute is local only."; } container address-family-route-attributes { description "Address-family-related route attributes."; choice route-type { description "Address-family-related route attributes. Future documents should specify these attributes by augmenting the cases in this choice."; case ip-route-attributes { } // case ip-route-attributes case mpls-route-attributes { } // case mpls-route-attributes case ethernet-route-attributes { } // case ethernet-route-attributes } // choice route-type } // container address-family-route-attributes } // container updated-route-attr container updated-route-vendor-attr { description "The vendor route attributes used for updating."; } // container updated-route-vendor-attr } // choice update-options } // list route-list } // container input-routes } // case match-route-prefix case match-route-attributes { description "Update the routes that match the route attributes condition."; container input-route-attributes { description "The route attributes are used for matching."; leaf route-preference { type uint32; mandatory true; description "ROUTE_PREFERENCE: This is a numerical value that allows for comparing routes from different protocols. Static configuration is also considered a protocol for the purpose of this field. It is also known as administrative-distance. The lower the value, the higher the preference."; } leaf local-only { type boolean; mandatory true; description "Indicate whether the attribute is local only."; } container address-family-route-attributes { description "Address-family-related route attributes."; choice route-type { description "Address-family-related route attributes. Future documents should specify these attributes by augmenting the cases in this choice."; case ip-route-attributes { } // case ip-route-attributes case mpls-route-attributes { } // case mpls-route-attributes case ethernet-route-attributes { } // case ethernet-route-attributes } // choice route-type } // container address-family-route-attributes } // container input-route-attributes container update-parameters { description "Update options: 1. update the nexthop 2. update the route attributes 3. update the route-vendor-attributes"; choice update-options { description "Update options: 1. update the nexthop 2. update the route attributes 3. update the route-vendor-attributes"; container updated-nexthop { description "The nexthop used for updating."; leaf nexthop-id { type uint32; description "An identifier that refers to a nexthop."; } leaf sharing-flag { type boolean; description "To indicate whether a nexthop is sharable or non-sharable: true - sharable (which means the nexthop can be shared with other routes) false - non-sharable (which means the nexthop can not be shared with other routes)"; } choice nexthop-type { description "Nexthop type options."; container nexthop-base { description "The base nexthop."; choice nexthop-base-type { description "Nexthop base type options."; leaf special { type special-nexthop-definition; description "A special nexthop."; } leaf outgoing-interface { type if:interface-ref; mandatory true; description "The nexthop is an outgoing interface."; } leaf ipv4-address { type inet:ipv4-address; mandatory true; description "The nexthop is an IPv4 address."; } leaf ipv6-address { type inet:ipv6-address; mandatory true; description "The nexthop is an IPv6 address."; } container egress-interface-ipv4-address { description "The nexthop is an egress-interface and an IP address. This can be used in cases where, e.g., the IP address is a link-local address."; leaf outgoing-interface { type if:interface-ref; mandatory true; description "Name of the outgoing interface."; } leaf ipv4-address { type inet:ipv4-address; mandatory true; description "The nexthop points to an interface with an IPv4 address."; } } // container egress-interface-ipv4-address container egress-interface-ipv6-address { description "The nexthop is an egress-interface and an IP address. This can be used in cases where, e.g., the IP address is a link-local address."; leaf outgoing-interface { type if:interface-ref; mandatory true; description "Name of the outgoing interface."; } leaf ipv6-address { type inet:ipv6-address; mandatory true; description "The nexthop points to an interface with an IPv6 address."; } } // container egress-interface-ipv6-address container egress-interface-mac-address { description "The egress-interface must be an Ethernet interface. Address resolution is not required for this nexthop."; leaf outgoing-interface { type if:interface-ref; mandatory true; description "Name of the outgoing interface."; } leaf ieee-mac-address { type yang:mac-address; mandatory true; description "The nexthop points to an interface with a specific MAC address."; } } // container egress-interface-mac-address case tunnel-encapsulation-nexthop { if-feature nexthop-tunnel; container tunnel-encapsulation { description "This can be an encapsulation representing an IP tunnel, MPLS tunnel, or others as defined in the info model. An optional egress-interface can be chained to the tunnel encapsulation to indicate which interface to send the packet out on. The egress-interface is useful when the network device contains Ethernet interfaces and one needs to perform address resolution for the IP packet."; choice tunnel-type { description "Tunnel options for nexthops."; case ipv4 { if-feature ipv4-tunnel; container ipv4-header { description "IPv4 header."; leaf src-ipv4-address { type inet:ipv4-address; mandatory true; description "The source IP address of the header."; } leaf dest-ipv4-address { type inet:ipv4-address; mandatory true; description "The destination IP address of the header."; } leaf protocol { type uint8; mandatory true; description "The protocol id of the header."; } leaf ttl { type uint8; description "The TTL of the header."; } leaf dscp { type uint8; description "The Differentiated Services Code Point (DSCP) field of the header."; } } // container ipv4-header } // case ipv4 case ipv6 { if-feature ipv6-tunnel; container ipv6-header { description "IPv6 header."; leaf src-ipv6-address { type inet:ipv6-address; mandatory true; description "The source IP address of the header."; } leaf dest-ipv6-address { type inet:ipv6-address; mandatory true; description "The destination IP address of the header."; } leaf next-header { type uint8; mandatory true; description "The next header of the IPv6 header."; } leaf traffic-class { type uint8; description "The traffic class value of the header."; } leaf flow-label { type inet:ipv6-flow-label; description "The flow label of the header."; } leaf hop-limit { type uint8 { range "1..255"; } description "The hop limit of the header."; } } // container ipv6-header } // case ipv6 case mpls { if-feature mpls-tunnel; container mpls-header { description "MPLS header."; list label-operations { key "label-oper-id"; description "Label operations."; leaf label-oper-id { type uint32; description "An optional identifier that points to a label operation."; } choice label-actions { description "Label action options."; container label-push { description "Label push operation."; leaf label { type uint32; mandatory true; description "The label to be pushed."; } leaf s-bit { type boolean; description "The s-bit ('Bottom of Stack' bit) of the label to be pushed."; } leaf tc-value { type uint8; description "The traffic class value of the label to be pushed."; } leaf ttl-value { type uint8; description "The TTL value of the label to be pushed."; } } // container label-push container label-swap { description "Label swap operation."; leaf in-label { type uint32; mandatory true; description "The label to be swapped."; } leaf out-label { type uint32; mandatory true; description "The out MPLS label."; } leaf ttl-action { type ttl-action-definition; description "The label TTL actions: - No-action - Copy to inner label - Decrease (the in-label) by 1 and copy to the out-label"; } } // container label-swap } // choice label-actions } // list label-operations } // container mpls-header } // case mpls case gre { if-feature gre-tunnel; container gre-header { description "GRE header."; choice dest-address-type { description "GRE options: IPv4 and IPv6"; leaf ipv4-dest { type inet:ipv4-address; mandatory true; description "The destination IP address of the GRE header."; } leaf ipv6-dest { type inet:ipv6-address; mandatory true; description "The destination IP address of the GRE header."; } } // choice dest-address-type leaf protocol-type { type uint16; mandatory true; description "The protocol type of the GRE header."; } leaf key { type uint64; description "The GRE key of the GRE header."; } } // container gre-header } // case gre case nvgre { if-feature nvgre-tunnel; container nvgre-header { description "NVGRE header."; choice nvgre-type { description "NVGRE can use either an IPv4 or an IPv6 header for encapsulation."; case ipv4 { leaf src-ipv4-address { type inet:ipv4-address; mandatory true; description "The source IP address of the header."; } leaf dest-ipv4-address { type inet:ipv4-address; mandatory true; description "The destination IP address of the header."; } leaf protocol { type uint8; mandatory true; description "The protocol id of the header."; } leaf ttl { type uint8; description "The TTL of the header."; } leaf dscp { type uint8; description "The Differentiated Services Code Point (DSCP) field of the header."; } } // case ipv4 case ipv6 { leaf src-ipv6-address { type inet:ipv6-address; mandatory true; description "The source IP address of the header."; } leaf dest-ipv6-address { type inet:ipv6-address; mandatory true; description "The destination IP address of the header."; } leaf next-header { type uint8; mandatory true; description "The next header of the IPv6 header."; } leaf traffic-class { type uint8; description "The traffic class value of the header."; } leaf flow-label { type inet:ipv6-flow-label; description "The flow label of the header."; } leaf hop-limit { type uint8 { range "1..255"; } description "The hop limit of the header."; } } // case ipv6 } // choice nvgre-type leaf virtual-subnet-id { type uint32; mandatory true; description "The subnet identifier of the NVGRE header."; } leaf flow-id { type uint8; description "The flow identifier of the NVGRE header."; } } // container nvgre-header } // case nvgre case vxlan { if-feature vxlan-tunnel; container vxlan-header { description "VXLAN header."; choice vxlan-type { description "NVGRE can use either an IPv4 or an IPv6 header for encapsulation."; case ipv4 { leaf src-ipv4-address { type inet:ipv4-address; mandatory true; description "The source IP address of the header."; } leaf dest-ipv4-address { type inet:ipv4-address; mandatory true; description "The destination IP address of the header."; } leaf protocol { type uint8; mandatory true; description "The protocol id of the header."; } leaf ttl { type uint8; description "The TTL of the header."; } leaf dscp { type uint8; description "The Differentiated Services Code Point (DSCP) field of the header."; } } // case ipv4 case ipv6 { leaf src-ipv6-address { type inet:ipv6-address; mandatory true; description "The source IP address of the header."; } leaf dest-ipv6-address { type inet:ipv6-address; mandatory true; description "The destination IP address of the header."; } leaf next-header { type uint8; mandatory true; description "The next header of the IPv6 header."; } leaf traffic-class { type uint8; description "The traffic class value of the header."; } leaf flow-label { type inet:ipv6-flow-label; description "The flow label of the header."; } leaf hop-limit { type uint8 { range "1..255"; } description "The hop limit of the header."; } } // case ipv6 } // choice vxlan-type leaf vxlan-identifier { type uint32; mandatory true; description "The VXLAN identifier of the VXLAN header."; } } // container vxlan-header } // case vxlan } // choice tunnel-type } // container tunnel-encapsulation } // case tunnel-encapsulation-nexthop case tunnel-decapsulation-nexthop { if-feature nexthop-tunnel; container tunnel-decapsulation { description "This is to specify the decapsulation of a tunnel header."; choice tunnel-type { description "Nexthop tunnel type options."; case ipv4 { if-feature ipv4-tunnel; container ipv4-decapsulation { description "IPv4 decapsulation."; leaf ipv4-decapsulation { type tunnel-decapsulation-action-definition; mandatory true; description "IPv4 decapsulation operations."; } leaf ttl-action { type ttl-action-definition; description "The TTL actions: no-action or copy to inner header."; } } // container ipv4-decapsulation } // case ipv4 case ipv6 { if-feature ipv6-tunnel; container ipv6-decapsulation { description "IPv6 decapsulation."; leaf ipv6-decapsulation { type tunnel-decapsulation-action-definition; mandatory true; description "IPv6 decapsulation operations."; } leaf hop-limit-action { type hop-limit-action-definition; description "The hop limit actions: no-action or copy to inner header."; } } // container ipv6-decapsulation } // case ipv6 case mpls { if-feature mpls-tunnel; container label-pop { description "MPLS decapsulation."; leaf label-pop { type mpls-label-action-definition; mandatory true; description "Pop a label from the label stack."; } leaf ttl-action { type ttl-action-definition; description "The label TTL action."; } } // container label-pop } // case mpls } // choice tunnel-type } // container tunnel-decapsulation } // case tunnel-decapsulation-nexthop case logical-tunnel-nexthop { if-feature nexthop-tunnel; container logical-tunnel { description "This can be an MPLS Label Switched Path (LSP) or a GRE tunnel (or others as defined in this document) that is represented by a unique identifier (e.g., name)."; leaf tunnel-type { type tunnel-type-definition; mandatory true; description "A tunnel type."; } leaf tunnel-name { type string; mandatory true; description "A tunnel name that points to a logical tunnel."; } } // container logical-tunnel } // case logical-tunnel-nexthop leaf rib-name { type string; description "A nexthop pointing to a RIB indicates that the route lookup needs to continue in the specified RIB. This is a way to perform chained lookups."; } leaf nexthop-ref { type nexthop-ref; mandatory true; description "A nexthop reference that points to a nexthop."; } } // choice nexthop-base-type } // container nexthop-base case nexthop-chain { if-feature nexthop-chain; container nexthop-chain { description "A chain nexthop."; list nexthop-list { key "nexthop-member-id"; description "A list of nexthops."; leaf nexthop-member-id { type uint32; mandatory true; description "A nexthop identifier that points to a nexthop list member. A nexthop list member is a nexthop."; } } // list nexthop-list } // container nexthop-chain } // case nexthop-chain case nexthop-replicate { if-feature nexthop-replicate; container nexthop-replicate { description "A replicate nexthop."; list nexthop-list { key "nexthop-member-id"; description "A list of nexthops."; leaf nexthop-member-id { type uint32; mandatory true; description "A nexthop identifier that points to a nexthop list member. A nexthop list member is a nexthop."; } } // list nexthop-list } // container nexthop-replicate } // case nexthop-replicate case nexthop-protection { if-feature nexthop-protection; container nexthop-protection { description "A protection nexthop."; list nexthop-list { key "nexthop-member-id"; description "A list of nexthop."; leaf nexthop-member-id { type uint32; mandatory true; description "A nexthop identifier that points to a nexthop list member. A nexthop list member is a nexthop."; } leaf nexthop-preference { type nexthop-preference-definition; mandatory true; description "Nexthop-preference is used for protection schemes. It is an integer value between 1 and 99. Lower values are more preferred. To download a primary/standby/tertiary group to the FIB, the nexthops that are resolved and are most preferred are selected."; } } // list nexthop-list } // container nexthop-protection } // case nexthop-protection case nexthop-load-balance { if-feature nexthop-load-balance; container nexthop-lb { description "A load-balance nexthop."; list nexthop-list { key "nexthop-member-id"; description "A list of nexthop."; leaf nexthop-member-id { type uint32; mandatory true; description "A nexthop identifier that points to a nexthop list member. A nexthop list member is a nexthop."; } leaf nexthop-lb-weight { type nexthop-lb-weight-definition; mandatory true; description "The weight of a nexthop of the load-balance nexthops."; } } // list nexthop-list } // container nexthop-lb } // case nexthop-load-balance } // choice nexthop-type } // container updated-nexthop container updated-route-attr { description "The route attributes used for updating."; leaf route-preference { type uint32; mandatory true; description "ROUTE_PREFERENCE: This is a numerical value that allows for comparing routes from different protocols. Static configuration is also considered a protocol for the purpose of this field. It is also known as administrative-distance. The lower the value, the higher the preference."; } leaf local-only { type boolean; mandatory true; description "Indicate whether the attribute is local only."; } container address-family-route-attributes { description "Address-family-related route attributes."; choice route-type { description "Address-family-related route attributes. Future documents should specify these attributes by augmenting the cases in this choice."; case ip-route-attributes { } // case ip-route-attributes case mpls-route-attributes { } // case mpls-route-attributes case ethernet-route-attributes { } // case ethernet-route-attributes } // choice route-type } // container address-family-route-attributes } // container updated-route-attr container updated-route-vendor-attr { description "The vendor route attributes used for updating."; } // container updated-route-vendor-attr } // choice update-options } // container update-parameters } // case match-route-attributes case match-route-vendor-attributes { if-feature route-vendor-attributes; description "Update the routes that match the vendor attributes condition"; container input-route-vendor-attributes { description "The vendor route attributes are used for matching."; } // container input-route-vendor-attributes container update-parameters-vendor { description "Update options: 1. update the nexthop 2. update the route attributes 3. update the route-vendor-attributes"; choice update-options { description "Update options: 1. update the nexthop 2. update the route attributes 3. update the route-vendor-attributes"; container updated-nexthop { description "The nexthop used for updating."; leaf nexthop-id { type uint32; description "An identifier that refers to a nexthop."; } leaf sharing-flag { type boolean; description "To indicate whether a nexthop is sharable or non-sharable: true - sharable (which means the nexthop can be shared with other routes) false - non-sharable (which means the nexthop can not be shared with other routes)"; } choice nexthop-type { description "Nexthop type options."; container nexthop-base { description "The base nexthop."; choice nexthop-base-type { description "Nexthop base type options."; leaf special { type special-nexthop-definition; description "A special nexthop."; } leaf outgoing-interface { type if:interface-ref; mandatory true; description "The nexthop is an outgoing interface."; } leaf ipv4-address { type inet:ipv4-address; mandatory true; description "The nexthop is an IPv4 address."; } leaf ipv6-address { type inet:ipv6-address; mandatory true; description "The nexthop is an IPv6 address."; } container egress-interface-ipv4-address { description "The nexthop is an egress-interface and an IP address. This can be used in cases where, e.g., the IP address is a link-local address."; leaf outgoing-interface { type if:interface-ref; mandatory true; description "Name of the outgoing interface."; } leaf ipv4-address { type inet:ipv4-address; mandatory true; description "The nexthop points to an interface with an IPv4 address."; } } // container egress-interface-ipv4-address container egress-interface-ipv6-address { description "The nexthop is an egress-interface and an IP address. This can be used in cases where, e.g., the IP address is a link-local address."; leaf outgoing-interface { type if:interface-ref; mandatory true; description "Name of the outgoing interface."; } leaf ipv6-address { type inet:ipv6-address; mandatory true; description "The nexthop points to an interface with an IPv6 address."; } } // container egress-interface-ipv6-address container egress-interface-mac-address { description "The egress-interface must be an Ethernet interface. Address resolution is not required for this nexthop."; leaf outgoing-interface { type if:interface-ref; mandatory true; description "Name of the outgoing interface."; } leaf ieee-mac-address { type yang:mac-address; mandatory true; description "The nexthop points to an interface with a specific MAC address."; } } // container egress-interface-mac-address case tunnel-encapsulation-nexthop { if-feature nexthop-tunnel; container tunnel-encapsulation { description "This can be an encapsulation representing an IP tunnel, MPLS tunnel, or others as defined in the info model. An optional egress-interface can be chained to the tunnel encapsulation to indicate which interface to send the packet out on. The egress-interface is useful when the network device contains Ethernet interfaces and one needs to perform address resolution for the IP packet."; choice tunnel-type { description "Tunnel options for nexthops."; case ipv4 { if-feature ipv4-tunnel; container ipv4-header { description "IPv4 header."; leaf src-ipv4-address { type inet:ipv4-address; mandatory true; description "The source IP address of the header."; } leaf dest-ipv4-address { type inet:ipv4-address; mandatory true; description "The destination IP address of the header."; } leaf protocol { type uint8; mandatory true; description "The protocol id of the header."; } leaf ttl { type uint8; description "The TTL of the header."; } leaf dscp { type uint8; description "The Differentiated Services Code Point (DSCP) field of the header."; } } // container ipv4-header } // case ipv4 case ipv6 { if-feature ipv6-tunnel; container ipv6-header { description "IPv6 header."; leaf src-ipv6-address { type inet:ipv6-address; mandatory true; description "The source IP address of the header."; } leaf dest-ipv6-address { type inet:ipv6-address; mandatory true; description "The destination IP address of the header."; } leaf next-header { type uint8; mandatory true; description "The next header of the IPv6 header."; } leaf traffic-class { type uint8; description "The traffic class value of the header."; } leaf flow-label { type inet:ipv6-flow-label; description "The flow label of the header."; } leaf hop-limit { type uint8 { range "1..255"; } description "The hop limit of the header."; } } // container ipv6-header } // case ipv6 case mpls { if-feature mpls-tunnel; container mpls-header { description "MPLS header."; list label-operations { key "label-oper-id"; description "Label operations."; leaf label-oper-id { type uint32; description "An optional identifier that points to a label operation."; } choice label-actions { description "Label action options."; container label-push { description "Label push operation."; leaf label { type uint32; mandatory true; description "The label to be pushed."; } leaf s-bit { type boolean; description "The s-bit ('Bottom of Stack' bit) of the label to be pushed."; } leaf tc-value { type uint8; description "The traffic class value of the label to be pushed."; } leaf ttl-value { type uint8; description "The TTL value of the label to be pushed."; } } // container label-push container label-swap { description "Label swap operation."; leaf in-label { type uint32; mandatory true; description "The label to be swapped."; } leaf out-label { type uint32; mandatory true; description "The out MPLS label."; } leaf ttl-action { type ttl-action-definition; description "The label TTL actions: - No-action - Copy to inner label - Decrease (the in-label) by 1 and copy to the out-label"; } } // container label-swap } // choice label-actions } // list label-operations } // container mpls-header } // case mpls case gre { if-feature gre-tunnel; container gre-header { description "GRE header."; choice dest-address-type { description "GRE options: IPv4 and IPv6"; leaf ipv4-dest { type inet:ipv4-address; mandatory true; description "The destination IP address of the GRE header."; } leaf ipv6-dest { type inet:ipv6-address; mandatory true; description "The destination IP address of the GRE header."; } } // choice dest-address-type leaf protocol-type { type uint16; mandatory true; description "The protocol type of the GRE header."; } leaf key { type uint64; description "The GRE key of the GRE header."; } } // container gre-header } // case gre case nvgre { if-feature nvgre-tunnel; container nvgre-header { description "NVGRE header."; choice nvgre-type { description "NVGRE can use either an IPv4 or an IPv6 header for encapsulation."; case ipv4 { leaf src-ipv4-address { type inet:ipv4-address; mandatory true; description "The source IP address of the header."; } leaf dest-ipv4-address { type inet:ipv4-address; mandatory true; description "The destination IP address of the header."; } leaf protocol { type uint8; mandatory true; description "The protocol id of the header."; } leaf ttl { type uint8; description "The TTL of the header."; } leaf dscp { type uint8; description "The Differentiated Services Code Point (DSCP) field of the header."; } } // case ipv4 case ipv6 { leaf src-ipv6-address { type inet:ipv6-address; mandatory true; description "The source IP address of the header."; } leaf dest-ipv6-address { type inet:ipv6-address; mandatory true; description "The destination IP address of the header."; } leaf next-header { type uint8; mandatory true; description "The next header of the IPv6 header."; } leaf traffic-class { type uint8; description "The traffic class value of the header."; } leaf flow-label { type inet:ipv6-flow-label; description "The flow label of the header."; } leaf hop-limit { type uint8 { range "1..255"; } description "The hop limit of the header."; } } // case ipv6 } // choice nvgre-type leaf virtual-subnet-id { type uint32; mandatory true; description "The subnet identifier of the NVGRE header."; } leaf flow-id { type uint8; description "The flow identifier of the NVGRE header."; } } // container nvgre-header } // case nvgre case vxlan { if-feature vxlan-tunnel; container vxlan-header { description "VXLAN header."; choice vxlan-type { description "NVGRE can use either an IPv4 or an IPv6 header for encapsulation."; case ipv4 { leaf src-ipv4-address { type inet:ipv4-address; mandatory true; description "The source IP address of the header."; } leaf dest-ipv4-address { type inet:ipv4-address; mandatory true; description "The destination IP address of the header."; } leaf protocol { type uint8; mandatory true; description "The protocol id of the header."; } leaf ttl { type uint8; description "The TTL of the header."; } leaf dscp { type uint8; description "The Differentiated Services Code Point (DSCP) field of the header."; } } // case ipv4 case ipv6 { leaf src-ipv6-address { type inet:ipv6-address; mandatory true; description "The source IP address of the header."; } leaf dest-ipv6-address { type inet:ipv6-address; mandatory true; description "The destination IP address of the header."; } leaf next-header { type uint8; mandatory true; description "The next header of the IPv6 header."; } leaf traffic-class { type uint8; description "The traffic class value of the header."; } leaf flow-label { type inet:ipv6-flow-label; description "The flow label of the header."; } leaf hop-limit { type uint8 { range "1..255"; } description "The hop limit of the header."; } } // case ipv6 } // choice vxlan-type leaf vxlan-identifier { type uint32; mandatory true; description "The VXLAN identifier of the VXLAN header."; } } // container vxlan-header } // case vxlan } // choice tunnel-type } // container tunnel-encapsulation } // case tunnel-encapsulation-nexthop case tunnel-decapsulation-nexthop { if-feature nexthop-tunnel; container tunnel-decapsulation { description "This is to specify the decapsulation of a tunnel header."; choice tunnel-type { description "Nexthop tunnel type options."; case ipv4 { if-feature ipv4-tunnel; container ipv4-decapsulation { description "IPv4 decapsulation."; leaf ipv4-decapsulation { type tunnel-decapsulation-action-definition; mandatory true; description "IPv4 decapsulation operations."; } leaf ttl-action { type ttl-action-definition; description "The TTL actions: no-action or copy to inner header."; } } // container ipv4-decapsulation } // case ipv4 case ipv6 { if-feature ipv6-tunnel; container ipv6-decapsulation { description "IPv6 decapsulation."; leaf ipv6-decapsulation { type tunnel-decapsulation-action-definition; mandatory true; description "IPv6 decapsulation operations."; } leaf hop-limit-action { type hop-limit-action-definition; description "The hop limit actions: no-action or copy to inner header."; } } // container ipv6-decapsulation } // case ipv6 case mpls { if-feature mpls-tunnel; container label-pop { description "MPLS decapsulation."; leaf label-pop { type mpls-label-action-definition; mandatory true; description "Pop a label from the label stack."; } leaf ttl-action { type ttl-action-definition; description "The label TTL action."; } } // container label-pop } // case mpls } // choice tunnel-type } // container tunnel-decapsulation } // case tunnel-decapsulation-nexthop case logical-tunnel-nexthop { if-feature nexthop-tunnel; container logical-tunnel { description "This can be an MPLS Label Switched Path (LSP) or a GRE tunnel (or others as defined in this document) that is represented by a unique identifier (e.g., name)."; leaf tunnel-type { type tunnel-type-definition; mandatory true; description "A tunnel type."; } leaf tunnel-name { type string; mandatory true; description "A tunnel name that points to a logical tunnel."; } } // container logical-tunnel } // case logical-tunnel-nexthop leaf rib-name { type string; description "A nexthop pointing to a RIB indicates that the route lookup needs to continue in the specified RIB. This is a way to perform chained lookups."; } leaf nexthop-ref { type nexthop-ref; mandatory true; description "A nexthop reference that points to a nexthop."; } } // choice nexthop-base-type } // container nexthop-base case nexthop-chain { if-feature nexthop-chain; container nexthop-chain { description "A chain nexthop."; list nexthop-list { key "nexthop-member-id"; description "A list of nexthops."; leaf nexthop-member-id { type uint32; mandatory true; description "A nexthop identifier that points to a nexthop list member. A nexthop list member is a nexthop."; } } // list nexthop-list } // container nexthop-chain } // case nexthop-chain case nexthop-replicate { if-feature nexthop-replicate; container nexthop-replicate { description "A replicate nexthop."; list nexthop-list { key "nexthop-member-id"; description "A list of nexthops."; leaf nexthop-member-id { type uint32; mandatory true; description "A nexthop identifier that points to a nexthop list member. A nexthop list member is a nexthop."; } } // list nexthop-list } // container nexthop-replicate } // case nexthop-replicate case nexthop-protection { if-feature nexthop-protection; container nexthop-protection { description "A protection nexthop."; list nexthop-list { key "nexthop-member-id"; description "A list of nexthop."; leaf nexthop-member-id { type uint32; mandatory true; description "A nexthop identifier that points to a nexthop list member. A nexthop list member is a nexthop."; } leaf nexthop-preference { type nexthop-preference-definition; mandatory true; description "Nexthop-preference is used for protection schemes. It is an integer value between 1 and 99. Lower values are more preferred. To download a primary/standby/tertiary group to the FIB, the nexthops that are resolved and are most preferred are selected."; } } // list nexthop-list } // container nexthop-protection } // case nexthop-protection case nexthop-load-balance { if-feature nexthop-load-balance; container nexthop-lb { description "A load-balance nexthop."; list nexthop-list { key "nexthop-member-id"; description "A list of nexthop."; leaf nexthop-member-id { type uint32; mandatory true; description "A nexthop identifier that points to a nexthop list member. A nexthop list member is a nexthop."; } leaf nexthop-lb-weight { type nexthop-lb-weight-definition; mandatory true; description "The weight of a nexthop of the load-balance nexthops."; } } // list nexthop-list } // container nexthop-lb } // case nexthop-load-balance } // choice nexthop-type } // container updated-nexthop container updated-route-attr { description "The route attributes used for updating."; leaf route-preference { type uint32; mandatory true; description "ROUTE_PREFERENCE: This is a numerical value that allows for comparing routes from different protocols. Static configuration is also considered a protocol for the purpose of this field. It is also known as administrative-distance. The lower the value, the higher the preference."; } leaf local-only { type boolean; mandatory true; description "Indicate whether the attribute is local only."; } container address-family-route-attributes { description "Address-family-related route attributes."; choice route-type { description "Address-family-related route attributes. Future documents should specify these attributes by augmenting the cases in this choice."; case ip-route-attributes { } // case ip-route-attributes case mpls-route-attributes { } // case mpls-route-attributes case ethernet-route-attributes { } // case ethernet-route-attributes } // choice route-type } // container address-family-route-attributes } // container updated-route-attr container updated-route-vendor-attr { description "The vendor route attributes used for updating."; } // container updated-route-vendor-attr } // choice update-options } // container update-parameters-vendor } // case match-route-vendor-attributes case match-nexthop { description "Update the routes that match the nexthop."; container input-nexthop { description "The nexthop used for matching."; leaf nexthop-id { type uint32; description "An identifier that refers to a nexthop."; } leaf sharing-flag { type boolean; description "To indicate whether a nexthop is sharable or non-sharable: true - sharable (which means the nexthop can be shared with other routes) false - non-sharable (which means the nexthop can not be shared with other routes)"; } choice nexthop-type { description "Nexthop type options."; container nexthop-base { description "The base nexthop."; choice nexthop-base-type { description "Nexthop base type options."; leaf special { type special-nexthop-definition; description "A special nexthop."; } leaf outgoing-interface { type if:interface-ref; mandatory true; description "The nexthop is an outgoing interface."; } leaf ipv4-address { type inet:ipv4-address; mandatory true; description "The nexthop is an IPv4 address."; } leaf ipv6-address { type inet:ipv6-address; mandatory true; description "The nexthop is an IPv6 address."; } container egress-interface-ipv4-address { description "The nexthop is an egress-interface and an IP address. This can be used in cases where, e.g., the IP address is a link-local address."; leaf outgoing-interface { type if:interface-ref; mandatory true; description "Name of the outgoing interface."; } leaf ipv4-address { type inet:ipv4-address; mandatory true; description "The nexthop points to an interface with an IPv4 address."; } } // container egress-interface-ipv4-address container egress-interface-ipv6-address { description "The nexthop is an egress-interface and an IP address. This can be used in cases where, e.g., the IP address is a link-local address."; leaf outgoing-interface { type if:interface-ref; mandatory true; description "Name of the outgoing interface."; } leaf ipv6-address { type inet:ipv6-address; mandatory true; description "The nexthop points to an interface with an IPv6 address."; } } // container egress-interface-ipv6-address container egress-interface-mac-address { description "The egress-interface must be an Ethernet interface. Address resolution is not required for this nexthop."; leaf outgoing-interface { type if:interface-ref; mandatory true; description "Name of the outgoing interface."; } leaf ieee-mac-address { type yang:mac-address; mandatory true; description "The nexthop points to an interface with a specific MAC address."; } } // container egress-interface-mac-address case tunnel-encapsulation-nexthop { if-feature nexthop-tunnel; container tunnel-encapsulation { description "This can be an encapsulation representing an IP tunnel, MPLS tunnel, or others as defined in the info model. An optional egress-interface can be chained to the tunnel encapsulation to indicate which interface to send the packet out on. The egress-interface is useful when the network device contains Ethernet interfaces and one needs to perform address resolution for the IP packet."; choice tunnel-type { description "Tunnel options for nexthops."; case ipv4 { if-feature ipv4-tunnel; container ipv4-header { description "IPv4 header."; leaf src-ipv4-address { type inet:ipv4-address; mandatory true; description "The source IP address of the header."; } leaf dest-ipv4-address { type inet:ipv4-address; mandatory true; description "The destination IP address of the header."; } leaf protocol { type uint8; mandatory true; description "The protocol id of the header."; } leaf ttl { type uint8; description "The TTL of the header."; } leaf dscp { type uint8; description "The Differentiated Services Code Point (DSCP) field of the header."; } } // container ipv4-header } // case ipv4 case ipv6 { if-feature ipv6-tunnel; container ipv6-header { description "IPv6 header."; leaf src-ipv6-address { type inet:ipv6-address; mandatory true; description "The source IP address of the header."; } leaf dest-ipv6-address { type inet:ipv6-address; mandatory true; description "The destination IP address of the header."; } leaf next-header { type uint8; mandatory true; description "The next header of the IPv6 header."; } leaf traffic-class { type uint8; description "The traffic class value of the header."; } leaf flow-label { type inet:ipv6-flow-label; description "The flow label of the header."; } leaf hop-limit { type uint8 { range "1..255"; } description "The hop limit of the header."; } } // container ipv6-header } // case ipv6 case mpls { if-feature mpls-tunnel; container mpls-header { description "MPLS header."; list label-operations { key "label-oper-id"; description "Label operations."; leaf label-oper-id { type uint32; description "An optional identifier that points to a label operation."; } choice label-actions { description "Label action options."; container label-push { description "Label push operation."; leaf label { type uint32; mandatory true; description "The label to be pushed."; } leaf s-bit { type boolean; description "The s-bit ('Bottom of Stack' bit) of the label to be pushed."; } leaf tc-value { type uint8; description "The traffic class value of the label to be pushed."; } leaf ttl-value { type uint8; description "The TTL value of the label to be pushed."; } } // container label-push container label-swap { description "Label swap operation."; leaf in-label { type uint32; mandatory true; description "The label to be swapped."; } leaf out-label { type uint32; mandatory true; description "The out MPLS label."; } leaf ttl-action { type ttl-action-definition; description "The label TTL actions: - No-action - Copy to inner label - Decrease (the in-label) by 1 and copy to the out-label"; } } // container label-swap } // choice label-actions } // list label-operations } // container mpls-header } // case mpls case gre { if-feature gre-tunnel; container gre-header { description "GRE header."; choice dest-address-type { description "GRE options: IPv4 and IPv6"; leaf ipv4-dest { type inet:ipv4-address; mandatory true; description "The destination IP address of the GRE header."; } leaf ipv6-dest { type inet:ipv6-address; mandatory true; description "The destination IP address of the GRE header."; } } // choice dest-address-type leaf protocol-type { type uint16; mandatory true; description "The protocol type of the GRE header."; } leaf key { type uint64; description "The GRE key of the GRE header."; } } // container gre-header } // case gre case nvgre { if-feature nvgre-tunnel; container nvgre-header { description "NVGRE header."; choice nvgre-type { description "NVGRE can use either an IPv4 or an IPv6 header for encapsulation."; case ipv4 { leaf src-ipv4-address { type inet:ipv4-address; mandatory true; description "The source IP address of the header."; } leaf dest-ipv4-address { type inet:ipv4-address; mandatory true; description "The destination IP address of the header."; } leaf protocol { type uint8; mandatory true; description "The protocol id of the header."; } leaf ttl { type uint8; description "The TTL of the header."; } leaf dscp { type uint8; description "The Differentiated Services Code Point (DSCP) field of the header."; } } // case ipv4 case ipv6 { leaf src-ipv6-address { type inet:ipv6-address; mandatory true; description "The source IP address of the header."; } leaf dest-ipv6-address { type inet:ipv6-address; mandatory true; description "The destination IP address of the header."; } leaf next-header { type uint8; mandatory true; description "The next header of the IPv6 header."; } leaf traffic-class { type uint8; description "The traffic class value of the header."; } leaf flow-label { type inet:ipv6-flow-label; description "The flow label of the header."; } leaf hop-limit { type uint8 { range "1..255"; } description "The hop limit of the header."; } } // case ipv6 } // choice nvgre-type leaf virtual-subnet-id { type uint32; mandatory true; description "The subnet identifier of the NVGRE header."; } leaf flow-id { type uint8; description "The flow identifier of the NVGRE header."; } } // container nvgre-header } // case nvgre case vxlan { if-feature vxlan-tunnel; container vxlan-header { description "VXLAN header."; choice vxlan-type { description "NVGRE can use either an IPv4 or an IPv6 header for encapsulation."; case ipv4 { leaf src-ipv4-address { type inet:ipv4-address; mandatory true; description "The source IP address of the header."; } leaf dest-ipv4-address { type inet:ipv4-address; mandatory true; description "The destination IP address of the header."; } leaf protocol { type uint8; mandatory true; description "The protocol id of the header."; } leaf ttl { type uint8; description "The TTL of the header."; } leaf dscp { type uint8; description "The Differentiated Services Code Point (DSCP) field of the header."; } } // case ipv4 case ipv6 { leaf src-ipv6-address { type inet:ipv6-address; mandatory true; description "The source IP address of the header."; } leaf dest-ipv6-address { type inet:ipv6-address; mandatory true; description "The destination IP address of the header."; } leaf next-header { type uint8; mandatory true; description "The next header of the IPv6 header."; } leaf traffic-class { type uint8; description "The traffic class value of the header."; } leaf flow-label { type inet:ipv6-flow-label; description "The flow label of the header."; } leaf hop-limit { type uint8 { range "1..255"; } description "The hop limit of the header."; } } // case ipv6 } // choice vxlan-type leaf vxlan-identifier { type uint32; mandatory true; description "The VXLAN identifier of the VXLAN header."; } } // container vxlan-header } // case vxlan } // choice tunnel-type } // container tunnel-encapsulation } // case tunnel-encapsulation-nexthop case tunnel-decapsulation-nexthop { if-feature nexthop-tunnel; container tunnel-decapsulation { description "This is to specify the decapsulation of a tunnel header."; choice tunnel-type { description "Nexthop tunnel type options."; case ipv4 { if-feature ipv4-tunnel; container ipv4-decapsulation { description "IPv4 decapsulation."; leaf ipv4-decapsulation { type tunnel-decapsulation-action-definition; mandatory true; description "IPv4 decapsulation operations."; } leaf ttl-action { type ttl-action-definition; description "The TTL actions: no-action or copy to inner header."; } } // container ipv4-decapsulation } // case ipv4 case ipv6 { if-feature ipv6-tunnel; container ipv6-decapsulation { description "IPv6 decapsulation."; leaf ipv6-decapsulation { type tunnel-decapsulation-action-definition; mandatory true; description "IPv6 decapsulation operations."; } leaf hop-limit-action { type hop-limit-action-definition; description "The hop limit actions: no-action or copy to inner header."; } } // container ipv6-decapsulation } // case ipv6 case mpls { if-feature mpls-tunnel; container label-pop { description "MPLS decapsulation."; leaf label-pop { type mpls-label-action-definition; mandatory true; description "Pop a label from the label stack."; } leaf ttl-action { type ttl-action-definition; description "The label TTL action."; } } // container label-pop } // case mpls } // choice tunnel-type } // container tunnel-decapsulation } // case tunnel-decapsulation-nexthop case logical-tunnel-nexthop { if-feature nexthop-tunnel; container logical-tunnel { description "This can be an MPLS Label Switched Path (LSP) or a GRE tunnel (or others as defined in this document) that is represented by a unique identifier (e.g., name)."; leaf tunnel-type { type tunnel-type-definition; mandatory true; description "A tunnel type."; } leaf tunnel-name { type string; mandatory true; description "A tunnel name that points to a logical tunnel."; } } // container logical-tunnel } // case logical-tunnel-nexthop leaf rib-name { type string; description "A nexthop pointing to a RIB indicates that the route lookup needs to continue in the specified RIB. This is a way to perform chained lookups."; } leaf nexthop-ref { type nexthop-ref; mandatory true; description "A nexthop reference that points to a nexthop."; } } // choice nexthop-base-type } // container nexthop-base case nexthop-chain { if-feature nexthop-chain; container nexthop-chain { description "A chain nexthop."; list nexthop-list { key "nexthop-member-id"; description "A list of nexthops."; leaf nexthop-member-id { type uint32; mandatory true; description "A nexthop identifier that points to a nexthop list member. A nexthop list member is a nexthop."; } } // list nexthop-list } // container nexthop-chain } // case nexthop-chain case nexthop-replicate { if-feature nexthop-replicate; container nexthop-replicate { description "A replicate nexthop."; list nexthop-list { key "nexthop-member-id"; description "A list of nexthops."; leaf nexthop-member-id { type uint32; mandatory true; description "A nexthop identifier that points to a nexthop list member. A nexthop list member is a nexthop."; } } // list nexthop-list } // container nexthop-replicate } // case nexthop-replicate case nexthop-protection { if-feature nexthop-protection; container nexthop-protection { description "A protection nexthop."; list nexthop-list { key "nexthop-member-id"; description "A list of nexthop."; leaf nexthop-member-id { type uint32; mandatory true; description "A nexthop identifier that points to a nexthop list member. A nexthop list member is a nexthop."; } leaf nexthop-preference { type nexthop-preference-definition; mandatory true; description "Nexthop-preference is used for protection schemes. It is an integer value between 1 and 99. Lower values are more preferred. To download a primary/standby/tertiary group to the FIB, the nexthops that are resolved and are most preferred are selected."; } } // list nexthop-list } // container nexthop-protection } // case nexthop-protection case nexthop-load-balance { if-feature nexthop-load-balance; container nexthop-lb { description "A load-balance nexthop."; list nexthop-list { key "nexthop-member-id"; description "A list of nexthop."; leaf nexthop-member-id { type uint32; mandatory true; description "A nexthop identifier that points to a nexthop list member. A nexthop list member is a nexthop."; } leaf nexthop-lb-weight { type nexthop-lb-weight-definition; mandatory true; description "The weight of a nexthop of the load-balance nexthops."; } } // list nexthop-list } // container nexthop-lb } // case nexthop-load-balance } // choice nexthop-type } // container input-nexthop container update-parameters-nexthop { description "Update options: 1. update the nexthop 2. update the route attributes 3. update the route-vendor-attributes"; choice update-options { description "Update options: 1. update the nexthop 2. update the route attributes 3. update the route-vendor-attributes"; container updated-nexthop { description "The nexthop used for updating."; leaf nexthop-id { type uint32; description "An identifier that refers to a nexthop."; } leaf sharing-flag { type boolean; description "To indicate whether a nexthop is sharable or non-sharable: true - sharable (which means the nexthop can be shared with other routes) false - non-sharable (which means the nexthop can not be shared with other routes)"; } choice nexthop-type { description "Nexthop type options."; container nexthop-base { description "The base nexthop."; choice nexthop-base-type { description "Nexthop base type options."; leaf special { type special-nexthop-definition; description "A special nexthop."; } leaf outgoing-interface { type if:interface-ref; mandatory true; description "The nexthop is an outgoing interface."; } leaf ipv4-address { type inet:ipv4-address; mandatory true; description "The nexthop is an IPv4 address."; } leaf ipv6-address { type inet:ipv6-address; mandatory true; description "The nexthop is an IPv6 address."; } container egress-interface-ipv4-address { description "The nexthop is an egress-interface and an IP address. This can be used in cases where, e.g., the IP address is a link-local address."; leaf outgoing-interface { type if:interface-ref; mandatory true; description "Name of the outgoing interface."; } leaf ipv4-address { type inet:ipv4-address; mandatory true; description "The nexthop points to an interface with an IPv4 address."; } } // container egress-interface-ipv4-address container egress-interface-ipv6-address { description "The nexthop is an egress-interface and an IP address. This can be used in cases where, e.g., the IP address is a link-local address."; leaf outgoing-interface { type if:interface-ref; mandatory true; description "Name of the outgoing interface."; } leaf ipv6-address { type inet:ipv6-address; mandatory true; description "The nexthop points to an interface with an IPv6 address."; } } // container egress-interface-ipv6-address container egress-interface-mac-address { description "The egress-interface must be an Ethernet interface. Address resolution is not required for this nexthop."; leaf outgoing-interface { type if:interface-ref; mandatory true; description "Name of the outgoing interface."; } leaf ieee-mac-address { type yang:mac-address; mandatory true; description "The nexthop points to an interface with a specific MAC address."; } } // container egress-interface-mac-address case tunnel-encapsulation-nexthop { if-feature nexthop-tunnel; container tunnel-encapsulation { description "This can be an encapsulation representing an IP tunnel, MPLS tunnel, or others as defined in the info model. An optional egress-interface can be chained to the tunnel encapsulation to indicate which interface to send the packet out on. The egress-interface is useful when the network device contains Ethernet interfaces and one needs to perform address resolution for the IP packet."; choice tunnel-type { description "Tunnel options for nexthops."; case ipv4 { if-feature ipv4-tunnel; container ipv4-header { description "IPv4 header."; leaf src-ipv4-address { type inet:ipv4-address; mandatory true; description "The source IP address of the header."; } leaf dest-ipv4-address { type inet:ipv4-address; mandatory true; description "The destination IP address of the header."; } leaf protocol { type uint8; mandatory true; description "The protocol id of the header."; } leaf ttl { type uint8; description "The TTL of the header."; } leaf dscp { type uint8; description "The Differentiated Services Code Point (DSCP) field of the header."; } } // container ipv4-header } // case ipv4 case ipv6 { if-feature ipv6-tunnel; container ipv6-header { description "IPv6 header."; leaf src-ipv6-address { type inet:ipv6-address; mandatory true; description "The source IP address of the header."; } leaf dest-ipv6-address { type inet:ipv6-address; mandatory true; description "The destination IP address of the header."; } leaf next-header { type uint8; mandatory true; description "The next header of the IPv6 header."; } leaf traffic-class { type uint8; description "The traffic class value of the header."; } leaf flow-label { type inet:ipv6-flow-label; description "The flow label of the header."; } leaf hop-limit { type uint8 { range "1..255"; } description "The hop limit of the header."; } } // container ipv6-header } // case ipv6 case mpls { if-feature mpls-tunnel; container mpls-header { description "MPLS header."; list label-operations { key "label-oper-id"; description "Label operations."; leaf label-oper-id { type uint32; description "An optional identifier that points to a label operation."; } choice label-actions { description "Label action options."; container label-push { description "Label push operation."; leaf label { type uint32; mandatory true; description "The label to be pushed."; } leaf s-bit { type boolean; description "The s-bit ('Bottom of Stack' bit) of the label to be pushed."; } leaf tc-value { type uint8; description "The traffic class value of the label to be pushed."; } leaf ttl-value { type uint8; description "The TTL value of the label to be pushed."; } } // container label-push container label-swap { description "Label swap operation."; leaf in-label { type uint32; mandatory true; description "The label to be swapped."; } leaf out-label { type uint32; mandatory true; description "The out MPLS label."; } leaf ttl-action { type ttl-action-definition; description "The label TTL actions: - No-action - Copy to inner label - Decrease (the in-label) by 1 and copy to the out-label"; } } // container label-swap } // choice label-actions } // list label-operations } // container mpls-header } // case mpls case gre { if-feature gre-tunnel; container gre-header { description "GRE header."; choice dest-address-type { description "GRE options: IPv4 and IPv6"; leaf ipv4-dest { type inet:ipv4-address; mandatory true; description "The destination IP address of the GRE header."; } leaf ipv6-dest { type inet:ipv6-address; mandatory true; description "The destination IP address of the GRE header."; } } // choice dest-address-type leaf protocol-type { type uint16; mandatory true; description "The protocol type of the GRE header."; } leaf key { type uint64; description "The GRE key of the GRE header."; } } // container gre-header } // case gre case nvgre { if-feature nvgre-tunnel; container nvgre-header { description "NVGRE header."; choice nvgre-type { description "NVGRE can use either an IPv4 or an IPv6 header for encapsulation."; case ipv4 { leaf src-ipv4-address { type inet:ipv4-address; mandatory true; description "The source IP address of the header."; } leaf dest-ipv4-address { type inet:ipv4-address; mandatory true; description "The destination IP address of the header."; } leaf protocol { type uint8; mandatory true; description "The protocol id of the header."; } leaf ttl { type uint8; description "The TTL of the header."; } leaf dscp { type uint8; description "The Differentiated Services Code Point (DSCP) field of the header."; } } // case ipv4 case ipv6 { leaf src-ipv6-address { type inet:ipv6-address; mandatory true; description "The source IP address of the header."; } leaf dest-ipv6-address { type inet:ipv6-address; mandatory true; description "The destination IP address of the header."; } leaf next-header { type uint8; mandatory true; description "The next header of the IPv6 header."; } leaf traffic-class { type uint8; description "The traffic class value of the header."; } leaf flow-label { type inet:ipv6-flow-label; description "The flow label of the header."; } leaf hop-limit { type uint8 { range "1..255"; } description "The hop limit of the header."; } } // case ipv6 } // choice nvgre-type leaf virtual-subnet-id { type uint32; mandatory true; description "The subnet identifier of the NVGRE header."; } leaf flow-id { type uint8; description "The flow identifier of the NVGRE header."; } } // container nvgre-header } // case nvgre case vxlan { if-feature vxlan-tunnel; container vxlan-header { description "VXLAN header."; choice vxlan-type { description "NVGRE can use either an IPv4 or an IPv6 header for encapsulation."; case ipv4 { leaf src-ipv4-address { type inet:ipv4-address; mandatory true; description "The source IP address of the header."; } leaf dest-ipv4-address { type inet:ipv4-address; mandatory true; description "The destination IP address of the header."; } leaf protocol { type uint8; mandatory true; description "The protocol id of the header."; } leaf ttl { type uint8; description "The TTL of the header."; } leaf dscp { type uint8; description "The Differentiated Services Code Point (DSCP) field of the header."; } } // case ipv4 case ipv6 { leaf src-ipv6-address { type inet:ipv6-address; mandatory true; description "The source IP address of the header."; } leaf dest-ipv6-address { type inet:ipv6-address; mandatory true; description "The destination IP address of the header."; } leaf next-header { type uint8; mandatory true; description "The next header of the IPv6 header."; } leaf traffic-class { type uint8; description "The traffic class value of the header."; } leaf flow-label { type inet:ipv6-flow-label; description "The flow label of the header."; } leaf hop-limit { type uint8 { range "1..255"; } description "The hop limit of the header."; } } // case ipv6 } // choice vxlan-type leaf vxlan-identifier { type uint32; mandatory true; description "The VXLAN identifier of the VXLAN header."; } } // container vxlan-header } // case vxlan } // choice tunnel-type } // container tunnel-encapsulation } // case tunnel-encapsulation-nexthop case tunnel-decapsulation-nexthop { if-feature nexthop-tunnel; container tunnel-decapsulation { description "This is to specify the decapsulation of a tunnel header."; choice tunnel-type { description "Nexthop tunnel type options."; case ipv4 { if-feature ipv4-tunnel; container ipv4-decapsulation { description "IPv4 decapsulation."; leaf ipv4-decapsulation { type tunnel-decapsulation-action-definition; mandatory true; description "IPv4 decapsulation operations."; } leaf ttl-action { type ttl-action-definition; description "The TTL actions: no-action or copy to inner header."; } } // container ipv4-decapsulation } // case ipv4 case ipv6 { if-feature ipv6-tunnel; container ipv6-decapsulation { description "IPv6 decapsulation."; leaf ipv6-decapsulation { type tunnel-decapsulation-action-definition; mandatory true; description "IPv6 decapsulation operations."; } leaf hop-limit-action { type hop-limit-action-definition; description "The hop limit actions: no-action or copy to inner header."; } } // container ipv6-decapsulation } // case ipv6 case mpls { if-feature mpls-tunnel; container label-pop { description "MPLS decapsulation."; leaf label-pop { type mpls-label-action-definition; mandatory true; description "Pop a label from the label stack."; } leaf ttl-action { type ttl-action-definition; description "The label TTL action."; } } // container label-pop } // case mpls } // choice tunnel-type } // container tunnel-decapsulation } // case tunnel-decapsulation-nexthop case logical-tunnel-nexthop { if-feature nexthop-tunnel; container logical-tunnel { description "This can be an MPLS Label Switched Path (LSP) or a GRE tunnel (or others as defined in this document) that is represented by a unique identifier (e.g., name)."; leaf tunnel-type { type tunnel-type-definition; mandatory true; description "A tunnel type."; } leaf tunnel-name { type string; mandatory true; description "A tunnel name that points to a logical tunnel."; } } // container logical-tunnel } // case logical-tunnel-nexthop leaf rib-name { type string; description "A nexthop pointing to a RIB indicates that the route lookup needs to continue in the specified RIB. This is a way to perform chained lookups."; } leaf nexthop-ref { type nexthop-ref; mandatory true; description "A nexthop reference that points to a nexthop."; } } // choice nexthop-base-type } // container nexthop-base case nexthop-chain { if-feature nexthop-chain; container nexthop-chain { description "A chain nexthop."; list nexthop-list { key "nexthop-member-id"; description "A list of nexthops."; leaf nexthop-member-id { type uint32; mandatory true; description "A nexthop identifier that points to a nexthop list member. A nexthop list member is a nexthop."; } } // list nexthop-list } // container nexthop-chain } // case nexthop-chain case nexthop-replicate { if-feature nexthop-replicate; container nexthop-replicate { description "A replicate nexthop."; list nexthop-list { key "nexthop-member-id"; description "A list of nexthops."; leaf nexthop-member-id { type uint32; mandatory true; description "A nexthop identifier that points to a nexthop list member. A nexthop list member is a nexthop."; } } // list nexthop-list } // container nexthop-replicate } // case nexthop-replicate case nexthop-protection { if-feature nexthop-protection; container nexthop-protection { description "A protection nexthop."; list nexthop-list { key "nexthop-member-id"; description "A list of nexthop."; leaf nexthop-member-id { type uint32; mandatory true; description "A nexthop identifier that points to a nexthop list member. A nexthop list member is a nexthop."; } leaf nexthop-preference { type nexthop-preference-definition; mandatory true; description "Nexthop-preference is used for protection schemes. It is an integer value between 1 and 99. Lower values are more preferred. To download a primary/standby/tertiary group to the FIB, the nexthops that are resolved and are most preferred are selected."; } } // list nexthop-list } // container nexthop-protection } // case nexthop-protection case nexthop-load-balance { if-feature nexthop-load-balance; container nexthop-lb { description "A load-balance nexthop."; list nexthop-list { key "nexthop-member-id"; description "A list of nexthop."; leaf nexthop-member-id { type uint32; mandatory true; description "A nexthop identifier that points to a nexthop list member. A nexthop list member is a nexthop."; } leaf nexthop-lb-weight { type nexthop-lb-weight-definition; mandatory true; description "The weight of a nexthop of the load-balance nexthops."; } } // list nexthop-list } // container nexthop-lb } // case nexthop-load-balance } // choice nexthop-type } // container updated-nexthop container updated-route-attr { description "The route attributes used for updating."; leaf route-preference { type uint32; mandatory true; description "ROUTE_PREFERENCE: This is a numerical value that allows for comparing routes from different protocols. Static configuration is also considered a protocol for the purpose of this field. It is also known as administrative-distance. The lower the value, the higher the preference."; } leaf local-only { type boolean; mandatory true; description "Indicate whether the attribute is local only."; } container address-family-route-attributes { description "Address-family-related route attributes."; choice route-type { description "Address-family-related route attributes. Future documents should specify these attributes by augmenting the cases in this choice."; case ip-route-attributes { } // case ip-route-attributes case mpls-route-attributes { } // case mpls-route-attributes case ethernet-route-attributes { } // case ethernet-route-attributes } // choice route-type } // container address-family-route-attributes } // container updated-route-attr container updated-route-vendor-attr { description "The vendor route attributes used for updating."; } // container updated-route-vendor-attr } // choice update-options } // container update-parameters-nexthop } // case match-nexthop } // choice match-options } output { leaf success-count { type uint32; mandatory true; description "The numbers of routes that are successfully added/deleted/updated."; } leaf failed-count { type uint32; mandatory true; description "The numbers of the routes that fail to be added/deleted/updated."; } container failure-detail { description "The failure detail reflects the reason why a route operation fails. It is an array that includes the route index and error code of the failed route."; list failed-routes { key "route-index"; description "The list of failed routes."; leaf route-index { type uint32; description "The route index of the failed route."; } leaf error-code { type uint32; description "The error code that reflects the failure reason. 0 - Reserved 1 - Trying to add a repeat route 2 - Trying to delete or update a route that does not exist 3 - Malformed route attributes"; } } // list failed-routes } // container failure-detail } } // rpc route-update rpc nh-add { description "To add a nexthop to a RIB. Inputs parameters: 1. rib-name 2. nexthop Actions: Add the nexthop to the RIB Outputs: 1. Operation result: true - success false - failed 2. nexthop identifier"; input { leaf rib-name { type string; mandatory true; description "A reference to the name of a RIB."; } leaf nexthop-id { type uint32; description "An identifier that refers to a nexthop."; } leaf sharing-flag { type boolean; description "To indicate whether a nexthop is sharable or non-sharable: true - sharable (which means the nexthop can be shared with other routes) false - non-sharable (which means the nexthop can not be shared with other routes)"; } choice nexthop-type { description "Nexthop type options."; container nexthop-base { description "The base nexthop."; choice nexthop-base-type { description "Nexthop base type options."; leaf special { type special-nexthop-definition; description "A special nexthop."; } leaf outgoing-interface { type if:interface-ref; mandatory true; description "The nexthop is an outgoing interface."; } leaf ipv4-address { type inet:ipv4-address; mandatory true; description "The nexthop is an IPv4 address."; } leaf ipv6-address { type inet:ipv6-address; mandatory true; description "The nexthop is an IPv6 address."; } container egress-interface-ipv4-address { description "The nexthop is an egress-interface and an IP address. This can be used in cases where, e.g., the IP address is a link-local address."; leaf outgoing-interface { type if:interface-ref; mandatory true; description "Name of the outgoing interface."; } leaf ipv4-address { type inet:ipv4-address; mandatory true; description "The nexthop points to an interface with an IPv4 address."; } } // container egress-interface-ipv4-address container egress-interface-ipv6-address { description "The nexthop is an egress-interface and an IP address. This can be used in cases where, e.g., the IP address is a link-local address."; leaf outgoing-interface { type if:interface-ref; mandatory true; description "Name of the outgoing interface."; } leaf ipv6-address { type inet:ipv6-address; mandatory true; description "The nexthop points to an interface with an IPv6 address."; } } // container egress-interface-ipv6-address container egress-interface-mac-address { description "The egress-interface must be an Ethernet interface. Address resolution is not required for this nexthop."; leaf outgoing-interface { type if:interface-ref; mandatory true; description "Name of the outgoing interface."; } leaf ieee-mac-address { type yang:mac-address; mandatory true; description "The nexthop points to an interface with a specific MAC address."; } } // container egress-interface-mac-address case tunnel-encapsulation-nexthop { if-feature nexthop-tunnel; container tunnel-encapsulation { description "This can be an encapsulation representing an IP tunnel, MPLS tunnel, or others as defined in the info model. An optional egress-interface can be chained to the tunnel encapsulation to indicate which interface to send the packet out on. The egress-interface is useful when the network device contains Ethernet interfaces and one needs to perform address resolution for the IP packet."; choice tunnel-type { description "Tunnel options for nexthops."; case ipv4 { if-feature ipv4-tunnel; container ipv4-header { description "IPv4 header."; leaf src-ipv4-address { type inet:ipv4-address; mandatory true; description "The source IP address of the header."; } leaf dest-ipv4-address { type inet:ipv4-address; mandatory true; description "The destination IP address of the header."; } leaf protocol { type uint8; mandatory true; description "The protocol id of the header."; } leaf ttl { type uint8; description "The TTL of the header."; } leaf dscp { type uint8; description "The Differentiated Services Code Point (DSCP) field of the header."; } } // container ipv4-header } // case ipv4 case ipv6 { if-feature ipv6-tunnel; container ipv6-header { description "IPv6 header."; leaf src-ipv6-address { type inet:ipv6-address; mandatory true; description "The source IP address of the header."; } leaf dest-ipv6-address { type inet:ipv6-address; mandatory true; description "The destination IP address of the header."; } leaf next-header { type uint8; mandatory true; description "The next header of the IPv6 header."; } leaf traffic-class { type uint8; description "The traffic class value of the header."; } leaf flow-label { type inet:ipv6-flow-label; description "The flow label of the header."; } leaf hop-limit { type uint8 { range "1..255"; } description "The hop limit of the header."; } } // container ipv6-header } // case ipv6 case mpls { if-feature mpls-tunnel; container mpls-header { description "MPLS header."; list label-operations { key "label-oper-id"; description "Label operations."; leaf label-oper-id { type uint32; description "An optional identifier that points to a label operation."; } choice label-actions { description "Label action options."; container label-push { description "Label push operation."; leaf label { type uint32; mandatory true; description "The label to be pushed."; } leaf s-bit { type boolean; description "The s-bit ('Bottom of Stack' bit) of the label to be pushed."; } leaf tc-value { type uint8; description "The traffic class value of the label to be pushed."; } leaf ttl-value { type uint8; description "The TTL value of the label to be pushed."; } } // container label-push container label-swap { description "Label swap operation."; leaf in-label { type uint32; mandatory true; description "The label to be swapped."; } leaf out-label { type uint32; mandatory true; description "The out MPLS label."; } leaf ttl-action { type ttl-action-definition; description "The label TTL actions: - No-action - Copy to inner label - Decrease (the in-label) by 1 and copy to the out-label"; } } // container label-swap } // choice label-actions } // list label-operations } // container mpls-header } // case mpls case gre { if-feature gre-tunnel; container gre-header { description "GRE header."; choice dest-address-type { description "GRE options: IPv4 and IPv6"; leaf ipv4-dest { type inet:ipv4-address; mandatory true; description "The destination IP address of the GRE header."; } leaf ipv6-dest { type inet:ipv6-address; mandatory true; description "The destination IP address of the GRE header."; } } // choice dest-address-type leaf protocol-type { type uint16; mandatory true; description "The protocol type of the GRE header."; } leaf key { type uint64; description "The GRE key of the GRE header."; } } // container gre-header } // case gre case nvgre { if-feature nvgre-tunnel; container nvgre-header { description "NVGRE header."; choice nvgre-type { description "NVGRE can use either an IPv4 or an IPv6 header for encapsulation."; case ipv4 { leaf src-ipv4-address { type inet:ipv4-address; mandatory true; description "The source IP address of the header."; } leaf dest-ipv4-address { type inet:ipv4-address; mandatory true; description "The destination IP address of the header."; } leaf protocol { type uint8; mandatory true; description "The protocol id of the header."; } leaf ttl { type uint8; description "The TTL of the header."; } leaf dscp { type uint8; description "The Differentiated Services Code Point (DSCP) field of the header."; } } // case ipv4 case ipv6 { leaf src-ipv6-address { type inet:ipv6-address; mandatory true; description "The source IP address of the header."; } leaf dest-ipv6-address { type inet:ipv6-address; mandatory true; description "The destination IP address of the header."; } leaf next-header { type uint8; mandatory true; description "The next header of the IPv6 header."; } leaf traffic-class { type uint8; description "The traffic class value of the header."; } leaf flow-label { type inet:ipv6-flow-label; description "The flow label of the header."; } leaf hop-limit { type uint8 { range "1..255"; } description "The hop limit of the header."; } } // case ipv6 } // choice nvgre-type leaf virtual-subnet-id { type uint32; mandatory true; description "The subnet identifier of the NVGRE header."; } leaf flow-id { type uint8; description "The flow identifier of the NVGRE header."; } } // container nvgre-header } // case nvgre case vxlan { if-feature vxlan-tunnel; container vxlan-header { description "VXLAN header."; choice vxlan-type { description "NVGRE can use either an IPv4 or an IPv6 header for encapsulation."; case ipv4 { leaf src-ipv4-address { type inet:ipv4-address; mandatory true; description "The source IP address of the header."; } leaf dest-ipv4-address { type inet:ipv4-address; mandatory true; description "The destination IP address of the header."; } leaf protocol { type uint8; mandatory true; description "The protocol id of the header."; } leaf ttl { type uint8; description "The TTL of the header."; } leaf dscp { type uint8; description "The Differentiated Services Code Point (DSCP) field of the header."; } } // case ipv4 case ipv6 { leaf src-ipv6-address { type inet:ipv6-address; mandatory true; description "The source IP address of the header."; } leaf dest-ipv6-address { type inet:ipv6-address; mandatory true; description "The destination IP address of the header."; } leaf next-header { type uint8; mandatory true; description "The next header of the IPv6 header."; } leaf traffic-class { type uint8; description "The traffic class value of the header."; } leaf flow-label { type inet:ipv6-flow-label; description "The flow label of the header."; } leaf hop-limit { type uint8 { range "1..255"; } description "The hop limit of the header."; } } // case ipv6 } // choice vxlan-type leaf vxlan-identifier { type uint32; mandatory true; description "The VXLAN identifier of the VXLAN header."; } } // container vxlan-header } // case vxlan } // choice tunnel-type } // container tunnel-encapsulation } // case tunnel-encapsulation-nexthop case tunnel-decapsulation-nexthop { if-feature nexthop-tunnel; container tunnel-decapsulation { description "This is to specify the decapsulation of a tunnel header."; choice tunnel-type { description "Nexthop tunnel type options."; case ipv4 { if-feature ipv4-tunnel; container ipv4-decapsulation { description "IPv4 decapsulation."; leaf ipv4-decapsulation { type tunnel-decapsulation-action-definition; mandatory true; description "IPv4 decapsulation operations."; } leaf ttl-action { type ttl-action-definition; description "The TTL actions: no-action or copy to inner header."; } } // container ipv4-decapsulation } // case ipv4 case ipv6 { if-feature ipv6-tunnel; container ipv6-decapsulation { description "IPv6 decapsulation."; leaf ipv6-decapsulation { type tunnel-decapsulation-action-definition; mandatory true; description "IPv6 decapsulation operations."; } leaf hop-limit-action { type hop-limit-action-definition; description "The hop limit actions: no-action or copy to inner header."; } } // container ipv6-decapsulation } // case ipv6 case mpls { if-feature mpls-tunnel; container label-pop { description "MPLS decapsulation."; leaf label-pop { type mpls-label-action-definition; mandatory true; description "Pop a label from the label stack."; } leaf ttl-action { type ttl-action-definition; description "The label TTL action."; } } // container label-pop } // case mpls } // choice tunnel-type } // container tunnel-decapsulation } // case tunnel-decapsulation-nexthop case logical-tunnel-nexthop { if-feature nexthop-tunnel; container logical-tunnel { description "This can be an MPLS Label Switched Path (LSP) or a GRE tunnel (or others as defined in this document) that is represented by a unique identifier (e.g., name)."; leaf tunnel-type { type tunnel-type-definition; mandatory true; description "A tunnel type."; } leaf tunnel-name { type string; mandatory true; description "A tunnel name that points to a logical tunnel."; } } // container logical-tunnel } // case logical-tunnel-nexthop leaf rib-name { type string; description "A nexthop pointing to a RIB indicates that the route lookup needs to continue in the specified RIB. This is a way to perform chained lookups."; } leaf nexthop-ref { type nexthop-ref; mandatory true; description "A nexthop reference that points to a nexthop."; } } // choice nexthop-base-type } // container nexthop-base case nexthop-chain { if-feature nexthop-chain; container nexthop-chain { description "A chain nexthop."; list nexthop-list { key "nexthop-member-id"; description "A list of nexthops."; leaf nexthop-member-id { type uint32; mandatory true; description "A nexthop identifier that points to a nexthop list member. A nexthop list member is a nexthop."; } } // list nexthop-list } // container nexthop-chain } // case nexthop-chain case nexthop-replicate { if-feature nexthop-replicate; container nexthop-replicate { description "A replicate nexthop."; list nexthop-list { key "nexthop-member-id"; description "A list of nexthops."; leaf nexthop-member-id { type uint32; mandatory true; description "A nexthop identifier that points to a nexthop list member. A nexthop list member is a nexthop."; } } // list nexthop-list } // container nexthop-replicate } // case nexthop-replicate case nexthop-protection { if-feature nexthop-protection; container nexthop-protection { description "A protection nexthop."; list nexthop-list { key "nexthop-member-id"; description "A list of nexthop."; leaf nexthop-member-id { type uint32; mandatory true; description "A nexthop identifier that points to a nexthop list member. A nexthop list member is a nexthop."; } leaf nexthop-preference { type nexthop-preference-definition; mandatory true; description "Nexthop-preference is used for protection schemes. It is an integer value between 1 and 99. Lower values are more preferred. To download a primary/standby/tertiary group to the FIB, the nexthops that are resolved and are most preferred are selected."; } } // list nexthop-list } // container nexthop-protection } // case nexthop-protection case nexthop-load-balance { if-feature nexthop-load-balance; container nexthop-lb { description "A load-balance nexthop."; list nexthop-list { key "nexthop-member-id"; description "A list of nexthop."; leaf nexthop-member-id { type uint32; mandatory true; description "A nexthop identifier that points to a nexthop list member. A nexthop list member is a nexthop."; } leaf nexthop-lb-weight { type nexthop-lb-weight-definition; mandatory true; description "The weight of a nexthop of the load-balance nexthops."; } } // list nexthop-list } // container nexthop-lb } // case nexthop-load-balance } // choice nexthop-type } output { leaf result { type boolean; mandatory true; description "Return the result of the rib-add operation: true - success false - failed"; } leaf reason { type string; description "The specific reason that caused the failure."; } leaf nexthop-id { type uint32; description "A nexthop identifier that is allocated to the nexthop."; } } } // rpc nh-add rpc nh-delete { description "To delete a nexthop from a RIB"; input { leaf rib-name { type string; mandatory true; description "A reference to the name of a RIB."; } leaf nexthop-id { type uint32; description "An identifier that refers to a nexthop."; } leaf sharing-flag { type boolean; description "To indicate whether a nexthop is sharable or non-sharable: true - sharable (which means the nexthop can be shared with other routes) false - non-sharable (which means the nexthop can not be shared with other routes)"; } choice nexthop-type { description "Nexthop type options."; container nexthop-base { description "The base nexthop."; choice nexthop-base-type { description "Nexthop base type options."; leaf special { type special-nexthop-definition; description "A special nexthop."; } leaf outgoing-interface { type if:interface-ref; mandatory true; description "The nexthop is an outgoing interface."; } leaf ipv4-address { type inet:ipv4-address; mandatory true; description "The nexthop is an IPv4 address."; } leaf ipv6-address { type inet:ipv6-address; mandatory true; description "The nexthop is an IPv6 address."; } container egress-interface-ipv4-address { description "The nexthop is an egress-interface and an IP address. This can be used in cases where, e.g., the IP address is a link-local address."; leaf outgoing-interface { type if:interface-ref; mandatory true; description "Name of the outgoing interface."; } leaf ipv4-address { type inet:ipv4-address; mandatory true; description "The nexthop points to an interface with an IPv4 address."; } } // container egress-interface-ipv4-address container egress-interface-ipv6-address { description "The nexthop is an egress-interface and an IP address. This can be used in cases where, e.g., the IP address is a link-local address."; leaf outgoing-interface { type if:interface-ref; mandatory true; description "Name of the outgoing interface."; } leaf ipv6-address { type inet:ipv6-address; mandatory true; description "The nexthop points to an interface with an IPv6 address."; } } // container egress-interface-ipv6-address container egress-interface-mac-address { description "The egress-interface must be an Ethernet interface. Address resolution is not required for this nexthop."; leaf outgoing-interface { type if:interface-ref; mandatory true; description "Name of the outgoing interface."; } leaf ieee-mac-address { type yang:mac-address; mandatory true; description "The nexthop points to an interface with a specific MAC address."; } } // container egress-interface-mac-address case tunnel-encapsulation-nexthop { if-feature nexthop-tunnel; container tunnel-encapsulation { description "This can be an encapsulation representing an IP tunnel, MPLS tunnel, or others as defined in the info model. An optional egress-interface can be chained to the tunnel encapsulation to indicate which interface to send the packet out on. The egress-interface is useful when the network device contains Ethernet interfaces and one needs to perform address resolution for the IP packet."; choice tunnel-type { description "Tunnel options for nexthops."; case ipv4 { if-feature ipv4-tunnel; container ipv4-header { description "IPv4 header."; leaf src-ipv4-address { type inet:ipv4-address; mandatory true; description "The source IP address of the header."; } leaf dest-ipv4-address { type inet:ipv4-address; mandatory true; description "The destination IP address of the header."; } leaf protocol { type uint8; mandatory true; description "The protocol id of the header."; } leaf ttl { type uint8; description "The TTL of the header."; } leaf dscp { type uint8; description "The Differentiated Services Code Point (DSCP) field of the header."; } } // container ipv4-header } // case ipv4 case ipv6 { if-feature ipv6-tunnel; container ipv6-header { description "IPv6 header."; leaf src-ipv6-address { type inet:ipv6-address; mandatory true; description "The source IP address of the header."; } leaf dest-ipv6-address { type inet:ipv6-address; mandatory true; description "The destination IP address of the header."; } leaf next-header { type uint8; mandatory true; description "The next header of the IPv6 header."; } leaf traffic-class { type uint8; description "The traffic class value of the header."; } leaf flow-label { type inet:ipv6-flow-label; description "The flow label of the header."; } leaf hop-limit { type uint8 { range "1..255"; } description "The hop limit of the header."; } } // container ipv6-header } // case ipv6 case mpls { if-feature mpls-tunnel; container mpls-header { description "MPLS header."; list label-operations { key "label-oper-id"; description "Label operations."; leaf label-oper-id { type uint32; description "An optional identifier that points to a label operation."; } choice label-actions { description "Label action options."; container label-push { description "Label push operation."; leaf label { type uint32; mandatory true; description "The label to be pushed."; } leaf s-bit { type boolean; description "The s-bit ('Bottom of Stack' bit) of the label to be pushed."; } leaf tc-value { type uint8; description "The traffic class value of the label to be pushed."; } leaf ttl-value { type uint8; description "The TTL value of the label to be pushed."; } } // container label-push container label-swap { description "Label swap operation."; leaf in-label { type uint32; mandatory true; description "The label to be swapped."; } leaf out-label { type uint32; mandatory true; description "The out MPLS label."; } leaf ttl-action { type ttl-action-definition; description "The label TTL actions: - No-action - Copy to inner label - Decrease (the in-label) by 1 and copy to the out-label"; } } // container label-swap } // choice label-actions } // list label-operations } // container mpls-header } // case mpls case gre { if-feature gre-tunnel; container gre-header { description "GRE header."; choice dest-address-type { description "GRE options: IPv4 and IPv6"; leaf ipv4-dest { type inet:ipv4-address; mandatory true; description "The destination IP address of the GRE header."; } leaf ipv6-dest { type inet:ipv6-address; mandatory true; description "The destination IP address of the GRE header."; } } // choice dest-address-type leaf protocol-type { type uint16; mandatory true; description "The protocol type of the GRE header."; } leaf key { type uint64; description "The GRE key of the GRE header."; } } // container gre-header } // case gre case nvgre { if-feature nvgre-tunnel; container nvgre-header { description "NVGRE header."; choice nvgre-type { description "NVGRE can use either an IPv4 or an IPv6 header for encapsulation."; case ipv4 { leaf src-ipv4-address { type inet:ipv4-address; mandatory true; description "The source IP address of the header."; } leaf dest-ipv4-address { type inet:ipv4-address; mandatory true; description "The destination IP address of the header."; } leaf protocol { type uint8; mandatory true; description "The protocol id of the header."; } leaf ttl { type uint8; description "The TTL of the header."; } leaf dscp { type uint8; description "The Differentiated Services Code Point (DSCP) field of the header."; } } // case ipv4 case ipv6 { leaf src-ipv6-address { type inet:ipv6-address; mandatory true; description "The source IP address of the header."; } leaf dest-ipv6-address { type inet:ipv6-address; mandatory true; description "The destination IP address of the header."; } leaf next-header { type uint8; mandatory true; description "The next header of the IPv6 header."; } leaf traffic-class { type uint8; description "The traffic class value of the header."; } leaf flow-label { type inet:ipv6-flow-label; description "The flow label of the header."; } leaf hop-limit { type uint8 { range "1..255"; } description "The hop limit of the header."; } } // case ipv6 } // choice nvgre-type leaf virtual-subnet-id { type uint32; mandatory true; description "The subnet identifier of the NVGRE header."; } leaf flow-id { type uint8; description "The flow identifier of the NVGRE header."; } } // container nvgre-header } // case nvgre case vxlan { if-feature vxlan-tunnel; container vxlan-header { description "VXLAN header."; choice vxlan-type { description "NVGRE can use either an IPv4 or an IPv6 header for encapsulation."; case ipv4 { leaf src-ipv4-address { type inet:ipv4-address; mandatory true; description "The source IP address of the header."; } leaf dest-ipv4-address { type inet:ipv4-address; mandatory true; description "The destination IP address of the header."; } leaf protocol { type uint8; mandatory true; description "The protocol id of the header."; } leaf ttl { type uint8; description "The TTL of the header."; } leaf dscp { type uint8; description "The Differentiated Services Code Point (DSCP) field of the header."; } } // case ipv4 case ipv6 { leaf src-ipv6-address { type inet:ipv6-address; mandatory true; description "The source IP address of the header."; } leaf dest-ipv6-address { type inet:ipv6-address; mandatory true; description "The destination IP address of the header."; } leaf next-header { type uint8; mandatory true; description "The next header of the IPv6 header."; } leaf traffic-class { type uint8; description "The traffic class value of the header."; } leaf flow-label { type inet:ipv6-flow-label; description "The flow label of the header."; } leaf hop-limit { type uint8 { range "1..255"; } description "The hop limit of the header."; } } // case ipv6 } // choice vxlan-type leaf vxlan-identifier { type uint32; mandatory true; description "The VXLAN identifier of the VXLAN header."; } } // container vxlan-header } // case vxlan } // choice tunnel-type } // container tunnel-encapsulation } // case tunnel-encapsulation-nexthop case tunnel-decapsulation-nexthop { if-feature nexthop-tunnel; container tunnel-decapsulation { description "This is to specify the decapsulation of a tunnel header."; choice tunnel-type { description "Nexthop tunnel type options."; case ipv4 { if-feature ipv4-tunnel; container ipv4-decapsulation { description "IPv4 decapsulation."; leaf ipv4-decapsulation { type tunnel-decapsulation-action-definition; mandatory true; description "IPv4 decapsulation operations."; } leaf ttl-action { type ttl-action-definition; description "The TTL actions: no-action or copy to inner header."; } } // container ipv4-decapsulation } // case ipv4 case ipv6 { if-feature ipv6-tunnel; container ipv6-decapsulation { description "IPv6 decapsulation."; leaf ipv6-decapsulation { type tunnel-decapsulation-action-definition; mandatory true; description "IPv6 decapsulation operations."; } leaf hop-limit-action { type hop-limit-action-definition; description "The hop limit actions: no-action or copy to inner header."; } } // container ipv6-decapsulation } // case ipv6 case mpls { if-feature mpls-tunnel; container label-pop { description "MPLS decapsulation."; leaf label-pop { type mpls-label-action-definition; mandatory true; description "Pop a label from the label stack."; } leaf ttl-action { type ttl-action-definition; description "The label TTL action."; } } // container label-pop } // case mpls } // choice tunnel-type } // container tunnel-decapsulation } // case tunnel-decapsulation-nexthop case logical-tunnel-nexthop { if-feature nexthop-tunnel; container logical-tunnel { description "This can be an MPLS Label Switched Path (LSP) or a GRE tunnel (or others as defined in this document) that is represented by a unique identifier (e.g., name)."; leaf tunnel-type { type tunnel-type-definition; mandatory true; description "A tunnel type."; } leaf tunnel-name { type string; mandatory true; description "A tunnel name that points to a logical tunnel."; } } // container logical-tunnel } // case logical-tunnel-nexthop leaf rib-name { type string; description "A nexthop pointing to a RIB indicates that the route lookup needs to continue in the specified RIB. This is a way to perform chained lookups."; } leaf nexthop-ref { type nexthop-ref; mandatory true; description "A nexthop reference that points to a nexthop."; } } // choice nexthop-base-type } // container nexthop-base case nexthop-chain { if-feature nexthop-chain; container nexthop-chain { description "A chain nexthop."; list nexthop-list { key "nexthop-member-id"; description "A list of nexthops."; leaf nexthop-member-id { type uint32; mandatory true; description "A nexthop identifier that points to a nexthop list member. A nexthop list member is a nexthop."; } } // list nexthop-list } // container nexthop-chain } // case nexthop-chain case nexthop-replicate { if-feature nexthop-replicate; container nexthop-replicate { description "A replicate nexthop."; list nexthop-list { key "nexthop-member-id"; description "A list of nexthops."; leaf nexthop-member-id { type uint32; mandatory true; description "A nexthop identifier that points to a nexthop list member. A nexthop list member is a nexthop."; } } // list nexthop-list } // container nexthop-replicate } // case nexthop-replicate case nexthop-protection { if-feature nexthop-protection; container nexthop-protection { description "A protection nexthop."; list nexthop-list { key "nexthop-member-id"; description "A list of nexthop."; leaf nexthop-member-id { type uint32; mandatory true; description "A nexthop identifier that points to a nexthop list member. A nexthop list member is a nexthop."; } leaf nexthop-preference { type nexthop-preference-definition; mandatory true; description "Nexthop-preference is used for protection schemes. It is an integer value between 1 and 99. Lower values are more preferred. To download a primary/standby/tertiary group to the FIB, the nexthops that are resolved and are most preferred are selected."; } } // list nexthop-list } // container nexthop-protection } // case nexthop-protection case nexthop-load-balance { if-feature nexthop-load-balance; container nexthop-lb { description "A load-balance nexthop."; list nexthop-list { key "nexthop-member-id"; description "A list of nexthop."; leaf nexthop-member-id { type uint32; mandatory true; description "A nexthop identifier that points to a nexthop list member. A nexthop list member is a nexthop."; } leaf nexthop-lb-weight { type nexthop-lb-weight-definition; mandatory true; description "The weight of a nexthop of the load-balance nexthops."; } } // list nexthop-list } // container nexthop-lb } // case nexthop-load-balance } // choice nexthop-type } output { leaf result { type boolean; mandatory true; description "Return the result of the rib-add operation: true - success; false - failed"; } leaf reason { type string; description "The specific reason that caused the failure."; } } } // rpc nh-delete notification nexthop-resolution-status-change { description "Nexthop resolution status (resolved/unresolved) notification."; container nexthop { description "The nexthop."; leaf nexthop-id { type uint32; description "An identifier that refers to a nexthop."; } leaf sharing-flag { type boolean; description "To indicate whether a nexthop is sharable or non-sharable: true - sharable (which means the nexthop can be shared with other routes) false - non-sharable (which means the nexthop can not be shared with other routes)"; } choice nexthop-type { description "Nexthop type options."; container nexthop-base { description "The base nexthop."; choice nexthop-base-type { description "Nexthop base type options."; leaf special { type special-nexthop-definition; description "A special nexthop."; } leaf outgoing-interface { type if:interface-ref; mandatory true; description "The nexthop is an outgoing interface."; } leaf ipv4-address { type inet:ipv4-address; mandatory true; description "The nexthop is an IPv4 address."; } leaf ipv6-address { type inet:ipv6-address; mandatory true; description "The nexthop is an IPv6 address."; } container egress-interface-ipv4-address { description "The nexthop is an egress-interface and an IP address. This can be used in cases where, e.g., the IP address is a link-local address."; leaf outgoing-interface { type if:interface-ref; mandatory true; description "Name of the outgoing interface."; } leaf ipv4-address { type inet:ipv4-address; mandatory true; description "The nexthop points to an interface with an IPv4 address."; } } // container egress-interface-ipv4-address container egress-interface-ipv6-address { description "The nexthop is an egress-interface and an IP address. This can be used in cases where, e.g., the IP address is a link-local address."; leaf outgoing-interface { type if:interface-ref; mandatory true; description "Name of the outgoing interface."; } leaf ipv6-address { type inet:ipv6-address; mandatory true; description "The nexthop points to an interface with an IPv6 address."; } } // container egress-interface-ipv6-address container egress-interface-mac-address { description "The egress-interface must be an Ethernet interface. Address resolution is not required for this nexthop."; leaf outgoing-interface { type if:interface-ref; mandatory true; description "Name of the outgoing interface."; } leaf ieee-mac-address { type yang:mac-address; mandatory true; description "The nexthop points to an interface with a specific MAC address."; } } // container egress-interface-mac-address case tunnel-encapsulation-nexthop { if-feature nexthop-tunnel; container tunnel-encapsulation { description "This can be an encapsulation representing an IP tunnel, MPLS tunnel, or others as defined in the info model. An optional egress-interface can be chained to the tunnel encapsulation to indicate which interface to send the packet out on. The egress-interface is useful when the network device contains Ethernet interfaces and one needs to perform address resolution for the IP packet."; choice tunnel-type { description "Tunnel options for nexthops."; case ipv4 { if-feature ipv4-tunnel; container ipv4-header { description "IPv4 header."; leaf src-ipv4-address { type inet:ipv4-address; mandatory true; description "The source IP address of the header."; } leaf dest-ipv4-address { type inet:ipv4-address; mandatory true; description "The destination IP address of the header."; } leaf protocol { type uint8; mandatory true; description "The protocol id of the header."; } leaf ttl { type uint8; description "The TTL of the header."; } leaf dscp { type uint8; description "The Differentiated Services Code Point (DSCP) field of the header."; } } // container ipv4-header } // case ipv4 case ipv6 { if-feature ipv6-tunnel; container ipv6-header { description "IPv6 header."; leaf src-ipv6-address { type inet:ipv6-address; mandatory true; description "The source IP address of the header."; } leaf dest-ipv6-address { type inet:ipv6-address; mandatory true; description "The destination IP address of the header."; } leaf next-header { type uint8; mandatory true; description "The next header of the IPv6 header."; } leaf traffic-class { type uint8; description "The traffic class value of the header."; } leaf flow-label { type inet:ipv6-flow-label; description "The flow label of the header."; } leaf hop-limit { type uint8 { range "1..255"; } description "The hop limit of the header."; } } // container ipv6-header } // case ipv6 case mpls { if-feature mpls-tunnel; container mpls-header { description "MPLS header."; list label-operations { key "label-oper-id"; description "Label operations."; leaf label-oper-id { type uint32; description "An optional identifier that points to a label operation."; } choice label-actions { description "Label action options."; container label-push { description "Label push operation."; leaf label { type uint32; mandatory true; description "The label to be pushed."; } leaf s-bit { type boolean; description "The s-bit ('Bottom of Stack' bit) of the label to be pushed."; } leaf tc-value { type uint8; description "The traffic class value of the label to be pushed."; } leaf ttl-value { type uint8; description "The TTL value of the label to be pushed."; } } // container label-push container label-swap { description "Label swap operation."; leaf in-label { type uint32; mandatory true; description "The label to be swapped."; } leaf out-label { type uint32; mandatory true; description "The out MPLS label."; } leaf ttl-action { type ttl-action-definition; description "The label TTL actions: - No-action - Copy to inner label - Decrease (the in-label) by 1 and copy to the out-label"; } } // container label-swap } // choice label-actions } // list label-operations } // container mpls-header } // case mpls case gre { if-feature gre-tunnel; container gre-header { description "GRE header."; choice dest-address-type { description "GRE options: IPv4 and IPv6"; leaf ipv4-dest { type inet:ipv4-address; mandatory true; description "The destination IP address of the GRE header."; } leaf ipv6-dest { type inet:ipv6-address; mandatory true; description "The destination IP address of the GRE header."; } } // choice dest-address-type leaf protocol-type { type uint16; mandatory true; description "The protocol type of the GRE header."; } leaf key { type uint64; description "The GRE key of the GRE header."; } } // container gre-header } // case gre case nvgre { if-feature nvgre-tunnel; container nvgre-header { description "NVGRE header."; choice nvgre-type { description "NVGRE can use either an IPv4 or an IPv6 header for encapsulation."; case ipv4 { leaf src-ipv4-address { type inet:ipv4-address; mandatory true; description "The source IP address of the header."; } leaf dest-ipv4-address { type inet:ipv4-address; mandatory true; description "The destination IP address of the header."; } leaf protocol { type uint8; mandatory true; description "The protocol id of the header."; } leaf ttl { type uint8; description "The TTL of the header."; } leaf dscp { type uint8; description "The Differentiated Services Code Point (DSCP) field of the header."; } } // case ipv4 case ipv6 { leaf src-ipv6-address { type inet:ipv6-address; mandatory true; description "The source IP address of the header."; } leaf dest-ipv6-address { type inet:ipv6-address; mandatory true; description "The destination IP address of the header."; } leaf next-header { type uint8; mandatory true; description "The next header of the IPv6 header."; } leaf traffic-class { type uint8; description "The traffic class value of the header."; } leaf flow-label { type inet:ipv6-flow-label; description "The flow label of the header."; } leaf hop-limit { type uint8 { range "1..255"; } description "The hop limit of the header."; } } // case ipv6 } // choice nvgre-type leaf virtual-subnet-id { type uint32; mandatory true; description "The subnet identifier of the NVGRE header."; } leaf flow-id { type uint8; description "The flow identifier of the NVGRE header."; } } // container nvgre-header } // case nvgre case vxlan { if-feature vxlan-tunnel; container vxlan-header { description "VXLAN header."; choice vxlan-type { description "NVGRE can use either an IPv4 or an IPv6 header for encapsulation."; case ipv4 { leaf src-ipv4-address { type inet:ipv4-address; mandatory true; description "The source IP address of the header."; } leaf dest-ipv4-address { type inet:ipv4-address; mandatory true; description "The destination IP address of the header."; } leaf protocol { type uint8; mandatory true; description "The protocol id of the header."; } leaf ttl { type uint8; description "The TTL of the header."; } leaf dscp { type uint8; description "The Differentiated Services Code Point (DSCP) field of the header."; } } // case ipv4 case ipv6 { leaf src-ipv6-address { type inet:ipv6-address; mandatory true; description "The source IP address of the header."; } leaf dest-ipv6-address { type inet:ipv6-address; mandatory true; description "The destination IP address of the header."; } leaf next-header { type uint8; mandatory true; description "The next header of the IPv6 header."; } leaf traffic-class { type uint8; description "The traffic class value of the header."; } leaf flow-label { type inet:ipv6-flow-label; description "The flow label of the header."; } leaf hop-limit { type uint8 { range "1..255"; } description "The hop limit of the header."; } } // case ipv6 } // choice vxlan-type leaf vxlan-identifier { type uint32; mandatory true; description "The VXLAN identifier of the VXLAN header."; } } // container vxlan-header } // case vxlan } // choice tunnel-type } // container tunnel-encapsulation } // case tunnel-encapsulation-nexthop case tunnel-decapsulation-nexthop { if-feature nexthop-tunnel; container tunnel-decapsulation { description "This is to specify the decapsulation of a tunnel header."; choice tunnel-type { description "Nexthop tunnel type options."; case ipv4 { if-feature ipv4-tunnel; container ipv4-decapsulation { description "IPv4 decapsulation."; leaf ipv4-decapsulation { type tunnel-decapsulation-action-definition; mandatory true; description "IPv4 decapsulation operations."; } leaf ttl-action { type ttl-action-definition; description "The TTL actions: no-action or copy to inner header."; } } // container ipv4-decapsulation } // case ipv4 case ipv6 { if-feature ipv6-tunnel; container ipv6-decapsulation { description "IPv6 decapsulation."; leaf ipv6-decapsulation { type tunnel-decapsulation-action-definition; mandatory true; description "IPv6 decapsulation operations."; } leaf hop-limit-action { type hop-limit-action-definition; description "The hop limit actions: no-action or copy to inner header."; } } // container ipv6-decapsulation } // case ipv6 case mpls { if-feature mpls-tunnel; container label-pop { description "MPLS decapsulation."; leaf label-pop { type mpls-label-action-definition; mandatory true; description "Pop a label from the label stack."; } leaf ttl-action { type ttl-action-definition; description "The label TTL action."; } } // container label-pop } // case mpls } // choice tunnel-type } // container tunnel-decapsulation } // case tunnel-decapsulation-nexthop case logical-tunnel-nexthop { if-feature nexthop-tunnel; container logical-tunnel { description "This can be an MPLS Label Switched Path (LSP) or a GRE tunnel (or others as defined in this document) that is represented by a unique identifier (e.g., name)."; leaf tunnel-type { type tunnel-type-definition; mandatory true; description "A tunnel type."; } leaf tunnel-name { type string; mandatory true; description "A tunnel name that points to a logical tunnel."; } } // container logical-tunnel } // case logical-tunnel-nexthop leaf rib-name { type string; description "A nexthop pointing to a RIB indicates that the route lookup needs to continue in the specified RIB. This is a way to perform chained lookups."; } leaf nexthop-ref { type nexthop-ref; mandatory true; description "A nexthop reference that points to a nexthop."; } } // choice nexthop-base-type } // container nexthop-base case nexthop-chain { if-feature nexthop-chain; container nexthop-chain { description "A chain nexthop."; list nexthop-list { key "nexthop-member-id"; description "A list of nexthops."; leaf nexthop-member-id { type uint32; mandatory true; description "A nexthop identifier that points to a nexthop list member. A nexthop list member is a nexthop."; } } // list nexthop-list } // container nexthop-chain } // case nexthop-chain case nexthop-replicate { if-feature nexthop-replicate; container nexthop-replicate { description "A replicate nexthop."; list nexthop-list { key "nexthop-member-id"; description "A list of nexthops."; leaf nexthop-member-id { type uint32; mandatory true; description "A nexthop identifier that points to a nexthop list member. A nexthop list member is a nexthop."; } } // list nexthop-list } // container nexthop-replicate } // case nexthop-replicate case nexthop-protection { if-feature nexthop-protection; container nexthop-protection { description "A protection nexthop."; list nexthop-list { key "nexthop-member-id"; description "A list of nexthop."; leaf nexthop-member-id { type uint32; mandatory true; description "A nexthop identifier that points to a nexthop list member. A nexthop list member is a nexthop."; } leaf nexthop-preference { type nexthop-preference-definition; mandatory true; description "Nexthop-preference is used for protection schemes. It is an integer value between 1 and 99. Lower values are more preferred. To download a primary/standby/tertiary group to the FIB, the nexthops that are resolved and are most preferred are selected."; } } // list nexthop-list } // container nexthop-protection } // case nexthop-protection case nexthop-load-balance { if-feature nexthop-load-balance; container nexthop-lb { description "A load-balance nexthop."; list nexthop-list { key "nexthop-member-id"; description "A list of nexthop."; leaf nexthop-member-id { type uint32; mandatory true; description "A nexthop identifier that points to a nexthop list member. A nexthop list member is a nexthop."; } leaf nexthop-lb-weight { type nexthop-lb-weight-definition; mandatory true; description "The weight of a nexthop of the load-balance nexthops."; } } // list nexthop-list } // container nexthop-lb } // case nexthop-load-balance } // choice nexthop-type } // container nexthop leaf nexthop-state { type nexthop-state-definition; mandatory true; description "Nexthop resolution status (resolved/unresolved) notification."; } } // notification nexthop-resolution-status-change notification route-change { description "Route change notification."; leaf rib-name { type string; mandatory true; description "A reference to the name of a RIB."; } leaf address-family { type address-family-definition; mandatory true; description "The address family of a RIB."; } leaf route-index { type uint64; mandatory true; description "Route index."; } container match { description "The match condition specifies the kind of route (IPv4, MPLS, etc.) and the set of fields to match on."; choice route-type { description "Route types: IPv4, IPv6, MPLS, MAC, etc."; case ipv4 { description "IPv4 route case."; container ipv4 { description "IPv4 route match."; choice ip-route-match-type { description "IP route match type options: match source, or match destination, or match source and destination."; leaf dest-ipv4-prefix { type inet:ipv4-prefix; mandatory true; description "An IPv4 destination address as the match."; } leaf src-ipv4-prefix { type inet:ipv4-prefix; mandatory true; description "An IPv4 source address as the match."; } container dest-src-ipv4-address { description "A combination of an IPv4 source and an IPv4 destination address as the match."; leaf dest-ipv4-prefix { type inet:ipv4-prefix; mandatory true; description "The IPv4 destination address of the match."; } leaf src-ipv4-prefix { type inet:ipv4-prefix; mandatory true; description "The IPv4 source address of the match."; } } // container dest-src-ipv4-address } // choice ip-route-match-type } // container ipv4 } // case ipv4 case ipv6 { description "IPv6 route case."; container ipv6 { description "IPv6 route match."; choice ip-route-match-type { description "IP route match type options: match source, match destination, or match source and destination."; leaf dest-ipv6-prefix { type inet:ipv6-prefix; mandatory true; description "An IPv6 destination address as the match."; } leaf src-ipv6-prefix { type inet:ipv6-prefix; mandatory true; description "An IPv6 source address as the match."; } container dest-src-ipv6-address { description "A combination of an IPv6 source and an IPv6 destination address as the match."; leaf dest-ipv6-prefix { type inet:ipv6-prefix; mandatory true; description "The IPv6 destination address of the match."; } leaf src-ipv6-prefix { type inet:ipv6-prefix; mandatory true; description "The IPv6 source address of the match."; } } // container dest-src-ipv6-address } // choice ip-route-match-type } // container ipv6 } // case ipv6 case mpls-route { description "MPLS route case."; leaf mpls-label { type uint32; mandatory true; description "The label used for matching."; } } // case mpls-route case mac-route { description "MAC route case."; leaf mac-address { type yang:mac-address; mandatory true; description "The MAC address used for matching."; } } // case mac-route case interface-route { description "Interface route case."; leaf interface-identifier { type if:interface-ref; mandatory true; description "The interface used for matching."; } } // case interface-route } // choice route-type } // container match leaf route-installed-state { type route-installed-state-definition; mandatory true; description "Indicates whether the route got installed in the FIB."; } leaf route-state { type route-state-definition; mandatory true; description "Indicates whether a route is active or inactive."; } list route-change-reasons { key "route-change-reason"; description "The reasons that cause the route change. A route change may result from several reasons; for example, a nexthop becoming resolved will make a route A active, which is of better preference than a currently active route B, which results in the route A being installed"; leaf route-change-reason { type route-change-reason-definition; mandatory true; description "The reason that caused the route change."; } } // list route-change-reasons } // notification route-change } // module ietf-i2rs-rib
© 2023 YumaWorks, Inc. All rights reserved.