rtr
NetworkInterface

NetworkInterface represents a virtual router interface in the system. This virtual router interface is defined on a network port.



public class NetworkInterface

Stats:
equipment.InterfaceAdditionalStats equipment.InterfaceStats rtr.InterfaceSecurityStats rtr.IpInterfaceAdditionalStats rtr.IpInterfaceStats rtr.MacAccountingStats rtr.NatControlQueueStats rtr.NetworkInterfaceEgressStats rtr.NetworkInterfaceIngressStats rtr.NetworkInterfaceURPFStats rtr.NgeKeygroupStats rtr.NgeL3RIStats rtr.PolicyAccountInterfaceStats rtr.PolicyAccountPolicerInterfaceStats rtr.ReassemblyProfilePolicyStats rtr.SarIpInterfaceStats rtr.SarIpInterfaceStatsRxExtra rtr.VRtrIfDcpFpDynamicStats rtr.VRtrIfDcpFpLocMonPlcrStats rtr.VRtrIfDcpFpStaticStats sas.ASWResultStats sas.SWResultStats service.CombinedNetworkInterfaceEgressPacketsOctets service.CombinedNetworkInterfaceIngressPacketsOctets service.CompleteNetworkInterfaceEgressPacketsOctets service.CompleteNetworkInterfaceIngressPacketsOctets service.NetworkInterfaceEgressOctets service.NetworkInterfaceEgressPackets service.NetworkInterfaceIngressOctets service.NetworkInterfaceIngressPackets

Properties
actualPrimaryStatus Actual primary interface status for this interface.

type=generic.TruthValue
access=read-only
default=false
Displayed(tab/group)=Actual Primary Status

adminGroupInclude

type=long
default=0
units=bitmap
Displayed(tab/group)=Groups Included (/Administrative Group)

adminLinkLclAddrPreferred

type=boolean
default=false
Displayed(tab/group)=Admin Link Local Address Preferred

adminLinkLocalAddr

type=InetAddress
default=0:0:0:0:0:0:0:0
Displayed(tab/group)=Admin Link Local Address

adminLinkLocalAddrType

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

adminLinkLocalAddrTypeWithZoneIndex

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

adminLinkLocalAddrWithZoneIndex

type=InetAddress
default=
Displayed(tab/group)=Admin Link Local Address

aluIfL4LoadBalancing aluVrtrIfL4LoadBalancing specifies the load balancing algorithm to be used on this interface. When the value is 'includeL4', the src and dst port are used in the hashing algorithm. When it's 'excludeL4', they are not included. When the value is 'system', the port inherits the global settings in .

type=rtr.AluIfL4LoadBalancing
default=system
Displayed(tab/group)=L4 Load Balance

arpLearnUnsolicited Specifies whether unsolicited learning is enabled or not.

type=boolean
default=false
Displayed(tab/group)=ARP Unsolicited Learning

arpProactiveRefresh Specifies whether proactive refresh is enabled or not.

type=boolean
default=false
Displayed(tab/group)=ARP Proactive Refresh

bcastAddress

type=string
access=read-only
default=0.0.0.0
maximum=50
Displayed(tab/group)=Broadcast Address

bfd.BfdConfig-Set type=Children-Set
bfd.BfdSession-Set type=Children-Set
bfd.BfdV6Config-Set type=Children-Set
bfdConfigured Specifies if BFD is configured on this interface.

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

bfdv6Configured Specifies if IPv6 BFD is configured on this interface.

type=boolean
access=read-only
default=false
Displayed(tab/group)=IPv6 BFD Configured (/BFD Configured)

cflowd.CflowdSampling-Set type=Children-Set
clear.ClearRequest-Set type=Children-Set
configPrimaryStatus Primary interface configuration status for this interface. If set to true, this interface will be used as the default interface for the VLAN on which it resides when possible.

type=generic.TruthValue
default=false
Displayed(tab/group)=Configured Primary Status

dCpuProtectionPolicyPointer Associates Distributed CPU Protection Policy with a Base Router Interface.

type=Pointer
default=
Displayed(tab/group)=NE DDoS Protection Policy (Security/NE Protection)

dadDisable The value of dadDisable specifies if the Duplicate Address Detection (DAD) is disabled for this interface.

type=boolean
default=false
Displayed(tab/group)=Duplicate Address Detection Disabled

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

type=long
default=0
minimum=0
maximum=1200
units=seconds
Displayed(tab/group)=Hold Up Period (/Hold Time IPv6)

delayedTimerIpv6 The value of delayedTimerIpv6 indicates the time left before the interface comes up or goes down, depending on the ongoing transition state of the interface.

type=long
access=read-only
default=-1
minimum=-1
maximum=1200
units=seconds
Displayed(tab/group)=Delayed Timer (/Hold Time IPv6)

