service
L3AccessInterface

Abstract L3 access interface used by a VPRN/IES service. This IP interface provides a service access point (SAP) to the subscriber network.



public abstract class L3AccessInterface

Stats:
rtr.IpInterfaceAdditionalStats rtr.IpInterfaceStats rtr.MacAccountingStats rtr.NatControlQueueStats rtr.NgeKeygroupStats rtr.SarIpInterfaceStats rtr.SarIpInterfaceStatsRxExtra service.L3AccessInterfaceURPFStats service.SapBaseStats service.SapEgrQosArbiterStats service.SapEgrQosHsmdaCntrStats service.SapEgrQosHsmdaQueueStats service.SapEgrQosPlcyQueueStats service.SapEgrQosPlcyStats service.SapEgrQosPolicerStats service.SapEgrQosPortIdArbiterStats service.SapEgrQosQueueStats service.SapEgrQosSchedStats service.SapEgrSchedPlcyPortStats service.SapEgrSchedPlcyStats service.SapIngQosArbiterStats service.SapIngQosPlcyQueueStats service.SapIngQosPlcyStats service.SapIngQosPolicerStats service.SapIngQosPortIdArbiterStats service.SapIngQosQueueStats service.SapIngQosSchedStats service.SapIngSchedPlcyPortStats service.SapIngSchedPlcyStats service.SapIngressQosPolicerStats service.SasSapEgrQosQueueStats service.SasSapIngQosQueueStats service.ServiceSapIngQosPlcyStats

Properties
aaApplicationProfile Specifies the unique name of an application assurance's application profile.

type=string
default=
minimum=0
maximum=32
Displayed(tab/group)=Application Profile (Application Assurance.General)

aaGrpId Specifies the groupId of the application profile corresponding to aaApplicationProfile.

type=int
default=1
Displayed(tab/group)=ISA-AA Group ID (Application Assurance.General)

aaPartId Specifies the partitionId of the application profile corresponding to aaApplicationProfile.

type=int
default=0
Displayed(tab/group)=ISA-AA Partition ID (Application Assurance.General)

aapolicy.AaReporting-Set type=Children-Set
adminGroupInclude

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

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

ancp.AncpStaticMap-Set type=Children-Set
antispoof.L3AntiSpoofing-Set type=Children-Set
arpLearnDynamic Specifies whether ARP entries are to be learnt dynamically.

type=boolean
default=true
Displayed(tab/group)=Learn Dynamic (Routed VPLS.ARP)

arpLearnUnsolicited Specifies whether unsolicited learning is enabled or not. When the value is set to 'true', unsolicited learning is enabled. When the value is set to 'false', unsolicited learning is disabled.

type=boolean
default=false

arpPopulateHostRoute The value of arpPopulateHostRoute specifies whether populate host is enabled or not on the interface with Ipv4. From 20.2 onwards, for 7x50 , 7705hm nodes, this is obsoleted. Use service.ARPHostRoute.populateHostRouteType instead.

type=boolean
Displayed(tab/group)=ARP populate Host Route

arpProactiveRefresh Specifies whether proactive refresh is enabled or not. When the value is set to 'true', proactive refresh is enabled. When the value is set to 'false', proactive refresh is disabled.

type=boolean
default=false

arpRouteTag The value of arpRouteTag specifies value of the route tag on the interface with Ipv4. It accepts values in both decimal[0|1..255] or hexadecimal[0x00..0xff] format. From 20.2 onwards, for 7x50 , 7705hm nodes, this is obsoleted. Use service.ARPHostRoute.hostRouteTag instead.

type=string
default=0
minimum=0
maximum=4
Displayed(tab/group)=ARP Route Tag

bandwidth Specifies the administrative access bandwidth assigned to this SAP.

type=long
default=0
minimum=0
maximum=6400000000
units=kbps
Displayed(tab/group)=Bandwidth (Port)

bfdConfigured

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

bfdv6Configured Specifies if IPv6 BFD is configured or not on this interface.

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

callingStationId

