netconfcentral logo

ietf-rsvp

HTML

ietf-rsvp@2020-07-24



  module ietf-rsvp {

    yang-version 1.1;

    namespace
      "urn:ietf:params:xml:ns:yang:ietf-rsvp";

    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:   <http://tools.ietf.org/wg/teas/>
     WG List:  <mailto:teas@ietf.org>

     Editor:   Vishnu Pavan Beeram
               <mailto:vbeeram@juniper.net>

     Editor:   Tarek Saad
               <mailto:tsaad@juniper.net>

     Editor:   Rakesh Gandhi
               <mailto:rgandhi@cisco.com>

     Editor:   Xufeng Liu
               <mailto: xufeng.liu.ietf@gmail.com>

     Editor:   Igor Bryskin
               <mailto:i_bryskin@yahoo.com>";

    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.";

    revision "2020-07-24" {
      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 {
      base 
      description "Base RSVP session type";
    }

    identity rsvp-session-ip {
      base rsvp-session-type;
      description "RSVP IP session type";
    }

    identity reservation-style {
      base 
      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 graceful-restart-config {
      description
        "Base configuration parameters relating to RSVP
       Graceful-Restart.";
      leaf enabled {
        type boolean;
        description
          "'true' if RSVP Graceful Restart is enabled.
         'false' if RSVP Graceful Restart is disabled.";
      }
    }  // grouping graceful-restart-config

    grouping graceful-restart {
      description
        "RSVP graceful restart parameters grouping.";
      container graceful-restart {
        description
          "RSVP graceful restart parameters container.";
        uses graceful-restart-config;
      }  // container graceful-restart
    }  // grouping graceful-restart

    grouping refresh-reduction-config {
      description
        "Configuration parameters related to RSVP refresh reduction.";
      leaf enabled {
        type boolean;
        description
          "'true' if RSVP Refresh Reduction is enabled.
         'false' if RSVP Refresh Reduction is disabled.";
      }
    }  // grouping refresh-reduction-config

    grouping refresh-reduction {
      description
        "Top level grouping for RSVP refresh reduction parameters.";
      container refresh-reduction {
        description
          "Top level container for RSVP refresh reduction parameters.";
        uses refresh-reduction-config;
      }  // container refresh-reduction
    }  // grouping refresh-reduction

    grouping authentication-config {
      description
        "Configuration parameters relating to RSVP authentication";
      leaf enabled {
        type boolean;
        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;
        }
        mandatory true;
        description
          "Cryptographic algorithm associated with key.";
      }
    }  // grouping authentication-config

    grouping authentication {
      description
        "Top level grouping for RSVP authentication parameters.";
      container authentication {
        description
          "Top level container for RSVP authentication parameters.";
        uses authentication-config;
      }  // container authentication
    }  // grouping authentication

    grouping hellos-config {
      description
        "Configuration parameters relating to RSVP hellos.";
      leaf enabled {
        type boolean;
        description
          "'true' if RSVP Hello is enabled.
         'false' if RSVP Hello is disabled.";
      }
    }  // grouping hellos-config

    grouping hellos {
      description
        "Top level grouping for RSVP hellos parameters.";
      container hellos {
        description
          "Top level container for RSVP hello parameters.";
        uses hellos-config;
      }  // container hellos
    }  // grouping hellos

    grouping signaling-parameters-config {
      description
        "Configuration parameters relating to RSVP signaling.";
    }  // grouping signaling-parameters-config

    grouping signaling-parameters {
      description
        "Top level grouping for RSVP signaling  parameters.";
      uses signaling-parameters-config;
    }  // grouping signaling-parameters

    grouping session-attributes {
      description
        "Top level grouping for RSVP session properties.";
      leaf destination-port {
        type inet:port-number;
        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" {
            value 0;
            description
              "RSVP session is up.";
          }
          enum "down" {
            value 1;
            description
              "RSVP session is down.";
          }
        }
        description
          "Enumeration of RSVP session states.";
      }

      leaf session-type {
        type identityref {
          base rsvp-session-type;
        }
        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).";
          }
        }  // list psb
      }  // container psbs

      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).";
          }
        }  // list rsb
      }  // container rsbs
    }  // grouping session-attributes

    grouping neighbor-attributes {
      description
        "Top level grouping for RSVP neighbor properties.";
      leaf address {
        type inet:ip-address;
        description
          "Address of the RSVP neighbor.";
      }

      leaf epoch {
        type uint32;
        description "Neighbor epoch.";
      }

      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 enabled {
          type boolean;
          description
            "'true' if graceful restart is enabled for the neighbor.";
        }

        leaf local-restart-time {
          type uint32;
          units "seconds";
          description
            "Local node restart time.";
        }

        leaf local-recovery-time {
          type uint32;
          units "seconds";
          description
            "Local node recover time.";
        }

        leaf neighbor-restart-time {
          type uint32;
          units "seconds";
          description
            "Neighbor restart time.";
        }

        leaf neighbor-recovery-time {
          type uint32;
          units "seconds";
          description
            "Neighbor recovery time.";
        }

        container helper-mode {
          description
            "Helper mode information.";
          leaf enabled {
            type boolean;
            description
              "'true' if helper mode is enabled.";
          }

          leaf max-helper-restart-time {
            type uint32;
            units "seconds";
            description
              "The time the router or switch waits after it discovers
             that a neighboring router has gone down before it
             declares the neighbor down.";
          }

          leaf max-helper-recovery-time {
            type uint32;
            units "seconds";
            description
              "The amount of time the router retains the state of its
             RSVP neighbors while they undergo a graceful restart.";
          }

          leaf neighbor-restart-time-remaining {
            type uint32;
            units "seconds";
            description
              "Number of seconds remaining for neighbor to send Hello
             message after restart.";
          }

          leaf neighbor-recovery-time-remaining {
            type uint32;
            units "seconds";
            description
              "Number of seconds remaining for neighbor to refresh.";
          }
        }  // container helper-mode
      }  // container graceful-restart

      leaf hello-status {
        type enumeration {
          enum "enabled" {
            value 0;
            description
              "RSVP Hellos enabled.";
          }
          enum "disabled" {
            value 1;
            description
              "RSVP Hellos disabled.";
          }
          enum "restarting" {
            value 2;
            description "RSVP restarting.";
          }
        }
        description "RSVP Hello status.";
      }

      leaf interface {
        type if:interface-ref;
        description
          "Interface where RSVP neighbor was detected.";
      }

      leaf neighbor-status {
        type enumeration {
          enum "up" {
            value 0;
            description "Neighbor state up.";
          }
          enum "down" {
            value 1;
            description
              "Neighbor state down.";
          }
          enum "hello-disable" {
            value 2;
            description
              "RSVP Hellos disabled.";
          }
          enum "restarting" {
            value 3;
            description
              "RSVP neighbor restarting.";
          }
        }
        description "RSVP neighbor state.";
      }

      leaf refresh-reduction-capable {
        type boolean;
        description
          "Enables all RSVP refresh reduction message bundling, RSVP
         message ID, reliable message delivery and summary refresh.";
        reference
          "RFC2961 RSVP Refresh Overhead Reduction Extensions";

      }

      leaf restart-count {
        type yang:counter32;
        description
          "Number of times this RSVP neighbor has restarted.";
      }

      leaf restart-time {
        type yang:date-and-time;
        description
          "Last restart time of the RSVP neighbor.";
      }
    }  // grouping neighbor-attributes

    grouping packet-statistics {
      description
        "Packet statistics grouping.";
      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 packets
    }  // grouping packet-statistics

    grouping message-statistics {
      description
        "RSVP protocol statistics grouping.";
      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 summary-refresh-sent {
          type yang:counter64;
          description
            "RSVP Summary refresh message sent count.";
        }

        leaf summary-refresh-received {
          type yang:counter64;
          description
            "RSVP Summary refresh message received count.";
        }

        leaf unknown-messages-received {
          type yang:counter64;
          description
            "Unknown messages received count.";
        }
      }  // container messages
    }  // grouping message-statistics

    grouping errors-statistics {
      description
        "Error statistics grouping.";
      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.";
        }
      }  // container errors
    }  // grouping errors-statistics

    grouping statistics {
      description
        "RSVP statistic attributes.";
      container statistics {
        config false;
        description
          "RSVP statistics container.";
        uses message-statistics;

        uses packet-statistics;

        uses errors-statistics;
      }  // container statistics
    }  // grouping statistics

    grouping global-attributes {
      description
        "Top level grouping for RSVP global properties.";
      container sessions {
        description
          "RSVP sessions container.";
        list session-ip {
          key "destination protocol-id destination-port";
          config false;
          description
            "List of RSVP sessions.";
          uses session-attributes;
        }  // list session-ip
      }  // container sessions

      uses statistics;
    }  // grouping global-attributes

    grouping intf-attributes {
      description
        "Top level grouping for RSVP interface properties.";
      uses signaling-parameters;

      uses refresh-reduction;

      uses hellos;

      uses authentication;

      uses statistics;
    }  // grouping intf-attributes

    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 globals {
          description
            "RSVP global properties.";
          uses global-attributes;

          uses graceful-restart;
        }  // container globals

        container interfaces {
          description
            "RSVP interfaces container.";
          uses intf-attributes;

          list interface {
            key "interface";
            description "RSVP interfaces.";
            leaf interface {
              type if:interface-ref;
              description "RSVP interface.";
            }

            uses intf-attributes;
          }  // list interface
        }  // container interfaces

        container neighbors {
          description
            "RSVP neighbors container";
          list neighbor {
            key "address";
            description
              "List of RSVP neighbors";
            uses neighbor-attributes;
          }  // list neighbor
        }  // container neighbors
      }  // container rsvp
    }

    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:globals"
              + "/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.";
      }
    }  // grouping session-ref

    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";
          leaf all {
            type empty;
            mandatory true;
            description
              "Match all RSVP sessions.";
          }
          container session-info {
            description
              "Specifies the specific session to invoke operation on";
            choice session-type {
              mandatory true;
              description
                "The RSVP session type.";
              case rsvp-session-ip {
                uses session-ref;
              }  // case rsvp-session-ip
            }  // choice session-type
          }  // container session-info
        }  // choice filter-type
      }
    }  // rpc clear-session

    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.";
          leaf all {
            type empty;
            mandatory true;
            description
              "Match all RSVP neighbor sessions.";
          }
          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.";
          }
        }  // choice filter-type
      }
    }  // rpc clear-neighbor

    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";
          leaf all {
            type empty;
            mandatory true;
            description
              "Match all RSVP security associations.";
          }
          leaf interface {
            type if:interface-ref;
            description
              "Interface where RSVP security association(s) to be
               detected.";
          }
        }  // choice filter-type
      }
    }  // rpc clear-authentication
  }  // module ietf-rsvp

