netconfcentral logo

ietf-bgp-operational

HTML

ietf-bgp-operational@2016-01-06



  module ietf-bgp-operational {

    yang-version 1;

    namespace
      "urn:ietf:params:xml:ns:yang:ietf-bgp-operational";

    prefix bgp-op;

    import ietf-inet-types {
      prefix inet;
    }
    import ietf-yang-types {
      prefix yang;
    }
    import ietf-bgp-types {
      prefix bgp-types;
    }

    organization "OpenConfig working group";

    contact
      "OpenConfig working group
    netopenconfig@googlegroups.com";

    description
      "This module is part of a YANG model for BGP protocol
    configuration, focusing on operational data (i.e., state
    variables) related to BGP operations";

    revision "2016-01-06" {
      description
        "Updated filename and namespace";
      reference
        "TBD";

    }


    grouping bgp-counters-message-types_common {
      description
        "Grouping of BGP message types, included for re-use
      across counters";
      leaf UPDATE {
        type uint64;
        description
          "Number of BGP UPDATE messages announcing, withdrawing
        or modifying paths exchanged.";
      }

      leaf NOTIFICATION {
        type uint64;
        description
          "Number of BGP NOTIFICATION messages indicating an
        error condition has occurred exchanged.";
      }
    }  // grouping bgp-counters-message-types_common

    grouping bgp-context-pfx-path-counters_common {
      description
        "Grouping containing common counters relating to prefixes and
      paths";
      leaf total-paths {
        type uint32;
        description
          "Total number of BGP paths within the context";
      }

      leaf total-prefixes {
        type uint32;
        description "";
      }
    }  // grouping bgp-context-pfx-path-counters_common

    grouping bgp-global_state {
      description
        "Grouping containing operational parameters relating to the
      global BGP instance";
      uses bgp-context-pfx-path-counters_common;
    }  // grouping bgp-global_state

    grouping bgp-global-afi-safi_state {
      description
        "Grouping containing operational parameters relating to each
      AFI-SAFI within the BGP global instance";
      uses bgp-context-pfx-path-counters_common;
    }  // grouping bgp-global-afi-safi_state

    grouping bgp-peer-group_state {
      description
        "Grouping containing operational parameters relating to a BGP
      peer group";
      uses bgp-context-pfx-path-counters_common;
    }  // grouping bgp-peer-group_state

    grouping bgp-neighbor_state {
      description
        "Grouping containing operational state variables relating to a
      BGP neighbor";
      leaf session-state {
        type enumeration {
          enum "IDLE" {
            value 0;
            description
              "neighbor is down, and in the Idle state of the
              FSM";
          }
          enum "CONNECT" {
            value 1;
            description
              "neighbor is down, and the session is waiting for
              the underlying transport session to be established";
          }
          enum "ACTIVE" {
            value 2;
            description
              "neighbor is down, and the local system is awaiting
              a conncetion from the remote peer";
          }
          enum "OPENSENT" {
            value 3;
            description
              "neighbor is in the process of being established.
              The local system has sent an OPEN message";
          }
          enum "OPENCONFIRM" {
            value 4;
            description
              "neighbor is in the process of being established.
              The local system is awaiting a NOTIFICATION or
              KEEPALIVE message";
          }
          enum "ESTABLISHED" {
            value 5;
            description
              "neighbor is up - the BGP session with the peer is
              established";
          }
        }
        description
          "Operational state of the BGP peer";
      }

      leaf-list supported-capabilities {
        type identityref {
          base bgp-types:bgp-capability;
        }
        description
          "BGP capabilities negotiated as supported with the peer";
      }
    }  // grouping bgp-neighbor_state

    grouping bgp-neighbor-afi-safi_state {
      description
        "Operational state on a per-AFI-SAFI basis for a BGP
      neighbor";
      leaf active {
        type boolean;
        description
          "This value indicates whether a particular AFI-SAFI has
        been succesfully negotiated with the peer. An AFI-SAFI
        may be enabled in the current running configuration, but a
        session restart may be required in order to negotiate the new
        capability.";
      }

      uses bgp-neighbor-prefix-counters_state;
    }  // grouping bgp-neighbor-afi-safi_state

    grouping bgp-neighbor-prefix-counters_state {
      description
        "Counters for BGP neighbor sessions";
      container prefixes {
        description
          "Prefix counters for the BGP session";
        leaf received {
          type uint32;
          description
            "The number of prefixes received from the neighbor";
        }

        leaf sent {
          type uint32;
          description
            "The number of prefixes advertised to the neighbor";
        }

        leaf installed {
          type uint32;
          description
            "The number of advertised prefixes installed in the
          Loc-RIB";
        }
      }  // container prefixes
    }  // grouping bgp-neighbor-prefix-counters_state

    grouping bgp-neighbor-message-counters-sent_state {
      description
        "Counters relating to messages sent to a BGP neighbor";
      uses bgp-counters-message-types_common;
    }  // grouping bgp-neighbor-message-counters-sent_state

    grouping bgp-neighbor-message-counters-received_state {
      description
        "Counters relating to the mesages received from a BGP
      neighbor";
      uses bgp-counters-message-types_common;
    }  // grouping bgp-neighbor-message-counters-received_state

    grouping bgp-neighbor-queue-counters_state {
      description
        "Counters relating to the message queues associated with the
      BGP peer";
      leaf input {
        type uint32;
        description
          "The number of messages received from the peer currently
        queued";
      }

      leaf output {
        type uint32;
        description
          "The number of messages queued to be sent to the peer";
      }
    }  // grouping bgp-neighbor-queue-counters_state

    grouping bgp-neighbor-transport_state {
      description
        "Operational state parameters relating to the transport session
      used for the BGP session";
      leaf local-port {
        type inet:port-number;
        description
          "Local TCP port being used for the TCP session supporting
        the BGP session";
      }

      leaf remote-address {
        type inet:ip-address;
        description
          "Remote port being used by the peer for the TCP session
        supporting the BGP session";
      }

      leaf remote-port {
        type inet:port-number;
        description
          "Remote address to which the BGP session has been
        established";
      }
    }  // grouping bgp-neighbor-transport_state

    grouping bgp-neighbor-error-handling_state {
      description
        "Operational state parameters relating to enhanced error
      error handling for BGP";
      leaf erroneous-update-messages {
        type uint32;
        description
          "The number of BGP UPDATE messages for which the
        treat-as-withdraw mechanism has been applied based
        on erroneous message contents";
      }
    }  // grouping bgp-neighbor-error-handling_state

    grouping bgp-neighbor-timers_state {
      description
        "Operational state parameters relating to BGP timers associated
      with the BGP session";
      leaf uptime {
        type yang:timeticks;
        description
          "This timer determines the amount of time since the
        BGP last transitioned in or out of the Established
        state";
      }

      leaf negotiated-hold-time {
        type decimal64 {
          fraction-digits 2;
        }
        description
          "The negotiated hold-time for the BGP session";
      }
    }  // grouping bgp-neighbor-timers_state

    grouping bgp-afi-safi_state {
      description
        "Operational state information relevant to all address
      families that may be carried by the BGP session";
    }  // grouping bgp-afi-safi_state

    grouping bgp-afi-safi-graceful-restart_state {
      description
        "Operational state information relevant to graceful restart
      for BGP";
      leaf peer-restart-time {
        type uint16 {
          range "0..4096";
        }
        description
          "The period of time (advertised by the peer) that
        the peer expects a restart of a BGP session to
        take";
      }

      leaf peer-restarting {
        type boolean;
        description
          "This flag indicates whether the remote neighbor is currently
        in the process of restarting, and hence received routes are
        currently stale";
      }

      leaf local-restarting {
        type boolean;
        description
          "This flag indicates whether the local neighbor is currently
        restarting. The flag is unset after all NLRI have been
        advertised to the peer, and the End-of-RIB (EOR) marker has
        been unset";
      }

      leaf mode {
        type enumeration {
          enum "HELPER-ONLY" {
            value 0;
            description
              "The local router is operating in helper-only mode, and
            hence will not retain forwarding state during a local
            session restart, but will do so during a restart of the
            remote peer";
          }
          enum "BILATERAL" {
            value 1;
            description
              "The local router is operating in both helper mode, and
            hence retains forwarding state during a remote restart,
            and also maintains forwarding state during local session
            restart";
          }
          enum "REMOTE-HELPER" {
            value 2;
            description
              "The local system is able to retain routes during restart
            but the remote system is only able to act as a helper";
          }
        }
        description
          "Ths leaf indicates the mode of operation of BGP graceful
        restart with the peer";
      }
    }  // grouping bgp-afi-safi-graceful-restart_state

    grouping bgp-neighbor-afi-safi-graceful-restart_state {
      description
        "Operational state variables relating to the graceful-restart
      mechanism on a per-AFI-SAFI basis";
      leaf received {
        type boolean;
        description
          "This leaf indicates whether the neighbor advertised the
        ability to support graceful-restart for this AFI-SAFI";
      }

      leaf advertised {
        type boolean;
        description
          "This leaf indicates whether the ability to support
        graceful-restart has been advertised to the peer";
      }
    }  // grouping bgp-neighbor-afi-safi-graceful-restart_state
  }  // module ietf-bgp-operational

