BgpFlowSpecConfig Object


Description:

Defines the characteristics of BGP Flowspecs.

Parents: BgpRouterConfig

Children: BgpSrv6VpnAttr, BgpSrv6VpnParams

Automatically-created children: BgpFsType10PacketLength, BgpFsType11DscpValue, BgpFsType12Fragment, BgpFsType1DestinationPrefix, BgpFsType2SourcePrefix, BgpFsType3IpProtocol, BgpFsType4Port, BgpFsType5DestinationPort, BgpFsType6SourcePort, BgpFsType7IcmpType, BgpFsType8IcmpCode, BgpFsType9TcpFlags, BgpVpnRouteConfig

Relations:

Side name
(Type)
Relative Description
EchoReplyErrorGeneration
(EchoReplyErrorFecInfo)

EchoReplyErrorGeneration

Mpls route params

ParamsThatCreate
(WizardGenerated)

BgpImportRouteTableParams

BgpFlowSpecConfig Writable Attributes

Attribute Description
AsNum

Autonomous system number.

Type: u16

Default: 1

Range: 0 - 65535

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

AsPathIncrementPerRouter

Increment applied on AS Paths to determine the AS Path value for subsequent routers within router block.

Type: u32

Default: 0

Range: 0 - 4294967295

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
SET

An unordered set of ASs that a route in the UPDATE message has traversed.

SEQUENCE

An ordered set of ASs that a route in the UPDATE message has traversed.

CONFED_SEQ

An ordered set of Member AS Numbers in the local confederation that the UPDATE message has traversed.

CONFED_SET

An unordered set of Member AS Numbers in the local confederation that the UPDATE message has traversed.

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

ComponentTypes

Specifies set of component types to be enabled.

Type: enum

Default: TYPE1_DESTINATION_PREFIX

Possible Values:

Value Description
TYPE1_DESTINATION_PREFIX

Enable Type-1 Destination Prefix.

TYPE2_SOURCE_PREFIX

Enable Type-2 Source Prefix.

TYPE3_IP_PROTOCOL

Enable Type 3 IP Protocol

TYPE4_PORT

Enable Type-4 Port.

TYPE5_DESTINATION_PORT

Enable Type-5 Destination Port.

TYPE6_SOURCE_PORT

Enable Type-6 Source Port.

TYPE7_ICMP_TYPE

Type-7 ICMP Type

TYPE8_ICMP_CODE

Type-8 ICMP Code

TYPE9_TCP_FLAGS

Type-9 TCP Flags

TYPE10_PACKET_LENGTH

Enable Type-10 Packet Length.

TYPE11_DSCP_VALUE

Enable Type-11 DSCP Value.

TYPE12_FRAGMENT

Type-12 Fragment

CopyBit

Enable copy.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Enable copy.

FALSE

Disable copy.

Dscp

The DSCP value to mark the traffic.

Type: u16

Default: 0x00

Range: 0x00 - 0x3f

EnableRedirect

Enable redirect action.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Enable redirect action.

FALSE

Disable redirect action.

EnableRedirectToIpNextHop

Enable redirect to IP next hop.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Enable redirect to IP next hop.

FALSE

Disable redirect to IP next hop.

EnableTrafficAction

Enable Traffic Action.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Enable traffic action.

FALSE

Disable traffic action.

EnableTrafficMarking

Enable traffic marking.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Enable traffic marking.

FALSE

Disable traffic marking.

EnableTrafficRate

Enable traffic rate action.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Enable traffic rate.

FALSE

Disable traffic rate.

EncodedBgpSrTlvs

Encoded BGP SR TLVs

Type: enum

Default: L3_SVC

Possible Values:

Value Description
L2_SVC

SRv6 L2 Service TLV

L3_SVC

SRv6 L3 Service TLV

ExtendedCommunity

Extended Community

Type: string

Default: "" (empty string)

Ipv6ExtendedCommunity

IPv6 Address Specific Extended Community

Type: string

Default: "" (empty string)

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

LocalPreferenceIncrementPerRouter

Increment applied on Local Preference to determine the Local Preference value for subsequent routers within router block.

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

MedIncrementPerRouter

Increment applied on MED to determine the MED value for subsequent routers within router block.

Type: u32

Default: 0

Range: 0 - 4294967295

NextHop

Next hop IP address to redirect the traffic.

Type: ip

Default: 192.0.1.0

NextHopPlaceHolder

Decides where to advertise Nexthop path attribute.

Type: enum

Default: NEXTHOP_IN_EXTENDED_COMMUNITY

Possible Values:

Value Description
NEXTHOP_IN_EXTENDED_COMMUNITY

Allow NextHop to advertise in extended community

NEXTHOP_IN_NLRI

Allow NextHop to advertise in NLRI

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

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.

RouteTarget

The extended community path Route Target to redirect.

Type: string

Default: 100:1

SampleBit

Enables traffic sampling and logging for this flow specification.

Type: bool

Default: TRUE

Possible Values:

Value Description
TRUE

Enables traffic sampling.

FALSE

Disables traffic sampling.

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.

SubAfi

Subsequent address family identifier.

Type: enum

Default: FLOW_SPEC

Possible Values:

Value Description
FLOW_SPEC

SubAfi is flowspec

FLOW_SPEC_VPN

SubAfi is flowspec VPN.

TerminateBit

Terminal Action.

Type: bool

Default: TRUE

Possible Values:

Value Description
TRUE

Enable Terminal Action.

FALSE

Disable Terminal Action.

TrafficRate

Traffic rate in bytes per second.

Type: u32

Default: 0

BgpFlowSpecConfig Read-Only Attributes

Read-Only Attribute Description
RouteCount

Number of flowspecs in this flowspec block.

Type: u32

Default: 1

RouteCountPerRouter

Number of flowspecs per router in this flowspec block.

Type: u32

Default: 1