type=string
default=
minimum=0
maximum=64
Displayed(tab/group)=Calling Station ID

cpmProtEthCfmMonitorFlags

type=service.EthCfmMonitorFlagsType
default=0
Displayed(tab/group)=Ethernet CFM Monitor Flags (Port/Security)

directedBroadcast

type=boolean
default=false
Displayed(tab/group)=Allow Directed Broadcasts

dynamicTnlRedNHAddr Specifies the IP address of the redundant next-hop for dynamic ISA tunnels on this interface

type=InetAddress
default=0.0.0.0
Displayed(tab/group)=Redundant Next-Hop IP Address for Dynamic ISA Tunnels (/Redundant Next Hop Addresses)

dynamicTnlRedNHAddrType Address type of the redundant next-hop address for dynamic ISA tunnels on this interface (dynamicTnlRedNHAddr)

type=rtr.InetAddressType
default=ipv4

egrIpLoadBalancing Specifies whether to include source address or destination address or both in LAG/ECMP hash on all configured IES/VPRN interfaces.

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

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

enableTableClassification Enable/disable Dscp/dot1p based policing. Unsetting this parameter will not allow the selection of the DSCP/Dot1p policy.

type=boolean
default=false
Displayed(tab/group)=Enable Table Classification (QoS/7210/7250 Specific)

enableTableClassificationForRvpls Enable/disable Dscp based policing under Rvpls. Unsetting this parameter will not allow the selection of DSCP policy.

type=boolean
default=false
Displayed(tab/group)=Enable Table Classification For VPLS (Routed VPLS.General/Ingress)

floodGarpAndUnknownReq Specifies whether to flood GARP and Unknown requests.

type=boolean
default=true
Displayed(tab/group)=Flood GARP And Unknown Request (Routed VPLS.ARP)

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

hostLockoutPolicyName Name of the host lockout Policy profile

type=string
access=read-only

hostLockoutPolicyPointer Pointer to the host lockout Policy

type=Pointer
default=
Displayed(tab/group)=Policy (/Host Lockout)

id

type=long
access=read-create
default=0
minimum=2
maximum=16384
Displayed(tab/group)=Interface ID

ifIpStatsEnable

type=boolean
default=false
Displayed(tab/group)=Ip-Stats Enabled

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

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

ignoreSapPortState

type=service.IgnoreSapPortStateActionType
default=stop

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

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

interfaceClass

type=rtr.RtrInterfaceClass
default=numbered
Displayed(tab/group)=Class

interfaceOperFlags The value of interfaceOperFlags specifies the reason why the interface is operationally down.

type=service.InterfaceOperFlags
access=read-only
Displayed(tab/group)=Interface Down Reason IPv4

interfaceOperFlagsIpv6 The value of interfaceOperFlags specifies the reason why the interface is operationally down.

type=service.InterfaceOperFlags
access=read-only
Displayed(tab/group)=Interface Down Reason IPv6

ipCriteriaOverrideTag This value specifies the tag-id for theIP Criteria override. A value of 0 means no ip-criteria override.

type=long
default=0
minimum=0
maximum=255
Displayed(tab/group)=Activate Tag ID (Override Policy Items.Ingress Criteria/IP Criteria)

ipMonitoring

type=boolean
default=false
Displayed(tab/group)=IP Src Monitoring (Port/Security)

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=long
default=0
minimum=0
maximum=9786
units=Octets
Displayed(tab/group)=Configured IP MTU (/Frame Size Constraints)

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=long
access=read-only
units=Octets
Displayed(tab/group)=Operational IP MTU (/Frame Size Constraints)

ipv6Allowed

type=boolean
default=false

ipv6CriteriaOverrideTag This vlaue specifies the tag-id for the IPv6 Criteria override. A value of 0 means no ipv6-criteria override.

type=long
default=0
minimum=0
maximum=255
Displayed(tab/group)=Activate Tag ID (Override Policy Items.Ingress Criteria/IPv6 Criteria)

ipv6FlowLabelHashing Specifies whether flow label load balancing is enabled for the configured L3 access 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

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)

