rtr
CandidatePath

This class contains information of the candidate path entries for a given Segment Routing Tree policy. Each object represents a unique path from root to a specific endpoint for the configuration information.



public class CandidatePath

Properties
activeInstance Specifies the active instance for the Segment Routing Tree Policy Candidate Path entry. This value maps to rtr.CandidatePathInstance.instanceId whose corresponding rtr.CandidatePathInstance.instanceValue has a non-default value.

type=int
default=0
minimum=0
maximum=2
Displayed(tab/group)=Active Instance

administrativeState Specifies the administrative state of the candidate path.

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

candidatePathName Specifies a path name of a given candidate path instance within a Segment Routing Tree replication policy entry and it is equivalent to an LSP.

type=string
access=read-create
default=
minimum=1
maximum=32
Mandatory on create
Displayed(tab/group)=Candidate Path Name

discriminator Specifies a 32 bit value associated with a Candidate Path entry that uniquely identifies it within the context of an SR-Policy from a specific Protocol-Origin.

type=long
access=read-only
default=0
Displayed(tab/group)=Discriminator

lspId Specifies a unique identifier assigned by the controller and remain unchanged throughout the life of a LSP (candidate path) for a given Candidate Path Entry.

type=long
access=read-only
Displayed(tab/group)=LSP ID

operationalState Indicates the operational status for a given candidate path.

type=netw.OperationalState
access=read-only
default=tmnxOutOfService
Displayed(tab/group)=Operational State (/States)

originatorAddress Specifies the originator address of this candidate path entry.

type=InetAddress
access=read-only
default=0.0.0.0

originatorAddressType Indicates the type of address for the Segment Routing Tree policy entry represented by rtr.CandidatePath.originatorAddress.

type=rtr.InetAddressType
access=read-only
default=ipv4

originatorAsn Specifies a 4 byte number to represent the originator asn value for a given candidate path entry inside a Segment Routing Tree replication policy instance.

type=int
access=read-only
default=0

policyName Specifies the name for the Segment Routing Tree policy.

type=string
access=read-only
maximum=32
Displayed(tab/group)=SR-Tree Policy

preference Determines the best preferred candidate-path among the list of candidate paths towards a leaf, Higher preference is chosen.

type=int
default=100
minimum=0
maximum=1024
Displayed(tab/group)=Preference

protocolOrigin Specifies the value of protocol-origin of a candidate path which is an 8-bit value which identifies the component or protocol that originates or signals the candidate path.

type=int
access=read-only
default=configuration
Displayed(tab/group)=Origin
enums=
    10: pcep - PCEP
    20: bgpSrPolicy - BGP SR-Policy
    30: configuration - Static Configuration

routerId

type=int
access=read-only
default=1
minimum=1
maximum=10240

rtr.CandidatePathInstance-Set type=Children-Set
  
Properties inherited from ManagedObject
actionMask, children-Set, deploymentState, isFaultSquelched, name, objectFullName, selfAlarmed
 
Supported Network Elements
7750 SR Supported from 20.0.0
7450 ESS Supported from 20.0.0
7950 XRS Supported from 20.0.0
7250 IXR Supported from 21.10.R1
Product Specifics
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
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