isis
Interface

Interface represents an ISIS interface.



public class Interface

Properties
adjacencyCount

type=long
access=read-only
default=0
Displayed(tab/group)=Adjacency Count (/Counters)

bfdAddressType Address type for BFD session, only IP V4 is supported currently

type=int
access=read-only
default=IPV4
Displayed(tab/group)=Address Type (/BFD)
enums=
    1: IPV4 - IPV4
    2: IPV6 - IPV6
    3: both - IPV4/IPV6

bfdEnabled specifies whether Bi-directional Forwarding Detection is enabled in this interface. When the value is 'true', this interface can establish BFD sessions and use BFD as a signalling mechanism. When it is 'false', it cannot use BFD.

type=boolean
default=false
Displayed(tab/group)=IPv4 BFD Enabled (/BFD)

creationOrigin

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

csnpInterval

type=long
default=10
minimum=1
maximum=65535
units=seconds
Displayed(tab/group)=CSNP Interval (Behavior)

defaultInstance Specifies whether a non-MI capable router can establish an adjacency and operate with an SR OS router in a non zero IS-IS instance

type=generic.TruthValue
default=false
Displayed(tab/group)=Default Instance (Behavior)

hasProblem

type=boolean
access=read-only
default=false
Displayed(tab/group)=RCA Audit Problem(s) (/RCA)

helloPadding Specifies whether padding should be done on the ISIS hello packets. If the value of helloPadding is set to disable, the padding is disabled on all types of interfaces for all adjacency states. If the value of helloPadding is set to adaptive, the padding is configured untill the state of the neighbor adjacency is up. If the value of helloPadding is set to loose, the padding is configured until the state of the neighbor adjacency is initialized. If the value of helloPadding is set to strict, the padding is configured for all adjacency states. If the value of helloPadding is set to none, the padding is disabled on all types of interfaces for all adjacency states.

type=isis.HelloPaddingType
default=disable
Displayed(tab/group)=Hello Padding (Behavior)

interfaceName

type=string
access=read-only
default=N/A
maximum=252

interfaceType

type=int
default=broadcast
Displayed(tab/group)=Type (/Capability)
enums=
    1: broadcast - Broadcast
    2: point_to_point - Point-to-Point

ipv4AdjacencySidType Specifies specifies whether the object ipv4AdjacencySidValue is not valid, an index value or an absolute label value.

type=int
default=0
Displayed(tab/group)=IPv4 SID Type (Segment Routing/Adjacency SID)
enums=
    0: none - None
    2: label - Label

ipv4AdjacencySidValue The value of the object ipv4AdjacencySidValue together with ipv4AdjacencySidType specifies the static adjacency SID value or index to be used for this adjacency.

type=long
default=0
minimum=0
maximum=4294967295
Displayed(tab/group)=IPv4 SID Value (Segment Routing/Adjacency SID)

ipv4IncludeBfdTlv specifies whether a BFD-enabled type-length-value (TLV) is included for IPv4 on this IS-IS interface..

type=boolean
default=false
Displayed(tab/group)=IPv4 Include BFD TLV (/BFD)

ipv4McastEnabled Specifies if IPv4 multicast routing is enabled for the interface.

type=generic.TruthValue
default=true
Displayed(tab/group)=IPv4 Multicast Enabled (Behavior)

ipv4SID Specifies the value of the label or index to be used for the prefix representing the primary address of the IPv4 network interface of type 'loopback'.

type=long
default=0
minimum=0
maximum=4294967295
Displayed(tab/group)=IPv4 SID Value (Segment Routing/Segment Routing)

ipv4SIDType Specifies what type of value is to be used for the prefix representing the primary address of the IPv4 network interface of type 'loopback'.

type=isis.SIDType
default=none
Displayed(tab/group)=IPv4 SID Type (Segment Routing/Segment Routing)

