| Parameter |
Choices/Defaults |
Comments |
|
config
dictionary
|
|
Specifies the BGP related configuration.
|
|
address_family
list
/ elements=dictionary
|
|
Specifies BGP address family related configurations.
|
|
|
afi
string
/ required
|
|
Type of address family to configure.
|
|
|
neighbors
list
/ elements=dictionary
|
|
Specifies BGP neighbor related configurations in Address Family configuration mode.
|
|
|
|
activate
boolean
|
|
Enable the Address Family for this Neighbor.
|
|
|
|
default_originate
boolean
|
|
Originate default route to this neighbor.
|
|
|
|
graceful_restart
boolean
|
|
Enable/disable graceful restart mode for this neighbor.
|
|
|
|
neighbor
string
/ required
|
|
Neighbor router address.
|
|
|
|
weight
integer
|
|
Assign weight for routes learnt from this neighbor.
The range is from 0 to 65535
|
|
|
networks
list
/ elements=dictionary
|
|
Specify Networks to announce via BGP.
For operation replace, this option is mutually exclusive with root level networks option.
|
|
|
|
masklen
integer
|
|
Subnet mask length for the Network to announce(e.g, 8, 16, 24, etc.).
|
|
|
|
prefix
string
/ required
|
|
Network ID to announce via BGP.
|
|
|
|
route_map
string
|
|
Route map to modify the attributes.
|
|
|
redistribute
list
/ elements=dictionary
|
|
Specifies the redistribute information from another routing protocol.
|
|
|
|
protocol
string
/ required
|
Choices:
- ospfv3
- ospf
- isis
- static
- connected
- rip
|
Specifies the protocol for configuring redistribute information.
|
|
|
|
route_map
string
|
|
Specifies the route map reference.
|
|
bgp_as
integer
/ required
|
|
Specifies the BGP Autonomous System (AS) number to configure on the device.
|
|
log_neighbor_changes
boolean
|
|
Enable/disable logging neighbor up/down and reset reason.
|
|
neighbors
list
/ elements=dictionary
|
|
Specifies BGP neighbor related configurations.
|
|
|
description
string
|
|
Neighbor specific description.
|
|
|
ebgp_multihop
integer
|
|
Specifies the maximum hop count for EBGP neighbors not on directly connected networks.
The range is from 1 to 255.
|
|
|
enabled
boolean
|
|
Administratively shutdown or enable a neighbor.
|
|
|
maximum_prefix
integer
|
|
Maximum number of prefixes to accept from this peer.
The range is from 0 to 4294967294.
|
|
|
neighbor
string
/ required
|
|
Neighbor router address.
|
|
|
password
string
|
|
Password to authenticate the BGP peer connection.
|
|
|
peer_group
string
|
|
Name of the peer group that the neighbor is a member of.
|
|
|
remote_as
integer
/ required
|
|
Remote AS of the BGP neighbor to configure.
|
|
|
remove_private_as
boolean
|
|
Remove the private AS number from outbound updates.
|
|
|
route_reflector_client
integer
|
|
Specify a neighbor as a route reflector client.
|
|
|
timers
dictionary
|
|
Specifies BGP neighbor timer related configurations.
|
|
|
|
holdtime
integer
/ required
|
|
Interval (in seconds) after not receiving a keepalive message that device declares a peer dead.
The range is from 3 to 7200.
Setting this value to 0 will not send keep-alives (hold forever).
|
|
|
|
keepalive
integer
/ required
|
|
Frequency (in seconds) with which the device sends keepalive messages to its peer.
The range is from 0 to 3600.
|
|
|
update_source
string
|
|
Source of the routing updates.
|
|
networks
list
/ elements=dictionary
|
|
Specify Networks to announce via BGP.
For operation replace, this option is mutually exclusive with networks option under address_family.
For operation replace, if the device already has an address family activated, this option is not allowed.
|
|
|
masklen
integer
|
|
Subnet mask length for the Network to announce(e.g, 8, 16, 24, etc.).
|
|
|
prefix
string
/ required
|
|
Network ID to announce via BGP.
|
|
|
route_map
string
|
|
Route map to modify the attributes.
|
|
redistribute
list
/ elements=dictionary
|
|
Specifies the redistribute information from another routing protocol.
|
|
|
protocol
string
/ required
|
Choices:
- ospf
- ospfv3
- static
- connected
- rip
- isis
|
Specifies the protocol for configuring redistribute information.
|
|
|
route_map
string
|
|
Specifies the route map reference.
|
|
router_id
string
|
|
Configures the BGP routing process router-id value.
|
|
operation
string
|
Choices:
merge ← - replace
- override
- delete
|
Specifies the operation to be performed on the BGP process configured on the device.
In case of merge, the input configuration will be merged with the existing BGP configuration on the device.
In case of replace, if there is a diff between the existing configuration and the input configuration, the existing configuration will be replaced by the input configuration for every option that has the diff.
In case of override, all the existing BGP configuration will be removed from the device and replaced with the input configuration.
In case of delete the existing BGP configuration will be removed from the device.
|