PcepProtocolConfig Object


Description:

PCEP protocol config.

Parents: EmulatedDevice

Children: PccLspConfig, PceLspConfig, PcepAssociationGroup, PcepAssociationType, PcepCustomPdu, PcepKeepaliveMessageConfig, PcepOpenMessageConfig, PcepVirtualLspId, PceReturnLspConfig

Result children (automatically created): PcepDeviceBlockResults, PcepDeviceResults

Relations:

Side name
(Type)
Relative Description
ViewControlPlaneMplsBindingResult
(ControlPlaneBindingResult)

ViewControlPlaneMplsBindingResult

Mpls control plane binding result.

ConvergenceConfig
(PrimaryPathProtocolConfig)

ConvergenceConfig, ConvergenceConfig

Primary path.


(PstCustomTlv)

PcepCustomTlv

Custom TLV.

ResultChild
(ResultChild)

PcepDeviceBlockResults, PcepDeviceResults

Use this to connect a results object to an object.

TimeComparisonPair
(TimeComparisonPairSrcProtocol)

TsnProtocolsTimeComparisonPair, TsnProtocolsTimeComparisonPair

UsesIf
(UsesIf)

Aal5If, EthIIIf, FcIf, GreIf, GroupIf, HdlcIf, Ipv4If, Ipv6If, Ipv6SrhIf, ItagIf, L2tpv2If, L2tpv3If, LispIf, MacsecIf, MplsIf, PppIf, PppoeIf, TrillIf, VbrasIf, VlanIf, VxlanGpeIf, VxlanIf

Specifies the interfaces used by the configuration object (configuration object examples: BgpRouterConfig, LdpRouterConfig, and so on).

PcepProtocolConfig Writable Attributes

Attribute Description
Common Writable Attributes Active, Name
Authentication

Type of authentication to be used.

Type: enum

Default: NONE

Possible Values:

Value Description
NONE

No authentication.

MD5

MD5.

CustomDstPort

This port number will be used as the destination port of PCEP session. This property is available when the property IsFixedDstPort is set to FALSE.

Type: u16

Default: 4189

DBVersionStart

LSP state DB version start value.

Type: u64

Default: 1

Range: 1 - 18446744073709551614

DeadTimer

How long the peer should wait before declaring the session dead if it receives no traffic.

Type: u8

Default: 120

EnableAutoBwCapability

Support Auto-Bandwidth Adjustment

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Enable Auto-Bandwidth Adjustment

FALSE

Disable Auto-Bandwidth Adjustment

EnableDBVersionTlv

Enable DB version TLV in Open message.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Enable.

FALSE

Disable.

EnableFlowSpecCapability

Enable FlowSpec Capability TLV

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Enable FlowSpec Capability TLV

FALSE

Disable FlowSpec Capability TLV

EnableInitLsp

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

Whether the emulated PCEP device supports LSP-Initialization capability. when the emulated PCEP device is the PCC, it means it will init the configured LSP; when the emulated PCEP device is the PCE, it means it allows the configured LSP to be inited by the peer.

Type: bool

Default: TRUE

Possible Values:

Value Description
TRUE

Emulated PCEP device supports LSP-Initialization capability.

FALSE

Emulated PCEP device does not support LSP-Initialization capability.

EnableMultipathCapability

Enable Support Multipath

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Enable Support Multipath

FALSE

Disable Support Multipath

EnableNegotiation

Whether the emulated PCEP device supports capability negotiation when there is a capability mismatch between the emulated PCEP device and its peer.

Type: bool

Default: TRUE

Possible Values:

Value Description
TRUE

Enable capability negotiation for the emulated PCEP device.

FALSE

Disable capability negotiation for the emulated PCEP device.

EnableP2MPCapability

Enable P2MP Capability TLV

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Enable P2MP Capability TLV

FALSE

Disable P2MP Capability TLV

EnablePCResults

Whether to display the details of the sending LSP.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Display the details of the sending LSP.

FALSE

Will not display the details of the sending LSP.

EnableSegmentRouting

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

Whether the emulated PCEP device supports segment routing capability.

Type: bool

Default: TRUE

Possible Values:

Value Description
TRUE

