ldp
Interface

Interface contains information of an LDP interface.



public class Interface

Stats:
ldp.InterfaceStats

Properties
administrativeStateIPv4 Indicates the desired Ipv4 administrative state for this interface

type=netw.AdministrativeState
default=tmnxInService
Displayed(tab/group)=Administrative State (Protocol Properties.IPv4)

bfdEnabled The value of bfdEnabled specifies whether BFD tracking of a LDP Session on this interface is enabled.

type=boolean
default=false
Displayed(tab/group)=Enable BFD Tracking (Protocol Properties.General)

creationOrigin

type=svt.L2RouteOriginType
access=read-create
default=manual

helloFactor

type=int
default=3
minimum=1
maximum=255
Displayed(tab/group)=Hello Factor (Protocol Properties.IPv4)

helloTimeout

type=int
default=15
minimum=2
maximum=65535
units=seconds
Displayed(tab/group)=Hello Timeout (Protocol Properties.IPv4)

inetAddressType Indicates the Inet address family of this interface.

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

inheritanceMask

type=long
default=0
bits=
    0x1: keepAliveFactor - Keep-Alive Factor
    0x2: keepAliveTimeout - Keep-Alive Timeout
    0x4: helloFactor
    0x8: helloTimeout
    0x10: backoffTime
    0x20: maxBackoffTime
    0x40: transportAddrType
    0x80: passiveMode

ipv4Enabled Enables the configuration that is to be used with LDP for ipv4 address.

type=boolean
default=true
Displayed(tab/group)=Enable IPv4 (Protocol Properties.General)

ipv4PfxFecCapability Whether traffic exchange for IPv4 prefix FECs is enabled or disabled on this interface.

type=ldp.MulticastFwdState
default=enabled
Displayed(tab/group)=IPv4 Prefix-FEC (Protocol Properties.IPv4/FEC)

ipv6BfdEnabled The value of ipv6BfdEnabled specifies whether BFD tracking is enabled to each resolved ipv6 FEC next hop and or ipv6 hello adjacency over this interface.

type=boolean
default=false
Displayed(tab/group)=Enable IPv6 BFD Tracking (Protocol Properties.General)

ipv6Enabled Enables the configuration that is to be used with LDP for ipv6 address.

type=boolean
default=false
Displayed(tab/group)=Enable IPv6 (Protocol Properties.General)

ipv6P2MPFecCapability Whether traffic exchange for IPv6 P2MP FECs is enabled or disabled on this interface.

type=ldp.MulticastFwdState
default=enabled
Displayed(tab/group)=IPv6 P2MP-FEC (Protocol Properties.IPv4/FEC)

ipv6PfxFecCapability Whether traffic exchange for IPv6 prefix FECs is enabled or disabled on this interface.

type=ldp.MulticastFwdState
default=enabled
Displayed(tab/group)=IPv6 Prefix-FEC (Protocol Properties.IPv4/FEC)

keepAliveFactor

type=int
default=3
minimum=1
maximum=255
Displayed(tab/group)=Keep-Alive Factor (Protocol Properties.IPv4)

keepAliveTimeout

type=int
default=30
minimum=2
maximum=65535
units=seconds
Displayed(tab/group)=Keep-Alive Timeout (Protocol Properties.IPv4)

ldp.AuthenticationKey-Set type=Children-Set
ldp.IPv6Extension-Set type=Children-Set
loadBalancingWeight Specifies an explicit load-balancing-weight for this interface. This weight overrides IGP route next-hop weights if configured.

type=long
default=0
minimum=0
maximum=4294967295
Displayed(tab/group)=Load Balancing Weight (Protocol Properties.General)

localLsrIfId Used for the local lsr id.

type=long
access=read-only
default=0

localLsrIfName The name of the local interface to be used.

type=string
access=read-only
default=

localLsrIfPointer The local lsr interface pointer.

type=Pointer
default=
Displayed(tab/group)=Interface (Protocol Properties.IPv4)

localLsrType Specifies whether the local interface address or the system interface address should be used as source Label Switch Router identifier (LSR-ID) to establish a link LDP adjacency with a LDP peer

type=ldp.TransAddrType
default=system
Displayed(tab/group)=Local LSR ID (Protocol Properties.IPv4)

multicastFwdEnabled Whether multicast traffic forwarding i.e IPv4 P2MP FECs is enabled or disabled on the interface.

type=ldp.MulticastFwdState
default=enabled
Displayed(tab/group)=IPv4 P2MP-FEC (Protocol Properties.IPv4/FEC)

operDownReasonCode Indicates the reason due to which the LDP instance is operationally down

type=ldp.LdpIfOperDownReasonCode
access=read-only
default=operUp
Displayed(tab/group)=Operational State Down Reason (/States)

operDownReasonCodeIPv4 Indicates the reason due to which the LDP ipv4 interface is operationally down

type=ldp.LdpIfOperDownReasonCode
access=read-only
default=operUp
Displayed(tab/group)=Operational State Down Reason (Protocol Properties.IPv4)

operationalStateIPv4 Specifies the current Ipv4 operational state of this interface."

