Interface BgpNeighborConfig
-
- All Superinterfaces:
org.opendaylight.yangtools.yang.binding.BindingObject
,org.opendaylight.yangtools.yang.binding.DataContainer
,org.opendaylight.yangtools.yang.binding.DataObject
@Generated("mdsal-binding-generator") public interface BgpNeighborConfig extends org.opendaylight.yangtools.yang.binding.DataObject
Neighbor level configuration items.This class represents the following YANG schema fragment defined in module openconfig-bgp
grouping bgp-neighbor_config { leaf peer-as { type inet:as-number; } leaf local-as { type inet:as-number; } leaf peer-type { type bgp-types:peer-type; } leaf auth-password { type string; } leaf remove-private-as { type bgp-types:remove-private-as-option; } leaf route-flap-damping { type boolean; default false; } leaf send-community { type bgp-types:community-type; default NONE; } leaf description { type string; } }
-
-
Field Summary
Fields Modifier and Type Field Description static @NonNull org.opendaylight.yangtools.yang.common.QName
QNAME
YANG identifier of the statement represented by this class.
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description String
getAuthPassword()
Return authPassword, ornull
if it is not present.String
getDescription()
Return description, ornull
if it is not present.org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.AsNumber
getLocalAs()
Return localAs, ornull
if it is not present.org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.AsNumber
getPeerAs()
Return peerAs, ornull
if it is not present.PeerType
getPeerType()
Return peerType, ornull
if it is not present.RemovePrivateAsOption
getRemovePrivateAs()
Return removePrivateAs, ornull
if it is not present.Boolean
getRouteFlapDamping()
Return routeFlapDamping, ornull
if it is not present.CommunityType
getSendCommunity()
Return sendCommunity, ornull
if it is not present.Class<? extends BgpNeighborConfig>
implementedInterface()
default @NonNull String
requireAuthPassword()
Return authPassword, guaranteed to be non-null.default @NonNull String
requireDescription()
Return description, guaranteed to be non-null.default @NonNull org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.AsNumber
requireLocalAs()
Return localAs, guaranteed to be non-null.default @NonNull org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.AsNumber
requirePeerAs()
Return peerAs, guaranteed to be non-null.default @NonNull PeerType
requirePeerType()
Return peerType, guaranteed to be non-null.default @NonNull RemovePrivateAsOption
requireRemovePrivateAs()
Return removePrivateAs, guaranteed to be non-null.default @NonNull Boolean
requireRouteFlapDamping()
Return routeFlapDamping, guaranteed to be non-null.default @NonNull CommunityType
requireSendCommunity()
Return sendCommunity, guaranteed to be non-null.
-
-
-
Method Detail
-
implementedInterface
Class<? extends BgpNeighborConfig> implementedInterface()
- Specified by:
implementedInterface
in interfaceorg.opendaylight.yangtools.yang.binding.DataContainer
- Specified by:
implementedInterface
in interfaceorg.opendaylight.yangtools.yang.binding.DataObject
-
getPeerAs
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.AsNumber getPeerAs()
Return peerAs, ornull
if it is not present.AS number of the peer.
- Returns:
AsNumber
peerAs, ornull
if it is not present.
-
requirePeerAs
default @NonNull org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.AsNumber requirePeerAs()
Return peerAs, guaranteed to be non-null.AS number of the peer.
- Returns:
AsNumber
peerAs, guaranteed to be non-null.- Throws:
NoSuchElementException
- if peerAs is not present
-
getLocalAs
org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.AsNumber getLocalAs()
Return localAs, ornull
if it is not present.The local autonomous system number that is to be used when establishing sessions with the remote peer or peer group, if this differs from the global BGP router autonomous system number.
- Returns:
AsNumber
localAs, ornull
if it is not present.
-
requireLocalAs
default @NonNull org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.inet.types.rev130715.AsNumber requireLocalAs()
Return localAs, guaranteed to be non-null.The local autonomous system number that is to be used when establishing sessions with the remote peer or peer group, if this differs from the global BGP router autonomous system number.
- Returns:
AsNumber
localAs, guaranteed to be non-null.- Throws:
NoSuchElementException
- if localAs is not present
-
getPeerType
PeerType getPeerType()
Return peerType, ornull
if it is not present.Explicitly designate the peer or peer group as internal (iBGP) or external (eBGP).
- Returns:
PeerType
peerType, ornull
if it is not present.
-
requirePeerType
default @NonNull PeerType requirePeerType()
Return peerType, guaranteed to be non-null.Explicitly designate the peer or peer group as internal (iBGP) or external (eBGP).
- Returns:
PeerType
peerType, guaranteed to be non-null.- Throws:
NoSuchElementException
- if peerType is not present
-
getAuthPassword
String getAuthPassword()
Return authPassword, ornull
if it is not present.Configures an MD5 authentication password for use with neighboring devices.
- Returns:
String
authPassword, ornull
if it is not present.
-
requireAuthPassword
default @NonNull String requireAuthPassword()
Return authPassword, guaranteed to be non-null.Configures an MD5 authentication password for use with neighboring devices.
- Returns:
String
authPassword, guaranteed to be non-null.- Throws:
NoSuchElementException
- if authPassword is not present
-
getRemovePrivateAs
RemovePrivateAsOption getRemovePrivateAs()
Return removePrivateAs, ornull
if it is not present.Remove private AS numbers from updates sent to peers.
- Returns:
RemovePrivateAsOption
removePrivateAs, ornull
if it is not present.
-
requireRemovePrivateAs
default @NonNull RemovePrivateAsOption requireRemovePrivateAs()
Return removePrivateAs, guaranteed to be non-null.Remove private AS numbers from updates sent to peers.
- Returns:
RemovePrivateAsOption
removePrivateAs, guaranteed to be non-null.- Throws:
NoSuchElementException
- if removePrivateAs is not present
-
getRouteFlapDamping
Boolean getRouteFlapDamping()
Return routeFlapDamping, ornull
if it is not present.Enable route flap damping.
- Returns:
Boolean
routeFlapDamping, ornull
if it is not present.
-
requireRouteFlapDamping
default @NonNull Boolean requireRouteFlapDamping()
Return routeFlapDamping, guaranteed to be non-null.Enable route flap damping.
- Returns:
Boolean
routeFlapDamping, guaranteed to be non-null.- Throws:
NoSuchElementException
- if routeFlapDamping is not present
-
getSendCommunity
CommunityType getSendCommunity()
Return sendCommunity, ornull
if it is not present.Specify which types of community should be sent to the neighbor or group. The default is to not send the community attribute
- Returns:
CommunityType
sendCommunity, ornull
if it is not present.
-
requireSendCommunity
default @NonNull CommunityType requireSendCommunity()
Return sendCommunity, guaranteed to be non-null.Specify which types of community should be sent to the neighbor or group. The default is to not send the community attribute
- Returns:
CommunityType
sendCommunity, guaranteed to be non-null.- Throws:
NoSuchElementException
- if sendCommunity is not present
-
getDescription
String getDescription()
Return description, ornull
if it is not present.An optional textual description (intended primarily for use with a peer or group
- Returns:
String
description, ornull
if it is not present.
-
requireDescription
default @NonNull String requireDescription()
Return description, guaranteed to be non-null.An optional textual description (intended primarily for use with a peer or group
- Returns:
String
description, guaranteed to be non-null.- Throws:
NoSuchElementException
- if description is not present
-
-