ipv4SidClearNFlag Specifies whether the node-sid flag (N-flag) should be cleared in an IPv4 prefix SID sub-TLV. When the value of ipv4SidClearNFlag is false, the prefix SID sub-TLV for the IPv4 prefix of a loopback interface is tagged as a node SID meaning that it belongs to this node only. When the value of ipv4SidClearNFlag is true, the same prefix SID sub-TLV may be advertised by multiple nodes.

type=boolean
default=false
Displayed(tab/group)=IPv4 SID Clear N-Flag (Segment Routing/Segment Routing)

ipv6AdjacencySidType Specifies specifies whether the object ipv6AdjacencySidValue is not valid, an index value or an absolute label value.

type=int
default=0
Displayed(tab/group)=IPv6 SID Type (Segment Routing/Adjacency SID)
enums=
    0: none - None
    2: label - Label

ipv6AdjacencySidValue The value of the object ipv6AdjacencySidValue together with ipv6AdjacencySidType specifies the static adjacency SID value or index to be used for this adjacency.

type=long
default=0
minimum=0
maximum=4294967295
Displayed(tab/group)=IPv6 SID Value (Segment Routing/Adjacency SID)

ipv6BfdEnabled specifies whether ipV6 Bi-directional Forwarding Detection is enabled in this interface. When the value is 'true', this interface can establish ipV6 BFD sessions and use BFD as a signalling mechanism. When it is 'false', it cannot use BFD.

type=boolean
default=false
Displayed(tab/group)=IPv6 BFD Enabled (/BFD)

ipv6IncludeBfdTlv specifies whether a BFD-enabled type-length-value (TLV) is included for IPv6 on this IS-IS interface..

type=boolean
default=false
Displayed(tab/group)=IPv6 Include BFD TLV (/BFD)

ipv6McastEnabled Specifies if IPv6 multicast routing is enabled for the interface.

type=generic.TruthValue
default=true
Displayed(tab/group)=IPv6 Multicast Enabled (Behavior)

ipv6SID Specifies the value of the label or index to be used for the prefix representing the primary address of the IPv6 network interface of type 'loopback'.

type=long
default=0
minimum=0
maximum=4294967295
Displayed(tab/group)=IPv6 SID Value (Segment Routing/Segment Routing)

ipv6SIDType Specifies what type of value is to be used for the prefix representing the primary address of the IPv6 network interface of type 'loopback'.

type=isis.SIDType
default=none
Displayed(tab/group)=IPv6 SID Type (Segment Routing/Segment Routing)

ipv6SidClearNFlag Specifies whether the node-sid flag (N-flag) should be cleared in an IPv6 prefix SID sub-TLV. When the value of ipv6SidClearNFlag is false, the prefix SID sub-TLV for the IPv6 prefix of a loopback interface is tagged as a node SID meaning that it belongs to this node only. When the value of ipv6SidClearNFlag is true, the same prefix SID sub-TLV may be advertised by multiple nodes.

type=boolean
default=false
Displayed(tab/group)=IPv6 SID Clear N-Flag (Segment Routing/Segment Routing)

ipv6UnicastEnabled

type=generic.TruthValue
default=false
Displayed(tab/group)=IPv6 Unicast Enabled (Behavior)

isis.Adjacency-Set type=Children-Set
isis.AuthenticationKey-Set type=Children-Set
isis.InterfaceFlexibleAlgorithm-Set type=Children-Set
isis.InterfaceLevelOneConfig-Set type=Children-Set
isis.InterfaceLevelTwoConfig-Set type=Children-Set
isis.SegmentRoutingAdjacencySetBinding-Set type=Children-Set
isisCircIndex

type=long
access=read-create
default=1
Displayed(tab/group)=Circuit ID (Behavior)

isisSysInstance

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

lastAuditTime Time of last running the RCA Audit of this object.

type=Date
access=read-only
Displayed(tab/group)=Last Audit Time (/RCA)

ldpSyncState Indicates if IGP-LDP synchronization is enabled on this interface.

