A YANG Data Model for Resource Reservation Protocol (RSVP)

Introduction YANG and is a data modeling language that was introduced to define the contents of a conceptual data store that allows networked devices to be managed using NETCONF . YANG has proved relevant beyond its initial confines, as bindings to other interfaces (e.g. RESTCONF ) and encoding other than XML (e.g. JSON) are being defined. Furthermore, YANG data models can be used as the basis of implementation for other interfaces, such as CLI and programmatic APIs. This document defines a YANG data model for the configuration and management of the RSVP protocol . The data model is divided into two modules: a base and extended RSVP YANG modules. The RSVP base YANG 'ietf-rsvp' module covers the data that is core to the function of the RSVP protocol and MUST be supported by vendors that support RSVP protocol . The RSVP extended 'ietf-rsvp-extended' module covers the data that is optional, or provides ability to tune RSVP protocol base functionality. The support for RSVP extended module features by vendors is considered optional. The RSVP YANG model provides the building blocks needed to allow augmentation by other models that extend the RSVP protocol-- such as using RSVP extensions to signal Label Switched Paths (LSPs) as defined in . The YANG module(s) defined in this document are compatible with the Network Management Datastore Architecture (NMDA) .

Requirements Language The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in BCP 14 when, and only when, they appear in all capitals, as shown here. The terminology for describing YANG data models is found in .

Prefixes in Data Node Names In this document, names of data nodes and other data model objects are prefixed using the standard prefix associated with the corresponding YANG imported modules, as shown in . Prefix YANG module Reference if ietf-interfaces rt ietf-routing rt-types ietf-routing-types inet ietf-inet-types yang ietf-yang-types key-chain ietf-key-chain

Model Tree Diagram A full tree diagram of the module(s) defined in this document is given in subsequent sections as per the syntax defined in .

Model Overview The RSVP YANG module augments the "control-plane-protocol" entry from the 'ietf-routing' module defined in . It also defines the identity "rsvp" of base type "rt:routing-protocol" to identify the RSVP routing protocol. The 'ietf-rsvp' model defines a single instance of the RSVP protocol. The top 'rsvp' container encompases data for one such RSVP protocol instance. Multiple instances can be defined as multiple control-plane protocols instances as described in . The YANG data model defined has the common building blocks for the operation of the base RSVP protocol for the session type defined in . The augmentation of this model by other models (e.g. to support RSVP Traffic Engineering (TE) extensions for signaling Label Switched Paths (LSPs)) are outside the scope of this document and are discussed in separate document(s).

Module(s) Relationship This RSVP YANG data model defined in this document is divided into two modules: a base and extended modules. The RSVP data covered in 'ietf-rsvp' module are categorized as core to the function of the protocol and MUST be supported by vendors claiming the support for RSVP protocol . The RSVP extended features that are covered in 'ietf-rsvp-extended' module are categorized as either optional or providing ability to better tune the basic functionality of the RSVP protocol. The support for RSVP extended features by all vendors is considered optional. The relationship between the base and RSVP extended YANG modules and the IETF routing YANG model is shown in .

Core Features The RSVP data covered in the 'ietf-rsvp' YANG module provides the common building blocks that are required to configure, operate and manage the RSVP protocol and MUST be supported by vendors that claim the support for base RSVP protocol defined in . In addition, the following standard RSVP core features are modeled under the 'ietf-rsvp' module: Basic operational statistics, including protocol messages, packets and errors. Basic RSVP authentication feature as defined in ) using string based authentication key. Basic RSVP Refresh Reduction feature as defined in (). Basic RSVP Hellos feature as defined in () Basic RSVP Graceful Restart feature as defined in , , and .

Optional Features Optional features are beyond the basic configuration, and operation of the RSVP protocol. The decision whether to support these RSVP features on a particular device is left to the vendor that supports the RSVP core features. The following optional features that are covered in the 'ietf-rsvp-extended' YANG module: Advanced operational statistics, including protocol messages, packets and errors. Advanced RSVP authentication features as defined in ) using various authentication key types including those defined in . Advanced RSVP Refresh Reduction features defined in (). Advanced RSVP Hellos features as defined in , and . Advanced RSVP Graceful Restart features as defined in , , and .

Data Model Structure The RSVP YANG data model defines the 'rsvp' top-level container that contains the configuration and operational state for the RSVP protocol. The presence of this container enables the RSVP protocol functionality. The 'rsvp' top-level container also includes data that has router level scope (i.e. applicable to all objects modeled under rsvp). It also contains configuration and state data about the following types of RSVP objects: interfaces neighbors sessions The derived state data is contained in "read-only" nodes directly under the intended object as shown in .

