BgpRouteGenRouteAttrParams Object


Description:

BGP specific route attribute parameters.

Parents: Ipv4RouteGenParams, Ipv6RouteGenParams

BgpRouteGenRouteAttrParams Writable Attributes

Attribute Description
Common Writable Attributes Active, Name
AsPathLengthDist

Specifies the distribution percentage of routes with specified number of AS Paths. 20 such entries can be configured to specify the route distribution percentage for 20 AS Path lengths.

Type: double

Default: 0

Range: 0 - 100

AsPathLengthDistType

AS Path length distribution type

Type: enum

Default: FIXED

Possible Values:

Value Description
FIXED

Fixed distribution type.

INTERNET

Internet distribution type.

CUSTOM

Custom distribution type.

AsPathLengthValues

Specifies number of AS Paths to be included in the generated routes. 20 such entries can be configured along with its distribution percentage.

Type: u8

Default: 1

Range: 1 - 128

Ipv4NextHopCount

Number of unique Next Hops in the route block. This count will have a multiplier affect on the route count.

Type: u32

Default: 1

Ipv4NextHopIncrement

Modifier to allow a route block to vary the Next Hop.

Type: ip

Default: 0.0.0.1

Ipv4PrefixLengthCount

Number of unique prefix lengths in the route block. This count will have a multiplier affect on the route count.

Type: u8

Default: 1

Range: 1 - 32

Ipv4PrefixLengthIncrement

Modifier to allow a route block to vary the prefix length.

Type: u32

Default: 1

Range: 1 - 32

Ipv6NextHop

IP address of the border router that should be used as the next hop to the destinations listed in the UPDATE message. This is the mandatory NEXT_HOP path attribute in UPDATE messages.

Type: ipv6

Default: 2000::1

Ipv6NextHopCount

Number of unique Next Hops in the route block. This count will have a multiplier affect on the route count.

Type: u32

Default: 1

Ipv6NextHopIncrement

Modifier to allow a route block to vary the Next Hop.

Type: ipv6

Default: 0::0

Ipv6PrefixLengthCount

Number of unique prefix lengths in the route block. This count will have a multiplier affect on the route count.

Type: u8

Default: 1

Range: 1 - 128

Ipv6PrefixLengthIncrement

Modifier to allow a route block to vary the prefix length.

Type: u32

Default: 1

Range: 1 - 128

LocalPreference

LOCAL_PREF path attribute in UPDATE messages. This informs other BGP speakers in the same AS of the local BGP speaker's degree of preference for a route. A higher number means more preference.

Type: u32

Default: 10

Range: 0 - 4294967295

LocalPreferenceIncrement

Modifier to allow a routeblock to vary the Local Preference. The count will be tied to Network Count.

Type: u32

Default: 0

Range: 0 - 4294967295

Med

Multi-exit discriminator (MED). This is the optional MULTI_EXIT_DISC path attribute (type code 4) in UPDATE messages. This value can be used by a BGP speaker's decision process to discriminate among multiple exit points to a neighboring autonomous system. An exit or entry point with a lower MED should be preferred.

Type: u32

Default: null

Range: 0 - 4294967295

MedIncrement

Modifier to allow a routeblock to vary the MED. The count will be tied to Network Count.

Type: u32

Default: 0

Range: 0 - 4294967295

NextHop

IP address of the border router that should be used as the next hop to the destinations listed in the UPDATE message. This is the mandatory NEXT_HOP path attribute in UPDATE messages.

Type: ip

Default: 1.1.1.1

PrimaryAsPathIncrement

Modifies the primary AS PATH of each route within a route block.

Type: string

Default: 1

PrimaryAsPathSuffix

AS path suffix for primary routes.

Type: string

Default: 1

RouteSubAfi

Sub afi type.

Type: enum

Default: UNICAST

Possible Values:

Value Description
UNICAST

SubAFI is Unicast.

MULTICAST

SubAFI is Multicast.

UNICAST_AND_MULTICAST

SubAFI is Unicast and Multicast.

LABELED_IP

SubAFI is Labeled_IP.

MDT

SubAFI is MDT.

VPN

SubAFI is VPN.

SecondaryAsPathIncrement

Modifies the secondary AS PATH of each route within a route block.

Type: string

Default: 1

SecondaryAsPathSuffix

AS path suffix for secondary routes.

Type: string

Default: 1

SrLabelIndex

SR label index.

Type: u32

Default: 0

UseIpv4DeviceAddrAsNextHop

NOTE: This attribute is deprecated. It will be removed in subsequent releases, so it is recommended that you do not use it.

Used to indicate if generated route block should use the device's IPv4 address as the next hop.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Use device IPv4 address as next hop.

FALSE

Use user specified next hop address.

UseIpv4DeviceInterfaceAddrAsNextHop

Used to indicate if generated route block should use the device's IPv4 Interface address as the next hop.

Type: bool

Default: TRUE

Possible Values:

Value Description
TRUE

Use IPv4 Device address as Next Hop

FALSE

Use user specified IPv4 Next hop address.

UseIpv6DeviceAddrAsNextHop

NOTE: This attribute is deprecated. It will be removed in subsequent releases, so it is recommended that you do not use it.

Used to indicate if generated route block should use the device's IPv6 address as the next hop.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Use device IPv6 address as next hop.

FALSE

Use user specified Next hop address.

UseIpv6DeviceInterfaceAddrAsNextHop

Used to indicate if generated route block should use the device's IPv6 Interface address as the next hop.

Type: bool

Default: TRUE

Possible Values:

Value Description
TRUE

Use IPv6 Device address as Next Hop

FALSE

Use user specified Next Hop

BgpRouteGenRouteAttrParams Read-Only Attributes

There are no read-only attributes.