type=int
access=read-only
Displayed(tab/group)=LDP Synchronization State (Behavior/LDP Synchronization)
enums=
    1: tmnxUnknown - Unknown
    2: tmnxInService - Up
    3: tmnxOutOfService - Down
    4: tmnxTransition - Transition

levelCapability

type=isis.IsisLevelType
default=level_1_and_2
Displayed(tab/group)=Level Capability (/Capability)

loadBalancingWeight Specifies an explicit load balancing weight for this interface.

type=long
default=0
minimum=0
maximum=4294967295
Displayed(tab/group)=Load Balancing Weight (Behavior)

loopfreeAlternateExclude The value of loopfreeAlternateExclude specifies whether or not the ISIS interface should be excluded during LFA calculations. The value of loopfreeAlternateExclude for an interface is only valid when both conditions are met - ISIS Site loopfreeAlternate has a value of 'true' and ISIS Level 1/2 loopfreeAlternateExclude has a value of false.

type=boolean
default=false
Displayed(tab/group)=Loop-free Alternate Exclude (Behavior)

lspPacingInterval

type=long
default=100
minimum=0
maximum=65535
units=seconds
Displayed(tab/group)=LSP Pacing Interval (Behavior)

meshGroup

type=long
default=1
minimum=1
maximum=2000000000
Displayed(tab/group)=Mesh Group (Behavior)

meshGroupStatus

type=int
default=disabled
Displayed(tab/group)=Mesh Group Status (Behavior)
enums=
    1: disabled - Disabled
    2: blocked - Blocked
    3: enabled - Enabled

passive

type=generic.TruthValue
default=false
Displayed(tab/group)=Passive (Behavior)

rca.Problem-Set type=Children-Set
retransmitInterval

type=long
default=5
minimum=1
maximum=65535
units=seconds
Displayed(tab/group)=Retransmit Interval (Behavior)

routeNextHopPointer The value specifies the next-hop template that must be applied to the prefixes which primary next-hop uses this interface name.

type=Pointer
default=
Displayed(tab/group)=Route Next-Hop Policy (Policies/LFA - Route Next-Hop Policy Template)

routeTag Specifies a 32-bit integer tag for the IP addresses of an interface. This tag can be used to apply administrative policy. A value of 0 indicates that the tag has not been set.

type=long
default=0
minimum=0
maximum=4294967295
Displayed(tab/group)=Route Tag (Behavior)

sidProtection Specifies whether the SID needs to be advertised with protection enabled or disabled. If the value is disabled, no protection is calculated and a single SID with B-flag cleared is sent in adjacency SID sub-TLV. If the value is enabled, SID protection is provided and a single SID with B-flag set is sent in adjacency SID sub-TLV.

type=generic.EnabledDisabled
default=enabled
Displayed(tab/group)=SID Protection (Segment Routing/Segment Routing)

teMetric Indicates the MPLS TE metric configured for this interface.

type=long
access=read-only
minimum=0
maximum=16777215
Displayed(tab/group)=TE Metric (Behavior)

 
Overridden Properties
application

default=isis

 
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:
isis.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:
isis.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 K 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
7701 CPAA
Generic NE 1.0.0
7705 SAR
7705 SAR H
DC VSC
DC 7850
DC 210
DC VSA8
7950 XRS
Product Specifics
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 20.0
7210 SAS M 21.0
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 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 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 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
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
7701 CPAA 8.0
7705 SAR Gen 2 25.0
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 21.0
7705 SAR Hm 22.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
7950 XRS 20.0
7950 XRS 21.0
7950 XRS 22.0
7950 XRS 23.0
7950 XRS 24.0
7950 XRS 25.0
DC 210 20.5
DC 210 5.0
DC 210 6.0
DC 7850 20.0
DC 7850 5.0
DC 7850 6.0
DC VSA8 5.0
DC VSA8 6.0
DC VSC 20.0
DC VSC 5.0
DC VSC 6.0