BgpEvpnIpPrefixRouteConfig Object

AS number to be used for the AGGREGATOR attribute.

Type: string

Default: "" (empty string)

IP address to be used for the AGGREGATOR attribute.

Type: ip

Default: null

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

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

Type: string

Default: 1

Number of AS Paths per route block.

Type: u32

Default: 1

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

Type: enum

Default: SEQUENCE

Possible Values:

IP Prefix type.

Type: enum

Default: Ipv4

Possible Values:

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:

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

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

Custom MPLS Label option for use to overwrite

Type: bool

Default: FALSE

Possible Values:

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:

VPN Parameter Distribution Type

Type: enum

Default: ROUND_ROBIN

Possible Values:

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

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

Ethernet Segment Identifier Value.

Type: string

Default: 0

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:

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

Type: u32

Default: 1

Range: 1 - 4294967295

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

Type: u32

Default: 0

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

Type: u32

Default: 0

Number of EVPN instances.

Type: u32

Default: 1

Extended Community EVI Route Target Value

Type: string

Default: 100:1

Extended Community EVI Route Target(RT) Step

Type: string

Default: 0:1

Extended Community.

Type: string

Default: "" (empty string)

Extended Community Step.

Type: string

Default: "" (empty string)

Extended Community Per Block Count.

Type: u32

Default: 1

Gateway IP address will encode an overlay IP index for the IP Prefixes.

Type: ip

Default: 0.0.0.0

Gateway IP address will encode an overlay IP index for the IP Prefixes.

Type: ipv6

Default: 0::0

Configures IGMP version

Type: enum

Default: IGMP_VERSION_2

Possible Values:

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

Type: bool

Default: FALSE

Possible Values:

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

VXLAN EVPN Overlay Configuration IPv4 step

Type: ip

Default: 0.0.1.0

IPv6 Originator Id

Type: ipv6

Default: null

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

VXLAN EVPN Overlay Configuration IPv6 step

Type: string

Default: 0:0:0:1::

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

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

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

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

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

MPLS Label option

Type: u32

Default: 0

Range: 0 - 1048575

MPLS Label option for step

Type: u32

Default: 0

Range: 0 - 1048575

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

Type: enum

Default: IGMP

Possible Values:

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

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

IPV6 Link Local address for the nexthop

Type: ipv6

Default: null

Identifies the type of Nexthop address (IPV4 or IPV6)

Type: enum

Default: IPV4

Possible Values:

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

Type: enum

Default: IGP

Possible Values:

Configures originating router's IPv4 address

Type: ip

Default: 0.0.0.0

Configures originating router's IPv6 address

Type: ipv6

Default: ::

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

Originator Id Type

Type: enum

Default: IPV4

Possible Values:

Route Category by default UNDEFINED.

Type: enum

Default: UNDEFINED

Possible Values:

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

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

Type: string

Default: 0:1

Route Label Assignment mode for routes in this route block.

Type: enum

Default: FIXED

Possible Values:

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

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

Type: string

Default: 0:1

BGP route's session IP version.

Type: enum

Default: IPV4V6

Possible Values:

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

Type: enum

Default: INCLUDE

Possible Values:

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

Type: ip

Default: 192.0.1.0

Configures source IPv4 address step.

Type: ip

Default: 0.0.0.1

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

Configures source IPv4 address count.

Type: u8

Default: 1

Range: 1 - 255

Number of routes in this route block.

Type: u32

Default: 1