Interface BgpPeer

  • All Superinterfaces:
    org.opendaylight.yangtools.yang.binding.Augmentable<BgpPeer>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.ChildOf<BgpPeers>, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject, org.opendaylight.yangtools.yang.binding.Identifiable<BgpPeerKey>

    public interface BgpPeer
    extends org.opendaylight.yangtools.yang.binding.ChildOf<BgpPeers>, org.opendaylight.yangtools.yang.binding.Augmentable<BgpPeer>, org.opendaylight.yangtools.yang.binding.Identifiable<BgpPeerKey>
    BGP Peer configure class

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

     list bgpPeer {
       key peerAddr;
       leaf peerAddr {
         type inet:ip-address;
       }
       leaf groupName {
         type string {
           length 1..47;
         }
       }
       leaf remoteAs {
         type string {
           length 1..11;
         }
       }
       leaf description {
         type string {
           length 1..80;
           pattern ([^?]*);
         }
       }
       leaf soo {
         type string {
           length 3..21;
         }
       }
       leaf substituteAsEnable {
         type boolean;
         default false;
       }
     }
     
    The schema path to identify an instance is l3vpn/bgp-af-vpn-instance-config/bgpPeers/bgpPeer

    To create instances of this class use BgpPeerBuilder.

    See Also:
    BgpPeerBuilder, BgpPeerKey
    • 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 Default Methods 
      Modifier and Type Method Description
      @Nullable java.lang.String getDescription()
      specifies the description.
      @Nullable java.lang.String getGroupName()
      peerGroupName
      @Nullable org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress getPeerAddr()
      The nerighbor address
      @Nullable java.lang.String getRemoteAs()
      Specifies the AS number of the peer.
      @Nullable java.lang.String getSoo()
      The peer soo command configures the Site of Origin (SoO) attribute for an EBGP peer in a BGP VPN instance.
      default java.lang.Class<BgpPeer> implementedInterface()  
      @Nullable java.lang.Boolean isSubstituteAsEnable()
      Using the peer substitute-as command, you can substitute the AS number of the specified peer in the as-path with the local AS number.
      BgpPeerKey key()  
      • Methods inherited from interface org.opendaylight.yangtools.yang.binding.Augmentable

        augmentation
    • Field Detail

      • QNAME

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

      • implementedInterface

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

        @Nullable org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress getPeerAddr()
        The nerighbor address
        Returns:
        org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress peerAddr, or null if not present
      • getGroupName

        @Nullable java.lang.String getGroupName()
        peerGroupName
        Returns:
        java.lang.String groupName, or null if not present
      • getRemoteAs

        @Nullable java.lang.String getRemoteAs()
        Specifies the AS number of the peer.
        Returns:
        java.lang.String remoteAs, or null if not present
      • getDescription

        @Nullable java.lang.String getDescription()
        specifies the description. The description is a string of letters or figures. The value ranges from 1 to 80 characters without spaces.
        Returns:
        java.lang.String description, or null if not present
      • getSoo

        @Nullable java.lang.String getSoo()
        The peer soo command configures the Site of Origin (SoO) attribute for an EBGP peer in a BGP VPN instance. Format is ASN:nn or IP-address:nn.
        Returns:
        java.lang.String soo, or null if not present
      • isSubstituteAsEnable

        @Nullable java.lang.Boolean isSubstituteAsEnable()
        Using the peer substitute-as command, you can substitute the AS number of the specified peer in the as-path with the local AS number.
        Returns:
        java.lang.Boolean substituteAsEnable, or null if not present
      • key

        BgpPeerKey key()
        Specified by:
        key in interface org.opendaylight.yangtools.yang.binding.Identifiable<BgpPeerKey>