Package org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.bgp.rev130715.bgp.neighbors

Interface BgpNeighbor

  • All Superinterfaces:
    org.opendaylight.yangtools.yang.binding.Augmentable<BgpNeighbor>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.ChildOf<BgpNeighbors>, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject, org.opendaylight.yangtools.yang.binding.Identifiable<BgpNeighborKey>
    @Generated("mdsal-binding-generator")
public interface BgpNeighbor
extends org.opendaylight.yangtools.yang.binding.ChildOf<BgpNeighbors>, org.opendaylight.yangtools.yang.binding.Augmentable<BgpNeighbor>, org.opendaylight.yangtools.yang.binding.Identifiable<BgpNeighborKey>

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

     list bgp-neighbor {
   key as-number;
   leaf as-number {
     type uint32;
   }
   choice peer-address-type {
     case ip-address {
       leaf ip-address {
         type inet:ip-address;
       }
     }
     case prefix {
       leaf prefix {
         type inet:ip-prefix;
       }
     }
     case host {
       leaf ip-host-address {
         type inet:host;
       }
     }
   }
   leaf prefix-list {
     type prefix-list-ref;
   }
   leaf default-action {
     type actions-enum;
   }
   container af-specific-config {
     container ipv4 {
       container mdt {
         uses neighbour-common-af-config;
       }
       container unicast {
         uses neighbour-ip-unicast-af-config;
       }
       container multicast {
         uses neighbour-ip-multicast-af-config;
       }
       container mvpn {
         uses neighbour-cast-af-config;
       }
     }
     container ipv6 {
       container unicast {
         uses neighbour-ip-unicast-af-config;
       }
       container multicast {
         uses neighbour-ip-multicast-af-config;
       }
       container mvpn {
         uses neighbour-common-af-config;
       }
     }
     container l2vpn {
       container evpn {
         uses neighbour-common-af-config;
       }
       container vpls {
         uses neighbour-common-af-config;
       }
     }
     container nsap {
       container unicast {
         uses neighbour-base-af-config;
         leaf prefix-list {
           type prefix-list-ref;
         }
       }
     }
     container rtfilter {
       container unicast {
         uses neighbour-base-af-config;
         leaf soft-reconfiguration {
           type boolean;
         }
       }
     }
     container vpnv4 {
       container unicast {
         uses neighbour-cast-af-config;
       }
       container multicast {
         uses neighbour-cast-af-config;
       }
     }
     container vpnv6 {
       container unicast {
         uses neighbour-cast-af-config;
       }
       container multicast {
         uses neighbour-cast-af-config;
       }
     }
   }
   container bgp-neighbor-state {
     leaf adminStatus {
       type bgp-peer-admin-status;
     }
     leaf in-lastupdatetime {
       type yang:timestamp;
     }
   }
   container bgp-neighbor-statistics {
     leaf nr-in-updates {
       type uint32;
     }
     leaf nr-out-updates {
       type uint32;
     }
   }
 }
    The schema path to identify an instance is bgp/bgp-neighbors/bgp-neighbor

    To create instances of this class use BgpNeighborBuilder.

    See Also:
    BgpNeighborBuilder, BgpNeighborKey

    • Field Detail

      • QNAME

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

    • Method Detail

      • implementedInterface

        default java.lang.Class<BgpNeighbor> 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 BgpNeighbor 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 BgpNeighbor 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 BgpNeighbor 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

      • getAsNumber

        org.opendaylight.yangtools.yang.common.Uint32 getAsNumber()
        Return asNumber, or null if it is not present.
        Returns:
        org.opendaylight.yangtools.yang.common.Uint32 asNumber, or null if it is not present.

      • getPeerAddressType

        PeerAddressType getPeerAddressType()
        Return peerAddressType, or null if it is not present.
        Returns:
        org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.bgp.rev130715.bgp.neighbors.bgp.neighbor.PeerAddressType peerAddressType, or null if it is not present.

      • getPrefixList

        java.lang.String getPrefixList()
        Return prefixList, or null if it is not present.
        Returns:
        java.lang.String prefixList, or null if it is not present.

      • getDefaultAction

        ActionsEnum getDefaultAction()
        Return defaultAction, or null if it is not present.
        Returns:
        org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.bgp.rev130715.ActionsEnum defaultAction, or null if it is not present.

      • getAfSpecificConfig

        AfSpecificConfig getAfSpecificConfig()
        Return afSpecificConfig, or null if it is not present. 
             
         Address family specific configuration parameters for the neighbours.
        Returns:
        org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.bgp.rev130715.bgp.neighbors.bgp.neighbor.AfSpecificConfig afSpecificConfig, or null if it is not present.

      • getBgpNeighborState

        BgpNeighborState getBgpNeighborState()
        Return bgpNeighborState, or null if it is not present. 
             
         The operational parameters describing the neighbour state. It is intended that
         this container may be augmented by vendors to reflect the vendor-specific
         operational state parameters.
        Returns:
        org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.bgp.rev130715.bgp.neighbors.bgp.neighbor.BgpNeighborState bgpNeighborState, or null if it is not present.

      • getBgpNeighborStatistics

        BgpNeighborStatistics getBgpNeighborStatistics()
        Return bgpNeighborStatistics, or null if it is not present. 
             
         The operational parameters describing the neighbour statistics. It is intended
         that this container may be augmented by vendors to reflect the vendor-specific
         staistical parameters.
        Returns:
        org.opendaylight.yang.gen.v1.urn.cisco.params.xml.ns.yang.bgp.rev130715.bgp.neighbors.bgp.neighbor.BgpNeighborStatistics bgpNeighborStatistics, or null if it is not present.