Interface BgpNeighborTimersConfig

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 BgpNeighborTimersConfig extends org.opendaylight.yangtools.yang.binding.DataObject
Config parameters related to timers associated with the BGP peer

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

 grouping bgp-neighbor-timers_config {
   leaf connect-retry {
     type decimal64 {
       fraction-digits 2;
     }
     default 30;
   }
   leaf hold-time {
     type decimal64 {
       fraction-digits 2;
     }
     default 90;
   }
   leaf keepalive-interval {
     type decimal64 {
       fraction-digits 2;
     }
     default 30;
   }
   leaf minimum-advertisement-interval {
     type decimal64 {
       fraction-digits 2;
     }
     default 30;
   }
 }
 
  • Field Summary

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

    Modifier and Type
    Method
    Description
    org.opendaylight.yangtools.yang.common.Decimal64
    Return connectRetry, or null if it is not present.
    org.opendaylight.yangtools.yang.common.Decimal64
    Return holdTime, or null if it is not present.
    org.opendaylight.yangtools.yang.common.Decimal64
    Return keepaliveInterval, or null if it is not present.
    org.opendaylight.yangtools.yang.common.Decimal64
    Return minimumAdvertisementInterval, or null if it is not present.
     
    default @NonNull org.opendaylight.yangtools.yang.common.Decimal64
    Return connectRetry, guaranteed to be non-null.
    default @NonNull org.opendaylight.yangtools.yang.common.Decimal64
    Return holdTime, guaranteed to be non-null.
    default @NonNull org.opendaylight.yangtools.yang.common.Decimal64
    Return keepaliveInterval, guaranteed to be non-null.
    default @NonNull org.opendaylight.yangtools.yang.common.Decimal64
    Return minimumAdvertisementInterval, 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 BgpNeighborTimersConfig> 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
    • getConnectRetry

      org.opendaylight.yangtools.yang.common.Decimal64 getConnectRetry()
      Return connectRetry, or null if it is not present.
           
               Time interval in seconds between attempts to establish a session with the peer.
           
       
      Returns:
      Decimal64 connectRetry, or null if it is not present.
    • requireConnectRetry

      default @NonNull org.opendaylight.yangtools.yang.common.Decimal64 requireConnectRetry()
      Return connectRetry, guaranteed to be non-null.
           
               Time interval in seconds between attempts to establish a session with the peer.
           
       
      Returns:
      Decimal64 connectRetry, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if connectRetry is not present
    • getHoldTime

      org.opendaylight.yangtools.yang.common.Decimal64 getHoldTime()
      Return holdTime, or null if it is not present.
           
               Time interval in seconds that a BGP session will be considered active in the
               absence of keepalive or other messages from the peer. The hold-time is typically
               set to 3x the keepalive-interval.
           
       
      Returns:
      Decimal64 holdTime, or null if it is not present.
    • requireHoldTime

      default @NonNull org.opendaylight.yangtools.yang.common.Decimal64 requireHoldTime()
      Return holdTime, guaranteed to be non-null.
           
               Time interval in seconds that a BGP session will be considered active in the
               absence of keepalive or other messages from the peer. The hold-time is typically
               set to 3x the keepalive-interval.
           
       
      Returns:
      Decimal64 holdTime, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if holdTime is not present
    • getKeepaliveInterval

      org.opendaylight.yangtools.yang.common.Decimal64 getKeepaliveInterval()
      Return keepaliveInterval, or null if it is not present.
           
               Time interval in seconds between transmission of keepalive messages to the
               neighbor. Typically set to 1/3 the hold-time.
           
       
      Returns:
      Decimal64 keepaliveInterval, or null if it is not present.
    • requireKeepaliveInterval

      default @NonNull org.opendaylight.yangtools.yang.common.Decimal64 requireKeepaliveInterval()
      Return keepaliveInterval, guaranteed to be non-null.
           
               Time interval in seconds between transmission of keepalive messages to the
               neighbor. Typically set to 1/3 the hold-time.
           
       
      Returns:
      Decimal64 keepaliveInterval, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if keepaliveInterval is not present
    • getMinimumAdvertisementInterval

      org.opendaylight.yangtools.yang.common.Decimal64 getMinimumAdvertisementInterval()
      Return minimumAdvertisementInterval, or null if it is not present.
           
               Minimum time which must elapse between subsequent UPDATE messages relating to a
               common set of NLRI being transmitted to a peer. This timer is referred to as
               MinRouteAdvertisementIntervalTimer by RFC 4721 and serves to reduce the number
               of UPDATE messages transmitted when a particular set of NLRI exhibit
               instability.
           
       
      Returns:
      Decimal64 minimumAdvertisementInterval, or null if it is not present.
    • requireMinimumAdvertisementInterval

      default @NonNull org.opendaylight.yangtools.yang.common.Decimal64 requireMinimumAdvertisementInterval()
      Return minimumAdvertisementInterval, guaranteed to be non-null.
           
               Minimum time which must elapse between subsequent UPDATE messages relating to a
               common set of NLRI being transmitted to a peer. This timer is referred to as
               MinRouteAdvertisementIntervalTimer by RFC 4721 and serves to reduce the number
               of UPDATE messages transmitted when a particular set of NLRI exhibit
               instability.
           
       
      Returns:
      Decimal64 minimumAdvertisementInterval, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if minimumAdvertisementInterval is not present