> . . +--rw interfaces . +-- ro <> . . +--rw neighbors . +-- ro <> . . +--rw sessions . +-- ro <> . rpcs: +--x clear-session +--x clear-neighbor +--x clear-authentication ]]> The following 'router-level':

The router-level scope configuration and state data are applicable to all modeled objects under the top-level 'rsvp' container, and MAY affect the RSVP protocol behavior.

'interfaces':

The 'interfaces' container includes a list of RSVP enabled interfaces. It also includes RSVP configuration and state data that is applicable to all interfaces. An entry in the interfaces list MAY carry its own configuration or state data. Any data or state under the "interfaces" container level is equally applicable to all interfaces unless it is explicitly overridden by configuration or state under a specific interface.

'neighbors' :

The 'neighbors' container includes a list of RSVP neighbors. An entry in the RSVP neighbor list MAY carry its own configuration and state relevant to the specific RSVP neighbor. The RSVP neighbors can be dynamically discovered using RSVP signaling, or can be explicitly configured.

'sessions':

The 'sessions' container includes a list RSVP sessions. An entry in the RSVP session list MAY carry its own configuration and state relevant to a specific RSVP session. RSVP sessions are usually derived state that are created as result of signaling. This model defines attributes related to IP RSVP sessions as defined in .

The defined YANG data model supports configuration inheritance for neighbors, and interfaces. Data nodes defined under the main container (e.g. the container that encompasses the list of interfaces, or neighbors) are assumed to apply equally to all elements of the list, unless overridden explicitly for a certain element (e.g. interface).

Model Notifications Modeling notifications data is key in any defined YANG data model. and define a subscription and push mechanism for YANG datastores. This mechanism currently allows the user to: Subscribe notifications on a per client basis Specify subtree filters or XPath filters so that only interested contents will be sent. Specify either periodic or on-demand notifications.

RSVP Base YANG Model The RSVP base module includes the core features and building blocks for modeling the RSVP protocol as described in .

Tree Diagram shows the YANG tree representation for configuration, state data and RPCs that are covered in 'ietf-rsvp' YANG module:

YANG Module The ietf-rsvp module imports from the following modules: ietf-interfaces defined in ietf-yang-types and ietf-inet-types defined in ietf-routing defined in ietf-key-chain defined in ietf-netconf-acm defined in This module also references the following documents: , , , , , , and .

