BgpIpv4RouteConfig Object

HOME | TECHNOLOGIES | TEST CONFIGURATION | SEQUENCER COMMANDS | GUI COMMAND NAMES | ALL COMMANDS | RESULT | PDU | ALL | OBJECT TREE

Description:

Defines the characteristics of BGP IPv4 routes.

Parents: BgpRouterConfig

Children: BgpCustomAttribute, BgpSrGlobalBlock, BgpSrIpv6Sid, BgpSrLabelIndex

Automatically-created children: BgpVpnRouteConfig, Ipv4NetworkBlock

Relations:

Side name
(Type)		 Relative Description
EchoReplyErrorGeneration
(EchoReplyErrorFecInfo)

EchoReplyErrorGeneration

Echo Reply Error Generation

ParamsThatCreate
(WizardGenerated)

BgpImportRouteTableParams, BgpImportRouteTableParams

Wizard Generated relation with Bgp Import Route Table Params

BgpIpv4RouteConfig Writable Attributes

Attribute Description
AddPathIdentifier

Add Path Identifier

Type: u32

Default: 1
AddPathIdentifierIncrement

Add Path Identifier Increment

Type: u32

Default: 0
AggregatorAs

AS number to be used for the AGGREGATOR attribute.

Type: string

Default: "" (empty string)

AggregatorIp

IP address to be used for the AGGREGATOR attribute.

Type: ip

Default: null
AigpMetric

AIGP Metric

Type: u64

Default: 10
AigpMetricIncrement

AIGP Metric Increment

Type: u64

Default: 0
AigpPresent

AIGP Present

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

AIGP Present is True
FALSE

AIGP Present is False
AsPath

List of AS numbers, in string format, that will be used in the AS_PATH attribute (type code 2) in BGP UPDATE messages. This list identifies the autonomous systems through which the routing information carried in the UPDATE message has passed.

Type: string

Default: 1
AsPathIncrement

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

Type: string

Default: 1
AsPathIncrementPerRouter

Increment applied on AS Paths to determine the AS Path value for subsequent routers within router block.

Type: u32

Default: 0

Range: 0 - 4294967295
AsPathPerBlockCount

Number of AS Paths per route block.

Type: u32

Default: 1
AsPathSegmentType

Path segment type for the AS path specified by the asPath attribute.

Type: enum

Default: SEQUENCE

Possible Values:

Value Description
SET

An unordered set of ASs that a route in the UPDATE message has traversed.
SEQUENCE

An ordered set of ASs that a route in the UPDATE message has traversed.
CONFED_SEQ

An ordered set of Member AS Numbers in the local confederation that the UPDATE message has traversed.
CONFED_SET

An unordered set of Member AS Numbers in the local confederation that the UPDATE message has traversed.
AtomicAggregatePresent

Whether to include the ATOMIC_AGGREGATE attribute in BGP UPDATE messages. When this is TRUE, the receiving BGP speaker cannot de-aggregate the prefix into more specific routes.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Include the ATOMIC_AGGREGATE attribute. The receiving BGP speaker cannot de-aggregate the prefix into more specific routes.
FALSE

Do not include the ATOMIC_AGGREGATE attribute. Specific routes can be de-aggregated .
BgpSrTlvFlags

Encoded BGP SR TLVs.

Type: enum

Default: SRV6

Possible Values:

Value Description
LABEL_INDEX

Label Index will be encoded in the SR PrefixSid TLV.
IPV6_SID

IPV6 SID will be encoded in the SR PrefixSid TLV.
SRGB

SRGB will be encoded in the SR PrefixSid TLV.
SRV6

SRv6 TLV will be encoded.
ClusterIdList

Identifies the route reflectors that a prefix has passed through. This is the optional CLUSTER_LIST path attribute (type code 10), as covered in RFC 2796. This needs a list of cluster IDs (router IDs). Enter up to 250 comma-separated cluster IDs in the form of IPv4 addresses.

Type: ip

Default: 0.0.0.0
Community

List of BGP communities in string format. A community is a group of destinations that share some common property. This is the optional COMMUNITIES community path attribute (type code 8) in UPDATE messages. BGP communities are described in RFC 1997.

Enter up to eight comma-separated pairs. Put a colon between the parts of the pair.

Example: AS:Value,AS:Value.

where each AS and Value is between 0 - 65535, up to 8 pairs. AS numbers cannot be duplicated. Each AS can have only one value.

Type: string

Default: 1:1
CommunityIncrement

Specifies a list of BGP community incrementers in string format. This is a list of incrementers, each element in the list will specify which community value is to be incremented.