Emulated PCEP device supports segment routing capability.

FALSE

Emulated PCEP device does not support segment routing capability.

EnableSegmentRoutingType

Enable Segment Routing Capability

Type: enum

Default: 1

Possible Values:

Value Description
SR

SR

SRV6

SRv6

EnableStateful

Whether the emulated PCEP device supports stateful PCE capabilities.

Type: bool

Default: TRUE

Possible Values:

Value Description
TRUE

Emulated PCEP device supports stateful PCE capabilities.

FALSE

Emulated PCEP device does not support stateful PCE capabilities.

Ipv4Tos

Provides an indication of the quality of service (IPv4) wanted.

Type: u8

Default: 192

Ipv6TrafficClass

Provides an indication of the quality of service (IPv6) wanted.

Type: u8

Default: 0

IpVersion

IP version to use for the PCEP session.

Type: enum

Default: IPV4

Possible Values:

Value Description
IPV4

IP version 4.

IPV6

IP version 6.

IsFixedDstPort

Whether the emulated PCEP device is to use 4189 as the session destination port or use a user-specify number.

Type: bool

Default: TRUE

Possible Values:

Value Description
TRUE

Emulated PCEP device will use 4189 as the session destination port.

FALSE

Emulated PCEP device will use a user-specify as the session destination port.

IsFixedSrcPort

Whether the emulated PCEP device is to use 4189 as the session source port or use a random number.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Emulated PCEP device will use 4189 as the session source port.

FALSE

Emulated PCEP device will use a random number as the session source port.

IsSessionInitiator

Whether the emulated PCEP device initiates the session.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Emulated PCEP device initiates the session.

FALSE

Emulated PCEP device waits for the peer to initiate the session.

KeepAliveTimer

Number of seconds between transmissions of Keepalive messages by the emulated PCE (in the absence of the sending of any other PCE packets) to the peer.

Type: u8

Default: 30

MaxAccDeadTimer

Maximum acceptable dead time.

Type: u8

Default: 255

MaxAccKeepAliveTimer

The maximum acceptable keep alive interval.

Type: u8

Default: 255

MaxEndD

Maximum End D

Type: u8

Default: 8

MaxEndPop

Maximum End Pop

Type: u8

Default: 8

MaxHEncaps

Maximum H.encaps

Type: u8

Default: 8

MaxSIDDepth

Maximum SID depth. Applicable when the property EnableSegmentRouting is true and PcepDeviceRole is PCC.

Type: u8

Default: 0

MaxSL

Maximum Segments Left

Type: u8

Default: 8

MinAccDeadTimer

Minimum acceptable dead time.

Type: u8

Default: 0

MinAccKeepAliveTimer

The minimum acceptable keep alive interval.

Type: u8

Default: 0

MsdTypes

MSD Types

Type: enum

Default: 0

Possible Values:

Value Description
MAX_SL

Maximum Segments Left

MAX_END_POP

Maximum End Pop

MAX_H_ENCAPS

Maximum H.Encaps

MAX_END_D

Maximum End D

MultipathCapValue

Multipath Capability TLV Flags

Type: enum

Default: 0

Possible Values:

Value Description
W_FLAG

W Flag

B_FLAG

B Flag

O_FLAG

O Flag

F_FLAG

F Flag

C_FLAG

C Flag

MultipathNum

Number of Multipath

Type: u16

Default: 1

OpenDelay

Number of seconds to wait before sending a session starting Open message.

Type: u8

Default: 0

P2MPCapValue

P2MP Capability TLV Value

Type: u16

Default: 0

Password

Password when authentication is set to MD5.

Type: string

Default: Spirent

PathSetupTypeList

Path setup type list.

Type: string

Default: 0,1

PcepCapability

What capabilities does the emulated PCEP device support. The user can pick zero or more capabilities from a list of independent options. (The user should enable "EnableStateful" to make this property available.)

Type: enum

Default: LSP_UPDATE_CAPABILITY|LSP_INSTANTIATION_CAPABILITY

Possible Values:

Value Description
LSP_UPDATE_CAPABILITY

LSP update capability.

INCLUDE_DB_VERSION

Include DB version.