delayedUpPeriodIpv6 The value of delayedUpPeriodIpv6 specifies the time in seconds that is used to bring up the IPv6 interface. In other words, the value of delayedUpPeriodIpv6 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=1200
units=seconds
Displayed(tab/group)=Hold Down Period (/Hold Time IPv6)

dhcp.DhcpClientConfiguration-Set type=Children-Set
dosProtection Pointer specifies the DoS Protection Policy that is applicable to this interface.

type=Pointer
default=NE DoS Protection:255
Displayed(tab/group)=NE DoS Protection (Security/NE Protection)

egrIpLoadBalancing Specifies whether to include source address or destination address or both in LAG/ECMP hash on IP interfaces.

type=rtr.EgrIpLoadBalancing
default=both
Displayed(tab/group)=Egress IP Load Balancing (/Load Balancing)

egressAggCIR Specifies the CIR of all egress queues for this Network Interface.

type=int
default=0
minimum=-1
maximum=100000000
units=kbps
Displayed(tab/group)=Aggregate CIR (Policies.QoS), Aggregate CIR (Policies.QoS/Egress Aggregate Rate Limit/Rate)

egressAggRateLimit Specifies the maximum total rate of all egress queues for this Network Interface. The value -1 means that there is no limit.

type=int
default=-1
minimum=-1
maximum=100000000
units=kbps
Displayed(tab/group)=Aggregate Rate Limit PIR (Policies.QoS), Aggregate Rate Limit (Policies.QoS/Egress Aggregate Rate Limit/Rate)

egressAggregateFilterId

type=long
access=read-only
default=0
minimum=0
maximum=65535

egressAggregateFilterName

type=string
access=read-only
default=
minimum=0
maximum=32

egressAggregateFilterPointer

type=Pointer
default=
Displayed(tab/group)=Egress ACL (Policies.General/Aggregate ACL)

egressCirPercent The administrative CIR percentage, in hundredths of a percent.

type=float
default=0
minimum=0
maximum=100
units=%
Displayed(tab/group)=CIR (Policies.QoS/Egress Aggregate Rate Limit/Percent Rate)

egressFilterId

type=long
access=read-only
default=0
minimum=0
maximum=65535

egressFilterName Specifies the policy name corresponding to the rtr.NetworkInterface.egressFilterPointer object. Please do not use this property to determine the policy name. Use the rtr.NetworkInterface.egressFilterPointer to get the policy object, from that get the policy name.

type=string
access=read-only
default=
minimum=0
maximum=32

egressFilterPointer

type=Pointer
default=
Displayed(tab/group)=Egress IP ACL (Policies.General/IP ACL)

egressIpv6FilterId

type=long
access=read-only
default=0
minimum=0
maximum=65535

egressIpv6FilterName Specifies the policy name corresponding to the rtr.NetworkInterface.egressIpv6FilterPointer object. Please do not use this property to determine the policy name. Use the rtr.NetworkInterface.egressIpv6FilterPointer to get the policy object, from that get the policy name.

type=string
access=read-only
default=
minimum=0
maximum=32

egressIpv6FilterPointer Pointer to the instance of the ACL IPv6 filter.

type=Pointer
default=
Displayed(tab/group)=Egress IPv6 ACL (Policies.General/IPv6 ACL)

egressNqueuePolicyName

type=string
access=read-only
default=
minimum=0
maximum=32

egressNqueuePolicyObjectPointer Pointer to the instance of Network Queue Policy

type=Pointer
default=
Displayed(tab/group)=Egress Network Queue Policy (Policies.QoS)

egressPirPercent The administrative PIR percentage, in hundredths of a percent.

type=float
default=100
minimum=0.01
maximum=100
units=%
Displayed(tab/group)=PIR (Policies.QoS/Egress Aggregate Rate Limit/Percent Rate)

egressRemarkPolicyObjectPointer Specifies Egress Remark Policy associated with this Network Interface.

type=Pointer
default=EgressRemarkPolicy7250SROS:default
Displayed(tab/group)=Egress Remark Policy (Policies.General/Network)

egressRemarkingPolicyObjectPointer Specifies Egress Remark Policy associated with this Network Interface. For IXR nodes from 19.5 onwards use property.

type=Pointer
default=egressRemark:2
Displayed(tab/group)=Egress Remarking Policy (Policies.General/Network)

egressVlanPlcyPortRedirect

type=generic.TruthValue
default=false
Displayed(tab/group)=Port Redirect (Policies.General/Network/Egress VLAN QoS Policy)

egressVlanQosPolicyObjectPointer Specifies Egress VLAN QOS Policy associated with this Network Interface.

type=Pointer
default=VlanQosPolicy7250SROS:default
Displayed(tab/group)=Policy (Policies.General/Network/Egress VLAN QoS Policy)