file "ietf-rsvp@2024-02-28.yang" module ietf-rsvp { yang-version 1.1; namespace "urn:ietf:params:xml:ns:yang:ietf-rsvp"; /* Replace with IANA when assigned */ prefix rsvp; import ietf-interfaces { prefix if; reference "RFC8343: A YANG Data Model for Interface Management"; } import ietf-inet-types { prefix inet; reference "RFC6991: Common YANG Data Types"; } import ietf-yang-types { prefix yang; reference "RFC6991: Common YANG Data Types"; } import ietf-routing { prefix rt; reference "RFC8349: A YANG Data Model for Routing Management (NMDA Version)"; } import ietf-key-chain { prefix key-chain; reference "RFC8177: YANG Data Model for Key Chains"; } import ietf-netconf-acm { prefix nacm; reference "RFC8341: Network Configuration Access Control Model"; } organization "IETF Traffic Engineering Architecture and Signaling (TEAS) Working Group"; contact "WG Web: WG List: Editor: Vishnu Pavan Beeram Editor: Tarek Saad Editor: Rakesh Gandhi Editor: Xufeng Liu Editor: Igor Bryskin "; description "This module contains the RSVP YANG data model. The model fully conforms to the Network Management Datastore Architecture (NMDA). Copyright (c) 2019 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 (https://trustee.ietf.org/license-info). This version of this YANG module is part of RFC XXXX; see the RFC itself for full legal notices."; // RFC Ed.: replace XXXX with actual RFC number and remove this // note. // RFC Ed.: update the date below with the date of RFC publication // and remove this note. revision 2024-02-28 { description "Initial version."; reference "RFCXXXX: A YANG Data Model for Resource Reservation Protocol (RSVP)"; } identity rsvp { base rt:routing-protocol; description "RSVP protocol"; } identity rsvp-session-type { description "Base RSVP session type"; } identity rsvp-session-ip { base rsvp-session-type; description "RSVP IP session type"; } identity reservation-style { description "Base identity for reservation style."; } identity reservation-wildcard-filter { base reservation-style; description "Wildcard-Filter (WF) Style."; reference "RFC2205"; } identity reservation-fixed-filter { base reservation-style; description "Fixed-Filter (FF) Style."; reference "RFC2205"; } identity reservation-shared-explicit { base reservation-style; description "Shared Explicit (SE) Style."; reference "RFC2205"; } grouping intf-attributes { description "Top level grouping for RSVP interface properties."; container refresh-reduction { description "Top level container for RSVP refresh reduction parameters."; leaf enabled { type boolean; default "true"; description "'true' if RSVP Refresh Reduction is enabled. 'false' if RSVP Refresh Reduction is disabled."; } reference "RFC2961 RSVP Refresh Overhead Reduction Extensions"; } container hellos { description "Top level container for RSVP hello parameters."; leaf enabled { type boolean; default "true"; description "'true' if RSVP Hello is enabled. 'false' if RSVP Hello is disabled."; reference "RFC3209: RSVP-TE: Extensions to RSVP for LSP Tunnels. RFC5495: Description of the Resource Reservation Protocol - Traffic-Engineered (RSVP-TE) Graceful Restart Procedures."; } } container authentication { description "Top level container for RSVP authentication parameters."; leaf enabled { type boolean; default "false"; description "'true' if RSVP Authentication is enabled. 'false' if RSVP Authentication is disabled."; } leaf authentication-key { type string; description "An authentication key string."; reference "RFC2747: RSVP Cryptographic Authentication"; } leaf crypto-algorithm { type identityref { base key-chain:crypto-algorithm; } description "Cryptographic algorithm associated with key."; } } container statistics { config false; description "RSVP statistics container."; container messages { description "RSVP protocol statistics container."; leaf ack-sent { type yang:counter64; description "RSVP Hello sent count."; } leaf ack-received { type yang:counter64; description "RSVP Hello received count."; } leaf bundle-sent { type yang:counter64; description "RSVP Bundle message sent count."; } leaf bundle-received { type yang:counter64; description "RSVP Bundle message received count."; } leaf hello-sent { type yang:counter64; description "RSVP Hello message sent count."; } leaf hello-received { type yang:counter64; description "RSVP Hello message received count."; } leaf integrity-challenge-sent { type yang:counter64; description "RSVP Integrity Challenge message sent count."; } leaf integrity-challenge-received { type yang:counter64; description "RSVP Integrity Challenge message received count."; } leaf integrity-response-sent { type yang:counter64; description "RSVP Integrity Response message sent count."; } leaf integrity-response-received { type yang:counter64; description "RSVP Integrity Response message received count."; } leaf notify-sent { type yang:counter64; description "RSVP Notify message sent count."; } leaf notify-received { type yang:counter64; description "RSVP Notify message received count."; } leaf path-sent { type yang:counter64; description "RSVP Path message sent count."; } leaf path-received { type yang:counter64; description "RSVP Path message received count."; } leaf path-err-sent { type yang:counter64; description "RSVP Path error message sent count."; } leaf path-err-received { type yang:counter64; description "RSVP Path error message received count."; } leaf path-tear-sent { type yang:counter64; description "RSVP Path tear message sent count."; } leaf path-tear-received { type yang:counter64; description "RSVP Path tear message received count."; } leaf resv-sent { type yang:counter64; description "RSVP Resv message sent count."; } leaf resv-received { type yang:counter64; description "RSVP Resv message received count."; } leaf resv-confirm-sent { type yang:counter64; description "RSVP Confirm message sent count."; } leaf resv-confirm-received { type yang:counter64; description "RSVP Confirm message received count."; } leaf resv-err-sent { type yang:counter64; description "RSVP Resv error message sent count."; } leaf resv-err-received { type yang:counter64; description "RSVP Resv error message received count."; } leaf resv-tear-sent { type yang:counter64; description "RSVP Resv tear message sent count."; } leaf resv-tear-received { type yang:counter64; description "RSVP Resv tear message received count."; } leaf srefresh-sent { type yang:counter64; description "RSVP Srefresh message sent count."; } leaf srefresh-received { type yang:counter64; description "RSVP Srefresh message received count."; } leaf unknown-messages-received { type yang:counter64; description "Unknown messages received count."; } } container packets { description "Packet statistics container."; leaf sent { type yang:counter64; description "RSVP packet sent count."; } leaf received { type yang:counter64; description "RSVP packet received count."; } } container errors { description "Error statistics container."; leaf authenticate { type yang:counter64; description "The total number of RSVP packets received with an authentication failure."; } leaf checksum { type yang:counter64; description "The total number of RSVP packets received with an invalid checksum value."; } leaf packet-length { type yang:counter64; description "The total number of packets received with an invalid packet length."; } } } } augment "/rt:routing/rt:control-plane-protocols/" + "rt:control-plane-protocol" { when "rt:type = 'rsvp:rsvp'" { description "This augment is only valid when routing protocol instance type is RSVP."; } description "RSVP protocol augmentation."; container rsvp { presence "Enable RSVP feature"; description "RSVP feature container"; container interfaces { description "RSVP interfaces container."; uses intf-attributes; list interface { key "name"; description "RSVP interfaces."; leaf name { type if:interface-ref; description "RSVP interface."; } uses intf-attributes; } } container sessions { description "RSVP sessions container."; list session-ip { key "destination protocol-id destination-port"; config false; description "List of RSVP sessions."; leaf destination-port { type uint16; description "RSVP destination port."; reference "RFC2205"; } leaf protocol-id { type uint8; description "The IP protocol ID."; reference "RFC2205, section 3.2"; } leaf source { type inet:ip-address; description "RSVP source address."; reference "RFC2205"; } leaf destination { type inet:ip-address; description "RSVP destination address."; reference "RFC2205"; } leaf session-name { type string; description "The signaled name of this RSVP session."; } leaf session-status { type enumeration { enum up { description "RSVP session is up."; } enum down { description "RSVP session is down."; } } description "Enumeration of RSVP session states."; } leaf session-type { type identityref { base rsvp-session-type; } mandatory "true"; description "RSVP session type."; } container psbs { description "Path State Block (PSB) container."; list psb { description "List of Path State Blocks."; leaf source-port { type inet:port-number; description "RSVP source port."; reference "RFC2205"; } leaf expires-in { type uint32; units "seconds"; description "Time to expiry (in seconds)."; } } } container rsbs { description "Reservation State Block (RSB) container."; list rsb { description "List of Reservation State Blocks."; leaf source-port { type inet:port-number; description "RSVP source port."; reference "RFC2205"; } leaf reservation-style { type identityref { base reservation-style; } description "RSVP reservation style."; } leaf expires-in { type uint32; units "seconds"; description "Time to expiry (in seconds)."; } } } } } container neighbors { description "RSVP neighbors container"; list neighbor { key "address"; description "List of RSVP neighbors"; leaf address { type inet:ip-address; description "Address of the RSVP neighbor."; } leaf epoch { type uint32; description "Neighbor epoch."; reference "RFC2961 and RFC5063"; } leaf expiry-time { type uint32; units "seconds"; description "Neighbor expiry time after which the neighbor state is purged if no states associated with it."; } container graceful-restart { description "Graceful restart information."; leaf neighbor-restart-time { type uint32; units "seconds"; config false; description "Time it takes the neighbor node to restart its RSVP-TE component (to the point where it can exchange RSVP Hello with its neighbors). A value of 0xffffffff indicates that the restart of the neighbor's control plane may occur over an indeterminate interval and that the operation of its data plane is unaffected by control plane failures."; reference "RFC3473"; } leaf neighbor-recovery-time { type uint32; units "seconds"; config false; description "The period of time, in milliseconds, that the neighbor node requires to re-synchronize RSVP and MPLS forwarding state with its neighbor. A value of zero (0) indicates that MPLS forwarding state was not preserved across a particular reboot."; reference "RFC3473"; } container helper-mode { config false; description "Helper mode information."; leaf neighbor-restart-time-remaining { type uint32; units "seconds"; description "Number of seconds remaining for neighbor to send Hello message after restart."; reference "RFC5063"; } leaf neighbor-recovery-time-remaining { type uint32; units "seconds"; description "Number of seconds remaining for neighbor to refresh."; reference "RFC5063"; } } // helper-mode } leaf hello-status { type enumeration { enum enabled { description "RSVP Hellos enabled."; } enum disabled { description "RSVP Hellos disabled."; } enum restarting { description "RSVP restarting."; } } config false; description "RSVP Hello status."; } leaf interface { type if:interface-ref; description "Interface where RSVP neighbor was detected."; } leaf neighbor-status { type enumeration { enum up { description "Neighbor state up."; } enum down { description "Neighbor state down."; } enum hello-disable { description "RSVP Hellos disabled."; } enum restarting { description "RSVP neighbor restarting."; } } config false; description "RSVP neighbor state."; } leaf refresh-reduction-capable { type boolean; default "true"; description "Enables all RSVP refresh reduction message bundling, RSVP message ID, reliable message delivery and Srefresh messages."; reference "RFC2961 RSVP Refresh Overhead Reduction Extensions"; } leaf restart-count { type yang:counter32; config false; description "Number of times this RSVP neighbor has restarted."; } leaf restart-time { type yang:date-and-time; config false; description "Last restart time of the RSVP neighbor."; reference "RFC3473"; } } } container graceful-restart { description "Graceful restart local information."; leaf enabled { type boolean; description "'true' if RSVP Graceful Restart is enabled. 'false' if RSVP Graceful Restart is disabled."; reference "RFC5495"; } leaf local-restart-time { type uint32; units "seconds"; description "Time it takes the local node to restart its RSVP-TE component (to the point where it can exchange RSVP Hello with its neighbors). A value of 0xffffffff indicates that the restart of the neighbor's control plane may occur over an indeterminate interval and that the operation of its data plane is unaffected by control plane failures."; reference "RFC3473"; } leaf local-recovery-time { type uint32; units "seconds"; description "The period of time, in seconds, that the local node requires to re-synchronize RSVP and MPLS forwarding state with its neighbor. A value of zero (0) indicates that MPLS forwarding state was not preserved across a particular reboot."; reference "RFC3473"; } container helper-mode { description "Helper mode information. In this mode, the node resynchronizes its stored states with a neighbor whose control plane has restarted. The helper mode term is borrowed from RFC3623 and adopted by several vendors vendors in their implementation of RSVP graceful restart."; leaf enabled { type boolean; description "'true' if helper mode is enabled."; } leaf max-helper-restart-time { type uint32; units "seconds"; default "20"; description "The maximum time the router or switch waits after it discovers that the neighboring router has gone down before it declares the neighbor down."; reference "RFC5063"; } leaf max-helper-recovery-time { type uint32; units "seconds"; default "180"; description "The maximum amount of time the router retains the state of its RSVP neighbors while they undergo a graceful restart."; reference "RFC5063"; } } } } } grouping session-ref { description "Session reference information"; leaf destination { type leafref { path "/rt:routing/rt:control-plane-protocols" + "/rt:control-plane-protocol/rsvp:rsvp" + "/rsvp:sessions/rsvp:session-ip/destination"; } mandatory true; description "The RSVP session destination."; } leaf protocol-id { type uint8; mandatory true; description "The RSVP session protocol ID."; } leaf destination-port { type inet:ip-address; mandatory true; description "The RSVP session destination port."; } } rpc clear-session { nacm:default-deny-all; description "Clears RSVP sessions RPC"; input { leaf routing-protocol-instance-name { type leafref { path "/rt:routing/rt:control-plane-protocols/" + "rt:control-plane-protocol/rt:name"; } mandatory true; description "Name of the RSVP protocol instance whose session is being cleared. If the corresponding RSVP instance doesn't exist, then the operation will fail with an error-tag of 'data-missing' and an error-app-tag of 'routing-protocol-instance-not-found'."; } choice filter-type { mandatory true; description "Filter choice"; case match-all { leaf all { type empty; mandatory true; description "Match all RSVP sessions."; } } case match-one { container session-info { description "Specifies the specific session to invoke the operation on."; choice session-type { mandatory true; description "The RSVP session type."; case rsvp-session-ip { uses session-ref; } } } } } } } rpc clear-neighbor { nacm:default-deny-all; description "RPC to clear the RSVP Hello session to a neighbor."; input { leaf routing-protocol-instance-name { type leafref { path "/rt:routing/rt:control-plane-protocols/" + "rt:control-plane-protocol/rt:name"; } mandatory true; description "Name of the RSVP protocol instance whose session is being cleared. If the corresponding RSVP instance doesn't exist, then the operation will fail with an error-tag of 'data-missing' and an error-app-tag of 'routing-protocol-instance-not-found'."; } choice filter-type { mandatory true; description "The Filter choice."; case match-all { leaf all { type empty; mandatory true; description "Match all RSVP neighbor sessions."; } } case match-one { leaf neighbor-address { type leafref { path "/rt:routing/rt:control-plane-protocols" + "/rt:control-plane-protocol/rsvp:rsvp" + "/rsvp:neighbors/rsvp:neighbor/address"; } mandatory true; description "Match the specific RSVP neighbor session."; } } } } } rpc clear-authentication { nacm:default-deny-all; description "Clears the RSVP Security Association (SA) before the lifetime expires."; input { leaf routing-protocol-instance-name { type leafref { path "/rt:routing/rt:control-plane-protocols/" + "rt:control-plane-protocol/rt:name"; } mandatory true; description "Name of the RSVP protocol instance whose session is being cleared. If the corresponding RSVP instance doesn't exist, then the operation will fail with an error-tag of 'data-missing' and an error-app-tag of 'routing-protocol-instance-not-found'."; } choice filter-type { mandatory true; description "Filter choice"; case match-all { leaf all { type empty; mandatory true; description "Match all RSVP security associations."; } } case match-one-interface { leaf interface { type if:interface-ref; description "Interface where RSVP security association(s) to be detected."; } } } } } }

]]>


