ressubscr
BgpPeeringPolicy

Defines an BGP Peering Policy that can be used to create BGP peering for routed subscriber hosts.



public class BgpPeeringPolicy

Properties
advertiseInactiveRts Specifies whether or not the advertising of inactive BGP routes to other BGP peers is allowed.

type=ressubscr.TruthValue
default=false
Displayed(tab/group)=Advertise Inactive Routes (Behavior)

asOverride Specifies whether or not the customer AS number in the ASPATH attribute is overridden with the own AS number.

type=ressubscr.TruthValue
default=false
Displayed(tab/group)=AS Override (AS Properties)

authKeyChain Specifies the keychain which will be used to sign and/or authenticate the BGP protocol stream.

type=string
default=
Displayed(tab/group)=BGP Keychain (/KeyChain)

clusterId Specifies the cluster ID for a route reflector server.

type=InetAddress
default=0.0.0.0
Displayed(tab/group)=Cluster ID

clusterIdAddrType

type=rtr.InetAddressType
default=ipv4

connectRetry Specifies the value (in seconds) of the BGP Connect Retry timer.

type=int
default=120
minimum=1
maximum=65535
units=seconds
Displayed(tab/group)=Connect Retry Time (Behavior)

dampening Specifies whether or not route dampening should be applied to learned routes.

type=ressubscr.TruthValue
default=false
Displayed(tab/group)=Damping (Behavior)

disable4ByteASN Specifies whether or not 4-byte ASN capability will be advertised by this peer.

type=ressubscr.TruthValue
default=false
Displayed(tab/group)=Disable 4Byte ASN (AS Properties)

disableClientReflect Specifies whether or not route reflection is active for this peer.

type=ressubscr.TruthValue
default=false
Displayed(tab/group)=Disable Client Reflect (Behavior)

disableComms Specifies whether or not the community attribute is to be sent to the peer for non-external communities.

type=ressubscr.TruthValue
default=false
Displayed(tab/group)=Disable Standard Communities (Behavior)

disableExtComms Specifies whether or not the community attribute is to be sent to the peer for external communities.

type=ressubscr.TruthValue
default=false
Displayed(tab/group)=Disable Extended Communities (Behavior)

disableFEFailover Specifies whether or not the router should drop an external BGP session immediately when the local interface goes down, or whether the BGP session should be kept up until the holdtime expires.

type=ressubscr.TruthValue
default=false
Displayed(tab/group)=Disable Fast External Failover (Behavior)

exportPolicy1 Specifies the export policy number 1 for this peer.

type=string
default=
minimum=0
maximum=32
Displayed(tab/group)=Policy 1 (Export Policies/Policies)

exportPolicy10 Specifies the export policy number 10 for this peer.

type=string
default=
minimum=0
maximum=32
Displayed(tab/group)=Policy 10 (Export Policies/Policies)

exportPolicy11 Specifies the export policy number 11 for this peer.

type=string
default=
minimum=0
maximum=32
Displayed(tab/group)=Policy 11 (Export Policies/Policies)

exportPolicy12 Specifies the export policy number 12 for this peer.

type=string
default=
minimum=0
maximum=32
Displayed(tab/group)=Policy 12 (Export Policies/Policies)

exportPolicy13 Specifies the export policy number 13 for this peer.

type=string
default=
minimum=0
maximum=32
Displayed(tab/group)=Policy 13 (Export Policies/Policies)

exportPolicy14 Specifies the export policy number 14 for this peer.

type=string
default=
minimum=0
maximum=32
Displayed(tab/group)=Policy 14 (Export Policies/Policies)

exportPolicy15 Specifies the export policy number 15 for this peer.

type=string
default=
minimum=0
maximum=32
Displayed(tab/group)=Policy 15 (Export Policies/Policies)

exportPolicy2 Specifies the export policy number 2 for this peer.

type=string
default=
minimum=0
maximum=32
Displayed(tab/group)=Policy 2 (Export Policies/Policies)

exportPolicy3 Specifies the export policy number 3 for this peer.

type=string
default=
minimum=0
maximum=32
Displayed(tab/group)=Policy 3 (Export Policies/Policies)

exportPolicy4 Specifies the export policy number 4 for this peer.