enableForwarding

type=generic.TruthValue
default=false
Displayed(tab/group)=Enable Forwarding

enableIngressStats Specifies if ingress statistics gathering is enabled for this interface.

type=boolean
default=false
Displayed(tab/group)=Enable Ingress Stats

enableMacAccountingStats Specifies if MAC accounting statistics gathering is enabled for this interface.

type=boolean
default=false
Displayed(tab/group)=Enable MAC Accounting Stats

encapsulationType This is the encapsulation type of the IP Interface. Only applicable for AOS Node types.

type=rtr.EncapType
default=ethernet2
Displayed(tab/group)=Interface Encap Type

firewall.InterfaceFirewall-Set type=Children-Set
forwardIPv4Packets Specifies if the interface forwards unencapsulated IPv4 packets while IPv6 is enabled and the interface has no IPv4 address configured. This can be used in the context of IETF RFC5549 Advertising IPv4 Network Layer Reachability Information with an IPv6 Next Hop.

type=boolean
default=false
Displayed(tab/group)=Forward IPv4 Packets

globalIfIndex The value of globalIndex uniquely identifies this interface in the tmnx system. This field provides an identifier for router interfaces similar to the ID value, except that ID is unique within each virtual router. The globalIndex is unique system wide regardless of the ID.

type=int
default=0
minimum=0
maximum=262144

gneIfPointer

type=Pointer
access=read-only
Displayed(tab/group)=Generic NE Interface (/Multi-Vendor)

greTermination Indicates gre-termination on the router interface

type=boolean
default=false
Displayed(tab/group)=GRE-Termination

greTerminationIpv6 Specifies whether the user can terminate MPLS-over-GRE on a IPv6 address with 128 prefix of a non-system interface.

type=boolean
default=false
Displayed(tab/group)=IPv6 GRE-Termination

hasProblem

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

hashingTreatment The value of hashingTreatment specifies whether it is used in the LAG and ECMP LSR hashing algorithm."

type=rtr.HashingTreatment
default=system
Displayed(tab/group)=Hashing Treatment (/Load Balancing)

icmp.VirtualInterfaceIcmpTLConfiguration-Set type=Children-Set
ifDhcpIpRelease

type=int
default=disabled
enums=
    1: enabled - Enabled
    2: disabled - Disabled

ifDhcpIpRenew

type=int
default=disabled
enums=
    1: enabled - Enabled
    2: disabled - Disabled

ifDhcpOption60 The value of option-60 filed that should be inserted in DHCP discover/request packet if configured.

type=string
default=OmniSwitch
minimum=1
maximum=64
Displayed(tab/group)=DHCP Option-60 (DHCP-CLIENT Parameter)

ifDhcpStatus DHCP status of the DHCP Client IP interface.

type=rtr.InterfaceDhcpStatus
access=read-only
Displayed(tab/group)=Client Status (DHCP-CLIENT Parameter)

ifIndex The ifIndex of the interface. Used only for 6850 nodes.

type=long
access=read-only
default=0

ifLsrIpLoadBalancing The value of ifLsrIpLoadBalancing specifies whether the IP Header is used in the LAG and ECMP LSR hashing algorithm. This is the per interface setting. When set to 'label-only (1)' only the label is used in the hashing algorithm. When set to 'label-ip (2)', the IP Header is included in the hashing algorithm. When set to 'ip-only (3)' the IP Header is used exclusively in the hashing Algorithm. When set to 'system (0)', the hashing algorithm is inherited from the setting of 'lsrIpLoadBalancing' under the NetworkElement object.

type=rtr.IfLsrIpLoadBalancing
default=system
Displayed(tab/group)=LSR IP Load Balancing (/Load Balancing)

ifTeIdLoadBalancing Specifies whether TEID load balancing is enabled for GTP-U/GTP-C tunnels on all configured Router interfaces.

type=boolean
default=false
Displayed(tab/group)=TEID Load Balancing (/Load Balancing)

ifType This property will distinguish between a regualr network interface and an mpls-tp interface.

type=rtr.RtrInterfaceType
access=read-create
default=network
Displayed(tab/group)=Domain

ilmDefaultForwarding Specifies the default-forwarding for the inter-AS Selective ILM interface. When the value is set to 'Forward', the labeled packets will be checked normally against the table of programmed ILMs to decide if it should be dropped or forwarded in a GRT, a VRF, or a L2 service context. When the value is set to 'Drop', all labeled packets received on that interface will automatically be dropped. This property is applicable only when ilmUntrusted is 'true'.

type=int
default=1
Displayed(tab/group)=ILM Default Forwarding
enums=
    1: forward - Forward
    2: drop - Drop

