Interface BfdParams

  • All Superinterfaces:
    org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject
    All Known Subinterfaces:
    MonitorProfile, MonitorProfileParams, Profile, Profile

    @Generated("mdsal-binding-generator")
    public interface BfdParams
    extends org.opendaylight.yangtools.yang.binding.DataObject

    This class represents the following YANG schema fragment defined in module aliveness-monitor

     grouping bfd-params {
       leaf min-rx {
         type uint32;
       }
       leaf min-tx {
         type uint32;
       }
       leaf decay_min_rx {
         type uint32;
       }
       leaf forwarding_if_rx {
         type string;
       }
       leaf cpath_down {
         type string;
       }
       leaf check_tnl_key {
         type string;
       }
     }
     
    The schema path to identify an instance is aliveness-monitor/bfd-params
    • Field Summary

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

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      java.lang.String getCheckTnlKey()
      Return checkTnlKey, or null if it is not present.
      java.lang.String getCpathDown()
      Return cpathDown, or null if it is not present.
      org.opendaylight.yangtools.yang.common.Uint32 getDecayMinRx()
      Return decayMinRx, or null if it is not present.
      java.lang.String getForwardingIfRx()
      Return forwardingIfRx, or null if it is not present.
      org.opendaylight.yangtools.yang.common.Uint32 getMinRx()
      Return minRx, or null if it is not present.
      org.opendaylight.yangtools.yang.common.Uint32 getMinTx()
      Return minTx, or null if it is not present.
      java.lang.Class<? extends BfdParams> implementedInterface()  
    • Field Detail

      • QNAME

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

      • implementedInterface

        java.lang.Class<? extends BfdParams> implementedInterface()
        Specified by:
        implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataContainer
        Specified by:
        implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataObject
      • getMinRx

        org.opendaylight.yangtools.yang.common.Uint32 getMinRx()
        Return minRx, or null if it is not present.
             
                 The shortest interval, in milliseconds, at which this BFD session offers to
                 receive BFD control messages. Defaults to 1000
             
         
        Returns:
        org.opendaylight.yangtools.yang.common.Uint32 minRx, or null if it is not present.
      • getMinTx

        org.opendaylight.yangtools.yang.common.Uint32 getMinTx()
        Return minTx, or null if it is not present.
             
                 The shortest interval, in milliseconds, at which this BFD session is willing to
                 transmit BFD control messages. Defaults to 100
             
         
        Returns:
        org.opendaylight.yangtools.yang.common.Uint32 minTx, or null if it is not present.
      • getDecayMinRx

        org.opendaylight.yangtools.yang.common.Uint32 getDecayMinRx()
        Return decayMinRx, or null if it is not present.
             
                 An alternate receive interval, in milliseconds, that must be greater than or
                 equal to bfd:min_rx. This feature may be disabled by setting a value of 0
             
         
        Returns:
        org.opendaylight.yangtools.yang.common.Uint32 decayMinRx, or null if it is not present.
      • getForwardingIfRx

        java.lang.String getForwardingIfRx()
        Return forwardingIfRx, or null if it is not present.
             
                 either true or false. True to consider the interface capable of packet I/O as
                 long as it continues to receive any packets (not just BFD packets)
             
         
        Returns:
        java.lang.String forwardingIfRx, or null if it is not present.
      • getCpathDown

        java.lang.String getCpathDown()
        Return cpathDown, or null if it is not present.
             
                 Set to true to notify the remote endpoint that traffic should not be forwarded
                 to this system for some reason other than a connectivity failure on the
                 interface being monitored. Defaults to false
             
         
        Returns:
        java.lang.String cpathDown, or null if it is not present.
      • getCheckTnlKey

        java.lang.String getCheckTnlKey()
        Return checkTnlKey, or null if it is not present.
             
                 either true or false. Set to true to make BFD accept only control messages with
                 a tunnel key of zero. By default, BFD accepts control messages with any tunnel
                 key.
             
         
        Returns:
        java.lang.String checkTnlKey, or null if it is not present.