Interface BgpAfiSafiGracefulRestartState

  • All Superinterfaces:
    org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject
    All Known Subinterfaces:
    NeighborGracefulRestartStateAugmentation, State5

    @Generated("mdsal-binding-generator")
    public interface BgpAfiSafiGracefulRestartState
    extends org.opendaylight.yangtools.yang.binding.DataObject
    Operational state information relevant to graceful restart for BGP

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

     grouping bgp-afi-safi-graceful-restart_state {
       leaf peer-restart-time {
         type uint16 {
           range 0..4096;
         }
       }
       leaf peer-restarting {
         type boolean;
       }
       leaf local-restarting {
         type boolean;
       }
       leaf mode {
         type enumeration {
           enum HELPER-ONLY {
           }
           enum BILATERAL {
           }
           enum REMOTE-HELPER {
           }
         }
       }
     }
     
    The schema path to identify an instance is openconfig-bgp-operationalbgp-afi-safi-graceful-restart_state
    • Field Detail

      • QNAME

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

      • implementedInterface

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

        org.opendaylight.yangtools.yang.common.Uint16 getPeerRestartTime()
        Return peerRestartTime, or null if it is not present.
             
                 The period of time (advertised by the peer) that the peer expects a restart of a
                 BGP session to take
             
         
        Returns:
        Uint16 peerRestartTime, or null if it is not present.
      • requirePeerRestartTime

        default @NonNull org.opendaylight.yangtools.yang.common.Uint16 requirePeerRestartTime()
        Return peerRestartTime, guaranteed to be non-null.
             
                 The period of time (advertised by the peer) that the peer expects a restart of a
                 BGP session to take
             
         
        Returns:
        Uint16 peerRestartTime, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if peerRestartTime is not present
      • getPeerRestarting

        Boolean getPeerRestarting()
        Return peerRestarting, or null if it is not present.
             
                 This flag indicates whether the remote neighbor is currently in the process of
                 restarting, and hence received routes are currently stale
             
         
        Returns:
        Boolean peerRestarting, or null if it is not present.
      • requirePeerRestarting

        default @NonNull Boolean requirePeerRestarting()
        Return peerRestarting, guaranteed to be non-null.
             
                 This flag indicates whether the remote neighbor is currently in the process of
                 restarting, and hence received routes are currently stale
             
         
        Returns:
        Boolean peerRestarting, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if peerRestarting is not present
      • getLocalRestarting

        Boolean getLocalRestarting()
        Return localRestarting, or null if it is not present.
             
                 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
             
         
        Returns:
        Boolean localRestarting, or null if it is not present.
      • requireLocalRestarting

        default @NonNull Boolean requireLocalRestarting()
        Return localRestarting, guaranteed to be non-null.
             
                 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
             
         
        Returns:
        Boolean localRestarting, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if localRestarting is not present
      • getMode

        BgpAfiSafiGracefulRestartState.Mode getMode()
        Return mode, or null if it is not present.
             
                 Ths leaf indicates the mode of operation of BGP graceful restart with the peer
             
         
        Returns:
        Mode mode, or null if it is not present.
      • requireMode

        default @NonNull BgpAfiSafiGracefulRestartState.Mode requireMode()
        Return mode, guaranteed to be non-null.
             
                 Ths leaf indicates the mode of operation of BGP graceful restart with the peer
             
         
        Returns:
        Mode mode, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if mode is not present