Type: string

Default: 1:1
CommunityPerBlockCount

Number of unique communities in this route block.

Type: u32

Default: 1
CustomMplsLabel

Enable Custom Mpls Label.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Using the Custom defined labels in MplsLabel and MplsLabelStep.

FALSE

Using the label defined in BGP MinLabel.

CustomSrv6EndPointBehavior

Custom SRv6 Endpoint Behavior

Type: u16

Default: 65535
EnableSegmentedNextHop

Enable Segmented NexHop to send Segmented next hop extended community in an BGP update message. This is sent only when SAFI is Multicast or Labelled IP

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Enable Segmented Nexthop Extended Community
FALSE

Disable Segmented Nexthop Extended Community

EnableSrv6Flags

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

Enable SRv6 Flags.

Type: bool

Default: TRUE

Possible Values:

Value Description
TRUE

Enable SRv6 Flags.
FALSE

Disable SRv6 Flags.
ExcludeAttributes

Exclude Attributes

Type: enum

Default: 0

Possible Values:

Value Description
ORIGIN

Exclude ORIGIN Attribute
AS_PATH

Exclude AS_PATH Attribute
NEXT_HOP

Exclude NEXT_HOP Attribute
LOCAL_PREF

Exclude LOCAL_PREF Attribute
ExtendedCommunity

Extended Community

Type: string

Default: "" (empty string)

ExtendedCommunityIncrement

Extended Community Step

Type: string

Default: "" (empty string)

ExtendedCommunityPerBlockCount

Extended Community Per Block Count

Type: u32

Default: 1
InsertRtImport

Specifies whether to insert the VRF Route Import extended community into the unicast route advertisement. The RT-Import global value will be the PE's IP address and the local value will be a unique value starting from zero and incremented per VRF on each port. For example: 7.7.7.7:0

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Inserts the VRF Route Import extended community into the unicast route advertisement
FALSE

VRF Route Import extended community is not inserted into the unicast route advertisement
Ipv6ArgLength

IPv6 argument length

Type: u8

Default: 48

Range: 0 - 128
Ipv6Arguments

IPv6 argument

Type: string

Default: 0
Ipv6FuncLength

IPv6 function length

Type: u8

Default: 8

Range: 1 - 128
Ipv6FuncOpcode

IPv6 function opcode

Type: string

Default: 0
Ipv6Loc

IPv6 locator

Type: ipv6

Default: bbbb:1:1:1::
Ipv6LocalNextHop

IPv6 Link Local Next Hop for the router block.

Type: ipv6

Default: null
Ipv6LocalNextHopIncrementPerRouter

Increment applied on IPv6 Local Next Hop to determine the IPv6 Local Next value for subsequent routers within router block

Type: ipv6

Default: 0::1
Ipv6LocLength

IPv6 locator length

Type: u8

Default: 64

Range: 1 - 128
Ipv6LocStep

IPv6 locator step

Type: ipv6

Default: 0:0:0:1::
Ipv6NextHop

IP address of the router that should be used as the IPV6 next hop to the destinations listed in the UPDATE message.

Type: ipv6

Default: null
Ipv6NextHopIncrement

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

Type: ipv6

Default: 0::1
Ipv6NextHopIncrementPerRouter

Increment applied on IPv6 Next Hop to determine the Next Hop value for subsequent routers within router block.

Type: ipv6

Default: 0::1
Ipv6NextHopList

IPv6 NextHop List in the route block.

Type: ipv6

Default: 2000::1
Label

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

This field is applicable when Safi is Labeled IP or VPN. It is a 20 bit value.

Type: enum

Default: NONE

Possible Values:

Value Description
NONE

None.
FIXED

Route Label type is a fixed number which is also the Minimum Label in BGP session level.
INCREMENTAL

Route Label type is Incremental, label base is the Minimum Label in BGP session level. Increase step is 1.
LargeCommunity

List of BGP communities in string format. A large community is a group of destinations that share some common property. This is the optional COMMUNITIES community path attribute (type code 8) in UPDATE messages. BGP large communities are described in RFC 8092.

Enter up to eight comma-separated pairs. Put a colon between the parts of the pair.

Example: AS:Value,AS:Value,AS:Value.

where each AS and Value is between 0 - ‭4294967295‬. AS numbers cannot be duplicated. Each AS can have only one value.

Type: string

Default: 1:1:1
LargeCommunityIncrement

Specifies a list of BGP community incrementers in string format. This is a list of incrementers, each element in the list will specify which community value is to be incremented.

