Description
BGP is a standardized exterior gateway protocol designed to exchange routing and reachability information among autonomous
systems on the Internet
Properties
- Name
- Specifies a symbolic name for the BGP process. (Identifier)
- RouterID
- Specifies the BGP router identifier IP.
- ASNum
- Associate the routing process with an autonomous system number.
- LocalPreference
- Local preference indicates the preferred path when there are multiple paths to the same destination. The path having a higher
preference is preferred. (Optional)
- RouteMapStatic
- Specifies a generic route-map for all imported static routes. (Optional)
- RouteMapOSPF
- Specifies a generic route-map for all imported OSPF routes. (Optional)
- RouteMapConnected
- Specifies a generic route-map for all connected routes. (Optional; Default: <withhold>)
- TableMap
- Specifies a generic route-map to filter for suppression/modification of incoming BGP updates. (Optional)
- TableMapFilter
- Sets which IP version of the matched routes of the TableMap to suppress. (Default: None)
- NoClientReflect
- Disables client-to-client route reflection. (Optional)
- ClusterID
- Specifies the BGP cluster ID to be used in route reflection. (Optional)
- ConfederID
- Specifies the BGP confederation identifier. (Optional)
- ConfederPeers
- Specifies the autonomous systems (comma separated) that belong to a confederation. (Optional)
- AutoSummary
- Specifies if and what type of routes to advertise summarized to the neighbors. (Optional)
- ScanTime
- Specifies the period after which router checks the validity of the routes in its database. (Default: 60)
- UpdateDelay
- Specifies the maximum time a graceful-restart capable router, which is restarting, will defer route-selection and advertisements
to all its graceful-restart capable neighbors. (Default: 120)
- GracefulRestart
- Enables BGP graceful-restart capabilities. (Optional)
- GracefulReset
- Set to not restart BGP daemon, so that any changes in network configurations that cause BGP reset do not affect packet forwarding.
(Default: No)
- GracefulRestartTime
- Specifies the maximum time that a graceful-restart neighbor waits to come back up after a restart. (Default: 120)
- GracefulStalePathTime
- Specifies the maximum time to preserve stale paths from a gracefully restarted neighbor. (Default: 360)
- LogEnabled
- Enable logging. (Default: Yes)
- DistanceExternal
- Distance for BGP external routes. (Optional)
- DistanceInternal
- Distance for BGP internal routes. (Optional)
- DistanceLocal
- Distance for BGP local routes. (Optional)
- MaxPathsExternal
- Number of supported equal-cost multi path eBGP routes. (Optional)
- MaxPathsInternal
- Number of supported equal-cost multi path iBGP routes. (Optional)
- Comments
- Text describing the current object. (Optional)
Description
IPv6 specific settings for BGP process.
Properties
- DistanceExternal
- Distance for BGP external routes. (Optional)
- DistanceInternal
- Distance for BGP internal routes. (Optional)
- DistanceLocal
- Distance for BGP local routes. (Optional)
- MaxPathsExternal
- Number of supported equal-cost multi path eBGP routes. (Optional)
- MaxPathsInternal
- Number of supported equal-cost multi path iBGP routes. (Optional)
![[Note]](images/note.png) |
Note |
This object type does not have an identifier and is identified by the name of the type only. There can only be one instance
of this type.
|
3.9.2. BGPBestPathSettings
Description
Grouped settings related to BGP best path selection
Properties
- IgnoreASPathLen
- Prevent considering the autonomous system path length as a factor in the algorithm for choosing a best path route. (Default: No)
- CompareConfederASPathLen
- Specifies that the AS confederation path length must be used when available in the BGP best path decision process. (Default: No)
- CompareRouterID
- Specifies to include router ID in the selection process; similar routes are compared and the route with the lowest router
ID is selected. (Default: No)
- DontCompareOriginatorID
- Changes the default bestpath selection by not comparing an originator-ID for an identical EBGP path. (Default: No)
- CompareMEDInConfederPath
- Compare MED along confederation paths. (Default: No)
- TreatMissingMEDAsWorst
- Treat missing MED as the least preferred one. (Default: No)
- RemoveRecvMED
- Remove received MED attribute. (Default: No)
- RemoveSendMED
- Remove sent MED attribute. (Default: No)
- TieBreakOnAge
- Always select a preferred older route. (Default: Yes)
![[Note]](images/note.png) |
Note |
This object type does not have an identifier and is identified by the name of the type only. There can only be one instance
of this type.
|
Description
Dampening minimizes the instability caused by route flapping
Properties
- Enabled
- Enable route dampening to minimize the instability caused by route flapping. (Optional)
- HalfLifeReachable
- Reachability half-life time for the penalty in minutes. The time for the penalty to decrease to one-half of its current value.
Default value is 15 minutes. (Optional)
- Reuse
- Value to start reusing a route. When the penalty for a suppressed route decays below the reuse value, the routes become unsuppressed.
Default value is 750. (Optional)
- Suppress
- Value to start suppressing a route. When the penalty for a route exceeds the suppress value, the route is suppressed. Default
value is 2000.
- Duration
- Maximum duration to suppress a stable route in minutes. Default value is 60 minutes.
- HalfLifeUnreachable
- Un-reachability half-life time for the penalty in minutes. Default value is 4x the value of HalfLifeReachable. (Optional)
- RouteMap
- Route map to specify criteria for dampening. (Optional)
![[Note]](images/note.png) |
Note |
This object type does not have an identifier and is identified by the name of the type only. There can only be one instance
of this type.
|
Description
BGP peer used for routing information exchange
Properties
- Name
- Specifies a symbolic name for the BGP neighbor. (Optional)
- IPAddress
- IP Address of the neighbor.
- Port
- TCP Port number of BGP neighbor. (Default: 179)
- Password
- MD5 message digest password. (Optional)
- RemoteASNum
- Neighbor autonomous system number.
- RoutingTable
- Specifies the routing table to use for communication with the BGP neighbor. (Default: main)
- SourceInterface
- The interface that the BGP traffic of the neighbor is received on. (Optional; Default: any)
- AddressFamily
- Address families to advertise and receive prefixes to/from. (Default: IPv4)
- Addressing
- Sets the IPv4 addressing types. (Default: Unicast)
- TimerKeepAlive
- Keep-alive messages are sent by a router to inform another router that the BGP connection between the two is still active.
The keep-alive timer interval is the period of time, in seconds, between each keep-alive message sent by the router. (Default: 180)
- TimerHoldTime
- The holdtime interval is the time, in seconds, the router waits to receive a keep-alive message and if it does not receive
a message for this period it declares the neighbor dead. (Default: 540)
- TimerConnect
- The connect interval is the time, in seconds, the router waits before trying to reconnect to disconnected neighbor. (Default: 120)
- TimerAdvertise
- Sets a minimum interval between the sending of BGP routing updates. (Optional)
- TimerASOrigin
- Sets the interval of sending AS origination routing updates. (Default: 15)
- Passive
- Set to not actively connect to the neighbor. (Optional)
- ForceVersion
- Controls the BGP version to use when communicating with the neighbor. (Default: Dynamic)
- FalloverDetection
- Specifies additional measures for faster fallover detection with the neighbor. (Optional)
- BFDTransmitInterval
- Specifies the transmit interval in milliseconds for the liveness detection. (Default: 250)
- BFDReceiveInterval
- Specifies in milliseconds the minimum time which packets are expected from the peer. (Default: 250)
- BFDHelloMultiplier
- Specifies the number of dropped packets before the link is declared down. (Default: 3)
- BFDSlowTimerInterval
- Specifies in milliseconds how often BFD control packets should be sent once the BFD session has been established. (Default: 2000)
- GracefulRestartWarnLog
- Generate log warning when graceful restart is required but not negotiated with neighbor. (Default: Yes)
- SoftReconfInbound
- Enables local storage of all the received prefixes and their attributes. This will require additional memory. (Default: No)
- PrefixListIn
- Specifies a prefix list for filtering of inbound BGP advertisements. Only the routes that match the prefix list are accepted.
(Optional)
- PrefixListOut
- Specifies a prefix list for filtering of outbound BGP advertisements. Only the routes that match the prefix list are sent
in updates. (Optional)
- RouteMapIn
- Specifies a route-map for filtering and modification of inbound BGP advertisements. Only the routes that pass the route-map
are accepted in updates. (Optional)
- RouteMapOut
- Specifies a route-map for filtering and modification of outbound BGP advertisements. Only the routes that pass the route-map
are sent in updates. (Optional)
- SendCommunity
- Specifies whether a community attribute should be sent to the BGP neighbor. (Optional)
- RouteReflector
- Specifies whether to run as a BGP route reflector and configure the specified neighbor as its client. (Optional)
- Weight
- Specifies a weight value to all routes learned from a neighbor. The route with the highest weight gets preference when the
same prefix is learned from more than one peer. (Optional)
- GracefulRestart
- Specifies whether the neighbor supports the capability of graceful-restart. (Optional)
- NextHopSelf
- Specifies whether to force the next hop to self when redistributing the prefix to another iBGP neighbor. (Optional)
- MaxPrefixes
- Specifies the maximum number of prefixes to receive from neighbor. (Optional)
- MaxPrefixesLimitAction
- Specifies action to take when the max prefix limit is reached. (Default: Disconnect)
- MaxPrefixesThreshold
- Specifies at what percentage of the maximum limit to start generate warning logs. (Optional)
- Comments
- Text describing the current object. (Optional)
![[Note]](images/note.png) |
Note |
If no Index is specified when creating an instance of this type, the object will be placed last in the list and the Index will be equal to the length of the list.
|
Description
IPv4 specific configuration for the BGP neighbor.
Properties
- SendCommunity
- Specifies whether a community attribute should be sent to the BGP neighbor. (Optional)
- RouteReflector
- Specifies whether to run as a BGP route reflector and configure the specified neighbor as its client. (Optional)
- Weight
- Specifies a weight value to all routes learned from a neighbor. The route with the highest weight gets preference when the
same prefix is learned from more than one peer. (Optional)
- GracefulRestart
- Specifies whether the neighbor supports the capability of graceful-restart. (Optional)
- NextHopSelf
- Specifies whether to force the next hop to self when redistributing the prefix to another iBGP neighbor. (Optional)
- MaxPrefixes
- Specifies the maximum number of prefixes to receive from neighbor. (Optional)
- MaxPrefixesLimitAction
- Specifies action to take when the max prefix limit is reached. (Default: Disconnect)
- MaxPrefixesThreshold
- Specifies at what percentage of the maximum limit to start generate warning logs. (Optional)
![[Note]](images/note.png) |
Note |
This object type does not have an identifier and is identified by the name of the type only. There can only be one instance
of this type.
|
Description
IPv6 specific configuration for the BGP neighbor.
Properties
- SendCommunity
- Specifies whether a community attribute should be sent to the BGP neighbor. (Optional)
- RouteReflector
- Specifies whether to run as a BGP route reflector and configure the specified neighbor as its client. (Optional)
- Weight
- Specifies a weight value to all routes learned from a neighbor. The route with the highest weight gets preference when the
same prefix is learned from more than one peer. (Optional)
- GracefulRestart
- Specifies whether the neighbor supports the capability of graceful-restart. (Optional)
- NextHopSelf
- Specifies whether to force the next hop to self when redistributing the prefix to another iBGP neighbor. (Optional)
- MaxPrefixes
- Specifies the maximum number of prefixes to receive from neighbor. (Optional)
- MaxPrefixesLimitAction
- Specifies action to take when the max prefix limit is reached. (Default: Disconnect)
- MaxPrefixesThreshold
- Specifies at what percentage of the maximum limit to start generate warning logs. (Optional)
![[Note]](images/note.png) |
Note |
This object type does not have an identifier and is identified by the name of the type only. There can only be one instance
of this type.
|
3.9.5. BGPPrefixAggregate
Description
Aggregation combines the characteristics of several different routes and advertises a single route
Properties
- Prefix
- Network prefix to aggregate.
- SummaryOnly
- Filter more specific routes from updates. (Default: No)
- SetAS
- Generate AS set path information. (Default: No)
- Comments
- Text describing the current object. (Optional)
![[Note]](images/note.png) |
Note |
If no Index is specified when creating an instance of this type, the object will be placed last in the list and the Index will be equal to the length of the list.
|
Description
Networks to be advertised by the BGP routing process
Properties
- Network
- Network range to advertise.
- Backdoor
- Enables the route to be the preferred route even if it has a greater distance. (Default: No)
- RouteMap
- Route map used to modify attributes. (Optional)
- Addressing
- Sets the IPv4 addressing types. (Default: Unicast)
- Comments
- Text describing the current object. (Optional)
![[Note]](images/note.png) |
Note |
If no Index is specified when creating an instance of this type, the object will be placed last in the list and the Index will be equal to the length of the list.
|
3.9.7. RouteExportRuleBGP
Description
A BGP export rule creates a filter to select BGP learned routes. The filtered routes can then through action rules either
be exported to "route distribution services", such as OSPF, or be added to one or more routing tables.
Properties
- Name
- Specifies a symbolic name for the rule. (Optional)
- DestinationNetworkExactly
- Specifies a network range which filtered routes need to match exactly. (Optional)
- DestinationNetworkIn
- Specifies a network range which filtered routes need to be within. (Optional)
- NextHop
- Specifies the next (router) hop which filtered routes need to match. (Optional)
- MetricRange
- Specifies a metric interval which filtered routes need to be within. (Optional)
- LogEnabled
- Enable logging. (Default: Yes)
- Comments
- Text describing the current object. (Optional)
![[Note]](images/note.png) |
Note |
If no Index is specified when creating an instance of this type, the object will be placed last in the list and the Index will be equal to the length of the list.
|
3.9.7.1. ExportToRoutingTable
Description
A routing table action is used to insert, update and remove routes to/from one or more routing tables.
Properties
- Name
- Specifies a symbolic name for the rule. (Optional)
- Destination
- Specifies to which routing table the route should be exported.
- OverrideStatic
- Allow matched routes to override statically configured routes. (Default: No)
- OverwriteDefault
- Allow matched routes to override the default route. (Default: No)
- OffsetMetric
- Offset to increase/decrease the metric of filtered routes. (Optional)
- LimitMetricRange
- Metric boundary for filtered routes. Metrics outside the boundary will be re-set to the nearest limit. (Optional)
- SetForward
- Sets/overrides the gateway IP for filtered routes. (Optional)
- LogEnabled
- Enable logging. (Default: Yes)
- ProxyARPAllInterfaces
- Always select all interfaces, including new ones, for publishing routes via Proxy ARP. (Default: No)
- ProxyARPInterfaces
- Specifies the interfaces on which the firewall should publish routes via Proxy ARP. (Optional)
- Comments
- Text describing the current object. (Optional)
![[Note]](images/note.png) |
Note |
If no Index is specified when creating an instance of this type, the object will be placed last in the list and the Index will be equal to the length of the list.
|
Description
An OSPF action is used to insert, update and remove routes to/from an OSPF process.
Properties
- Name
- Specifies a symbolic name for the rule. (Optional)
- ExportToProcess
- Specifies to which OSPF process the route should be exported.
- SetTag
- Sets tag for filtered routes. Tags can be used as filter criteria in other routers. (Optional)
- OffsetMetricType2
- Offset to increase/decrease the metric type 2 of filtered routes. (Optional)
- SetRouteType
- Sets the route type for matched routes. (Optional)
- OffsetMetric
- Offset to increase/decrease the metric of filtered routes. (Optional)
- LimitMetricRange
- Metric boundary for filtered routes. Metrics outside the boundary will be re-set to the nearest limit. (Optional)
- SetForward
- Sets/overrides the gateway IP for filtered routes. (Optional)
- LogEnabled
- Enable logging. (Default: Yes)
- Comments
- Text describing the current object. (Optional)
![[Note]](images/note.png) |
Note |
If no Index is specified when creating an instance of this type, the object will be placed last in the list and the Index will be equal to the length of the list.
|