LSP_INSTANTIATION_CAPABILITY

LSP instantiation capability.

TRIGGERED_RESYNC

Triggered resync.

DELTA_LSP_SYNC_CAPABILITY

Delta LSP sync capability.

TRIGGERED_INITIAL_SYNC

Triggered initial sync.

P2MP_CAPABILITY

P2MP Capability

P2MP_LSP_UPDATE_CAPABILITY

P2MP LSP Update

P2MP_LSP_INSTANTIATION_CAPABILITY

P2MP LSP Instantiation

PcepDeviceRole

Set the emulated device to PCC or PCE.

Type: enum

Default: PCE

Possible Values:

Value Description
PCC

Emulated device is a PCC.

PCE

Emulated device is a PCE.

PcepMode

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

Emulated PCEP device could be chosen to work in different mode, which are Active Stateful, Passive Stateful and Stateless. Currently only Active Stateful is supported. This property is now obsoleted.

Type: enum

Default: ACTIVE

Possible Values:

Value Description
ACTIVE

Active Stateful PCEP.

PcepSessionIpAddress

IP address of the emulated PCEP device.

Type: enum

Default: INTERFACE_IP

Possible Values:

Value Description
INTERFACE_IP

Deploy INTERFACE_IP as its IP address.

ROUTER_ID

Deploy ROUTER_ID as its IP address.

PceResultCount

PCE Received Results Count

Type: u32

Default: 10

Range: 1 - 10000

PeerIpv4Addr

Starting IPv4 address of the PCEP peer for the session.

Type: ip

Default: null

PeerIpv4AddrStep

IPv4 address step of the PCEP peer for the session.

Type: ip

Default: 0.0.0.1

PeerIpv6Addr

Starting IPv6 address of the PCEP peer for the session.

Type: ipv6

Default: null

PeerIpv6AddrStep

IPv6 address step of the PCEP peer for the session.

Type: ipv6

Default: 0000::1

SpeakerEntityID

Speaker entity identifier.

Type: string

Default: "" (empty string)

Range: 0 - 32 characters

SrCapabilityFlags

SR Capability Flags

Type: enum

Default: N_FLAG|X_FLAG

Possible Values:

Value Description
BIT0

Bit 0

BIT1

Bit 1

BIT2

Bit 2

BIT3

Bit 3

BIT4

Bit 4

P_FLAG

P Flag

N_FLAG

N Flag

X_FLAG

X Flag

SrLFlag

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

SR capability L flag.

Type: bool

Default: TRUE

Possible Values:

Value Description
TRUE

Set.

FALSE

Unset.

SrNFlag

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

SR capability N flag.

Type: bool

Default: TRUE

Possible Values:

Value Description
TRUE

Set.

FALSE

Unset.

SrPFlag

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

SR capability P flag.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Set.

FALSE

Unset.

Srv6CapabilityFlags

SRv6 Capability Flags

Type: enum

Default: N_FLAG|X_FLAG

Possible Values:

Value Description
BIT0

Bit 0

BIT1

Bit 1

BIT2

Bit 2

BIT3

Bit 3

BIT4

Bit 4

BIT5

Bit 5

BIT6

Bit 6

BIT7

Bit 7

BIT8

Bit 8

BIT9

Bit 9

BIT10

Bit 10

BIT11

Bit 11

BIT12

Bit 12

BIT13

Bit 13

N_FLAG

N Flag

X_FLAG

X Flag

SyncTimer

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

How long the emulated PCEP device would wait before it starts to compute requests which contain SVEC objects.

Type: u8

Default: 60

Ttl

Time to live.

Type: u8

Default: 64

Range: 1 - 255

UseCustomMessage

Whether the user customize the PCEP messages. When this property is set to true, the user can add custom PCEP objects to PCEP messages.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Custom objects will be used in the PCEP messages.

FALSE

Custom objects will not be used in the PCEP messages.

UsePartialBlockState

Use partial block state.

Type: bool

Default: FALSE

Possible Values:

Value Description
TRUE

Use.

FALSE

Do not use.

PcepProtocolConfig Read-Only Attributes

Read-Only Attribute Description
Common Read-Only Attributes State