isTrusted

type=generic.TruthValue
default=true
Displayed(tab/group)=Trusted

l3InterfaceAdministrativeState

type=netw.AdministrativeState
default=serviceUp
Displayed(tab/group)=Administrative State

l3InterfaceDescription

type=string
default=
minimum=0
maximum=255
Displayed(tab/group)=Description

l3dosProtection Pointer specifies the DoS Protection Policy that's applicable to the SAP on this interface.

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

lagLinkMapProfilePointer Pointer to the LAG Link Mapping Profile

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

lastOperStateChange indicates the sysUpTime when the operational state of this interface last changed

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

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)

loopbackEnabled Specifies that the interface is designated as a loopback interface on the site. A loopback interface cannot be associated with any SAPS

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

macMonitoring

type=boolean
default=false
Displayed(tab/group)=MAC Monitoring (Port/Security)

monitorOperGroupName The monitor group name that this interface is assigned to.

type=string
default=

monitorOperGroupPtr The pointer to the operational group, which is monitored by this object. Used for UI display. For OSSI setting, use: service.L3AccessInterface.monitorOperGroupName instead.

type=Pointer
default=
Displayed(tab/group)=Monitored Group Name (/Operational Group)

multiChassisShuntingProfile Specifies the profile name to be used for MC shunting

type=string
default=
Displayed(tab/group)=Profile Name (/Multi-Chassis Shunting Profile)

ndLearnDynamic Specifies whether ND entries are to be learnt dynamically.

type=boolean
default=true
Displayed(tab/group)=Learn Dynamic (Routed VPLS.ND)

neighbhorPopulateHostRoute The value of neighbhorPopulateHostRoute specifies whether populate host is enabled or not.This can be set only when Ipv6 is enabled on the interface. From 20.2 onwards, for 7x50 , 7705hm nodes, this is obsoleted. Use service.NDHostRoute.populateHostRouteType instead.

type=boolean
Displayed(tab/group)=Neighbor Populate Host Route

neighbhorRouteTag The value of neighbhorRouteTag specifies value of the route tag. It accepts values in decimal[0|1..255] or hexadecimal[0x00..0xff] format. This can be set only when Ipv6 is enabled on the interface. From 20.2 onwards, for 7x50 , 7705hm nodes, this is obsoleted. Use service.NDHostRoute.hostRouteTag instead.

type=string
default=0
minimum=0
maximum=4
Displayed(tab/group)=Neighbor Route Tag

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
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
enums=
    0: none - None
    1: global - Global
    2: linkLocal - Link Local
    3: both - Both

numberOfIpAddressLikeCtps

type=int
access=read-only
default=0

numberOfLoopbackAddresses

type=int
access=read-only
default=0

overrides Map of overrides of default custom property values.

type=Map (Pointer to string)

physicalAddress

type=MacAddress
default=00-00-00-00-00-00
Displayed(tab/group)=MAC Address

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

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

primaryIPv4Address

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

primaryIPv4PrefixLength

type=int
access=read-only
default=0

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

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

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)

routedOverrideQosPolicyPointer Specifies the Ingress DSCP Classification used by this Rvpls.

type=Pointer
default=
Displayed(tab/group)=Routed Override Qos Policy (Routed VPLS.General/Ingress)

rtr.DhcpRelayConfiguration-Set type=Children-Set
rtr.IpcpConfiguration-Set type=Children-Set
rtr.StaticArp-Set type=Children-Set
rtr.VirtualInterfaceIcmpConfiguration-Set type=Children-Set
rtr.VirtualInterfaceNtpConfiguration-Set type=Children-Set
sapEgressAggregateMeterBurst Specifies the maximum burst size for egress meters on the interface in kilobits.

type=int
default=-1
minimum=-1
maximum=2146959
Displayed(tab/group)=Egress Meter Burst (QoS/Aggregate Rate Limit)

sapEgressAggregateMeterEnableStats

type=generic.TruthValue
default=false
Displayed(tab/group)=Enable Egress Meter Stats (QoS/Aggregate Rate Limit)