ilmUntrusted Specifies whether the interface can participate in the Selective ILM (Incoming Label Map) feature. This is usually done for an inter-AS interface.

type=boolean
default=false
Displayed(tab/group)=ILM Not-Trusted

ingrDestinationClassLookup Specifies if traffic coming in through this interface can be filtered at the egress side based on the destination class.

type=boolean
default=false
Displayed(tab/group)=Ingress Destination Class Lookup

ingressAggregateFilterId

type=long
access=read-only
default=0
minimum=0
maximum=65535

ingressAggregateFilterName

type=string
access=read-only
default=
minimum=0
maximum=32

ingressAggregateFilterPointer

type=Pointer
default=
Displayed(tab/group)=Ingress ACL (Policies.General/Aggregate ACL)

ingressFilterId

type=long
access=read-only
default=0
minimum=0
maximum=65535

ingressFilterName Specifies the policy name corresponding to the rtr.NetworkInterface.ingressFilterPointer object. Please do not use this property to determine the policy name. Use the rtr.NetworkInterface.ingressFilterPointer to get the policy object, from that get the policy name.

type=string
access=read-only
default=
minimum=0
maximum=32

ingressFilterPointer

type=Pointer
default=
Displayed(tab/group)=Ingress IP ACL (Policies.General/IP ACL)

ingressFlowspec Specifies if ingress flowspec IPv4 is enabled for this interface.

type=boolean
default=false
Displayed(tab/group)=Enable Ingress FlowSpec IPv4

ingressIPv6Flowspec Specifies if ingress flowspec IPv6 is enabled for this interface.

type=boolean
default=false
Displayed(tab/group)=Enable Ingress FlowSpec IPv6

ingressIpv6FilterId

type=long
access=read-only
default=0
minimum=0
maximum=65535

ingressIpv6FilterName Specifies the policy name corresponding to the rtr.NetworkInterface.ingressIpv6FilterPointer object. Please do not use this property to determine the policy name. Use the rtr.NetworkInterface.ingressIpv6FilterPointer to get the policy object, from that get the policy name.

type=string
access=read-only
default=
minimum=0
maximum=32

ingressIpv6FilterPointer Pointer to the instance of the ACL IPv6 filter.

type=Pointer
default=
Displayed(tab/group)=Ingress IPv6 ACL (Policies.General/IPv6 ACL)

initDelayEnableIpv6 When the value initDelayEnable is set to 'false', everytime the system attempts to bring the IPv6 interface operationally up, it will be delayed by the value of delayedUpPeriod. 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 delayedUpPeriod.

type=boolean
default=false
Displayed(tab/group)=Delay on Init Only (/Hold Time IPv6)

ipHelperAddress Indicates the gateway to forward the UDP traffic sent to the local broadcast address

type=InetAddress
default=0.0.0.0
Displayed(tab/group)=IP Helper Gateway Address

ipHelperAdrrType

type=rtr.InetAddressType
default=ipv4

ipTunnelRemoteIpAddr Specifies the IP address of the remote end of the IP tunnel associated with this interface (the source IP address in the tunneled IP datagram headers received by this system).

type=InetAddress
default=0.0.0.0
Displayed(tab/group)=IP Tunnel Remote IP Address

ipTunnelRemoteIpAddrType Specifies the type of ipTunnelRemoteIpAddr.

type=rtr.InetAddressType
default=ipv4

ipv6Allowed

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

ipv6FlowLabelHashing Specifies whether flow label load balancing is enabled for the configured router interface. A value of 'true' enables the load balancing in ECMP and LAG based on the output of a hash performed on the triplet in the header of an IPv6 packet received on the interface. This property value is not used on the header of an IPv4 packet received on the interface.

type=boolean
default=false
Displayed(tab/group)=IPv6 Flow Label Load Balancing (/Load Balancing)

ipv6NeighborLimit Specifies the maximum number of IPv6 neighbor entries that can be learned on an IP interface

type=int
default=-1
minimum=-1
maximum=102400
Displayed(tab/group)=Limit (/IPv6 Neighbor)

ipv6NeighborLogOnly Specifies whether the warning messages have been enabled or not when ipv6 Neighbor Threshold(vRtrIfIpv6NbrThreshold) is exceeded

type=boolean
default=false
Displayed(tab/group)=Log Only (/IPv6 Neighbor)

ipv6NeighborThreshold Specifies a percentage of IPv6 Neighbor Limit(vRtrIfIpv6NbrLimit) when exceeded, triggers a tmnxVRtrIpv6NbrThresholdExceeded notification to be sent.

type=int
default=90
minimum=1
maximum=100
Displayed(tab/group)=Threshold (/IPv6 Neighbor)

ipv6OperationalState

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

isGne Is this a network interface on a GNE?

type=boolean
access=read-only
default=false

