Interface BgpRouter

  • All Superinterfaces:
    org.opendaylight.yangtools.yang.binding.Augmentable<BgpRouter>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.ChildOf<BgpData>, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject

    @Generated("mdsal-binding-generator")
    public interface BgpRouter
    extends org.opendaylight.yangtools.yang.binding.ChildOf<BgpData>, org.opendaylight.yangtools.yang.binding.Augmentable<BgpRouter>
    This is a top-level container for the BGP router.

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

     container bgp-router {
       leaf local-as-number {
         type uint32;
       }
       leaf local-as-identifier {
         type inet:ip-address;
       }
       container rpki-config {
         container cache-server-config {
           choice server {
             case ip-address {
               leaf ip-address {
                 type inet:ip-address;
               }
             }
             case host-name {
               leaf ip-host-address {
                 type inet:host;
               }
             }
           }
           choice transport {
             case tcp {
               leaf tcp-port {
                 type uint32;
               }
             }
             case ssh {
               leaf ssh-port {
                 type uint32;
               }
             }
           }
           leaf user-name {
             type string;
           }
           leaf password {
             type string;
           }
           leaf preference-value {
             type uint8 {
               range 1..10;
             }
           }
           leaf purge-time {
             type uint16 {
               range 30..360;
             }
           }
           choice refresh-time {
             case disable {
               leaf refresh-time-disable {
                 type boolean;
               }
             }
             case set-time {
               leaf refresh-interval {
                 type uint16 {
                   range 15..3600;
                 }
               }
             }
           }
           choice responce-time {
             case disable {
               leaf responce-time-disable {
                 type boolean;
               }
             }
             case set-time {
               leaf responce-interval {
                 type uint16 {
                   range 15..3600;
                 }
               }
             }
           }
         }
         container validation-config {
           leaf enable {
             type boolean;
             default true;
           }
           leaf enable-ibgp {
             type boolean;
           }
           choice validation-time {
             case validation-off {
               leaf disable {
                 type boolean;
               }
             }
             case set-time {
               leaf prefix-validation-time {
                 type uint16 {
                   range 5..60;
                 }
               }
             }
           }
         }
         container bestpath-computation {
           leaf enable {
             type boolean;
           }
           leaf allow-invalid {
             type boolean;
           }
         }
       }
       container af-configuration {
         container ipv4 {
           container mdt {
             container bgp {
               leaf dampening {
                 type boolean;
                 default false;
               }
               leaf scan-time {
                 type uint8 {
                   range 5..60;
                 }
               }
               uses slow-peer-config;
               leaf soft-reconfig-backup {
                 type boolean;
               }
               leaf propagate-dmzlink-bw {
                 type boolean;
               }
             }
           }
           container multicast {
             container bgp {
               uses bgp-af-config;
             }
             leaf auto-summary {
               type boolean;
             }
             uses router-af-config;
             leaf default-metric {
               type uint32;
             }
           }
           container unicast {
             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;
                 }
               }
             }
             leaf auto-summary {
               type boolean;
             }
             uses router-af-config;
             uses maximum-paths;
             leaf synchronization {
               type boolean;
             }
           }
           container mvpn {
             container bgp {
               uses bgp-af-mvpn-config;
             }
             leaf auto-summary {
               type boolean;
             }
           }
         }
         container ipv6 {
           container multicast {
             container bgp {
               uses bgp-af-config;
             }
             uses router-af-config;
           }
           container unicast {
             container bgp {
               uses bgp-af-config;
             }
             uses router-af-config;
             leaf default-metric {
               type uint32;
             }
             uses maximum-paths;
             leaf synchronization {
               type boolean;
             }
           }
           container mvpn {
             container bgp {
               uses bgp-af-mvpn-config;
             }
           }
         }
         container l2vpn {
           container vpls {
             container bgp {
               leaf scan-time {
                 type uint8 {
                   range 5..60;
                 }
               }
               uses slow-peer-config;
             }
           }
         }
         container nsap {
           container unicast {
             container bgp {
               container aggregate-timer {
                 leaf enable {
                   type boolean;
                   default true;
                 }
                 leaf threshold {
                   type uint16 {
                     range 6..60;
                   }
                 }
               }
               leaf dampening {
                 type boolean;
                 default false;
               }
               leaf propagate-dmzlink-bw {
                 type boolean;
               }
               leaf redistribute-internal {
                 type boolean;
               }
               leaf scan-time {
                 type uint8 {
                   range 5..60;
                 }
               }
               uses slow-peer-config;
               leaf soft-reconfig-backup {
                 type boolean;
               }
             }
             leaf default-metric {
               type uint32;
             }
             uses maximum-paths;
             leaf network {
               type inet:ip-address;
             }
             uses redistribute;
             leaf synchronization {
               type boolean;
             }
           }
         }
       }
       container rtfilter {
         container unicast {
           container bgp {
             uses slow-peer-config;
           }
           uses maximum-paths;
         }
       }
       container vpnv4 {
         container unicast {
           container bgp {
             uses bgp-af-vpn-config;
           }
           uses maximum-paths;
         }
         container multicast {
           container bgp {
             uses bgp-af-vpn-config;
           }
           uses maximum-paths;
         }
       }
       container vpnv6 {
         container unicast {
           container bgp {
             uses bgp-af-vpn-config;
           }
         }
       }
     }
     
    The schema path to identify an instance is bgp/bgp-router

    To create instances of this class use BgpRouterBuilder.

    See Also:
    BgpRouterBuilder
    • Field Detail

      • QNAME

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

      • implementedInterface

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

        static int bindingHashCode​(@NonNull BgpRouter 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 BgpRouter 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 BgpRouter 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
      • getLocalAsNumber

        org.opendaylight.yangtools.yang.common.Uint32 getLocalAsNumber()
        Return localAsNumber, or null if it is not present.
        Returns:
        org.opendaylight.yangtools.yang.common.Uint32 localAsNumber, or null if it is not present.
      • getLocalAsIdentifier

        org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress getLocalAsIdentifier()
        Return localAsIdentifier, or null if it is not present.
        Returns:
        org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress localAsIdentifier, or null if it is not present.
      • getRpkiConfig

        RpkiConfig getRpkiConfig()
        Return rpkiConfig, or null if it is not present.
             
                 RPKI configuration parameters.
             
         
        Returns:
        org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.bgp.rev130715.bgp.router.RpkiConfig rpkiConfig, or null if it is not present.
      • getAfConfiguration

        AfConfiguration getAfConfiguration()
        Return afConfiguration, or null if it is not present.
             
                 Top level container for address families specific configuration of the BGP
                 router.
             
         
        Returns:
        org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.bgp.rev130715.bgp.router.AfConfiguration afConfiguration, or null if it is not present.
      • getRtfilter

        Rtfilter getRtfilter()
        Return rtfilter, or null if it is not present.
        Returns:
        org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.bgp.rev130715.bgp.router.Rtfilter rtfilter, or null if it is not present.
      • getVpnv4

        Vpnv4 getVpnv4()
        Return vpnv4, or null if it is not present.
        Returns:
        org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.bgp.rev130715.bgp.router.Vpnv4 vpnv4, or null if it is not present.
      • getVpnv6

        Vpnv6 getVpnv6()
        Return vpnv6, or null if it is not present.
        Returns:
        org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.bgp.rev130715.bgp.router.Vpnv6 vpnv6, or null if it is not present.