sapEgressAggregateMeterRate Specifies the transmission rate for egress meters on the interface in kilobits per second.

type=int
default=0
minimum=-1
maximum=20000000
units=kbps
Displayed(tab/group)=Egress Meter Rate (QoS/Aggregate Rate Limit)

sapIngressAggregateMeterBurst

type=int
default=-1
minimum=-1
maximum=2146959
Displayed(tab/group)=Ingress Meter Burst (QoS/Aggregate Rate Limit)

sapIngressAggregateMeterCBS Specifies the cbs to be used. The value -1 means maximum cbs.

type=int
default=-2
minimum=-2
maximum=33292
Displayed(tab/group)=Ingress Meter CBS (QoS/Aggregate Rate Limit)

sapIngressAggregateMeterCIR Specifies the ingress aggregate policer CIR. Please note, value "-1" represents the MAX rate.

type=long
default=-2
minimum=-2
maximum=1000000000
units=kbps
Displayed(tab/group)=Ingress Meter CIR (QoS/Aggregate Rate Limit)

sapIngressAggregateMeterRate Specifies the ingress aggregate policer rate. Please note, value "-1" represents the MAX rate.

type=long
default=0
minimum=-1
maximum=1000000000
units=kbps
Displayed(tab/group)=Ingress Meter Rate (QoS/Aggregate Rate Limit)

sapIngressAggregatePlcrAlgoType Specifies the policer mode.

type=int
default=2
Displayed(tab/group)=Ingress Policer Algorithm Type (QoS/Aggregate Rate Limit)
enums=
    1: trtcmDs - Two rate three color marking without coupling
    2: trtcmDsCoupled - Two rate three color marking with coupling

sapIngressAggregateShaperRateCIR Specifies the CIR for unicast ingress traffic in queues on the access interface. The system ingress scheduler distributes this bandwidth to FCs associated with queues.

type=int
default=0
minimum=-1
maximum=20000000
units=kbps
Displayed(tab/group)=Aggregate Shaper CIR Rate (QoS/Aggregate Rate Limit)

sapIngressAggregateShaperRatePIR Specifies the PIR for unicast ingress traffic in FCs associated with queues on the access interface.

type=int
default=-1
minimum=-1
maximum=20000000
units=kbps
Displayed(tab/group)=Aggregate Shaper PIR Rate (QoS/Aggregate Rate Limit)

sapIngressIPFilterPair Specifies if ip filter pair has been enabled or disabled.

type=boolean
default=false
Displayed(tab/group)=Ingress IP Filter Pair (ACL)

sapIngressWithAggregateMeter

type=generic.TruthValue
default=false
Displayed(tab/group)=Ingress Meter (QoS/Aggregate Rate Limit)

sasEgressPolicyId

type=long
access=read-only
default=0

sasEgressPolicyName

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

sasEgressPolicyObjectPointer

type=Pointer
default=sasAccessEgress:1
Displayed(tab/group)=Egress Policy (QoS/7210/7250 Specific)

sasIngressPolicyId

type=long
access=read-only
default=1

sasIngressPolicyName

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

sasIngressPolicyObjectPointer

type=Pointer
default=sasAccessIngress:1
Displayed(tab/group)=Ingress Policy (QoS/7210/7250 Specific)

schedulerPolicyObjectPointer

type=Pointer
default=schedulerPolicy:default
Displayed(tab/group)=Scheduler Policy (QoS/7210/7250 Specific)

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)

