BgpEvpnJoinSynchRouteConfig Object


Description:

Specifies parameter to configure for EVPN join synch route

Parents: BgpRouterConfig

Children: BgpCustomAttribute

Relations:

Side name
(Type)
Relative Description
JoinedMulticastGroup
(JoinedMulticastGroup)

Ipv4Group

BGP EVPN Join IPv4 multicast group

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

Type: string

Default: 1:1

DataPlaneEncap

Data plane encapsulation

Type: enum

Default: NONE

Possible Values:

Value Description
NONE

NONE

MPLS

MPLS

VXLAN

VXLAN

SRV6

SRV6

DistributionType

VPN parameter distribution type

Type: enum

Default: ROUND_ROBIN

Possible Values:

Value Description
ROUND_ROBIN

RoundRobin

LINEAR

Linear

EsImportRouteTarget

Specify the Ethernet Segment Import Route Target value

Type: mac

Default: 00:00:00:00:00:00

EthernetSegmentId

Ethernet Segment Identifier

Type: string

Default: 0

EthernetSegmentType

Ethernet segment type

Type: enum

Default: TYPE0

Possible Values:

Value Description
TYPE0

Type-0 Operator

TYPE1

Type-1 IEEE 802.1AX LACP

TYPE2

Type-2 Bridged LAN

TYPE3

Type-3 MAC Based

TYPE4

Type-4 Router Id

TYPE5

Type-5 Autonomous System

TYPE6

Type-6 Multi Site Router-ID

EthernetTagId

Ethernet Tag Identifier

Type: u32

Default: 0

EviCount

Number of EVPN instances.

Type: u32

Default: 1

ExtCommunityEviRouteTarget

Extended Community EVI Route Target Value

Type: string

Default: 100:1

ExtCommunityEviRouteTargetStep

Extended Community EVI Route Target(RT) Step

Type: string

Default: 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

IgmpVersion

Configures IGMP version

Type: enum

Default: IGMP_VERSION_2

Possible Values:

Value Description
IGMP_VERSION_1

Configure the IGMP version 1

IGMP_VERSION_2

Configure the IGMP version 2

IGMP_VERSION_3

Configure the IGMP version 3

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

MulticastProtocol

Configures the Multicast protocol for type 6 and type 7 EVPN routes

Type: enum

Default: IGMP

Possible Values:

Value Description
IGMP

Multicast protocol - IGMP will be used

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.

Type: ipv6

Default: null

NextHopLinkLocal

IPv6 Link Local address for the nexthop

Type: ipv6

Default: null

NextHopType

Next Hop Type of the router that should be used as the next hop.

Type: enum

Default: IPV4

Possible Values:

Value Description
IPV4

IPv4

IPV6

IPv6

Origin

Defines the origin of the path information.

Type: enum

Default: IGP

Possible Values:

Value Description
IGP

IGP

EGP

EGP

INCOMPLETE

Incomplete

OriginatingRouterIpv4Addr

Configures originating router's IPv4 address

Type: ip

Default: 0.0.0.0

OriginatingRouterIpv6Addr

Configures originating router's IPv6 address

Type: ipv6

Default: ::

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 by default UNDEFINED.

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

RouteDistinguisher

Route distinguisher in string format. This is a field in the NLRI. An 8-byte value that is concatenated with an IPv4 prefix to create a unique VPN IPv4 prefix.

Type: string

Default: 192.0.0.1:1

RouteDistinguisherStep

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

Type: string

Default: 0:1

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.

SourceFilterMode

Configures source filter mode -Include Group Type or Exclude Group Type

Type: enum

Default: INCLUDE

Possible Values:

Value Description
INCLUDE

Configure the Include group type

EXCLUDE

Configure the Exclude group type

SourceIpv4Addr

Configures source IPv4 address to be used for source filter mode- Include Group Type

Type: ip

Default: 192.0.1.0

SourceIpv4AddrStep

Configures source IPv4 address step.

Type: ip

Default: 0.0.0.1

SrcCount

Configures source IPv4 address count.

Type: u8

Default: 1

Range: 1 - 255

BgpEvpnJoinSynchRouteConfig Read-Only Attributes

There are no read-only attributes.