type=string
default=
minimum=0
maximum=32
Displayed(tab/group)=Policy 4 (Export Policies/Policies)

exportPolicy5 Specifies the export policy number 5 for this peer.

type=string
default=
minimum=0
maximum=32
Displayed(tab/group)=Policy 5 (Export Policies/Policies)

exportPolicy6 Specifies the export policy number 6 for this peer.

type=string
default=
minimum=0
maximum=32
Displayed(tab/group)=Policy 6 (Export Policies/Policies)

exportPolicy7 Specifies the export policy number 7 for this peer.

type=string
default=
minimum=0
maximum=32
Displayed(tab/group)=Policy 7 (Export Policies/Policies)

exportPolicy8 Specifies the export policy number 8 for this peer.

type=string
default=
minimum=0
maximum=32
Displayed(tab/group)=Policy 8 (Export Policies/Policies)

exportPolicy9 Specifies the export policy number 9 for this peer.

type=string
default=
minimum=0
maximum=32
Displayed(tab/group)=Policy 9 (Export Policies/Policies)

holdTime Specifies the value (in seconds) of the BGP Hold Time Parameter.

type=int
default=90
minimum=0
maximum=65535
units=seconds
Displayed(tab/group)=Hold Time (Behavior)

importPolicy1 Specifies the import policy number 1 for this peer.

type=string
default=
minimum=0
maximum=32
Displayed(tab/group)=Policy 1 (Import Policies/Policies)

importPolicy10 Specifies the import policy number 10 for this peer.

type=string
default=
minimum=0
maximum=32
Displayed(tab/group)=Policy 10 (Import Policies/Policies)

importPolicy11 Specifies the import policy number 11 for this peer.

type=string
default=
minimum=0
maximum=32
Displayed(tab/group)=Policy 11 (Import Policies/Policies)

importPolicy12 Specifies the import policy number 12 for this peer.

type=string
default=
minimum=0
maximum=32
Displayed(tab/group)=Policy 12 (Import Policies/Policies)

importPolicy13 Specifies the import policy number 13 for this peer.

type=string
default=
minimum=0
maximum=32
Displayed(tab/group)=Policy 13 (Import Policies/Policies)

importPolicy14 Specifies the import policy number 14 for this peer.

type=string
default=
minimum=0
maximum=32
Displayed(tab/group)=Policy 14 (Import Policies/Policies)

importPolicy15 Specifies the import policy number 15 for this peer.

type=string
default=
minimum=0
maximum=32
Displayed(tab/group)=Policy 15 (Import Policies/Policies)

importPolicy2 Specifies the import policy number 2 for this peer.

type=string
default=
minimum=0
maximum=32
Displayed(tab/group)=Policy 2 (Import Policies/Policies)

importPolicy3 Specifies the import policy number 3 for this peer.

type=string
default=
minimum=0
maximum=32
Displayed(tab/group)=Policy 3 (Import Policies/Policies)

importPolicy4 Specifies the import policy number 4 for this peer.

type=string
default=
minimum=0
maximum=32
Displayed(tab/group)=Policy 4 (Import Policies/Policies)

importPolicy5 Specifies the import policy number 5 for this peer.

type=string
default=
minimum=0
maximum=32
Displayed(tab/group)=Policy 5 (Import Policies/Policies)

importPolicy6 Specifies the import policy number 6 for this peer.

type=string
default=
minimum=0
maximum=32
Displayed(tab/group)=Policy 6 (Import Policies/Policies)

importPolicy7 Specifies the import policy number 7 for this peer.

type=string
default=
minimum=0
maximum=32
Displayed(tab/group)=Policy 7 (Import Policies/Policies)

importPolicy8 Specifies the import policy number 8 for this peer.

type=string
default=
minimum=0
maximum=32
Displayed(tab/group)=Policy 8 (Import Policies/Policies)

importPolicy9 Specifies the import policy number 9 for this peer.

type=string
default=
minimum=0
maximum=32
Displayed(tab/group)=Policy 9 (Import Policies/Policies)

inheritValueExport If the inheritValue is set to true, all the export policies inherit the operational values. If the inheritValue is set to false, policies use the administratively set values.

type=boolean
default=true
Displayed(tab/group)=Inherit Value (Export Policies)

inheritValueImport If the inheritValue is set to true, all the import policies inherit the operational values. If the inheritValue is set to false, policies use the administratively set values.