RSVP Extended YANG Model

The RSVP extended module augments the RSVP base module with optional feature data
as described in .

Tree Diagram

 shows the YANG tree representation for configuration and
state data that are covered in 'ietf-rsvp-extended' YANG module:




YANG Module

The 'ietf-rsvp-extended' module imports from the following modules:


  ietf-rsvp defined in this document
  ietf-routing defined in 
  ietf-yang-types and ietf-inet-types defined in 
  ietf-key-chain defined in 


 shows the RSVP extended YANG module:

This module also references the following documents:
, , , , , and .

 file "ietf-rsvp-extended@2024-02-28.yang"
module ietf-rsvp-extended {
  yang-version 1.1;
  namespace "urn:ietf:params:xml:ns:yang:ietf-rsvp-extended";
  prefix rsvp-extended;

  import ietf-rsvp {
    prefix rsvp;
    reference
      "RFCXXXX: A YANG Data Model for Resource Reservation Protocol
       (RSVP)";
  }
  import ietf-routing {
    prefix rt;
    reference
      "RFC8349: A YANG Data Model for Routing Management
       (NMDA Version)";
  }
  import ietf-yang-types {
    prefix yang;
    reference
      "RFC6991: Common YANG Data Types";
  }
  import ietf-key-chain {
    prefix key-chain;
    reference
      "RFC8177: YANG Data Model for Key Chains";
  }

