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>
@Generated("mdsal-binding-generator") 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 classThis 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/bgpPeerTo 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 Static Methods Instance Methods Abstract Methods Default Methods Deprecated Methods Modifier and Type Method Description static boolean
bindingEquals(@NonNull BgpPeer thisObj, java.lang.Object obj)
Default implementation ofObject.equals(Object)
contract for this interface.static int
bindingHashCode(@NonNull BgpPeer obj)
Default implementation ofObject.hashCode()
contract for this interface.static java.lang.String
bindingToString(@NonNull BgpPeer obj)
Default implementation ofObject.toString()
contract for this interface.java.lang.String
getDescription()
Return description, ornull
if it is not present.java.lang.String
getGroupName()
Return groupName, ornull
if it is not present.org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress
getPeerAddr()
Return peerAddr, ornull
if it is not present.java.lang.String
getRemoteAs()
Return remoteAs, ornull
if it is not present.java.lang.String
getSoo()
Return soo, ornull
if it is not present.java.lang.Boolean
getSubstituteAsEnable()
Return substituteAsEnable, ornull
if it is not present.default java.lang.Class<BgpPeer>
implementedInterface()
default java.lang.Boolean
isSubstituteAsEnable()
Deprecated, for removal: This API element is subject to removal in a future version.BgpPeerKey
key()
-
-
-
Method Detail
-
implementedInterface
default java.lang.Class<BgpPeer> implementedInterface()
- Specified by:
implementedInterface
in interfaceorg.opendaylight.yangtools.yang.binding.DataContainer
- Specified by:
implementedInterface
in interfaceorg.opendaylight.yangtools.yang.binding.DataObject
-
bindingHashCode
static int bindingHashCode(@NonNull BgpPeer obj)
Default implementation ofObject.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
- ifobj
is null
-
bindingEquals
static boolean bindingEquals(@NonNull BgpPeer thisObj, java.lang.Object obj)
Default implementation ofObject.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 invocationobj
- Object acting as argument to equals invocation- Returns:
- True if thisObj and obj are considered equal
- Throws:
java.lang.NullPointerException
- ifthisObj
is null
-
bindingToString
static java.lang.String bindingToString(@NonNull BgpPeer obj)
Default implementation ofObject.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
- ifobj
is null
-
getPeerAddr
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress getPeerAddr()
Return peerAddr, ornull
if it is not present.The nerighbor address
- Returns:
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.IpAddress
peerAddr, ornull
if it is not present.
-
getGroupName
java.lang.String getGroupName()
Return groupName, ornull
if it is not present.peerGroupName
- Returns:
java.lang.String
groupName, ornull
if it is not present.
-
getRemoteAs
java.lang.String getRemoteAs()
Return remoteAs, ornull
if it is not present.Specifies the AS number of the peer.
- Returns:
java.lang.String
remoteAs, ornull
if it is not present.
-
getDescription
java.lang.String getDescription()
Return description, ornull
if it is not present.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, ornull
if it is not present.
-
getSoo
java.lang.String getSoo()
Return soo, ornull
if it is not present.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, ornull
if it is not present.
-
getSubstituteAsEnable
java.lang.Boolean getSubstituteAsEnable()
Return substituteAsEnable, ornull
if it is not present.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, ornull
if it is not present.
-
isSubstituteAsEnable
@Deprecated(forRemoval=true) default java.lang.Boolean isSubstituteAsEnable()
Deprecated, for removal: This API element is subject to removal in a future version.
-
key
BgpPeerKey key()
- Specified by:
key
in interfaceorg.opendaylight.yangtools.yang.binding.Identifiable<BgpPeerKey>
-
-