service.ARPHostRoute-Set type=Children-Set
service.AccessPolicyMeterOverride-Set type=Children-Set
service.EgressAccessPolicyQueueOverride-Set type=Children-Set
service.EgressSchedulerPolicyEntryOverride-Set type=Children-Set
service.HsmdaEgressAccessPolicyQueueOverride-Set type=Children-Set
service.IngressAccessPolicyQueueOverride-Set type=Children-Set
service.IngressSchedulerPolicyEntryOverride-Set type=Children-Set
service.NDHostRoute-Set type=Children-Set
service.OperGrpBindingMonitor-Set type=Children-Set
service.RvplsArpHostRoute-Set type=Children-Set
service.RvplsNdHostRoute-Set type=Children-Set
service.SASAccessPolicyQueueOverride-Set type=Children-Set
service.SapEgrPolicerCtlOverride-Set type=Children-Set
service.SapEgrQosHsWrrGroupOverride-Set type=Children-Set
service.SapEgressPolicerOverride-Set type=Children-Set
service.SapIngPolicerCtlOverride-Set type=Children-Set
service.SapIngressPolicerOverride-Set type=Children-Set
service.SapLagPerLinkHash-Set type=Children-Set
service.SapTodMonitor-Set type=Children-Set
sharedRiskLinkGroupPointers Set of shared risk link groups this interface is associated with.

type=Set (Pointer)

shcvAction Specifies the action to be taken for hosts on this interface whose host connectivity checking fails. "Alarm" will raise an alarm indicating that a host is disconnected on this SAP. "Remove" will raise an alarm and remove the DHCP state and release allocated resources.

type=service.ShcvAction
default=alarm
Displayed(tab/group)=SHCV Action (Subscriber Management.Host Connectivity/Subscriber Host Connectivity Verification)

shcvInterval The default value depends whether the NE supports SHCV: if NE supports SHCV the default value is 10 minutes, otherwise is 0. The interval specifies the time, in minutes, within which hosts on a SAP should be verified. The interval starts for each host individually, when it is created. Dynamic and static hosts are treated in the same way. The actual rate dependents on the number of known hosts and the interval. Interval value '0' means SHCV is administratively disabled.

type=int
default=0
minimum=0
maximum=6000
units=minutes
Displayed(tab/group)=SHCV Interval (Subscriber Management.Host Connectivity/Subscriber Host Connectivity Verification)

shcvPolicyIPv4Pointer Specifies the Subscriber Host Connectivity Verification (SHCV) policy for both IPv4 only. A non empty value is only allowed while the value of shcvInterval is equal to zero and while the value of shcvPolicyPointer is empty

type=Pointer
default=
Displayed(tab/group)=SHCV IPv4 Policy (Subscriber Management.Host Connectivity/SHCV IPv4 Policy)

shcvRetryCount Specifies the number of connectivity check retransmissions. Setting the value to (n) specifies that, for any given host, at most (n+1) probes are done each interval, and (n+1) missed replies are considered as a connectivity failure.

type=int
default=2
minimum=2
maximum=29
Displayed(tab/group)=SHCV Retry Count (Subscriber Management.Host Connectivity/Subscriber Host Connectivity Verification)

shcvRetryTimeout Specifies the timeout in seconds before a connectivity check retransmission.

type=int
default=10
minimum=10
maximum=60
units=seconds
Displayed(tab/group)=SHCV Retry Timeout (Subscriber Management.Host Connectivity/Subscriber Host Connectivity Verification)

