rtr
VirtualInterface

Abstract class that represents a virtual router interface in the system.



public abstract class VirtualInterface

Properties
cflowdType This attribute is deprecated for 7750/7450/7950 13.0 and above nodes. Please use cflowd.CflowdSampling instead.

type=int
default=1
enums=
    1: none - None
    2: acl - ACL Ingress Only
    3: interface - Interface Ingress Only
    4: aclEgressOnly - ACL Egress Only
    5: interfaceEgressOnly - Interface Egress Only
    6: aclIngressEgress - ACL Ingress Egress
    7: interfaceIngressEgress - Interface Ingress Egress

directedBroadcast

type=boolean
default=false

id

type=long
access=read-create
default=0
minimum=1
maximum=5119

initDelayEnable When the value initDelayEnable is set to 'false', everytime the system attempts to bring the IPv4 interface operationally up, it will be delayed by the value of pimRPDelayedUpPeriod. When the value initDelayEnable is set to 'true', only the next time the system attempts to bring the interface operationally up, it will be delayed by the value of pimRPDelayedUpPeriod.

type=boolean
default=false

interfaceClass

type=rtr.RtrInterfaceClass
default=numbered

ipMtu The value of IP MTU is used to reflect the MTU size of this interface in the header of an ICMP MTU exceeded message when a packet is too large to be transmitted on this interface. The default size is calculated by subtracting the DLC header size from the physical MTU size of the interface. The range is 0 or between 512 and 9786. When a value of zero (0) is specified, the value is set to the calculated default size.

type=int
default=0
minimum=0
maximum=9786
units=Octets

ipOperMtu The value of the operational IP MTU indicates the operational value of the IP MTU on this interface. It is the minimum of the IP MTU and the MTU of the physical port this interface is bound to.

type=int
access=read-only
units=Octets

isTrusted

type=generic.TruthValue
default=true

loopbackEnabled

type=boolean
default=false

numberOfIpAddressLikeCtps

type=int
access=read-only
default=0

numberOfLoopbackAddresses

type=int
access=read-only
default=0

physicalAddress

type=MacAddress
default=00-00-00-00-00-00

pimRPDelayedDownPeriod The value of pimRPDelayedDownPeriod specifies the time in seconds that is used to bring down the IPv4 interface. In other words, the value of pimRPDelayedDownPeriod indicates the hold up time before the interface is going down.

type=long
default=0
minimum=0
maximum=1200
units=seconds

pimRPDelayedUpPeriod The value of pimRPDelayedUpPeriod specifies the time in seconds that is used to bring up the IPv4 interface. In other words, the value of pimRPDelayedUpPeriod indicates the hold down time before the interface is coming up. When interface comes up, it will not become operational until after the specified delay.

type=long
default=0
minimum=0
maximum=65535
units=seconds

pimRPDelayedUpTimer The value of pimRPDelayedUpTimer indicates the time left before the IPv4 interface comes up when pimRPDelayedUpPeriod is configured to a non-zero value. From SR 14.0.R1, the value of pimRPDelayedUpTimer also indicates the time left before the IPv4 interface goes down when pimRPDelayedDownPeriod is configured to a non-zero value.

type=int
access=read-only
default=-1
minimum=-1
maximum=65535
units=seconds

primaryIPv4Address

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

primaryIPv4PrefixLength

type=int
access=read-only
default=0

unnumberedReference

type=string
default=
minimum=0
maximum=32

unnumberedReferenceType

type=rtr.UnnumberedReferenceType
default=system

 
Overridden Properties
administrativeState

default=vRtrIfUp

description

maximum=255

displayedName

minimum=1
maximum=32

 
Properties inherited from netw.PortClientInterface
terminationParticipationType
 
Properties inherited from netw.PortTerminatingInterface
innerEncapValue, outerEncapValue, portIdentifyingName, portPointer
 
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

configureIpAddresses

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.
configInfoList : List (config(rtr.VirtualRouterIpAddress)) -
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:
ipAddrs : List (summary(rtr.VirtualRouterIpAddress)) -
Exceptions:
rtr.VirtualInterface.configureIpAddressesException

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:
interfaces : List (generic.CommonManagedEntityInformation) -

findByIpAddress

Input Parameters:
nodeId : string -
routingInstance : long -
ipAddress : string -
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:
interfaceInstance : summary(rtr.VirtualInterface) -

findByIpAddressFilter

Input Parameters:
ipAddressFilter : 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:
ipAddressStringByInterfaceInfo : Map (string to summary(rtr.VirtualInterface)) -

findByIpAddressList

Input Parameters:
ipAdressSet : Set (string) -
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:
ipAddressStringByInterfaceInfo : Map (string to summary(rtr.VirtualInterface)) -

findByName

Input Parameters:
nodeId : string -
routingInstance : long -
interfaceName : string -
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:
interfaceInstance : summary(rtr.VirtualInterface) -