isMulticastTranslation To check if multicast translation is enabled.

type=rtr.MulticastTranslationType
default=mcTranslateOff
Displayed(tab/group)=Multicast Translation

isPtpInterface

type=boolean
access=read-only
default=false
Displayed(tab/group)=PTP Interface

lagLinkMapProfilePointer Pointer to the LAG Link Mapping Profile

type=Pointer
default=
Displayed(tab/group)=LAG Link Map Profile (Port)

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

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

lastOperStateChange Indicates the sysUpTime when the operational state of this interface last changed.

type=Date
access=read-only
default=0
units=seconds
Displayed(tab/group)=Last Operational State Change

ldpEoLib Specifies if end-of-lib LDP messages from a LDP peer are to be processed or not. If the value of ldpEolib is equal to 'true' and the value of the ldpSyncTimer is not zero, the end-of-lib LDP messages are processed, the LDP sync timer is terminated and the IGP link cost is restored accordingly. If the value of the ldpSyncTimer is zero, the value of ldpEolib will be set to 'false'.

type=boolean
default=false
Displayed(tab/group)=LDP End Of Lib (/LDP Synchronization Timer)

ldpSyncTimer Specifies a time interval used for IGP-LDP synchronization.

type=int
default=0
minimum=0
maximum=1800
units=seconds
Displayed(tab/group)=LDP Synchronization Timer (/LDP Synchronization Timer)

linkLocalAddress

type=InetAddress
access=read-only
default=0.0.0.0
Displayed(tab/group)=Link Local Address

linkLocalAddressState

type=rtr.IPv6AddressState
access=read-only
default=unknown
Displayed(tab/group)=Link Local Address State

linkLocalAddressType

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

localDhcp6ServerPointer Pointer to a Local DHCPv6 server.

type=Pointer
default=
Displayed(tab/group)=Local DHCPv6 Server (Local DHCP)

localDhcpServerName The value of localDhcpServerName specifies the local DHCP server that can be reached via this interface. The server itself is configured on virtual router level. Assigning an IP address to it is done here by linking it to an interface. A server can be linked to several interfaces on the same virtual router.

type=string
default=
minimum=0
maximum=32

localDhcpServerPointer Pointer to the instance of local DHCP server.

type=Pointer
default=
Displayed(tab/group)=Local DHCP Server (Local DHCP)

monitorMcRedirect

type=boolean
default=false
Displayed(tab/group)=Monitor McRedirect (McRedirect)

monitorMcRedirectHighThresh

type=int
default=1000
minimum=0
Displayed(tab/group)=High Threshold (McRedirect/Threshold Packets)

monitorMcRedirectLowThresh

type=int
default=500
minimum=0
Displayed(tab/group)=Low Threshold (McRedirect/Threshold Packets)

mplsEnabled Indicates MPLS Enabled on this interface

type=boolean
default=false

neighborLearnUnsolicited Specifies unsolicited learning address type. When the value is set to 'global', address is global. When the value is set to 'linkLocal', address is linkLocal.

type=int
default=0
Displayed(tab/group)=Neighbor Unsolicited Learning
enums=
    0: none - None
    1: global - Global
    2: linkLocal - Link Local
    3: both - Both

neighborProactiveRefresh Specifies address type of proactive refresh. When the value is set to 'global', address is global. When the value is set to 'linkLocal', address is link local.

type=int
default=0
Displayed(tab/group)=Neighbor Proactive Refresh
enums=
    0: none - None
    1: global - Global
    2: linkLocal - Link Local
    3: both - Both

networkIngressObjectPointer Specifies Network Ingress Policy associated with this Network Interface. For IXR nodes from 19.5 onwards use property.

type=Pointer
default=networkIngress:1
Displayed(tab/group)=Network Ingress Policy (Policies.General/Network)

networkIngressPolicyId

type=long
access=read-only
default=0

networkIngressPolicyName Specifies the policy name corresponding to the rtr.NetworkInterface.networkIngressObjectPointer object. Please do not use this property to determine the policy name. Use the rtr.NetworkInterface.networkIngressObjectPointer to get the policy object, from that get the policy name.

type=string
access=read-only
default=
maximum=252

networkIngressPolicyObjectPointer Specifies Network Ingress policy associated with this Network Interface.

type=Pointer
default=NetworkIngressPolicy7250SROS:default
Displayed(tab/group)=Network Ingress Policy (Policies.General/Network)

networkPolicyId

type=long
access=read-only
default=0

networkPolicyName Specifies the policy name corresponding to the rtr.NetworkInterface.networkPolicyObjectPointer object. Please do not use this property to determine the policy name. Use the rtr.NetworkInterface.networkPolicyObjectPointer to get the policy object, from that get the policy name.

type=string
access=read-only
default=
maximum=252

networkPolicyObjectPointer

