Overview Package Class Deprecated Help

rtr
ReplicationSegmentPolicyNextHop

This class contains configuration of the next hop entries within a replication policy. Each object of this class represents a unique path from root to a specific endpoint.

public class ReplicationSegmentPolicyNextHop

Properties
administrativeState Specifies the administrative state of the Segment Routing Tree replication policy entry.

type=netw.AdministrativeState
default=tmnxOutOfService
Displayed(tab/group)=Administrative State (/States)
nextHopAddress Specifies the root address of this next-hop entry for a given candidate path entry inside a Segment Routing Tree replication policy instance. Should be a valid unicast IP address.

type=InetAddress
default=0.0.0.0
Displayed(tab/group)=Next Hop Address
nextHopAddressType Specifies the type of rtr.ReplicationSegmentPolicyNextHop.nextHopAddress.

type=rtr.InetAddressType
default=ipv4
nextHopId Indicates the next-hop group index within a candidate path entry inside a Segment Routing Treee replication policy instance.

type=int
access=read-create
minimum=1
maximum=4096
Mandatory on create
Displayed(tab/group)=ID
nextHopInterfaceName Specifies the name of next hop out going interface for a given candidate path entry inside a Segment Routing Tree replication policy instance.

type=string
default=
Displayed(tab/group)=Next Hop Interface Name
operDownReason Indicates indicates the down reason state of Segment Routing Next Hop entry.

type=int
access=read-only
default=none
Displayed(tab/group)=State Cause (/States)
enums=
    0: none - None
    1: invalidNHop - Invalid Next Hop
    2: rtrIfDown - Interface Down
    3: rtrIfv6Down - IPv6 Interface Down
    4: rtmUnresolved - RTM Unresolved
    5: ifNotUnnum - Not Unnumbered Interface
    6: ifNotipv6LinkLocal - No IPv6 Link Local Address on Interface
    7: bfdDown - BFD Down
    8: rtrIfNotFound - No Interface
    9: idxAllocFail - ID Allocation Failure
    10: invalidLabelStack - Invalid Label Stack
    11: srTunnelProgramFail - SR Tunnel Program Failure
    12: srTunnelDown - SR Tunnel Down
operationalState Indicates the operational status for a given Segment Routing Tree replication policy entry.

type=netw.OperationalState
access=read-only
default=tmnxOutOfService
Displayed(tab/group)=Operational State (/States)
policyName Specifies the name of this Segment Routing Tree replication policy entry to be referenced by mvpn pmsi.

type=string
access=read-only
maximum=32
Displayed(tab/group)=Replication Segment Policy
protectionNextHopAddress Indicates the type of address for the protection next-hop address.

type=InetAddress
access=read-only
default=0.0.0.0
Displayed(tab/group)=Protection Address (/Next Hop Protection)
protectionNextHopAddressType Indicates the type of rtr.ReplicationSegmentPolicyNextHop.protectionNextHopAddress.

type=rtr.InetAddressType
access=read-only
default=ipv4
protectionNextHopId Specifies the protection id for a given candidate path entry inside a Segment Routing Tree replication policy instance.

type=int
default=0
minimum=0
maximum=4096
Displayed(tab/group)=Protection ID (/Next Hop Protection)
protectionNextHopInterfaceName Indicates the name of next hop out going interface for a given protect next hop candidate path entry inside a Segment Routing Tree replication policy instance.

type=string
access=read-only
default=
Displayed(tab/group)=Protection Next Hop Interface Name (/Next Hop Protection)
protectionNextHopOperDownReason Indicates the protection Next Hop entry operational down reason state.

type=int
access=read-only
default=none
Displayed(tab/group)=Protection State Cause (/Next Hop Protection)
enums=
    0: none - None
    1: invalidNHop - Invalid Next Hop
    2: rtrIfDown - Interface Down
    3: rtrIfv6Down - IPv6 Interface Down
    4: rtmUnresolved - RTM Unresolved
    5: ifNotUnnum - Not Unnumbered Interface
    6: ifNotipv6LinkLocal - No IPv6 Link Local Address on Interface
    7: bfdDown - BFD Down
    8: rtrIfNotFound - No Interface
    9: idxAllocFail - ID Allocation Failure
    10: invalidLabelStack - Invalid Label Stack
    11: srTunnelProgramFail - SR Tunnel Program Failure
    12: srTunnelDown - SR Tunnel Down
protectionNextHopOperationalState Indicates the operational status of the protection Next Hop entry.

type=netw.OperationalState
access=read-only
default=tmnxOutOfService
Displayed(tab/group)=Protection Operational State (/Next Hop Protection)
routerId

type=int
access=read-only
default=1
minimum=1
maximum=10240
rtr.NextHopReplicationLabel-Set type=Children-Set
weightedLoadBalancing Specifies the weighted load balancing value for a given candidate path entry inside a Segment Routing Tree replication policy instance.

type=long
access=read-only
default=0
Displayed(tab/group)=Weighted Load Balancing
  
Properties inherited from ManagedObject
actionMask, children-Set, deploymentState, isFaultSquelched, name, objectFullName, selfAlarmed
 
Methods

configureReplicationLabels

Configure the labels by providing the list of labels separated by space. The existing Replication Labels are replaced with the values specified in the input. If the input is empty then all the Replication Labels are reset. If the total entries is more than allowed labels then the extra input is ignored.
Input Parameters:
deployer : Deployer - the deployment state
synchronousDeploy : boolean - (Optional) Specify whether to block until the changes have been fully deployed to the network. A value of "true" means to block. A value of "false" means to return immediately. Default: false (asynchronous)
clearOnDeployFailure : boolean - (Optional) Specify whether to clear any failed deployers. A value of "true" means to clear. A value of "false" means to leave the failed deployer. Default: false
deployRetries : int - (Optional) The number of times to attempt re-deployment during synchronous deployment. This parameter is meaningless in the asynchronous case. Default: 0
deployRetryInterval : long - (Optional) The number of milliseconds to wait between deployment retries. This parameter is meaningless in the asynchronous case. Default: 0
taskDescription : string - (Optional) A user friendly description of what the operation does. This information will be used by the task manager.
nextHopInstance : Pointer - Specifies the Replication Segment Next Hop under which the labels have to be configured.
labelStringValue : string - Specifies the labels separated by space. The value provided will replace the entire labels currently available to the new values. E.G.: 111 222 333
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
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