Interface Bgp

  • All Superinterfaces:
    org.opendaylight.yangtools.yang.binding.Augmentable<Bgp>, BgpAfConfig, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.ChildOf<Unicast>, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject, SlowPeerConfig

    @Generated("mdsal-binding-generator")
    public interface Bgp
    extends org.opendaylight.yangtools.yang.binding.ChildOf<Unicast>, org.opendaylight.yangtools.yang.binding.Augmentable<Bgp>, BgpAfConfig
    BGP specific commands for ipv4-unicast address family/sub-addess family combination.

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

     container bgp {
       uses bgp-af-config;
       leaf always-compare-med {
         type boolean;
         default false;
       }
       leaf enforce-first-as {
         type boolean;
         default true;
       }
       leaf fast-external-fallover {
         type boolean;
         default true;
       }
       leaf suppress-inactive {
         type boolean;
       }
       leaf asnotation {
         type enumeration {
           enum asplain;
           enum dot;
         }
       }
       leaf enable-client-to-client-reflection {
         type boolean;
         default true;
       }
       leaf cluster-id {
         type string;
       }
       container confederation {
         leaf identifier {
           type string;
         }
         list peers {
           key as-name;
           leaf as-name {
             type string;
           }
         }
       }
       container consistency-checker {
         leaf enable {
           type boolean;
         }
         leaf interval {
           type uint16 {
             range 5..1440;
           }
         }
         choice inconsistency-action {
           case error-message {
             leaf generate-error-message-only {
               type boolean;
             }
           }
           case autorepair {
             leaf perform-autorepair {
               type boolean;
             }
           }
         }
       }
       leaf deterministic-med {
         type boolean;
       }
       container graceful-restart {
         leaf enable {
           type boolean;
         }
         leaf restart-time {
           type uint16 {
             range 1..3600;
           }
           default 120;
         }
         leaf stalepath-time {
           type uint16 {
             range 5..3600;
           }
           default 360;
         }
       }
       container listener-congfig {
         leaf enable {
           type boolean;
         }
         leaf limit {
           type uint16 {
             range 1..5000;
           }
           default 100;
         }
         leaf range {
           type uint16 {
             range 0..32;
           }
         }
         leaf peer-group {
           type string;
         }
       }
       leaf log-neighbor-changes {
         type boolean;
       }
       leaf max-as-limit {
         type uint16 {
           range 1..254;
         }
       }
       container router-id {
         leaf enable {
           type boolean;
         }
         choice config-type {
           case static {
             leaf ip-address {
               type boolean;
             }
           }
           case auto-config {
             leaf enable-auto-config {
               type boolean;
             }
           }
         }
       }
       container transport {
         leaf enable-path-mtu-discovery {
           type boolean;
           default true;
         }
       }
     }
     
    The schema path to identify an instance is bgp/bgp-router/af-configuration/ipv4/unicast/bgp

    To create instances of this class use BgpBuilder.

    See Also:
    BgpBuilder
    • Field Detail

      • QNAME

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

      • implementedInterface

        default java.lang.Class<Bgp> implementedInterface()
        Specified by:
        implementedInterface in interface BgpAfConfig
        Specified by:
        implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataContainer
        Specified by:
        implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataObject
        Specified by:
        implementedInterface in interface SlowPeerConfig
      • bindingHashCode

        static int bindingHashCode​(@NonNull Bgp obj)
        Default implementation of Object.hashCode() contract for this interface. Implementations of this interface are encouraged to defer to this method to get consistent hashing results across all implementations.
        Parameters:
        obj - Object for which to generate hashCode() result.
        Returns:
        Hash code value of data modeled by this interface.
        Throws:
        java.lang.NullPointerException - if obj is null
      • bindingEquals

        static boolean bindingEquals​(@NonNull Bgp thisObj,
                                     java.lang.Object obj)
        Default implementation of Object.equals(Object) contract for this interface. Implementations of this interface are encouraged to defer to this method to get consistent equality results across all implementations.
        Parameters:
        thisObj - Object acting as the receiver of equals invocation
        obj - Object acting as argument to equals invocation
        Returns:
        True if thisObj and obj are considered equal
        Throws:
        java.lang.NullPointerException - if thisObj is null
      • bindingToString

        static java.lang.String bindingToString​(@NonNull Bgp obj)
        Default implementation of Object.toString() contract for this interface. Implementations of this interface are encouraged to defer to this method to get consistent string representations across all implementations.
        Parameters:
        obj - Object for which to generate toString() result.
        Returns:
        String value of data modeled by this interface.
        Throws:
        java.lang.NullPointerException - if obj is null
      • getAlwaysCompareMed

        java.lang.Boolean getAlwaysCompareMed()
        Return alwaysCompareMed, or null if it is not present.
             
                 Allow comparing MED from different neighbors.
             
         
        Returns:
        java.lang.Boolean alwaysCompareMed, or null if it is not present.
      • isAlwaysCompareMed

        @Deprecated(forRemoval=true)
        default java.lang.Boolean isAlwaysCompareMed()
        Deprecated, for removal: This API element is subject to removal in a future version.
      • getEnforceFirstAs

        java.lang.Boolean getEnforceFirstAs()
        Return enforceFirstAs, or null if it is not present.
             
                 Enforce the first AS for EBGP routes(default).
             
         
        Returns:
        java.lang.Boolean enforceFirstAs, or null if it is not present.
      • isEnforceFirstAs

        @Deprecated(forRemoval=true)
        default java.lang.Boolean isEnforceFirstAs()
        Deprecated, for removal: This API element is subject to removal in a future version.
      • getFastExternalFallover

        java.lang.Boolean getFastExternalFallover()
        Return fastExternalFallover, or null if it is not present.
             
                 Immediately reset session if a link to a directly connected external peer goes
                 down.
             
         
        Returns:
        java.lang.Boolean fastExternalFallover, or null if it is not present.
      • isFastExternalFallover

        @Deprecated(forRemoval=true)
        default java.lang.Boolean isFastExternalFallover()
        Deprecated, for removal: This API element is subject to removal in a future version.
      • getSuppressInactive

        java.lang.Boolean getSuppressInactive()
        Return suppressInactive, or null if it is not present.
             
                 Suppress routes that are not in the routing table.
             
         
        Returns:
        java.lang.Boolean suppressInactive, or null if it is not present.
      • isSuppressInactive

        @Deprecated(forRemoval=true)
        default java.lang.Boolean isSuppressInactive()
        Deprecated, for removal: This API element is subject to removal in a future version.
      • getAsnotation

        Bgp.Asnotation getAsnotation()
        Return asnotation, or null if it is not present.
             
                 Sets the default asplain notation.
             
         
        Returns:
        org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.bgp.rev130715.bgp.router.af.configuration.ipv4.unicast.Bgp.Asnotation asnotation, or null if it is not present.
      • getEnableClientToClientReflection

        java.lang.Boolean getEnableClientToClientReflection()
        Return enableClientToClientReflection, or null if it is not present.
             
                 Manages client to client route reflection.
             
         
        Returns:
        java.lang.Boolean enableClientToClientReflection, or null if it is not present.
      • isEnableClientToClientReflection

        @Deprecated(forRemoval=true)
        default java.lang.Boolean isEnableClientToClientReflection()
        Deprecated, for removal: This API element is subject to removal in a future version.
      • getClusterId

        java.lang.String getClusterId()
        Return clusterId, or null if it is not present.
             
                 Configure Route-Reflector Cluster-id.
             
         
        Returns:
        java.lang.String clusterId, or null if it is not present.
      • getConfederation

        Confederation getConfederation()
        Return confederation, or null if it is not present.
             
                 AS confederation parameters.
             
         
        Returns:
        org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.bgp.rev130715.bgp.router.af.configuration.ipv4.unicast.bgp.Confederation confederation, or null if it is not present.
      • getConsistencyChecker

        ConsistencyChecker getConsistencyChecker()
        Return consistencyChecker, or null if it is not present.
             
                 Consistency-checker configuration.
             
         
        Returns:
        org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.bgp.rev130715.bgp.router.af.configuration.ipv4.unicast.bgp.ConsistencyChecker consistencyChecker, or null if it is not present.
      • getDeterministicMed

        java.lang.Boolean getDeterministicMed()
        Return deterministicMed, or null if it is not present.
             
                 If enabled it enforce the deterministic comparison of the MED value between all
                 paths received from within the same autonomous system.
             
         
        Returns:
        java.lang.Boolean deterministicMed, or null if it is not present.
      • isDeterministicMed

        @Deprecated(forRemoval=true)
        default java.lang.Boolean isDeterministicMed()
        Deprecated, for removal: This API element is subject to removal in a future version.
      • getGracefulRestart

        GracefulRestart getGracefulRestart()
        Return gracefulRestart, or null if it is not present.
             
                 Controls the BGP graceful restart capability.
             
         
        Returns:
        org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.bgp.rev130715.bgp.router.af.configuration.ipv4.unicast.bgp.GracefulRestart gracefulRestart, or null if it is not present.
      • getListenerCongfig

        ListenerCongfig getListenerCongfig()
        Return listenerCongfig, or null if it is not present.
             
                 Associates a subnet range with a BGP peer group and activate the BGP dynamic
                 neighbors feature.
             
         
        Returns:
        org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.bgp.rev130715.bgp.router.af.configuration.ipv4.unicast.bgp.ListenerCongfig listenerCongfig, or null if it is not present.
      • getLogNeighborChanges

        java.lang.Boolean getLogNeighborChanges()
        Return logNeighborChanges, or null if it is not present.
             
                 Log neighbor up/down and reset reason.
             
         
        Returns:
        java.lang.Boolean logNeighborChanges, or null if it is not present.
      • isLogNeighborChanges

        @Deprecated(forRemoval=true)
        default java.lang.Boolean isLogNeighborChanges()
        Deprecated, for removal: This API element is subject to removal in a future version.
      • getMaxAsLimit

        org.opendaylight.yangtools.yang.common.Uint16 getMaxAsLimit()
        Return maxAsLimit, or null if it is not present.
             
                 Configures BGP to discard routes that have a number of autonomous system numbers
                 in AS-path that exceed the specified value.
             
         
        Returns:
        org.opendaylight.yangtools.yang.common.Uint16 maxAsLimit, or null if it is not present.
      • getRouterId

        RouterId getRouterId()
        Return routerId, or null if it is not present.
             
                 Configures a fixed router ID for the local BGP routing process.
             
         
        Returns:
        org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.bgp.rev130715.bgp.router.af.configuration.ipv4.unicast.bgp.RouterId routerId, or null if it is not present.
      • getTransport

        Transport getTransport()
        Return transport, or null if it is not present.
             
                 Manages transport session parameters.
             
         
        Returns:
        org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.bgp.rev130715.bgp.router.af.configuration.ipv4.unicast.bgp.Transport transport, or null if it is not present.