Overview Package Class Deprecated Help

vprn
ServiceAccessPoint

A Service Access Point identifies the customer interface point in a Routed CO VPRN solution.

public class ServiceAccessPoint

Stats:
arp.SapArpHostStats ressubscr.HostTrackStatsOnSap ressubscr.SubVlanStats service.PppoeSapStats service.SapAtmPppStats service.SapDcpFpDynamicStats service.SapDcpFpLocMonPlcrStats service.SapDcpFpStaticStats vprn.SapDataTrigStats

Properties
clear.ClearRequest-Set type=Children-Set
creationOrigin

type=svt.L2RouteOriginType
access=read-create
default=manual
lmmCollectStats Specifies whether or not to compute the Y.1731 ETH-LM 'RxFCl' and 'TxFCl' service frame counters for the specified SAP.The 'RxFCl' and 'TxFCl' counters are used by ETH-LM loss measurement tests.

type=boolean
default=false
Displayed(tab/group)=Enable LMM Session Stats Collection (OAM.ETH-CFM/LMM Session Stats Collection)
lmmFcCollection Specifies which forwarding class levels (in and out of profile combined) have enabled the computation for Y.1731 Ethernet Loss Measurement (ETH-LM) RxFCl andTxFCl service frame counters for the specified SAP. If the bit corresponding to a forwarding class level is set, then a unique counter will be used to track all the combined in and out of profile traffic associated with that forwarding class.

type=nat.FcBitMask
default=0
Displayed(tab/group)=Collect ETH-LMM FC Stats (OAM.ETH-CFM/LMM Session Stats Collection)
lmmFcCollectionInProfile Specifies which forwarding class levels (in profile only) have enabled the computation for Y.1731 Ethernet Loss Measurement (ETH-LM) RxFCl andTxFCl service frame counters for the specified SAP. If the bit corresponding to a forwarding class level is set, then a unique counter will be used to track all the combined in and out of profile traffic associated with that forwarding class.

type=nat.FcBitMask
default=0
Displayed(tab/group)=Collect ETH-LMM FC Stats in Profile (OAM.ETH-CFM/LMM Session Stats Collection)
mcLagPropHoldTimeRemain "The value of mcLagPropHoldTimeRemain indicates the remaining time, in seconds, until MEPs on this SAP will react to a Multi-Chassis LAG protocol or port change. The value zero (0) indicates there are no pending events, or the SAP is not a MC-LAG SAP. This object corresponds to the global configuration timer: TIMETRA-IEEE8021-CFM-MIB::tmnxDot1agCfmMcLagPropHoldTime."

type=long
access=read-only
Displayed(tab/group)=MC-LAG Hold Time (OAM.ETH-CFM/Facility Meps)
ressubscr.HostLockoutInfo-Set type=Children-Set
ressubscr.HostTrackingInfoPerSap-Set type=Children-Set
ressubscr.SapSubMgmtCfg-Set type=Children-Set
service.SapLagPerLinkHash-Set type=Children-Set
squelchIngressLevel Specifies the ETH-CFM level or levels that are silently discarded on ingress to the SAP. Any received ETH-CFM PDU matching a level that has been set will be dropped without regard for any other ETH-CFM criteria.

type=ethernetoam.SquelchIngressLevelType
default=none
Displayed(tab/group)=Squelch Ingress Level (OAM.ETH-CFM/Squelch Ingress Level)
tunnelFaultNotification The value of tunnelFaultNotification specifies whether the SAP will 'accept' CFM fault notifications from a Tunnel MEP and process the notifications (i.e. do fault handling and/or fault propagation), or 'ignore' the notification. Both TIMETRA-SERV-MIB::svcEthCfmTunnelFaultNotification and this object MUST be set to 'accept' for the SAP to process the notification. The value 'notApplicable' is used by the system to represent a SAP which supports ETH-CFM, but not this object.

type=service.TunnelFaultNotificationType
default=accept
Displayed(tab/group)=Tunnel Fault Notification (OAM.ETH-CFM/Facility Meps)
vprn.SapIgmpHostTracking-Set type=Children-Set
 
Overridden Properties
description

maximum=160
id

serviceType

default=vprn
 
Properties inherited from service.ServiceAccessPoint
aaApplicationProfile, aaGrpId, aaPartId, ancp.AncpStaticMap-Set, antiSpoofing, antispoof.AntiSpoofingStaticHosts-Set, antispoof.SapStaticIPv6Hosts-Set, callingStationId, cpmProtEthCfmMonitorFlags, description, displayedName, hostLockoutPolicyName, hostLockoutPolicyPointer, id, innerEncapValue, ipMonitoring, lagLinkMapProfilePointer, macMonitoring, memberOperGroupName, monitorOperGroupName, outerEncapValue, portPointer, sapSubType, service.OperGrpBindingMember-Set, service.OperGrpBindingMonitor-Set, service.SapDefaultHost-Set, service.SapDefaultHostV6-Set
 
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

requestClearIgmpHostTracking

Request clearing of all IGMP Host Tracking information for this ServiceAccessPoint. 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.
aInOnlyStats : boolean - Whether to clear the IGMP Host Tracking statistics only (host tracking info is not cleared).
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 service.AccessInterface
findSitesFor, moveSapToAnotherService
 
Supported Network Elements
7750 SR
7705 SAR Gen 2
7705 SAR Hm
7450 ESS Supported from 8.0.R1 until 10.0.R1
  • Excluded chassis types: 7450-ESS1, 7450-ESS6, 7450-ESS6V
  • Required Capabilities: MixedMode
Supported from 10.0.R1
  • Excluded chassis types: 7450-ESS1
  • Required Capabilities: MixedMode
Product Specifics
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 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
7750 SR 20.0
7750 SR 21.0
7750 SR 22.0
7750 SR 23.0
7750 SR 24.0
7750 SR 25.0