shcvSource Specifies the source to be used for the generation of Subscriber Host Connectivity Verification (SHCV) packets. Valid values are 'VRRP' and 'Interface' 'VRRP' specifies that the VRRP state should be used to select the proper IP and MAC address. The IP and MAC address are selected as follows: SHCV packets sourced by VRRP IP interface acting as a master will use VRRP VRID MAC address as a source MAC address, and VRRP IP as source IP address. SHCV packets sourced by VRRP IP interface acting as a backup will use IP interface MAC address as a source MAC address, and IP interface as source IP address (to prevent poisoning of host's arp-cache). (Default) 'Interface' forces the containing interface's IP and MAC address to be used. As there may be up to 16 possible subnets on an interface, the SHCV tool will always use the subnet to which the host is using. For IES group interfaces, the address of the subscriber interface will be used.

type=service.ShcvSource
default=interface
Displayed(tab/group)=SHCV Source (Subscriber Management.Host Connectivity/Subscriber Host Connectivity Verification)

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

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

spokeSdpBindingPointer

type=Pointer
access=read-only
default=
Displayed(tab/group)=Spoke SDP Binding (/Spoke SDP Binding)

spokeSdpBindingUsed

type=boolean
access=read-only
default=false

staticTnlRedNHAddr Specifies the IP address of the redundant next-hop for static ISA tunnels on this interface

type=InetAddress
default=0.0.0.0
Displayed(tab/group)=Redundant Next-Hop IP Address for Static ISA Tunnels (/Redundant Next Hop Addresses)

staticTnlRedNHAddrType Address type of the redundant next-hop IP address for static ISA tunnels on this interface (staticTnlRedNHAddr)

type=rtr.InetAddressType
default=ipv4

todSuitePointer Pointer to the instance of the ToD Suite object.

type=Pointer
default=
Displayed(tab/group)=Time of Day Suite (TOD Suite)

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

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

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

type=generic.EnabledDisabled
default=disabled

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

type=generic.EnabledDisabled
default=disabled

unnumberedInterfaceName

type=string
default=
minimum=0
maximum=32
Displayed(tab/group)=Unnumbered Interface Name (/Unnumbered)

unnumberedIpAddress

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

unnumberedIpAddressType

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

unnumberedReferenceType

type=rtr.UnnumberedReferenceType
default=system
Displayed(tab/group)=Unnumbered Type (/Unnumbered)

usesMultipointShared

type=generic.TruthValue
default=false
Displayed(tab/group)=Use Multipoint Shared Queue (QoS/Shared Queue)

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

vplsEgressIPv4FilterId Indicates IPv4 Filter Id with an egress interface.

type=long
access=read-only
default=0

vplsEgressIPv4FilterPointer Associates IPv4 Filter Id with an egress interface. Filters control the forwarding and dropping of packets based on IP criteria.

type=Pointer
default=
Displayed(tab/group)=IPv4 Filter (Routed VPLS.General/Egress)

vplsEgressIPv6FilterId Indicates IPv6 Filter Id with an egress interface.

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

vplsEgressIPv6FilterPointer Associates IPv6 Filter Id with an egress interface. Filters control the forwarding and dropping of packets based on IP criteria.

type=Pointer
default=
Displayed(tab/group)=IPv6 Filter (Routed VPLS.General/Egress)

vplsEgressQosPolicyId

type=long
access=read-only
default=0

vplsEgressQosPolicyPointer

type=Pointer
default=
Displayed(tab/group)=Qos Policy (Routed VPLS.General/Egress)

vplsIngressIPv4FilterId

type=long
access=read-only
default=0

vplsIngressIPv4FilterPointer

type=Pointer
default=
Displayed(tab/group)=IPv4 Filter (Routed VPLS.General/Ingress)

vplsIngressIPv6FilterId

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

vplsIngressIPv6FilterPointer

type=Pointer
default=
Displayed(tab/group)=IPv6 Filter (Routed VPLS.General/Ingress)

vplsName Specifies the name of the VPLS service routed by this interface.

type=string
default=
minimum=0
maximum=64
Displayed(tab/group)=VPLS Name (Routed VPLS.General)

vplsOperState Indicates the operational status of the Routed VPLS service on this interface.

type=netw.OperationalState
access=read-only
default=serviceDown
Displayed(tab/group)=Binding Status (Routed VPLS.General)

vplsStateFailureReason

type=string
access=read-only
default=
Displayed(tab/group)=Failure Reason (Routed VPLS.General)

zoneId

type=long
minimum=0
maximum=65535

zonePointer

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

 
Overridden Properties
description

maximum=160

displayedName

minimum=1
maximum=32

outerEncapValue The value of -1 represents "auto-assign" when Encap Type is 'Dot1 Q'. For SAPs that have an Ethernet Tunnel Endpoint as the Terminating Port, the value of 8191 represents a control SAP. If set to 8191, the value of the 'ethTunnelControlSap' property is set to true.

maximum=4094

 
Properties inherited from service.AccessInterface
aarpPointer, aarpServRefType, accountingOn, accountingPolicyId, accountingPolicyName, accountingPolicyObjectPointer, administrativeState, aggregation, aggregationSchedulerName, aggregationSchedulerObjectPointer, alarmProfile, atm.SapAtmConfiguration-Set, ccagSnmpPortId, dCpuProtectionPolicyPointer, dependantOlcState, displayedName, dosProtection, egressAggCIR, egressAggRateLUB, egressAggRateLimit, egressAggRateLimitCIR, egressAggRateLimitEnabled, egressAggRateLimitPIR, egressAggregateFilterId, egressAggregateFilterName, egressAtmPolicyId, egressCirPercent, egressFilterId, egressFilterName, egressFilterPointer, egressFilterType, egressFrameBaseAccounting, egressIpFilterId, egressIpv6FilterId, egressIpv6FilterName, egressIpv6FilterPointer, egressMacFilterId, egressPirPercent, egressPolicerPolicyPointer, egressPolicyId, egressPolicyName, egressPolicyObjectPointer, egressPortQueueGroupPointer, egressQinqMarkTopBitsOnly, egressQueueAccountingOn, egressRedirectListQueueGroup, egressRemarkPolicyObjectPointer, egressRemarkingPolicyObjectPointer, egressSchedulerMode, egressSchedulerName, egressSchedulerObjectPointer, egressShaperGrpName, egressShaperGrpPointer, egressVlanQosPolicyObjectPointer, hsEgrSecondaryShaper, hsmdaEgrQosPackByteOffOvrd, hsmdaEgrQosWrrPlcyOvrd, hsmdaEgrSecondaryShaper, ingressAggCIR, ingressAggRateLimit, ingressAggregateFilterId, ingressAggregateFilterName, ingressAtmPolicyId, ingressFilterId, ingressFilterName, ingressFilterPointer, ingressFilterType, ingressInstanceId, ingressIpFilterId, ingressIpv6FilterId, ingressIpv6FilterName, ingressIpv6FilterPointer, ingressMacFilterId, ingressMatchQinqDot1pBits, ingressPolicerAccountingOn, ingressPolicerPolicyPointer, ingressPolicyId, ingressPolicyName, ingressPolicyObjectPointer, ingressQueueGroupName, ingressRedirectListQueueGroup, ingressSchedulerMode, ingressSchedulerName, ingressSchedulerObjectPointer, ingressShaperGrpName, ingressShaperGrpPointer, innerEncapValue, lockOlcState, macLearnOptions, mirrorStatus, mprvlanId, olcState, operationalFlags, outerEncapValue, pmonPolicy, pmonPolicyId, portDescription, rateType, rowStatus, sapEgressAggregateShaperRate, sapEgressStatsEnable, sapEgressStatsPktsMode, sapEgressVlanQosPlcyPortRedirect, sapIngressAggregateShaperRate, sapIngressCounterMode, sapIngressCounterType, sapIngressStatsEnable, scpPointer, scpPointers, serviceDescription, serviceId, serviceIdString, serviceName, serviceType, sharedPolicerPolicyObjectPointer, sharedQueueOn, subscriberId, subscriberName, svcComponentId, templateVersionPointer, transitIpPolicyPointer, transitPrefixPolicyPointer, vPortName
 
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

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) -

findProtocols

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

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:
service.L3AccessInterface.removeIpAddressException

shutDown

Used to administratively disable the access interface.
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

turnUp

Used to administratively enable the access interface.
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
Methods inherited from service.AccessInterface
findSitesFor, moveSapToAnotherService
 
Supported Network Elements
7450 ESS
7210 SAS E
7210 SAS D
7210 SAS Dxp
7210 SAS K
7750 SR
7705 SAR Gen 2
7705 SAR Hm
7705 SAR
Generic NE
7705 SAR H
7210 SAS M
7210 SAS X Supported from 4.0.R2
7210 SAS T
7210 SAS Mxp
7210 SAS S/Sx
7210 SAS R
7250 IXR
DC VSC
DC 7850
DC 210
DC VSA8
7950 XRS
Wavence SM
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
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
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