Interface BgpNeighborTransportConfig

  • 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

    @Generated("mdsal-binding-generator")
    public interface BgpNeighborTransportConfig
    extends org.opendaylight.yangtools.yang.binding.DataObject
    Configuration parameters relating to the transport protocol used by the BGP session to the peer

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

     grouping bgp-neighbor-transport_config {
       leaf tcp-mss {
         type uint16;
       }
       leaf mtu-discovery {
         type boolean;
         default false;
       }
       leaf passive-mode {
         type boolean;
         default false;
       }
       leaf local-address {
         type union {
           type inet:ip-address;
           type string;
         }
       }
     }
     
    The schema path to identify an instance is openconfig-bgpbgp-neighbor-transport_config
    • Field Detail

      • QNAME

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

      • implementedInterface

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

        org.opendaylight.yangtools.yang.common.Uint16 getTcpMss()
        Return tcpMss, or null if it is not present.
             
                 Sets the max segment size for BGP TCP sessions.
             
         
        Returns:
        Uint16 tcpMss, or null if it is not present.
      • requireTcpMss

        default @NonNull org.opendaylight.yangtools.yang.common.Uint16 requireTcpMss()
        Return tcpMss, guaranteed to be non-null.
             
                 Sets the max segment size for BGP TCP sessions.
             
         
        Returns:
        Uint16 tcpMss, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if tcpMss is not present
      • getMtuDiscovery

        Boolean getMtuDiscovery()
        Return mtuDiscovery, or null if it is not present.
             
                 Turns path mtu discovery for BGP TCP sessions on (true) or off (false)
             
         
        Returns:
        Boolean mtuDiscovery, or null if it is not present.
      • requireMtuDiscovery

        default @NonNull Boolean requireMtuDiscovery()
        Return mtuDiscovery, guaranteed to be non-null.
             
                 Turns path mtu discovery for BGP TCP sessions on (true) or off (false)
             
         
        Returns:
        Boolean mtuDiscovery, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if mtuDiscovery is not present
      • getPassiveMode

        Boolean getPassiveMode()
        Return passiveMode, or null if it is not present.
             
                 Wait for peers to issue requests to open a BGP session, rather than initiating
                 sessions from the local router.
             
         
        Returns:
        Boolean passiveMode, or null if it is not present.
      • requirePassiveMode

        default @NonNull Boolean requirePassiveMode()
        Return passiveMode, guaranteed to be non-null.
             
                 Wait for peers to issue requests to open a BGP session, rather than initiating
                 sessions from the local router.
             
         
        Returns:
        Boolean passiveMode, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if passiveMode is not present
      • getLocalAddress

        BgpNeighborTransportConfig.LocalAddress getLocalAddress()
        Return localAddress, or null if it is not present.
             
                 Set the local IP (either IPv4 or IPv6) address to use for the session when
                 sending BGP update messages. This may be expressed as either an IP address or
                 reference to the name of an interface.
             
         
        Returns:
        LocalAddress localAddress, or null if it is not present.
      • requireLocalAddress

        default @NonNull BgpNeighborTransportConfig.LocalAddress requireLocalAddress()
        Return localAddress, guaranteed to be non-null.
             
                 Set the local IP (either IPv4 or IPv6) address to use for the session when
                 sending BGP update messages. This may be expressed as either an IP address or
                 reference to the name of an interface.
             
         
        Returns:
        LocalAddress localAddress, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if localAddress is not present