type=boolean
default=true
Displayed(tab/group)=Inherit Value (Import Policies)

inheritanceMask

type=long
default=unspecified
bits=
    0x8: advertiseInactiveRts
    0x10: noAggregatorID
    0x20: asOverride
    0x40: authKeyChain
    0x80: md5Auth
    0x100: md5AuthKey
    0x200: clusterId
    0x400: connectRetry
    0x800: dampening
    0x1000: disableClientReflect
    0x2000: disableComms
    0x4000: disableExtComms
    0x8000: disableFEFailover
    0x10000: importPolicy1
    0x20000: importPolicy2
    0x40000: importPolicy3
    0x80000: importPolicy4
    0x100000: importPolicy5
    0x200000: exportPolicy1
    0x400000: exportPolicy2
    0x800000: exportPolicy3
    0x1000000: exportPolicy4
    0x2000000: exportPolicy5
    0x4000000: holdTime
    0x8000000: keepAlive - Keep-Alive
    0x10000000: localAddressType
    0x20000000: localAddress
    0x40000000: localAS
    0x80000000: localASPrivate
    0x100000000: localPreference
    0x200000000: loopDetect
    0x400000000: medSource
    0x800000000: medValue
    0x1000000000: minASOrigination
    0x2000000000: minRteAdvertisement
    0x4000000000: multiHop
    0x8000000000: nextHopSelf
    0x10000000000: passive
    0x20000000000: peerAS
    0x40000000000: preference
    0x80000000000: maxPrefix
    0x100000000000: removePrivateAS
    0x200000000000: minTTLValue
    0x400000000000: peerType
    0x800000000000: disable4ByteASN
    0x1000000000000: removePrivateASLmtd

keepAlive Specifies the value of the BGP Keepalive timer.

type=int
default=30
minimum=0
maximum=21845
units=seconds
Displayed(tab/group)=Keep-Alive (Behavior)

localAS Specifies the autonomous system number to be advertised to this peer.

type=long
default=0
minimum=0
maximum=4294967295
Displayed(tab/group)=Local AS (AS Properties/Local AS)

localASPrivate Specifies that the local autonomous system number is hidden in paths learned from peering.

type=ressubscr.TruthValue
default=false
Displayed(tab/group)=Private (AS Properties/Local AS)

localAddress Specifies the address of the peer group local address.

type=InetAddress
default=0.0.0.0
Displayed(tab/group)=Local Address

localAddressType Specifies the address type of the peer group local address.

type=rtr.InetAddressType
default=ipv4

localPreference Specifies the default value for the Local Preference attribute. This value is used if the BGP route arrives from a BGP peer without the Local Pref attribute set. It is overridden by any value set via a route policy.

type=long
default=100
minimum=0
maximum=4294967295
Displayed(tab/group)=Local Preference (Behavior)

loopDetect Specifies how the peer session should deal with loop detection in the AS Path.

type=int
default=ignore
Displayed(tab/group)=Loop Detect (Behavior)
enums=
    1: drop - Drop
    2: ignore - Ignore
    3: off - Off
    4: discardRoute - Discard Route

maxPrefix This parameter is no longer supported in SR 23.0.R1, as it is not being used" Specifies the maximum number of routes that can be learned from this peer

DEPRECATED: 23.0
type=long
default=0
minimum=0
maximum=4294967295
Displayed(tab/group)=Prefix Limit (Behavior)

md5Auth Specifies whether or not authentication using MD5 message based digest protocol is enabled.

type=ressubscr.TruthValue
default=false
Displayed(tab/group)=MD5 Authentication (Authentication)

md5AuthKey Specifies the authentication key to be used between BGP peers neighbors when establishing sessions. It is not visible outside of NFM-P server.

type=string
default=
minimum=0
maximum=255
Displayed(tab/group)=Authentication Key (Authentication)

medSource Specifies the Multi Exit Discriminator value source for this peer.

type=int
default=none
Displayed(tab/group)=MED Source (/MED)
enums=
    1: igpCost - IGP Cost
    2: metricVal - Metric Value
    3: none - None

medValue Specifies, when tBgpPeerMEDSource is Metric Value, the Multi Exit Discriminator value for this peer. Otherwise the value of this object is ignored.