  organization
    "IETF Traffic Engineering Architecture and Signaling (TEAS)
     Working Group";
  contact
    "WG Web:   
     WG List:  

     Editor:   Vishnu Pavan Beeram
               

     Editor:   Tarek Saad
               

     Editor:   Rakesh Gandhi
               

     Editor:   Xufeng Liu
               

     Editor:   Igor Bryskin
               ";
  description
    "This module contains the Extended RSVP YANG data model.
     The model fully conforms to the Network Management Datastore
     Architecture (NMDA).

     Copyright (c) 2019 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
     (https://trustee.ietf.org/license-info).
     This version of this YANG module is part of RFC XXXX; see
     the RFC itself for full legal notices.";

  // RFC Ed.: replace XXXX with actual RFC number and remove this
  // note.
  // RFC Ed.: update the date below with the date of RFC publication
  // and remove this note.

  revision 2024-02-28 {
    description
      "Initial version.";
    reference
      "RFCXXXX: A YANG Data Model for Resource Reservation Protocol
       (RSVP)";
  }

  grouping authentication-extended {
    description
      "Configuration parameters relating to RSVP authentication.";
    leaf lifetime {
      type uint32 {
        range "30..86400";
      }
      units "seconds";
      description
        "Life time for each security association.";
      reference
        "RFC2747: RSVP Cryptographic Authentication";
    }
    leaf window-size {
      type uint32 {
        range "1..64";
      }
      description
        "Window-size to limit number of out-of-order messages.";
      reference
        "RFC2747: RSVP Cryptographic Authentication";
    }
    leaf challenge {
      type empty;
      description
        "Enable challenge messages.";
      reference
        "RFC2747: RSVP Cryptographic Authentication";
    }
    leaf retransmits {
      type uint32 {
        range "1..10000";
      }
      description
        "Number of retransmits when messages are dropped.";
      reference
        "RFC2747: RSVP Cryptographic Authentication";
    }
    leaf key-chain {
      type key-chain:key-chain-ref;
      description
        "Key chain name to authenticate RSVP
         signaling messages.";
      reference
        "RFC2747: RSVP Cryptographic Authentication";
    }
  }

  grouping hellos-extended {
    description
      "Configuration parameters relating to RSVP hellos";
    leaf interface-based {
      type empty;
      description
        "Enable interface-based Hello adjacency if present.";
    }
    leaf hello-interval {
      type uint32;
      units "milliseconds";
      description
        "Configure interval between successive Hello messages in
         milliseconds.";
      reference
        "RFC3209: RSVP-TE: Extensions to RSVP for LSP Tunnels.
         RFC5495: Description of the Resource Reservation Protocol -
         Traffic-Engineered (RSVP-TE) Graceful Restart Procedures.";
    }
    leaf hello-misses {
      type uint32 {
        range "1..10";
      }
      description
        "Configure max number of consecutive missed Hello messages.";
      reference
        "RFC3209: RSVP-TE: Extensions to RSVP for LSP Tunnels.
         RFC5495: Description of the Resource Reservation Protocol -
         Traffic- Engineered (RSVP-TE) Graceful Restart Procedures.";
    }
  }

  grouping signaling-parameters-extended {
    description
      "Configuration parameters relating to RSVP signaling";
    leaf refresh-interval {
      type uint32;
      units "seconds";
      description
        "Set interval between successive refreshes";
      reference "RFC2205";
    }
    leaf refresh-misses {
      type uint32;
      description
        "Set max number of consecutive missed messages for state
         expiry";
      reference "RFC2205";
    }
    leaf checksum-enable {
      type empty;
      description
        "Enable RSVP message checksum computation";
      reference "RFC2205";
    }
    leaf patherr-state-removal {
      type empty;
      description
        "State-Removal flag in Path Error message if present.";
      reference "RFC3473";
    }
  }

  grouping refresh-reduction-extended {
    description
      "Configuration parameters relating to RSVP refresh reduction.";
    leaf bundle-message-max-size {
      type uint32 {
        range "512..65000";
      }
      description
        "Configure maximum size (bytes) of a single RSVP Bundle
         message.";
      reference "RFC2961";
    }
    leaf ack-hold-time {
      type uint32;
      units "milliseconds";
      description
        "Configure hold time in milliseconds for sending RSVP ACK
         message(s).";
      reference "RFC2961";
    }
    leaf ack-max-size {
      type uint32;
      description
        "Configure max size of a single RSVP ACK message.";
      reference "RFC2961";
    }
    leaf ack-retransmit-time {
      type uint32;
      units "milliseconds";
      description
        "Configure min delay in milliseconds to wait for an
         acknowledgment before being retransmitted.";
      reference "RFC2961";
    }
    leaf srefresh-ack-desired {
      type empty;
      description
        "Enables the sending of MESSAGE_ID with ACK_Desired
         set with Srefresh messages.";
      reference "RFC2961";
    }
    leaf srefresh-max-size {
      type uint32 {
        range "20..65000";
      }
      description
        "Configure max size (bytes) of a single RSVP Srefresh
         message.";
      reference "RFC2961";
    }
    leaf srefresh-relative-period {
      type uint8 {
        range "10..100";
      }
      description
        "Configures the period of Srefreshes relative to standard
         refresh message period in percentage.";
    }
  }

  grouping packets-extended-statistics {
    description
      "Packet statistics.";
    leaf discontinuity-time {
      type yang:date-and-time;
      description
        "The time on the most recent occasion at which any one or
         more of the statistic counters suffered a discontinuity.
         If no such discontinuities have occurred since the last
         re-initialization of the local management subsystem, then
         this node contains the time the local management subsystem
         re-initialized itself.";
    }
    leaf out-dropped {
      type yang:counter64;
      description
        "Out RSVP packet drop count.";
    }
    leaf in-dropped {
      type yang:counter64;
      description
        "In RSVP packet drop count.";
    }
    leaf out-errors {
      type yang:counter64;
      description
        "Out RSVP packet errors count.";
    }
    leaf in-errors {
      type yang:counter64;
      description
        "In RSVP packet rx errors count.";
    }
  }

  /**
   * RSVP extensions augmentations
   */

  /**
   * RSVP all interfaces extensions
   */

  /* RSVP interface signaling extensions */
  augment "/rt:routing/rt:control-plane-protocols/"
        + "rt:control-plane-protocol/rsvp:rsvp/rsvp:interfaces" {
    description
      "RSVP signaling all interfaces configuration extensions";
    uses signaling-parameters-extended;
  }

  /* Packet statistics extension */
  augment "/rt:routing/rt:control-plane-protocols/"
        + "rt:control-plane-protocol/rsvp:rsvp/rsvp:interfaces/"
        + "rsvp:statistics/rsvp:packets" {
    description
      "RSVP packets all interfaces configuration extensions";
    uses packets-extended-statistics;
  }

  /* RSVP refresh reduction extension */
  augment "/rt:routing/rt:control-plane-protocols/"
        + "rt:control-plane-protocol/rsvp:rsvp/rsvp:interfaces/"
        + "rsvp:refresh-reduction" {
    description
      "RSVP refresh-reduction all interface configuration
       extensions";
    uses refresh-reduction-extended;
  }

  /* RSVP hellos extension */
  augment "/rt:routing/rt:control-plane-protocols/"
        + "rt:control-plane-protocol/rsvp:rsvp/rsvp:interfaces/"
        + "rsvp:hellos" {
    description
      "RSVP hello all interfaces configuration extensions";
    uses hellos-extended;
  }

  /* RSVP authentication extension */
  augment "/rt:routing/rt:control-plane-protocols/"
        + "rt:control-plane-protocol/rsvp:rsvp/rsvp:interfaces/"
        + "rsvp:authentication" {
    description
      "RSVP authentication all interfaces configuration extensions";
    uses authentication-extended;
  }

  /**
   * RSVP per interface extensions
   */
  /* RSVP interface signaling extensions */

  augment "/rt:routing/rt:control-plane-protocols/"
        + "rt:control-plane-protocol/rsvp:rsvp/rsvp:interfaces/"
        + "rsvp:interface" {
    description
      "RSVP signaling interface configuration extensions";
    uses signaling-parameters-extended;
  }

  /* Packet statistics extension */
  augment "/rt:routing/rt:control-plane-protocols/"
        + "rt:control-plane-protocol/rsvp:rsvp/rsvp:interfaces/"
        + "rsvp:interface/rsvp:statistics/rsvp:packets" {
    description
      "RSVP packet stats extensions";
    uses packets-extended-statistics;
  }

  /* RSVP refresh reduction extension */
  augment "/rt:routing/rt:control-plane-protocols/"
        + "rt:control-plane-protocol/rsvp:rsvp/rsvp:interfaces/"
        + "rsvp:interface/rsvp:refresh-reduction" {
    description
      "RSVP refresh-reduction interface configuration extensions";
    uses refresh-reduction-extended;
  }

  /* RSVP hellos extension */
  augment "/rt:routing/rt:control-plane-protocols/"
        + "rt:control-plane-protocol/rsvp:rsvp/rsvp:interfaces/"
        + "rsvp:interface/rsvp:hellos" {
    description
      "RSVP hello interface configuration extensions";
    uses hellos-extended;
  }

  /* RSVP authentication extension */
  augment "/rt:routing/rt:control-plane-protocols/"
        + "rt:control-plane-protocol/rsvp:rsvp/rsvp:interfaces/"
        + "rsvp:interface/rsvp:authentication" {
    description
      "RSVP authentication interface configuration extensions";
    uses authentication-extended;
  }
}

]]>




