BgpEvpnMacAdvRouteConfig Object


Description:

Defines the characteristics of BGP EVPN MAC/IP Advertisement routes.

Parents: BgpRouterConfig

Children: BgpCustomAttribute, BgpSrv6VpnAttr, BgpSrv6VpnParams, Ipv4NetworkBlock, Ipv6NetworkBlock

Automatically-created children: MacBlock

BgpEvpnMacAdvRouteConfig 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

CustomMplsLabel

Custom MPLS Label

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Enable Custom MPLS Label

FALSE

Disable Custom MPLS Label

CustomMplsLabel2

Custom MPLS Label2 option for user to overwirte

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Enable Custom MPLS Label2

FALSE

Disable Custom MPLS Label2

DataPlaneEncap

When set to value other than NONE, BGP encapsulation extended community is sent in BGP Update messages. BGP encapsulation extended community is used to indicate the supported encapsulation.

Type: enum

Default: NONE

Possible Values:

Value Description
NONE

BGP encapsulation extended community is not sent in BGP Update messages.

MPLS

BGP encapsulation extended community is sent in BGP Update messages with tunnel type set to MPLS.

VXLAN

BGP encapsulation extended community is sent in BGP Update messages with tunnel type set to VXLAN.

SRV6

SRV6

DefaultGatewayExtended

Specifies whether to advertise Default Gateway extended community attribute in MAC/IP advertisement routes.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Default Gateway extended community attribute is advertised in MAC/IP advertisement routes.

FALSE

Default Gateway extended community attribute is not advertised in MAC/IP advertisement routes.

DistributionType

VPN Parameter Distribution Type

Type: enum

Default: ROUND_ROBIN

Possible Values:

Value Description
ROUND_ROBIN

Distribution Type Roundrobin

LINEAR

Distribution Type Linear

EnableETreeExtendedCommunity

E-Tree Extended Community

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Enable E-Tree Extended Community

FALSE

Disable E-Tree Extended Community

EncapLabel

Encapsulation label specifies the VNI/VSID value for VXLAN/NVGRE. Encapsulation label field is visible only when data plane encapsulation is set to VXLAN and EVPN AD route type is set to per-EVI.

Type: u32

Default: 0

Range: 0 - 16777215

EncapLabel2

Specifies the L3 VNI value which is advertised as MPLS Label2 in MAC/IP route NLRI. This field is visible only when data plane encapsulation is set to VXLAN and MPLS Label2 field is set to true.

Type: u32

Default: 0

Range: 0 - 16777215

EncapLabel2Step

Increment value for encapsulation label2(L3 VNI) for each successive VRF within a routeblock. This field is visible only when data plane encapsulation is set to VXLAN and MPLS Label2 field is set to true.

Type: u32

Default: 0

Range: 0 - 16777215

EncapLabelStep

Increment value for encapsulation label(VNI/VSID) for each successive VRF within a routeblock. Encapsulation label step is visible only when data plane encapsulation is set to VXLAN and EVPN AD route type is set to per-EVI.

Type: u32

Default: 0

Range: 0 - 16777215

EthernetSegmentId

Ethernet Segment Identifier Value.

Type: string

Default: 0

EthernetSegmentType

ESI Type is a 1 octet field that specifies the format of the remaining 9 octets of the ESI Value. ESI is a unique non-zero identifier that identifies an Ethernet segment.

Type: enum

Default: TYPE0

Possible Values:

Value Description
TYPE0

ESI Type 0.

TYPE1

ESI Type 1.

TYPE2

ESI Type 2.

TYPE3

ESI Type 3.

TYPE4

ESI Type 4.

TYPE5

ESI Type 5.

TYPE6

Type-6 Multi Site Router-ID

EthernetTagCountPerEvi

Number of unique Ethernet Tag Ids for each EVI within a routeblock.

Type: u32

Default: 1

Range: 1 - 4294967295

EthernetTagId