Type: string

Default: 1:1:1
LargeCommunityPerBlockCount

Number of unique communities in this route block.

Type: u32

Default: 1
LocalPreference

Value for the 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
LocalPreferenceIncrementPerRouter

Increment applied on Local Preference to determine the Local Preference value for subsequent routers within router block.

Type: u32

Default: 0

Range: 0 - 4294967295
MdtGroupAddr

MDT Group address.

Type: ip

Default: 0.0.0.0
MdtIpv4Addr

MDT IPv4 address.

Type: ip

Default: 0.0.0.0
Med

Value for the 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
MedIncrementPerRouter

Increment applied on MED to determine the MED value for subsequent routers within router block.

Type: u32

Default: 0

Range: 0 - 4294967295
MplsLabel

The minimum value of custom Mpls values.

Type: u32

Default: 16

Range: 0 - 1048575
MplsLabelStep

The step of custom Mpls values.

Type: u32

Default: 1

Range: 0 - 1048575
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: null
NextHopAddrType

IP address of the router that should be used as the next hop Addr Type

Type: enum

Default: IPV4

Possible Values:

Value Description
IPV4

IPv4 address
IPV6

IPv6 address
NextHopCount

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

Type: u32

Default: 1
NextHopIncrement

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

Type: ip

Default: 0.0.0.1
NextHopIncrementPerRouter

Increment applied on Next Hop to determine the Next Hop value for subsequent routers within router block.

Type: ip

Default: 0.0.0.1
NextHopList

NextHopList is sent when Add path capability is enabled for Unicast, LabeledIp and VPN safi

Type: ip

Default: 1.1.1.1
NextHopType

NextHopType to identify if Nexthop is a list of ip addresses or single ip address

Type: enum

Default: NEXTHOP_INCREMENT

Possible Values:

Value Description
NEXTHOP_INCREMENT

Nexthop type is NEXTHOP_INCREMENT, single nexthop with increment

NEXTHOP_LIST

Nexthop type is NEXTHOP_LIST, list of nexthops without increment. This is enabled only when Add path capability is enabled
Origin

Describes how a prefix came to be routed by BGP. It defines the origin of the path information. This attribute is generated by the AS that originated the route(s) in the update message.

Type: enum

Default: IGP

Possible Values:

Value Description
IGP

IGP (0) - The Network Layer Reachability Information is interior to the originating AS.
EGP

EGP (1) - The Network Layer Reachability Information was learned through EGP.
INCOMPLETE

Incomplete (2) - The Network Layer Reachability Information was learned in some other way.
OriginatorId

Router ID of the originator of the route in the local AS. This is the optional ORIGINATOR_ID path attribute (type code 9).

Type: ip

Default: null
OverrideGlobalSrgb

Override Global SRGB.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

To use the SRGB configured on the route.
FALSE

To use the Global SRGB.
PrefixLengthCount

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
PrefixLengthIncrement

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

Type: u8

Default: 1

Range: 1 - 32
RouteLabel

Route Label is used for establishing Ingress Replication PMSI tunnel. Only applicable when PMSI Tunnel Type is Ingress Replication.

Type: enum

Default: FIXED

Possible Values:

Value Description
FIXED

Route Label type is a fixed number which is also the Minimum Label in BGP session level.
INCREMENTAL

Route Label type is Incremental, label base is the Minimum Label in BGP session level. Increase step is 1.
EXCLICIT_NULL

Route Label type is Explicit_Null. Label value is 0.
IMPLICIT_NULL

Route Label type is Implicit_Null. Label value is 3.
RouteSubAfi

Route's subsequent address family identifier.

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.
SessionIpVersion

BGP route's session IP version.

Type: enum

Default: IPV4V6

Possible Values:

Value Description
IPV4

IP version is IPv4.
IPV6

IP version is IPv6.
IPV4V6

IP version is dual stack.
Srv6ArgLength

SRv6 argument length.

Type: u8

Default: 32

Range: 0 - 128
Srv6EndPointBehavior

SRv6 Endpoint Behavior

Type: enum

Default: CUSTOM

Possible Values:

Value Description
END_DX6

End.DX6
END_DX4

End.DX4
END_DT6

End.DT6
END_DT4

End.DT4
END_DT46

End.DT46
END_DX2

End.DX2
END_DX2V

End.DX2V
END_DT2U

End.DT2U
END_DT2M

End.DT2M
END_DX6_NEXT_CSID

End.DX6 with NEXT-CSID
END_DX4_NEXT_CSID