IANA Considerations

This document registers the following URIs in the IETF XML registry
.  Following the format in , the following registration
is requested to be made.



This document registers two YANG modules in the YANG Module Names
registry .




Security Considerations

The YANG module specified in this document defines a schema for data that is
designed to be accessed via network management protocols such as NETCONF
 or RESTCONF . The lowest NETCONF layer is the secure
transport layer, and the mandatory-to-implement secure transport is Secure
Shell (SSH) .  The lowest RESTCONF layer is HTTPS, and the
mandatory-to-implement secure transport is TLS .

The Network Configuration Access Control Model (NACM)  provides the
means to restrict access for particular NETCONF or RESTCONF users to a
preconfigured subset of all available NETCONF or RESTCONF protocol operations
and content.

There are a number of data nodes defined in the YANG module(s) defined in this
document that are writable/creatable/deletable (i.e., config true, which is the
default).  These data nodes may be considered sensitive or vulnerable in some
network environments.  Write operations (e.g., <edit-config>) to these data
nodes without proper protection can have a negative effect on network
operations. These are the subtrees and data nodes and their sensitivity/vulnerability:

/rt:routing/rt:control-plane-protocols/rt:control-plane-protocol/rsvp:rsvp/
    /rsvp:globals
    /rsvp:interfaces
    /rsvp:sessions


  All of which are considered sensitive and if access to either of these is