Summary

  
  
Organization IETF Traffic Engineering Architecture and Signaling (TEAS) Working Group
  
Module ietf-rsvp
Version 2020-07-24
File ietf-rsvp@2020-07-24.yang
  
Prefix rsvp
Namespace urn:ietf:params:xml:ns:yang:ietf-rsvp
  
Cooked /cookedmodules/ietf-rsvp/2020-07-24
YANG /src/ietf-rsvp@2020-07-24.yang
XSD /xsd/ietf-rsvp@2020-07-24.xsd
  
Abstract This module contains the RSVP YANG data model. The model fully conforms to the Network Management Datastore Architecture (NMDA)....
  
Contact
WG Web:   <http://tools.ietf.org/wg/teas/>
WG List:  <mailto:teas@ietf.org>

Editor:   Vishnu Pavan Beeram
	  <mailto:vbeeram@juniper.net>

Editor:   Tarek Saad
	  <mailto:tsaad@juniper.net>

Editor:   Rakesh Gandhi
	  <mailto:rgandhi@cisco.com>

Editor:   Xufeng Liu
	  <mailto: xufeng.liu.ietf@gmail.com>

Editor:   Igor Bryskin
	  <mailto:i_bryskin@yahoo.com>

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.

Groupings

Grouping Objects Abstract
authentication authentication Top level grouping for RSVP authentication parameters.
authentication-config enabled authentication-key crypto-algorithm Configuration parameters relating to RSVP authentication
errors-statistics errors Error statistics grouping.
global-attributes sessions statistics Top level grouping for RSVP global properties.
graceful-restart graceful-restart RSVP graceful restart parameters grouping.
graceful-restart-config enabled Base configuration parameters relating to RSVP Graceful-Restart.
hellos hellos Top level grouping for RSVP hellos parameters.
hellos-config enabled Configuration parameters relating to RSVP hellos.
intf-attributes refresh-reductionhellosauthenticationstatistics Top level grouping for RSVP interface properties.
message-statistics messages RSVP protocol statistics grouping.
neighbor-attributes address epoch expiry-time graceful-restart hello-status interface neighbor-status refresh-reduction-capable restart-count restart-time Top level grouping for RSVP neighbor properties.
packet-statistics packets Packet statistics grouping.
refresh-reduction refresh-reduction Top level grouping for RSVP refresh reduction parameters.
refresh-reduction-config enabled Configuration parameters related to RSVP refresh reduction.
session-attributes destination-port protocol-id source destination session-name session-status session-type psbs rsbs Top level grouping for RSVP session properties.
session-ref destination protocol-id destination-port Session reference information
signaling-parameters Top level grouping for RSVP signaling parameters.
signaling-parameters-config Configuration parameters relating to RSVP signaling.
statistics statistics RSVP statistic attributes.

RPC Methods

RPC Abstract
clear-authentication Clears the RSVP Security Association (SA) before the lifetime expires.
clear-neighbor RPC to clear the RSVP Hello session to a neighbor.
clear-session Clears RSVP sessions RPC