End.DX4 with NEXT-CSID
END_DT6_NEXT_CSID

End.DT6 with NEXT-CSID
END_DT4_NEXT_CSID

End.DT4 with NEXT-CSID
END_DT46_NEXT_CSID

End.DT46 with NEXT-CSID
END_DX2_NEXT_CSID

End.DX2 with NEXT-CSID
END_DX2V_NEXT_CSID

End.DX2V with NEXT-CSID
END_DX2U_NEXT_CSID

End.DX2U with NEXT-CSID
END_DX2M_NEXT_CSID

End.DX2M with NEXT-CSID
CUSTOM

Custom
Srv6Func

SRv6 Function.

Type: enum

Default: CUSTOM

Possible Values:

Value Description
END_DX6

End.DX6
END_DX4

End.DX4
END_DT6

End.DT6
END_DT4

End.DT4
END_DT46

End.DT46
END_DX2

End.DX2
END_DX2V

End.DX2V
END_DT2U

End.DT2U
END_DT2M

End.DT2M
END_DX6_NEXT_CSID

End.DX6 with NEXT-CSID
END_DX4_NEXT_CSID

End.DX4 with NEXT-CSID
END_DT6_NEXT_CSID

End.DT6 with NEXT-CSID
END_DT4_NEXT_CSID

End.DT4 with NEXT-CSID
END_DT46_NEXT_CSID

End.DT46 with NEXT-CSID
END_DX2_NEXT_CSID

End.DX2 with NEXT-CSID
END_DX2V_NEXT_CSID

End.DX2V with NEXT-CSID
END_DX2U_NEXT_CSID

End.DX2U with NEXT-CSID
END_DX2M_NEXT_CSID

End.DX2M with NEXT-CSID
CUSTOM

Custom BGP SRv6 Function.
Srv6FuncLength

SRv6 function length.

Type: u8

Default: 32

Range: 0 - 128
Srv6LocBlockLength

SRv6 locator block length

Type: u8

Default: 32

Range: 0 - 128
Srv6LocLength

SRv6 locator length.

Type: u8

Default: 32

Range: 0 - 128
Srv6LocStep

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

SRv6 locator step.

Type: ipv6

Default: ::
Srv6ServiceDataSubTlvFlags

Select SRv6 service data sub TLVs

Type: enum

Default: STRUCTURE

Possible Values:

Value Description
STRUCTURE

SRv6 SID Structure Sub-Sub-TLV
Srv6Sid

SRv6 SID

Type: ipv6

Default: 2001::
Srv6SidInfoSubTlvType

SRv6 SID information sub TLV type

Type: u8

Default: 1

Range: 1 - 255
Srv6SidStep

SRv6 SID step

Type: ipv6

Default: ::
Srv6SidStructureSubSubTlvType

SRv6 SID structure sub sub TLV type

Type: u8

Default: 1

Range: 1 - 255
Srv6SubTlvType

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

SRv6 TLV type.

Type: u8

Default: 1
Srv6TranspositionLength

SRv6 transposition length

Type: u8

Default: 0

Range: 0 - 24
Srv6TranspositionOffset

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

SRv6 transposition offset

Type: u8

Default: 0

Range: 0 - 15
Srv6TranspositionOffsetInBits

SRv6 transposition offset in bits

Type: u8

Default: 0

Range: 0 - 127
SubAfi

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

Subsequent address family identifier.

Type: enum

Default: UNICAST

Possible Values:

Value Description
UNICAST

SubAFI is Unicast.
MULTICAST

SubAFI is Multicast.
UNICAST_AND_MULTICAST

SubAFI is Unicast and Multicast.
UseDeviceAddressAsNextHop

Use emulated device address as Next Hop.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Use emulated device address as Next Hop value.
FALSE

Use configured Next Hop address.
UseDynamicLabel

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

Deprecated.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Deprecated.
FALSE

Deprecated.
VpnPresent

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

Whether a VPN is present.

Enabled if the Label attribute is set to FIXED or INCREMENTAL.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

VPN is present.
FALSE

VPN is not present.
WithdrawMplsLabel

Withdraw Custom MPLS Label

Type: bool

Default: TRUE

Possible Values:

Value Description
TRUE

Enable Withdraw Custom MPLS Label

FALSE

Disable Withdraw Custom MPLS Label

BgpIpv4RouteConfig Read-Only Attributes

Read-Only Attribute Description
RouteCount

Number of routes in this route block.

Type: u32

Default: 1
RouteCountPerRouter

Number of routes per router in this route block.

Type: u32

Default: 1