compromised, it can result in temporary network outages or be employed to
mount DoS attacks.


Some of the readable data nodes in this YANG module may be considered sensitive
or vulnerable in some network environments. It is thus important to control
read access (e.g., via get, get-config, or notification) to these data nodes.
These are the subtrees and data nodes and their sensitivity/vulnerability:

/rt:routing/rt:control-plane-protocols/rt:control-plane-protocol/rsvp:rsvp/
    /rsvp:globals
    /rsvp:interfaces
    /rsvp:sessions


  Additional information from these state data nodes can be inferred with respect
to the network topology, and device location and subsequently be used to mount
other attacks in the network.


For RSVP authentication, the configuration supported is via the specification of
key-chains  or the direct specification of key and authentication
algorithm, and hence security considerations of  are inherited.  This
includes the considerations with respect to the local storage and handling of
authentication keys.

Some of the RPC operations defined in this YANG module may be considered
sensitive or vulnerable in some network environments.  It is thus
important to control access to these operations.  The RSVP YANG
module support the "clear-session" and "clear-neighbor" RPCs.  If
access to either of these is compromised, they can result in
temporary network outages be employed to mount DoS attacks.

The security considerations spelled out in the YANG 1.1 specification
 apply for this document as well.


Acknowledgement

The authors would like to thank Tom Petch for reviewing and providing useful
feedback about the document. The authors would also like to thank Lou Berger,
Xia Chen, Bin Wen, and Raqib Jones for reviewing and providing valuable feedback on this document.


Appendix A

A simple network setup is shown in {fig-example title}.  R1 runs the RSVP routing
protocol on both interfaces 'ge0/0/0/1', and 'ge0/0/0/2'.



The instance data tree could then be as follows:




Contributors