type=Pointer
default=Network:1
Displayed(tab/group)=Network Policy (Policies.General/Network)

operStateReason

type=rtr.OperStateReason
access=read-only
Displayed(tab/group)=Operational State Reason

policyAccountingTemplatePointer The value points to the policy accounting template created under Routing policies.

type=Pointer
default=
Displayed(tab/group)=Policy Accounting Template (Policies.General/Routing Ingress Accounting Template)

qosEgrQGrpInstanceId Specifies the instance of the egress queue group for this interface.

type=long
default=0
minimum=0
maximum=65535
Displayed(tab/group)=Queue Group Instance ID (Policies.General/Network/Egress Port Redirect)

qosIngFpRedirectQGrpPointer Specifies the forwarding-plane queue group policy for this interface.

type=Pointer
default=
Displayed(tab/group)=Queue Group Template Policy (Policies.General/Network/Ingress Forwarding Plane Redirect)

qosIngQGrpInstanceId Specifies the instance of the forwarding-plane ingress queue group for this interface

type=long
default=0
minimum=0
maximum=65535
Displayed(tab/group)=Queue Group Instance ID (Policies.General/Network/Ingress Forwarding Plane Redirect)

qosRouteLookupIpv4 QoS classification of the ingress IPv4 packets on an interface based on the QoS information associated with routes in the forwarding table.

type=rtr.QosLookup
default=none
Displayed(tab/group)=QoS Route Lookup IPv4

qosRouteLookupIpv6 QoS classification of the ingress IPv6 packets on an interface based on the QoS information associated with routes in the forwarding table.

type=rtr.QosLookup
default=none
Displayed(tab/group)=QoS Route Lookup IPv6

radiusProxyServerPointer Pointer to a RADIUS Proxy Server. Setting this pointer binds the interface to a particular RADIUS Proxy Server and creates an instance of aaa.RadiusProxyInterface. Clearing this pointer deletes the associated RADIUS Proxy Interface.

type=Pointer
default=
Displayed(tab/group)=RADIUS Proxy Server (RADIUS Proxy Server)

rateType

type=rtr.RateType
default=kbps
Displayed(tab/group)=Rate Type (Policies.QoS/Egress Aggregate Rate Limit)

rca.Problem-Set type=Children-Set
reachableTime Secifies the time an IPv6 neighbor on this interface remains in reachable state. While in this state, no neighbor-unreachability detection has to be done.A value of zero (0) indicates that the time specified in vRtrIpv6ReachableTime for the parent router is used instead.

type=long
default=0
minimum=0
maximum=3600
units=seconds
Displayed(tab/group)=Reachable Timer

redirectQueueGroupName

type=string
access=read-only
default=
maximum=252

redirectQueueGroupPointer

type=Pointer
default=
Displayed(tab/group)=Queue Group Template Policy (Policies.General/Network/Egress Port Redirect)

routingProfilePolicyId

type=long
access=read-only
default=0

routingProfilePolicyPointer Pointer to the instance of the Reassembly Profile Policy.

type=Pointer
default=
Displayed(tab/group)=Re-Assembly Profile Policy (Policies.General/Re-Assembly)

rtr.DhcpClient-Set type=Children-Set
rtr.DhcpRelayConfiguration-Set type=Children-Set
rtr.DirectInterfaceCtp-Set type=Children-Set
rtr.IPSecSecuredInterface-Set type=Children-Set
rtr.NeighborDiscovery-Set type=Children-Set
rtr.NetworkInterfaceDomainBindings-Set type=Children-Set
rtr.NetworkInterfacePolicyExtend-Set type=Children-Set
rtr.ProxyNeighborDiscovery-Set type=Children-Set
rtr.RouterAdvertisement-Set type=Children-Set
rtr.SecureNeighborDiscovery-Set type=Children-Set
rtr.StaticArp-Set type=Children-Set
rtr.UnnumberedInterfaceCtp-Set type=Children-Set
rtr.VirtualInterfaceArpConfiguration-Set type=Children-Set
rtr.VirtualInterfaceIcmp6Configuration-Set type=Children-Set
rtr.VirtualInterfaceIcmpConfiguration-Set type=Children-Set
rtr.VirtualInterfaceNtpConfiguration-Set type=Children-Set
rtr.VirtualInterfacePtpConfiguration-Set type=Children-Set
rtr.VirtualRouterIpAddress-Set type=Children-Set
rtr.VirtualRouterSubscriberPrefix-Set type=Children-Set
sas.DelayMetricConfiguration-Set type=Children-Set
schedulerPolicyObjectPointer

type=Pointer
default=schedulerPolicy:default
Displayed(tab/group)=Scheduler Policy (Policies.General/Network)

securityPolicyBypass The value of securityPolicyBypass indicates whether traffic on this interface bypasses the security check.

