BgpIpv4MvpnType7RouteConfig Object


Description:

Used by PE routers for advertising and withdrawing source-specific C-multicast (Type-7) IPv4 routes.

Children: BgpCustomAttribute, Ipv4NetworkBlock

Relations:

Side name
(Type)
Relative Description
JoinedMulticastGroup
(JoinedMulticastGroup)

Ipv4Group

Specifies the IPv4 C-multicast group object handle that contains a range of multicast groups to advertise or withdraw. A combination of each source and each group will be made when advertising and withdrawing Type-7 routes.

JoinedSource
(JoinedSource)

Ipv4NetworkBlock

Specifies the IPv4 C-multicast source network block object handle that contains a range of multicast sources to advertise or withdraw. A combination of each source and each group will be made when advertising and withdrawing Type-7 routes.

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

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

EnableGtm

Enable GTM on MVPN IPv4 route Type 6 or Type 7 which sends RD as 0.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

GTM is enabled.

FALSE

GTM is disabled.

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

ImportRouteTargetFromSource

Enable to import the route target from the source PE. Disable to configure the route target manually

Type: bool

Default: TRUE

Possible Values:

Value Description
TRUE

Enables learning the RT-import from source PE. The learnt value will be used as the route target for c-multicast routes

FALSE

Route target will be configured manually

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

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 global address for the nexthop.

Type: ipv6

Default: null

NextHopLinkLocal

IPV6 Link Local address for the nexthop.

Type: ipv6

Default: null

NextHopType

IP address type of Next Hop, ipv4 or ipv6.

Type: enum

Default: IPV4

Possible Values:

Value Description
IPV4

Next Hop is an IPv4 address.

IPV6

Next Hop is an IPv6 address.

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

OriginatorIdType

Originator Id Type

Type: enum

Default: IPV4

Possible Values:

Value Description
IPV4

IPv4

IPV6

IPv6

RouteCategory

Route Category Enum

Type: enum

Default: UNDEFINED

Possible Values:

Value Description
UNDEFINED

Route Category Undefined

PRIMARY

Route Category Primary

SECONDARY

Route Category Secondary

UNIQUE

Route Category Unique

ANY

Route Category Any

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

SendIfType5Recved

Only applicable when Route Type is Type7, Specifies whether Type 7 auto responds to Type 5.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Type 7 will be sent out after receiving Type 5 with the same RP/Source Network and Multicast Group.

FALSE

Type 7 will be sent out after session is up.

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.

Type

C-multicast route type.

Type: enum

Default: TYPE7

Possible Values:

Value Description
TYPE6

Enum Join Route Type 6, Shared Tree Join Route, originated by receiver PE routers. originated when a PE receives a shared tree C-join (C-*,C-G)through its PE-CE interface.

TYPE7

Enum Join Route Type 7, Source Tree Join Route, originated by receiver PE routers. Originated when a PE receives a source tree C-join (C-S,C-G) or originated by the PE that already has a Type 6 route and receives a Type 5 route.

UpstreamPeAddress

The upstream PE's IPv4 router address is applicable when ImportRouteTargetFromSource = TRUE. It is used to aid the RT-import learning process by filtering incoming unicast routes that originate from the specified PE address.

Type: ip

Default: 192.0.0.1

UpstreamPeAsNumber

Specifies the upstream PE's AS number

Type: u16

Default: 1001

Range: 0 - 65535

UpstreamPeRouteDistinguisher

Specifies the upstream PE's route distinguisher.

Type: string

Default: 100:1

UpstreamPeRt

The upstream PE's router target is applicable when ImportRouteTargetFromSource = TRUE. It is used to aid the RT-import learning process by filtering incoming unicast routes that originate from the specified route target.

Type: string

Default: 100:1

BgpIpv4MvpnType7RouteConfig Read-Only Attributes

There are no read-only attributes.