pcep
AbstractPcepEntity

This class contains information describing the Path Computation Element communications Protocol (PCEP) configured parameters and cumulative statistics.



public abstract class AbstractPcepEntity

Properties
administrativeState Specifies the desired administrative state of this PCEP entity.

type=netw.AdministrativeState
default=tmnxOutOfService
Displayed(tab/group)=Administrative State (/State)

allowNegotiation Specifies whether the PCEP entity will permit negotiation of session parameters.

type=boolean
access=read-only
Displayed(tab/group)=Allow Negotiations (Information)

connectTimer Specifies time that the PCEP entity will wait to establish a TCP connection with a peer. If a TCP connection is not established within this time, then PCEP aborts the session setup attempt.

type=int
access=read-only
units=seconds
Displayed(tab/group)=Connection Timer (Information)

deadTimer Specifies the DeadTimer that this PCEP entity will propose in the initial OPEN message of each session it is involved in. This is the time after which a peer should declare a session down if it does not receive any PCEP messages. Zero suggests that the peer does not run a DeadTimer at all.

type=int
access=read-only
units=seconds
Displayed(tab/group)=Dead Timer (Information)

deadTimerInterval Specifies the dead timer interval that this PCEP entity proposes in the initial OPEN message of each session it is involved in. This is the time after which a peer should declare a session down if it does not receive any PCEP messages. This value should always be greater than keepAliveInterval.

type=int
default=120
minimum=1
maximum=255
units=seconds
Displayed(tab/group)=Dead Timer Interval

displayedName

type=string
access=read-only
default=
maximum=252

entityCapabilities Indicates the capabilities associated with this PCEP entity.

type=pcep.PcepCapabilities
access=read-only
Displayed(tab/group)=Capabilities (Information)

entityType Specifies the type of this PCEP entity. It takes one of the following values: - PCC (1) : this entity is a Path Computation Client (PCC) - PCE (2) : this entity is a Path Computation Server (PCE).

type=int
access=read-create
default=1
minimum=1
maximum=2
Displayed(tab/group)=Type
enums=
    1: pcc - PCC
    2: pce - PCE

index Specifies the unique identifier for this PCEP entity. The value of index can only be set to 1, when the value of entityType is set to 'PCC (1)'. The value of index can only be set to 2, when the value of entityType is set to 'PCE (2)'.

type=long
access=read-create
default=1
minimum=1
maximum=2
Displayed(tab/group)=ID

keepAliveInterval Specifies keep alive interval that this PCEP entity proposes in the initial OPEN message of each session it is involved in. This is the maximum time between two consecutive messages sent to a peer. This value should always be less than deadTimerInterval.

type=int
default=30
minimum=1
maximum=255
units=seconds
Displayed(tab/group)=Keep-Alive Interval

keepAliveTimer Specifies the Keepalive transmission timer that this PCEP entity will propose in the initial OPEN message of each session it is involved in. This is the maximum time between two consecutive messages sent to a peer. Zero means that the PCEP entity prefers not to send Keepalives at all. Note that the actual Keepalive transmission intervals, in either direction of an active PCEP session, are determined by negotiation between the peers as specified by RFC 5440, and so may differ from this configured value.

type=int
access=read-only
units=seconds
Displayed(tab/group)=Keep-Alive Timer (Information)

keepWaitTimer Specifies time that the PCEP entity will wait to receive a Keepalive or PCErr message from a peer during session initialization after receiving an Open message. If no Keepalive or PCErr message is received within this time, then PCEP terminates the TCP connection and deletes the associated Session entry.

type=int
access=read-only
units=seconds
Displayed(tab/group)=Keep Wait Timer (Information)

localAddress Specifies the local Internet IPv4 address of this PCEP entity.

type=InetAddress
default=0.0.0.0
Displayed(tab/group)=Local Address

localAddressIPv6 Specifies the local Internet IPv6 address of this PCEP entity.

type=InetAddress
default=0:0:0:0:0:0:0:0

localAddressIPv6Type Specifies the address type of this PCEP entity's IPv6 address.

type=rtr.InetAddressType
default=ipv6

localAddressType Specifies the address type of this PCEP entity's IPv4 address.

type=rtr.InetAddressType
default=ipv4

maxSessions Specifies maximum number of sessions involving this PCEP entity that can exist at any time.

type=int
access=read-only
Displayed(tab/group)=Maximum Sessions (Information)

maxUnknownMessages Specifies maximum number of unknown messages that any session on this PCEP entity is willing to accept per minute before terminating the session.

type=int
default=10
minimum=1
maximum=255
Displayed(tab/group)=Maximum Unknown Messages

