BgpMvpnType1RouteConfig Object


Description:

Used by PE routers for advertising and learning intra-AS MVPN membership information.

Parents: BgpRouterConfig

Children: BgpCustomAttribute, BgpMsr6MsidConfig

Relations:

Side name
(Type)
Relative Description
JoinedMulticastGroup
(JoinedMulticastGroup)

Ipv4Group

Associate a multicast group to be matched to fetch Global-ID to resolve lable from MLDP P2MP Type-1 traffic. When traffic destination address match the JoinedMulticastGroup and traffic source matches the SourceAddress specified in MVPN Type-1 route configuration, the associated Global ID of MVPN Type-1 route will be used to resolve the label for MLDP P2MP Type-1 Traffic.

PMulticastGroup
(PMulticastGroup)

Ipv4Group

Used as PIM SSM tunnel identifier together with P Root Node Address.

BgpMvpnType1RouteConfig Writable Attributes

Attribute Description
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

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

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

BfirID

BFIR-id is an Identifier number within a given sub-domain

Type: u16

Default: 1

BfrPrefix

This will either be a /32 IPv4 address or a /128 IPv6 address. Whether the address is IPv4 or IPv6 can be inferred from the total length of the PMSI Tunnel attribute.

Type: ip

Default: 192.85.1.1

BfrPrefixType

BFR Prefix Type

Type: enum

Default: IPV4

Possible Values:

Value Description
IPV4

IPv4

IPV6

IPv6

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

Type: string

Default: 1:1

DataPlaneEncap

MVPN Encapsulation Type

Type: enum

Default: NONE

Possible Values:

Value Description
NONE

No Encapsulation

VXLAN

VXLAN Encapsulation

EnableBierPtaMvpnSbit

Enable S-Bit for BIER PTA tunnel

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Set the MPLS label as zero for BIER-PTA tunnel

FALSE

Set the MPLS label with configured value for BIER-PTA tunnel

EnableGtm

Enable GTM on MVPN AD route type 1 which sends RD as 0

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

GTM is enabled.

FALSE

GTM is disabled.

EnablePmsiAdvertisement

Enable or disable the inclusion of the PMSI attribute in MVPN AD routes.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

PMSI attribute will be carried in MVPN AD routes

FALSE

PMSI attribute will not be included in MVPN AD routes

EnableSegmentedNextHop

Enable Segmented NexHop to send Segmented next hop extended community in an BGP update message.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Segmented Nexthop extended community is enabled.

FALSE

Segmented Nexthop extended community is disabled.

EncapLabel

VNI/VSID value

Type: u32

Default: 0

Range: 0 - 16777215

EncapLabelStep

VNI/VSID incremental steps

Type: u32

Default: 0

Range: 0 - 16777215

EndGroupAddr

End address of P-Multicast group.

Type: ip

Default: 192.0.0.1

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

GlobalID

Global ID for type 1 opaque type. Only applicable when Tunnel Type is MLDP P2MP LSP.

Type: u32

Default: 1

GroupCount

P-Multicast Group Count.

Type: u32

Default: 1

Ipv6BfrPrefix

IPv6 BFR Prefix

Type: ipv6

Default: 2000::1

Ipv6OriginatorId

IPv6 Originator Id

Type: ipv6

Default: null

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

LeafId

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

Leaf ID

Type: u8

Default: 1

Range: 0 - 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

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

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

NextHopGlobal

IPv6 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: null

NextHopLinkLocal

IPv6 Linklocal address for the nexthop

Type: ipv6

Default: null

NextHopType

Identifies the nexthop type based on the interface in which BGP is running

Type: enum

Default: IPV4

Possible Values:

Value Description
IPV4

NextHop type IPv4

IPV6

NextHop type IPv6

OpaqueType

LDP Opaque Type. Only applicable when Tunnel Type is MLDP P2MP LSP.

Type: enum

Default: TYPE1_GLOBAL_ID

Possible Values:

Value Description
TYPE1_GLOBAL_ID

Mldp Opaque Type is Type 1 global ID

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.

OriginatingRouteDistinguisher

Originating route distinguisher in string format. This is a field in the MCAST-VPN NLRI. An 8-byte value to uniquely identify an MVPN VRF.

Type: string

Default: 100:1

OriginatingRouteDistinguisherStep

Increment value for Originating RD for each successive VRF within a route block.

Type: string

Default: 0:1

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

OriginatorIdType

Originator Id Type

Type: enum

Default: IPV4

Possible Values:

Value Description
IPV4

IPv4

IPV6

IPv6

PmsiFlags

PMSI Flags MVPN Type 1

Type: enum

Default: LEAF_INFO_REQ

Possible Values:

Value Description
LEAF_INFO_REQ

Leaf Info Required

BIT1

Bit 1

BIT2

Bit 2

BIT3

Bit 3

BIT4

Bit 4

BIT5

Bit 5

BIT6

Bit 6

BIT7

Bit 7

PmsiPRootNodeAddr

Specifies the address of the node which generates this PIM SSM tunnel.

Type: ip

Default: 192.0.0.1

PmsiTunnel

Object handle of the RSVP P2MP tunnel block

Type: handle

Default: 0

PmsiTunnelType

Method of establishing PMSI Tunnel.

Type: enum

Default: RSVP_TE_P2MP_LSP

Possible Values:

Value Description
RSVP_TE_P2MP_LSP

The method of establishing MVPN Intra PMSI Tunnel is RSVP_TE_P2MP_LSP.

MLDP_P2MP_LSP

The method of establishing MVPN Intra PMSI Tunnel is MLDP_P2MP_LSP.

PIM_SSM_TREE

The method of establishing MVPN Intra PMSI Tunnel is PIM SSM Tree

INGRESS_REPLICATION_MVPN

The method of establishing MVPN Intra PMSI Tunnel is INGRESS_REPLICATION_MVPN. Which means downstream router will allocate label for upstream router to establish tunnel.

BIER_PTA_MVPN

The method of establishing PMSI Tunnel is BIER_PTA_MVPN. It is an architecture that provides optimal multicast forwarding through a "multicast domain", without requiring intermediate routers to maintain any per-flow state or to engage in an explicit tree-building protocol.

PRootNodeAddress

Specifies the address of the node which generates this PIM SSM tunnel.

Type: ip

Default: 192.85.1.3

RootID

Root ID for type 1 opaque type. Only applicable when Tunnel Type is MLDP P2MP LSP.

Type: ip

Default: 192.0.1.0

RouteCategory

Route Category

Type: enum

Default: UNDEFINED

Possible Values:

Value Description
UNDEFINED

Route Category is undefined

PRIMARY

Route Category is primary.

SECONDARY

Route Category is secondary

UNIQUE

Route Category is unique

ANY

Route Category can be any.

RouteLabel

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

Type: enum

Default: INCREMENTAL

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.

RouteTarget

Value of the extended community path attribute called Route Target, in string format. This is the Route Target extended community, carried in the optional Extended Community path attribute (type code 16) in UPDATE messages. The Route Target identifies a set of sites to which a PE router distributes routes. BGP extended communities are described in an Internet Draft.

Type: string

Default: 100:1

RouteTargetStep

Increment value for RT for each successive VRF within a routeblock.

Type: string

Default: 0:1

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.

SourceAddress

Defines the Source Address of the traffic. This property is not sent in the route to DUT, instead it is used as helper while resolving traffic streams. When traffic destination address match the JoinedMulticastGroup and traffic source matches the SourceAddress specified in MVPN Type-1 route configuration, the associated Global ID of MVPN Type-1 route will be used to resolve the label for MLDP P2MP Type-1 Traffic. The Global-ID sent from MVPN Type-1 route will be received by LDP along with label from DUT. When traffic is initiated for a given source and destination multicast group, the SourceAddress and JoinedMulticastGroup is used to identify the Global ID and and to fetch the lable assiciaed with the Global ID to be used in the traffic.

Type: ip

Default: 192.85.1.3

StartGroupAddr

Start address of P-Multicast group.

Type: ip

Default: 192.0.0.1

SubDomainID

ID of the Sub-Domain to which the BFIR will assign the packets that it transmits on the PMSI identified by the NLRI of the BGP I-PMSI or S-PMSI A-D route that contains this PTA

Type: u8

Default: 1

SupportedAfi

Specifies the Address Family Indicator (AFI) of the MCAST-VPN NLRI

Type: enum

Default: IPV4

Possible Values:

Value Description
IPV4

Sets the AFI to IPv4 (1)

IPV6

Sets the AFI to IPv6 (2)

IPV4V6

Results in two separate BGP Updates where AFI set to IPv4 (1) and AFI set to IPv6 (2) in the other update.

VrfCount

Number of unique VRFs to create within a route block.

Type: u32

Default: 1

BgpMvpnType1RouteConfig Read-Only Attributes

There are no read-only attributes.