type=boolean
default=false
Displayed(tab/group)=ByPass Zone Config (Zone)

sharedRiskLinkGroupPointers Set of shared risk link groups this interface is associated with.

type=Set (Pointer)

showLinkInIgpTopology Indicates the link associated with this interface should be showed on the IGP topology map.

type=rtr.IgpTopologyType
default=policy
Displayed(tab/group)=Show Link In IGP Topology

spiLoadBalancing Specifies whether SPI use in hashing is enabled on the configured router interface.

type=boolean
default=false
Displayed(tab/group)=SPI Load Balancing (/Load Balancing)

staleTime The value of staleTime specifies the time an IPv6 neighbor cache entry on this interface remains in stale state. When this time has elapsed, the system removes the neighbor cache entry.The value zero means that the actual value is taken from the object vRtrIpv6NdCacheStaleTime in the parent router instance.

type=long
default=0
minimum=0
maximum=65535
units=seconds
Displayed(tab/group)=Stale Timer

steeringDlSfc The value of steeringDlSfc configures interface between standalone SSG node (or PGW/GGSN combined with SSG) and the service function chain (SFC). If the value of steeringDlSfc is 'true', packet processing for downlink user traffic received from SFC is enabled. User traffic received from SFC is processed on anchor MG-ISM card but to avoid sending user traffic from MG-ISM back to SFC, a flag is required to indicate SFC is already done and user traffic must be forwarded based on destination IP address.

type=boolean
default=false
Displayed(tab/group)=Downlink User traffic received from SFC

steeringUlGw The value of steeringUlGw configures interface between standalone SSG and PGW/GGSN. Source IP based packet processing for uplink user If the value of steeringUlGw is 'true', Source IP based packet processing for uplink user traffic received from PGW/GGSN is enabled. User traffic received from PGW/GGSN is processed on anchor MG-ISM card.

type=boolean
default=false
Displayed(tab/group)=Uplink User traffic received from PGW/GGSN

stripLabel The value of stripLabel specifies whether a packet received on the interface will have its MPLS labels stripped from the packet (true) or not (false).

type=generic.TruthValue
default=false
Displayed(tab/group)=Strip Label

tcpMss This property specifies the TCP maximum segment size(MSS) for TCP connections originated from the associated IP interface. The valid range is 0|384..9158. For SROS 19.10.R1 onwards it is 0|384..9746.

type=int
default=0
minimum=0
maximum=9746
Displayed(tab/group)=TCP-MSS IPv4

tcpMssIpv6 This property specifies the TCP maximum segment size(MSS) for TCP connections originated from the associated IPv6 interface. The valid range is 0|1220..9138. For SROS 19.10.R1 onwards it is 0|1220..9726.

type=int
default=0
minimum=0
maximum=9726
Displayed(tab/group)=TCP-MSS IPv6

uRPFCheckMode Specifies the mode of unicast RPF check for IPv4. It is applicable only when uRPFCheckState is set to 'enabled'."

type=rtr.URPFCheckMode
default=strict
Displayed(tab/group)=URPF Check Mode IPv4 (/Unicast RPF)

uRPFCheckModeIpv6 Specifies the mode of unicast RPF check for IPv6. It is applicable only when uRPFCheckStateIpv6 is set to 'enabled'.

type=rtr.URPFCheckMode
default=strict
Displayed(tab/group)=URPF Check Mode IPv6 (/Unicast RPF)

uRPFCheckState Specifies whether unicast RPF (uRPF) Check is enabled for IPv4 on the interface.

type=generic.EnabledDisabled
default=disabled
Displayed(tab/group)=URPF Check State IPv4 (/Unicast RPF)

uRPFCheckStateForSelectedVprns Enables selective uRPF checking. When the value of uRPFCheckStateForSelectedVprns is 'true', packets that are associated to a VPRN will be subjected to the uRPF treatment configured for this interface if the associated VPRN has TIMETRA-SERV-MIB::svcNetIngUrpfCheckState set to 'true'. When the value of vRtrIfUrpfSelectedVprnsOnly is 'false', uRPF check will be done for all packets associated with a VPRN.

type=boolean
default=false
Displayed(tab/group)=URPF Check State for Selected VPRN(s) (/Unicast RPF)

uRPFCheckStateIpv6 Specifies whether unicast RPF (uRPF) Check is enabled for IPv6 on the interface.

type=generic.EnabledDisabled
default=disabled
Displayed(tab/group)=URPF Check State IPv6 (/Unicast RPF)

uRPFIgnoreDefault Specifies if the default route is to be disregarded while performing the uRPF check for IPv4 on the interface.

type=boolean
default=false
Displayed(tab/group)=URPF Ignore Default IPv4 (/Unicast RPF)