maxUnknownRequests Specifies maximum number of unrecognized requests and replies that any session on this PCEP entity is willing to accept per minute before terminating the session. A PCRep message contains an unrecognized reply if it contains an RP object whose request ID does not correspond to any in-progress request sent by this PCEP entity. A PCReq message contains an unrecognized request if it contains an RP object whose request ID is zero.

type=int
access=read-only
Displayed(tab/group)=Maximum Unknown Requests (Information)

openWaitTimer Specifies time that the PCEP entity will wait to receive an Open message from a peer after the TCP connection has come up. If no Open message is received within this time, then PCEP terminates the TCP connection and deletes the associated Session entry.

type=int
access=read-only
units=seconds
Displayed(tab/group)=Open Wait Timer (Information)

operationalState Specifies the operational status of the PCEP entity. It takes one of the following values - operStatusUp(1): the PCEP entity is active. operStatusDown(2): the PCEP entity is inactive. operStatusGoingUp(3): the PCEP entity is activating. operStatusGoingDown(4): the PCEP entity is deactivating. operStatusFailed(5): the PCEP entity has failed and will recover when possible. operStatusFailedPerm(6): the PCEP entity has failed and will not recover without operator intervention.

type=pcep.PcepOperationalState
access=read-only
default=operStatusDown
Displayed(tab/group)=Operational State (/State)

overloaded Indicates whether this PCEP entity is overloaded with the processing of existing requests and is unable to handle new requests leading to unacceptable response times.

type=boolean
access=read-only
Displayed(tab/group)=Overloaded (Information)

requestTimer Specified the maximum time that the PCEP entity will wait for a response to a PCReq message.

type=int
access=read-only
units=seconds
Displayed(tab/group)=Request Timer (Information)

routerId

type=int
access=read-only
default=1
minimum=1
maximum=10240
Displayed(tab/group)=Routing Instance ID (/Routing Instance)

routerName

type=string
access=read-only
default=
minimum=0
maximum=32
Displayed(tab/group)=Routing Instance Name (/Routing Instance)

routingInstancePointer

type=string
access=read-only
default=
maximum=252

siteId

type=string
access=read-only
default=0.0.0.0
maximum=64
Displayed(tab/group)=Site ID (/Site)

siteName

type=string
access=read-only
default=
maximum=252
Displayed(tab/group)=Site Name (/Site)

syncTimer The value of SyncTimer is used in the case of a synchronized path computation request using the SVEC object. A value of zero is returned if and only if the entity does not use the SyncTimer.

type=int
access=read-only
units=seconds
Displayed(tab/group)=Synchronization Timer (Information)

  
Properties inherited from ManagedObject
actionMask, children-Set, deploymentState, isFaultSquelched, name, objectFullName, selfAlarmed
 
Supported Network Elements
7450 ESS Supported from 14.0.R1
7750 SR Supported from 14.0.R1
7705 SAR Gen 2
7705 SAR Hm
7950 XRS Supported from 14.0.R1
7705 SAR Supported from 8.0.R7
7705 SAR H Supported from 8.0.R7
7210 SAS K Supported from 11.0.R2
  • Required Capabilities: NetworkMode
7210 SAS Mxp Supported from 11.0.R2
  • Required Capabilities: NetworkMode
7210 SAS R Supported from 11.0.R2
7250 IXR Supported from 19.5.R1
Product Specifics
7210 SAS R 20.0
7210 SAS R 21.0
7210 SAS R 22.0
7210 SAS R 23.0
7210 SAS R 24.0
7210 SAS R 25.0
7250 IXR 20.0
7250 IXR 21.0
7250 IXR 22.0
7250 IXR 23.0
7250 IXR 24.0
7250 IXR 25.0
7450 ESS 20.0
7450 ESS 21.0
7450 ESS 22.0
7450 ESS 23.0
7450 ESS 24.0
7450 ESS 25.0
7705 SAR Gen 2 25.0
7705 SAR H 23.0
7705 SAR H 24.0
7705 SAR H 25.0
7705 SAR H 9.0
7705 SAR Hm 20.0
7705 SAR Hm 21.0
7705 SAR Hm 22.0
7705 SAR Hm 23.0
7705 SAR Hm 24.0
7705 SAR Hm 25.0
7705 SAR 21.0
7705 SAR 22.0
7705 SAR 23.0
7705 SAR 24.0
7705 SAR 25.0
7750 SR 20.0
7750 SR 21.0
7750 SR 22.0
7750 SR 23.0
7750 SR 24.0
7750 SR 25.0
7950 XRS 20.0
7950 XRS 21.0
7950 XRS 22.0
7950 XRS 23.0
7950 XRS 24.0
7950 XRS 25.0