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

Interface BgpNeighborGracefulRestartConfig

All Superinterfaces:

org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject

All Known Subinterfaces:

Config, State

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;
   }
 }
 

The schema path to identify an instance is openconfig-bgp/bgp-neighbor-graceful-restart_config

Field Summary

Fields

Modifier and Type	Field	Description
static @NonNull org.opendaylight.yangtools.yang.common.QName	QNAME

Method Summary

Modifier and Type	Method	Description
org.opendaylight.yangtools.yang.common.Uint16	getRestartTime()	Estimated time (in seconds) for the local BGP speaker to restart a session.
BigDecimal	getStaleRoutesTime()	An upper-bound on the time thate stale routes will be retained by a router after a session is restarted.
Class<? extends BgpNeighborGracefulRestartConfig>	implementedInterface()
Boolean	isEnabled()	Enable or disable the graceful-restart capability.
Boolean	isHelperOnly()	Enable graceful-restart in helper mode only.

Field Detail

QNAME

static final @NonNull org.opendaylight.yangtools.yang.common.QName QNAME

Method Detail

implementedInterface

Class<? extends BgpNeighborGracefulRestartConfig> implementedInterface()

Specified by:

implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataContainer

Specified by:

implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataObject

isEnabled

Boolean isEnabled()

Enable or disable the graceful-restart capability.

Returns:

java.lang.Boolean enabled, or null if not present

getRestartTime

org.opendaylight.yangtools.yang.common.Uint16 getRestartTime()

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 <= the hold-time value.

Returns:

org.opendaylight.yangtools.yang.common.Uint16 restartTime, or null if not present

getStaleRoutesTime

BigDecimal getStaleRoutesTime()

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:

java.math.BigDecimal staleRoutesTime, or null if not present

isHelperOnly

Boolean isHelperOnly()

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:

java.lang.Boolean helperOnly, or null if not present