Ethernet Tag ID is a 32-bit field that identifies a particular broadcast domain in an EVPN Instance.

Type: u32

Default: 0

EthernetTagIdStep

Modifier to allow a route block to vary the Ethernet Tag Id.

Type: u32

Default: 0

ETreeExtendedCommunityFlags

E-Tree Extended Community Flags

Type: enum

Default: 1

Possible Values:

Value Description
LEAF

LEAF for E-Tree Extended Community

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

IncludeMacMobility

Advertise MAC Mobility extended community attribute in MAC/IP advertisement routes.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

MAC Mobility extended community attribute is advertised in MAC/IP advertisement routes.

FALSE

MAC Mobility extended community attribute is not advertised in MAC/IP advertisement routes.

Ipv4Step

VXLAN EVPN Overlay Configuration IPv4 step

Type: ip

Default: 0.0.0.1

Ipv6OriginatorId

IPv6 Originator Id

Type: ipv6

Default: null

Ipv6Step

VXLAN EVPN Overlay Configuration IPv6 step

Type: string

Default: ::1

IsMPLSLabel2

Specifies if the optional MPLS Label2 value is carried in MAC/IP advertisement route NLRI.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

MPLS Label2 value is picked from label manager and advertised in MAC/IP route NLRI.

FALSE

MPLS Label2 value is not advertised in MAC/IP route NLRI.

IsStatic

MAC addresses moved or not

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

MAC addresses cannot be moved.

FALSE

MAC addresses can be moved.

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

MacStep

VXLAN EVPN Overlay Configuration MAC step

Type: string

Default: 00:00:00:00:00:01

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 route block to vary the MED. The count will be tied to Network Count.

Type: u32

Default: 0

Range: 0 - 4294967295

MplsLabel

Configuration Start MPLS Label

Type: u32

Default: 0

Range: 0 - 1048575

MplsLabel2

MPLS Label2 option

Type: u32

Default: 0

Range: 0 - 1048575

MplsLabel2Step

MPLS Label2 option step

Type: u32

Default: 0

Range: 0 - 1048575

MplsLabelStep

Configuration start step for MPLS Label

Type: u32

Default: 0

Range: 0 - 1048575

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.

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

Link local IPv6 address for the nexthop

Type: ipv6

Default: null

NextHopType

Determines the type of nexthop IPv4 or IPv6 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

Origin

Setting of the mandatory ORIGIN path attribute in UPDATE messages. This defines the origin of the path information.

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.

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 (RD) in string format. A route distinguisher is 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 route block.

Type: string

Default: 0:1

RouteLabelAssignmentMode

Route Label Assignment mode for routes in this route block.

Type: enum

Default: FIXED

Possible Values:

Value Description
FIXED

All routes in the route block will carry the same MPLS label.

INCREMENTAL

Each route in the route block will carry incremented MPLS label.

RouterMacExtended

Specifies whether to advertise Router's MAC extended community attribute in MAC/IP advertisement routes.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Router's MAC extended community attribute is advertised in MAC/IP advertisement routes.

FALSE

Router's MAC extended community attribute is not advertised in MAC/IP advertisement routes.

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.

Type: string

Default: 100:1

RouteTargetStep

Increment value for RT for each successive VRF within a route block.

Type: string

Default: 0:1

SequenceNumber

Specifies the sequence number carried in the MAC Mobility Extended Community attribute.

Type: u32

Default: 0

Range: 0 - 4294967295

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

SourceMac

Specifies the 6-octet Router's MAC value carried in the Router's MAC extended community. Router's MAC address represents the Network Virtualization Endpoint's MAC address.

Type: mac

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

SrcCount

Configures source IPv4 address count.

Type: u8

Default: 1

Range: 1 - 255

BgpEvpnMacAdvRouteConfig Read-Only Attributes

Read-Only Attribute Description
RouteCount

Number of routes in this route block.

Type: u32

Default: 1