BgpSrTePolicyConfig Object


Description:

Defines the characteristics of BGP SR TE Policy routes.

Parents: BgpRouterConfig

Children: BgpCustomAttribute, BgpSrTePolicySgListAttribute

Automatically-created children: BgpSrTePolicyAttribute, BgpSrTePolicyTlvTypeConfig

BgpSrTePolicyConfig Writable Attributes

Attribute Description
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

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

AS path increment.

Type: string

Default: 0

AsPathPerBlockCount

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

AS path per block count.

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
Community

List of BGP communities in string format.

Type: string

Default: 1:1

CommunityIncrement

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

Community increment.

Type: string

Default: 0:0

CommunityPerBlockCount

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

Community per block count.

Type: u32

Default: 1

Distinguisher

Uniquely identifies the policy.

Type: u32

Default: 0

DistinguisherStep

Distinguisher step.

Type: u32

Default: 1

EnableRouteTarget

Enable RouteTarget

Type: bool

Default: TRUE

Possible Values:

Value Description
TRUE

RouteTarget is enabled

FALSE

RouteTarget is disabled

Endpoint

Identifies the endpoint of a policy.

Type: ip

Default: 192.0.0.1

EndpointCount

Endpoint count.

Type: u32

Default: 1

Range: 1 - 4294967295

EndpointIncrement

IPv4 endpoint increment.

Type: ip

Default: 0.0.0.1

EndpointIncrementMode

Endpoint increment mode.

Type: enum

Default: REPEAT_BEFORE_INCREMENT

Possible Values:

Value Description
REPEAT_BEFORE_INCREMENT

Repeat before increment.

ROUND_ROBIN

Round robin.

ExcludeAttributes

Exclude Attributes for SR-TE Policy

Type: enum

Default: 0

Possible Values:

Value Description
ORIGIN

Exclude Origin Attribute

AS_PATH

Exclude AS Path Attribute

ExtendedCommunity

Extended Community

Type: string

Default: 0x03:0x0b:0:0

ExtendedCommunityIncrement

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

Extended community step.

Type: string

Default: "" (empty string)

ExtendedCommunityPerBlockCount

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

Extended community per block count.

Type: u32

Default: 1

Ipv6Endpoint

Identifies the endpoint of a policy.

Type: ipv6

Default: 2000::1

Ipv6EndpointIncrement

IPv6 endpoint increment.

Type: ipv6

Default: 0::1

Ipv6NextHop

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: 2000::1

IpVersion

IP version.

Type: enum

Default: IPV4

Possible Values:

Value Description
IPV4

IPv4.

IPV6

IPv6.

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

LocalPreferenceIncrement

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

Local preference increment.

Type: u32

Default: 0

Range: 0 - 4294967295

NextHop

IPv4 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

NextHopLength

Next hop length.

Type: enum

Default: LENGTH_16

Possible Values:

Value Description
LENGTH_16

16 bytes next hop.

LENGTH_32

32 bytes next hop.

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.

PolicyColor

match the color of the destination prefixes in order to steer traffic into the SR TE Policy.

Type: u32

Default: 0

PolicyColorStep

Policy color step.

Type: u32

Default: 1

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.

RouteCount

Route count.

Type: u32

Default: 1

Range: 1 - 4294967295

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: 192.0.1.0:1

RouteTargetCount

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

Route target count.

Type: u32

Default: 1

RouteTargetStep

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

Route target step.

Type: string

Default: 0:0

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.

BgpSrTePolicyConfig Read-Only Attributes

There are no read-only attributes.