type=long
default=0
minimum=0
maximum=4294967295
Displayed(tab/group)=MED Value (/MED)

minASOrigination Specifies the minimal interval (in seconds) at which a given path attribute can be advertised to a peer.

DEPRECATED: 18.6 - This parameter is no longer supported in SR 16.0.R1, as it is not being used
type=int
default=15
minimum=2
maximum=255
units=seconds
Displayed(tab/group)=Min AS Origination (AS Properties)

minRteAdvertisement Specifies the minimum interval at which a given path attribute can be advertised to a peer.

type=int
default=30
minimum=1
maximum=255
units=seconds
Displayed(tab/group)=Min Route Advertisement (Behavior)

minTTLValue Specifies the minimum TTL value for an incoming BGP packet.

type=long
default=0
minimum=0
maximum=255
Displayed(tab/group)=Minimum TTL Value (Behavior)

multiHop Specifies the TTL used in IP packet header for BGP advertisements.

type=int
default=0
minimum=0
maximum=255
Displayed(tab/group)=Multi Hop (Behavior)

nextHopSelf Specifies whether or not routes advertised to EBGP peers have NEXTHOP path attribute set to this router's physical interface. When false, third party routes are advertised.

type=ressubscr.TruthValue
default=false
Displayed(tab/group)=Next Hop Self (Behavior)

noAggregatorID Specifies whether or not the router ID in the BGP aggregator path attribute is set to zero.

type=ressubscr.TruthValue
default=false
Displayed(tab/group)=Aggregator ID Zero (Behavior)

passive Specifies whether or not this router will attempt to connect to the peer, or will wait for the peer to connect. If set to true, this router will NOT attempt to connect to the peer, but will wait passively for the peer to connect.

type=ressubscr.TruthValue
default=false
Displayed(tab/group)=Passive (Behavior)

peerAS Specifies the Autonomous System number for the remote peer.

type=long
default=0
minimum=0
maximum=4294967295
Displayed(tab/group)=Peer AS (AS Properties)

peerType Specifies the type of peer.

type=int
default=none
Displayed(tab/group)=Peer Type (Behavior)
enums=
    1: none - Inherit
    2: internal - Internal
    3: external - External

preference Specifies the route preference for routes learned via the peer.

type=long
default=170
minimum=1
maximum=255
Displayed(tab/group)=Preference (Behavior)

removePrivateAS Specifies whether or not private AS numbers should be stripped from the AS Path before advertising them to BGP peers.

type=ressubscr.TruthValue
default=false
Displayed(tab/group)=Remove Private AS (AS Properties/Remove Private AS)

removePrivateASLmtd Specifies whether this BGP peer will remove the private AS numbers.

type=ressubscr.TruthValue
default=false
Displayed(tab/group)=Limited (AS Properties/Remove Private AS)

 
Overridden Properties
displayedName Unique policy identity

access=read-create
minimum=1
maximum=32

 
Properties inherited from policy.PolicyDefinition
configurationAction, configurationMode, discoveryState, displayedName, distributionMode, isMaster, lastSyncTime, numberOfUnderlyingPolicyItems, origin, policyMode, policySyncGroupPointer, policyType
 
Properties inherited from policy.PolicyObject
description, displayedName, globalPolicy, id, isLocal, policyType, siteId, siteName, templateObject
 
Properties inherited from ManagedObject
actionMask, children-Set, deploymentState, isFaultSquelched, name, objectFullName, selfAlarmed
 
Methods inherited from policy.PolicyDefinition
distribute, distributeUsingGroups, distributeV2, evaluatePolicy, findGlobal, findLocal, findReleased, getSyncTaskResult, resetToReleasedPolicy, setConfigurationModeToDraft, setConfigurationModeToReleased, setDistributionModeToLocalEditOnly, setDistributionModeToSyncWithGlobal, syncTo, syncToLocalWithResync
 
Supported Network Elements
7750 SR
7705 SAR Gen 2
7705 SAR Hm
7450 ESS Supported for all versions
  • Excluded chassis types: 7450-ESS1
Product Specifics
7705 SAR Gen 2 25.0
7750 SR 20.0
7750 SR 21.0
7750 SR 22.0
7750 SR 23.0
7750 SR 24.0
7750 SR 25.0