Package org.opendaylight.yang.gen.v1.http.openconfig.net.yang.bgp.rev151009

Interface BgpNeighborGracefulRestartConfig

All Superinterfaces:
org.opendaylight.yangtools.yang.binding.BindingContract<org.opendaylight.yangtools.yang.binding.DataContainer>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject
All Known Subinterfaces:
Config, State
@Generated("mdsal-binding-generator") public interface BgpNeighborGracefulRestartConfig extends org.opendaylight.yangtools.yang.binding.DataObject
Configuration parameters relating to BGP graceful restart.

This class represents the following YANG schema fragment defined in module openconfig-bgp 

 grouping bgp-neighbor-graceful-restart_config {
   leaf enabled {
     type boolean;
   }
   leaf restart-time {
     type uint16 {
       range 0..4096;
     }
   }
   leaf stale-routes-time {
     type decimal64 {
       fraction-digits 2;
     }
   }
   leaf helper-only {
     type boolean;
   }
 }

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final @NonNull org.opendaylight.yangtools.yang.common.QName
    QNAME
    YANG identifier of the statement represented by this class.

  • Method Summary

    Modifier and Type
    Method
    Description
    Boolean
    getEnabled()
    Return enabled, or null if it is not present.
    Boolean
    getHelperOnly()
    Return helperOnly, or null if it is not present.
    org.opendaylight.yangtools.yang.common.Uint16
    getRestartTime()
    Return restartTime, or null if it is not present.
    org.opendaylight.yangtools.yang.common.Decimal64
    getStaleRoutesTime()
    Return staleRoutesTime, or null if it is not present.
    Class<? extends BgpNeighborGracefulRestartConfig>
    implementedInterface()
     
    default @NonNull Boolean
    requireEnabled()
    Return enabled, guaranteed to be non-null.
    default @NonNull Boolean
    requireHelperOnly()
    Return helperOnly, guaranteed to be non-null.
    default @NonNull org.opendaylight.yangtools.yang.common.Uint16
    requireRestartTime()
    Return restartTime, guaranteed to be non-null.
    default @NonNull org.opendaylight.yangtools.yang.common.Decimal64
    requireStaleRoutesTime()
    Return staleRoutesTime, guaranteed to be non-null.

  • Field Details

    • QNAME

      static final @NonNull org.opendaylight.yangtools.yang.common.QName QNAME
      YANG identifier of the statement represented by this class.

  • Method Details

    • implementedInterface

      Class<? extends BgpNeighborGracefulRestartConfig> implementedInterface()
      Specified by:
      implementedInterface in interface org.opendaylight.yangtools.yang.binding.BindingContract<org.opendaylight.yangtools.yang.binding.DataContainer>
      Specified by:
      implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataObject

    • getEnabled

      Boolean getEnabled()
      Return enabled, or null if it is not present. 
           
         Enable or disable the graceful-restart capability.
      Returns:
      Boolean enabled, or null if it is not present.

    • requireEnabled

      default @NonNull Boolean requireEnabled()
      Return enabled, guaranteed to be non-null. 
           
         Enable or disable the graceful-restart capability.
      Returns:
      Boolean enabled, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if enabled is not present

    • getRestartTime

      org.opendaylight.yangtools.yang.common.Uint16 getRestartTime()
      Return restartTime, or null if it is not present. 
           
         Estimated time (in seconds) for the local BGP speaker to restart a session. This
         value is advertise in the graceful restart BGP capability. This is a 12-bit
         value, referred to as Restart Time in RFC4724. Per RFC4724, the suggested
         default value is &lt;= the hold-time value.
      Returns:
      Uint16 restartTime, or null if it is not present.

    • requireRestartTime

      default @NonNull org.opendaylight.yangtools.yang.common.Uint16 requireRestartTime()
      Return restartTime, guaranteed to be non-null. 
           
         Estimated time (in seconds) for the local BGP speaker to restart a session. This
         value is advertise in the graceful restart BGP capability. This is a 12-bit
         value, referred to as Restart Time in RFC4724. Per RFC4724, the suggested
         default value is &lt;= the hold-time value.
      Returns:
      Uint16 restartTime, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if restartTime is not present

    • getStaleRoutesTime

      org.opendaylight.yangtools.yang.common.Decimal64 getStaleRoutesTime()
      Return staleRoutesTime, or null if it is not present. 
           
         An upper-bound on the time thate stale routes will be retained by a router after
         a session is restarted. If an End-of-RIB (EOR) marker is received prior to this
         timer expiring stale-routes will be flushed upon its receipt - if no EOR is
         received, then when this timer expires stale paths will be purged. This timer is
         referred to as the Selection_Deferral_Timer in RFC4724
      Returns:
      Decimal64 staleRoutesTime, or null if it is not present.

    • requireStaleRoutesTime

      default @NonNull org.opendaylight.yangtools.yang.common.Decimal64 requireStaleRoutesTime()
      Return staleRoutesTime, guaranteed to be non-null. 
           
         An upper-bound on the time thate stale routes will be retained by a router after
         a session is restarted. If an End-of-RIB (EOR) marker is received prior to this
         timer expiring stale-routes will be flushed upon its receipt - if no EOR is
         received, then when this timer expires stale paths will be purged. This timer is
         referred to as the Selection_Deferral_Timer in RFC4724
      Returns:
      Decimal64 staleRoutesTime, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if staleRoutesTime is not present

    • getHelperOnly

      Boolean getHelperOnly()
      Return helperOnly, or null if it is not present. 
           
         Enable graceful-restart in helper mode only. When this leaf is set, the local
         system does not retain forwarding its own state during a restart, but supports
         procedures for the receiving speaker, as defined in RFC4724.
      Returns:
      Boolean helperOnly, or null if it is not present.

    • requireHelperOnly

      default @NonNull Boolean requireHelperOnly()
      Return helperOnly, guaranteed to be non-null. 
           
         Enable graceful-restart in helper mode only. When this leaf is set, the local
         system does not retain forwarding its own state during a restart, but supports
         procedures for the receiving speaker, as defined in RFC4724.
      Returns:
      Boolean helperOnly, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if helperOnly is not present