uRPFIgnoreDefaultIpv6 Specifies if the default route is to be disregarded while performing the uRPF check for IPv6 on the interface.

type=boolean
default=false
Displayed(tab/group)=URPF Ignore Default IPv6 (/Unicast RPF)

unidirectionalLinkDelay Specifies the average link delay in microseconds for this router interface. A value of 0 indicates that the delay is not specified for this router interface.

type=int
default=0
minimum=0
maximum=16777214
units=microseconds
Displayed(tab/group)=Static Delay

useIngressPort The value of useIngressPort specifies whether ingress port is used in the LAG and ECMP hashing algorithm. When set to 'true', the ingress port is used in the hashing algorithm."

type=rtr.UseIngressPortType
default=system
Displayed(tab/group)=Use Ingress Port (/Load Balancing)

vRtrIngressIPFilterPair Specifies if ip filter pair has been enabled or disabled on this network interface.

type=boolean
default=false
Displayed(tab/group)=Ingress IP Filter Pair (Policies.General)

vasIfType The value of this property specifies whether this is a VAS access-facing interface (for ESM/AA this means sub-facing interface). It allows to skip over egress PBR for after-VAS traffic and allows to skip over AA divert when AA is deployed.

type=service.VasIfType
default=none
Displayed(tab/group)=VAS Interface Type

vlanId The VLAN ID assigned to this router interface.

type=int
access=read-only
default=0

vlanPointer Pointer to the instance of local DHCP server.

type=Pointer
default=
Displayed(tab/group)=VLAN (VLAN/VLAN)

vrrp.Instance-Set type=Children-Set
vrrp.InstanceV6-Set type=Children-Set
zoneId

type=long
minimum=0
maximum=65535

zonePointer

type=Pointer
default=
Displayed(tab/group)=Zone Id (Zone)

 
Overridden Properties
id

maximum=16384

outerEncapValue Provisioned outer encap value. This value is propagated into: terminatedPortOuterEncapValue.

minimum=0
maximum=4094

 
Properties inherited from rtr.VirtualInterface
administrativeState, cflowdType, description, directedBroadcast, displayedName, id, initDelayEnable, interfaceClass, ipMtu, ipOperMtu, isTrusted, loopbackEnabled, numberOfIpAddressLikeCtps, numberOfLoopbackAddresses, physicalAddress, pimRPDelayedDownPeriod, pimRPDelayedUpPeriod, pimRPDelayedUpTimer, primaryIPv4Address, primaryIPv4PrefixLength, unnumberedReference, unnumberedReferenceType
 
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

findGmplsLoopbackInterfaceAddresses

Find all addresses configured on a Network Interface of type gmpls-loopback.
Input Parameters:
siteId : 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:
addressesList : List (generic.CommonManagedEntityInformation) -

findLinkMapProfiles

Find LAG Link Mapping Profiles which are associated with this LAG.
Input Parameters:
portPointer : 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:
profilesList : List (generic.CommonManagedEntityInformation) -

findQueueQroupPolicesAppliedOnPort

Input Parameters:
portPointer : 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:
queueGroupPolicyList : List (generic.CommonManagedEntityInformation) -
Exceptions:
rtr.NetworkInterface.findQueueQroupPolicesAppliedOnPortException

requestPolicyAccountStatsClear

Request clearing of Policy Accounting Statistics on this interface. When this method returns resources for the clear have been allocated but the clear has not been performed yet. To retrieve the result eventually, use the returned request handle as input param of the retrieveClearRequest method of the clear.ClearCommandManager.
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.
aInAcctType : int - The Account Type of the Accounting Statistics. A '0' will clear entries related to source class. A '1' will clear entries related to destination class.
aInAcctIndex : int - The Account Index of the Accounting Statistics. The valid range is [1-255].
aInClearAll : boolean - A 'true' value will clear all Policy Account statistics for this interface. A 'false' value will consider the other two parameters to clear entries. If this is 'true' then other parameters are ignored.
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:
aOutResult : clear.RequestHandleStruct - A request handle which allows the retrieval of the request (and its result when it becomes available) through the ClearCommandManager's retrieveClearRequest method.
Methods inherited from rtr.VirtualInterface
configureIpAddresses, find, findByIpAddress, findByIpAddressFilter, findByIpAddressList, findByName, findIpAddress, findProtocols, remove, removeIpAddress, shutDown, turnUp
 
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 (all versions)
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 (all versions)
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 E (all versions)
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 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 (all versions)
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 (all versions)
7701 CPAA 8.0
7705 SAR Gen 2 (all versions)
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 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 (all versions)
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 (all versions)
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 (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 (all versions)
DC VSA8 5.0
DC VSA8 6.0
DC VSC (all versions)
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 (all versions)
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 (all versions)
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