findIpAddress

DEPRECATED - 8.0.R1
Use root find instead.
Input Parameters:
instanceFullName : string - the full name of the object.
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:
ipAddrs : List (summary(rtr.VirtualRouterIpAddress)) -
Exceptions:
rtr.VirtualInterface.findIpAddressException

findProtocols

Input Parameters:
instanceFullName : string - the full name of the object.
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:
interfaces : List (generic.CommonManagedEntityInformation) -
Exceptions:
rtr.VirtualInterface.findProtocolsException

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:
rtr.VirtualInterface.removeException

removeIpAddress

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.
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:
ipAddrs : List (summary(rtr.VirtualRouterIpAddress)) -
Exceptions:
rtr.VirtualInterface.removeIpAddressException

shutDown

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
Output Parameters:
administrativeState : int -
Exceptions:
rtr.VirtualInterface.shutDownException

turnUp

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
Output Parameters:
administrativeState : int -
Exceptions:
rtr.VirtualInterface.turnUpException
Supported Network Elements
7450 ESS
7210 SAS M
7210 SAS X
7210 SAS E
7210 SAS D
7210 SAS K
7210 SAS T
7210 SAS Mxp
7210 SAS Dxp
7210 SAS S/Sx
7210 SAS R
7250 IXR
7750 SR
7705 SAR Gen 2
7705 SAR Hm
7705 SAR
7705 SAR H
7701 CPAA
OS6850/6850E
OS6855
OS6400
Generic NE 1.0.0
OS6250
OS6450
OS6350
OS9700E/9800E
OS6900
OS6860E/OS6860N
OS6870
OS6865
OS6560/OS6560E
OS6570M
OS6465
OS6360
DC VSC
DC 7850
DC 210
DC VSA8
7950 XRS
Wavence SM Supported from 18.1.0
Product Specifics
7210 SAS D 20.0.0
7210 SAS D 21.0.0
7210 SAS D 22.0.0
7210 SAS D 23.0.0
7210 SAS D 24.0.0
7210 SAS D 25.0.0
7210 SAS Dxp 20.0
7210 SAS Dxp 21.0
7210 SAS Dxp 22.0
7210 SAS Dxp 23.0
7210 SAS Dxp 24.0
7210 SAS Dxp 25.0
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
OS6250 6.6.3
OS6250 6.6.4
OS6250 6.6.5
OS6250 6.7.1
OS6350 6.7.2
OS6360 8.10
OS6360 8.10
OS6360 8.9
OS6360 8.9
OS6400 6.4.3
OS6400 6.4.4
OS6400 6.4.5
OS6450 6.6.4
OS6450 6.6.5
OS6450 6.7.1
OS6450 6.7.2
OS6465 8.10
OS6465 8.10
OS6465 8.6
OS6465 8.7
OS6465 8.8
OS6465 8.8
OS6465 8.9
OS6465 8.9
OS6465 8.9
OS6560/OS6560E 8.10
OS6560/OS6560E 8.10
OS6560/OS6560E 8.6
OS6560/OS6560E 8.7
OS6560/OS6560E 8.8
OS6560/OS6560E 8.8
OS6560/OS6560E 8.9
OS6560/OS6560E 8.9
OS6560/OS6560E 8.9
OS6570M 8.10
OS6570M 8.10
OS6570M 8.9
OS6850/6850E 6.4.2
OS6850/6850E 6.4.3
OS6850/6850E 6.4.4
OS6850/6850E 6.4.5
OS6850/6850E 6.4.6
OS6855 6.4.4
OS6855 6.4.5
OS6855 6.4.6
OS6860E/OS6860N 8.10
OS6860E/OS6860N 8.10
OS6860E/OS6860N 8.6
OS6860E/OS6860N 8.7
OS6860E/OS6860N 8.8
OS6860E/OS6860N 8.8
OS6860E/OS6860N 8.9
OS6860E/OS6860N 8.9
OS6860E/OS6860N 8.9
OS6865 8.10
OS6865 8.10
OS6865 8.6
OS6865 8.7
OS6865 8.8
OS6865 8.8
OS6865 8.9
OS6865 8.9
OS6865 8.9
OS6870 8.10
OS6900 8.10
OS6900 8.10
OS6900 8.6
OS6900 8.7
OS6900 8.8
OS6900 8.8
OS6900 8.9
OS6900 8.9
OS6900 8.9
OS9700E/9800E 6.4.3
OS9700E/9800E 6.4.4
OS9700E/9800E 6.4.5
OS9700E/9800E 6.4.6
Wavence SM 19A.0.0
Wavence SM 20A.0.0
Wavence SM 21A.0.0
Wavence SM 22.0.0
Wavence SM 22A.0.0
Wavence SM 23.0.0
Wavence SM 23A.0.0
Wavence SM 24.0.0
Wavence SM 25.0.0