type=netw.OperationalState
access=read-only
default=unknown
Displayed(tab/group)=Operational State (Protocol Properties.IPv4)

peerAddress

type=string
access=read-only
default=0.0.0.0
maximum=50

transportAddressType

type=ldp.TransAddrType
default=system
Displayed(tab/group)=Address Type (Protocol Properties.IPv4)

 
Overridden Properties
administrativeState

default=tmnxInService

 
Properties inherited from netw.RouterTerminatingNonIpInterface
additionalForNamingInterfaceName, interfaceId
 
Properties inherited from netw.RouterTerminatingInterface
interfaceClass, serviceId, serviceType, subscriberId
 
Properties inherited from netw.StatefullConnectableInterface
administrativeState, compositeState, encapType, operationalState, resourceState, underlyingResourceState
 
Properties inherited from netw.ConnectableInterface
actualMtu, ctpPointer, encapType, isExclusiveTermination, mtuMismatch, portId, portName, provisionedMtu, routerId, routerName, terminatedObjectId, terminatedObjectName, terminatedObjectPointer, terminatedPortClassName, terminatedPortCombinedEncapValue, terminatedPortInnerEncapValue, terminatedPortOuterEncapValue, terminatedPortPointer, terminationParticipationType
 
Properties inherited from netw.LogicalInterface
application, description, displayedName, domain, nodeId, nodeName
 
Properties inherited from ManagedObject
actionMask, children-Set, deploymentState, isFaultSquelched, name, objectFullName, selfAlarmed
 
Methods

configure

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.
instanceFullName : string - the full name of the object.
configInfo : generic.CommonManagedContainmentEntityConfigurationInformation -
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Output Parameters:
objectFullName : string -
Exceptions:
ldp.Interface.configureException

find

DEPRECATED - 8.0.R1
Use root find instead.
Input Parameters:
filter : FilterHolder -
resultFilter : ResultFilter - (Optional) Filter for narrowing down the information returned per object
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Output Parameters:
infoList : List (generic.CommonManagedEntityInformation) -

remove

DEPRECATED - 8.0.R1
Use
generic.GenericObject.deleteInstance() instead.
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.
instanceFullName : string - the full name of the object.
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Exceptions:
ldp.Interface.removeException
Supported Network Elements
7450 ESS
7210 SAS M Supported for all versions
  • Required Capabilities: NetworkMode
7210 SAS T Supported for all versions
  • Required Capabilities: NetworkMode
7210 SAS Mxp Supported for all versions
  • Required Capabilities: NetworkMode
7210 SAS S/Sx
7210 SAS X
7210 SAS R
7250 IXR
7750 SR
7705 SAR Gen 2
7705 SAR Hm
7705 SAR
7705 SAR H
Generic NE 1.0.0
OS9700E/9800E
DC VSC
DC 7850
DC 210
DC VSA8
7950 XRS
7210 SAS K Supported from 9.0.R6
  • Required Capabilities: NetworkMode
Product Specifics
7210 SAS K (all versions)
7210 SAS K 20.0
7210 SAS K 21.0
7210 SAS K 22.0
7210 SAS K 23.0
7210 SAS K 24.0
7210 SAS K 25.0
7210 SAS M (all versions)
7210 SAS M 20.0
7210 SAS M 21.0
7210 SAS Mxp (all versions)
7210 SAS Mxp 20.0
7210 SAS Mxp 21.0
7210 SAS Mxp 22.0
7210 SAS Mxp 23.0
7210 SAS Mxp 24.0
7210 SAS Mxp 25.0
7210 SAS R (all versions)
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
7210 SAS S/Sx (all versions)
7210 SAS S/Sx 20.0
7210 SAS S/Sx 21.0
7210 SAS S/Sx 22.0
7210 SAS S/Sx 23.0
7210 SAS S/Sx 24.0
7210 SAS S/Sx 25.0
7210 SAS T (all versions)
7210 SAS T 20.0
7210 SAS T 21.0
7210 SAS T 22.0
7210 SAS T 23.0
7210 SAS T 24.0
7210 SAS T 25.0
7210 SAS X (all versions)
7250 IXR (all versions)
7250 IXR 20.0
7250 IXR 21.0
7250 IXR 22.0
7250 IXR 23.0
7250 IXR 24.0
7250 IXR 25.0
7705 SAR Gen 2 25.0
7705 SAR H (all versions)
7705 SAR H 20.0
7705 SAR H 21.0
7705 SAR H 22.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 23.0
7705 SAR Hm 24.0
7705 SAR Hm 25.0
7705 SAR 20.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
DC 210 (all versions)
DC 210 20.5
DC 210 5.0
DC 210 6.0
DC 7850 (all versions)
DC 7850 20.0
DC 7850 5.0
DC 7850 6.0
DC VSA8 5.0
DC VSA8 6.0
DC VSC (all versions)
DC VSC 20.0
DC VSC 5.0
DC VSC 6.0
OS9700E/9800E (all versions)
OS9700E/9800E 6.4.3
OS9700E/9800E 6.4.4
OS9700E/9800E 6.4.5
OS9700E/9800E 6.4.6