Summary

  
  
Organization OpenConfig working group
  
Module ietf-bgp-operational
Version 2016-01-06
File ietf-bgp-operational@2016-01-06.yang
  
Prefix bgp-op
Namespace urn:ietf:params:xml:ns:yang:ietf-bgp-operational
  
Cooked /cookedmodules/ietf-bgp-operational/2016-01-06
YANG /src/ietf-bgp-operational@2016-01-06.yang
XSD /xsd/ietf-bgp-operational@2016-01-06.xsd
  
Abstract This module is part of a YANG model for BGP protocol configuration, focusing on operational data (i.e., state variables) related...
  
Contact
OpenConfig working group
netopenconfig@googlegroups.com

Description

 
This module is part of a YANG model for BGP protocol
configuration, focusing on operational data (i.e., state
variables) related to BGP operations

Groupings

Grouping Objects Abstract
bgp-afi-safi-graceful-restart_state peer-restart-time peer-restarting local-restarting mode Operational state information relevant to graceful restart for BGP
bgp-afi-safi_state Operational state information relevant to all address families that may be carried by the BGP session
bgp-context-pfx-path-counters_common total-paths total-prefixes Grouping containing common counters relating to prefixes and paths
bgp-counters-message-types_common UPDATE NOTIFICATION Grouping of BGP message types, included for re-use across counters
bgp-global-afi-safi_state total-paths total-prefixes Grouping containing operational parameters relating to each AFI-SAFI within the BGP global instance
bgp-global_state total-paths total-prefixes Grouping containing operational parameters relating to the global BGP instance
bgp-neighbor-afi-safi-graceful-restart_state received advertised Operational state variables relating to the graceful-restart mechanism on a per-AFI-SAFI basis
bgp-neighbor-afi-safi_state active prefixes Operational state on a per-AFI-SAFI basis for a BGP neighbor
bgp-neighbor-error-handling_state erroneous-update-messages Operational state parameters relating to enhanced error error handling for BGP
bgp-neighbor-message-counters-received_state UPDATE NOTIFICATION Counters relating to the mesages received from a BGP neighbor
bgp-neighbor-message-counters-sent_state UPDATE NOTIFICATION Counters relating to messages sent to a BGP neighbor
bgp-neighbor-prefix-counters_state prefixes Counters for BGP neighbor sessions
bgp-neighbor-queue-counters_state input output Counters relating to the message queues associated with the BGP peer
bgp-neighbor-timers_state uptime negotiated-hold-time Operational state parameters relating to BGP timers associated with the BGP session
bgp-neighbor-transport_state local-port remote-address remote-port Operational state parameters relating to the transport session used for the BGP session
bgp-neighbor_state session-state supported-capabilities Grouping containing operational state variables relating to a BGP neighbor
bgp-peer-group_state total-paths total-prefixes Grouping containing operational parameters relating to a BGP peer group