Overview Package Class Deprecated Help

vpls
MSap

Defines the VPLS MSAP configuration.

public class MSap

Stats:
ressubscr.MSapEventLog

Properties
activeLastChange Timestamp for the last detected change of the MSAP.

type=Date
access=read-only
default=0
Displayed(tab/group)= Last Active State Change (MSAP Properties/MSAP State Time Stamps)
creationMsapPolicyName Name of the MSAP policy that was use in creation of this MSAP

type=string
access=read-only
default=
creationMsapPolicyObjectPointer FDN of the MSAP policy used in the creation of this MSAP

type=Pointer
default=
Displayed(tab/group)=Creation MSAP Policy (MSAP Properties)
creationPolicyReeval Trigger MSAP policy re-evaluation when set to doAction. This will sync the MSAP properties to the new values of a changed MSAP policy.

type=service.ActionType
default=notApplicable
Displayed(tab/group)=Creation MSAP Policy Re-evaluation (MSAP Properties)
creationSapCombinedEncapValue Combined Encapsulation value of the capture SAP that created this MSAP

type=long
access=read-only
default=0
creationSapPointer FDN of the capture SAP that created this MSAP

type=Pointer
access=read-only
default=
Displayed(tab/group)=Creation Capture Access Interface (MSAP Properties)
creationSapPortId Port ID of the capture SAP that created this MSAP

type=long
access=read-only
default=0
creationSapSvcId Service ID of the capture SAP that created this MSAP

type=long
access=read-only
default=0
creationTime Timestamp for the creation of the MSAP.

type=Date
access=read-only
default=0
Displayed(tab/group)=MSAP Creation (MSAP Properties/MSAP State Time Stamps)
isActive

type=boolean
access=read-only
default=true
Displayed(tab/group)=Active (/SAP Sub Type)
isIdle Indicates if this managed SAP is 'idle', meaning that there are no hosts associated with this managed SAP.

type=boolean
access=read-only
Displayed(tab/group)=Idle (MSAP Properties)
isSticky Indicates if this managed SAP is 'sticky'. The system will remove a 'sticky' managed SAP only upon explicit request of a management client.

type=boolean
access=read-only
Displayed(tab/group)=Sticky (MSAP Properties)
 
Overridden Properties
accountingOn

default=false
accountingPolicyId

accountingPolicyName

accountingPolicyObjectPointer

aggregation

aggregationSchedulerName

aggregationSchedulerObjectPointer

description

displayedName

dosProtection Pointer specifies the DoS Protection Policy that's applicable to this interface.

egressAtmPolicyId Reference to the ATM QoS Egress Policy. Is only applicable if the encapsulation type is ATM otherwise it is ignored. The value can be zero only in two cases: 1) if encapsulation type is not ATM 2) if encapsulation type is ATM but no terminating port (PVC Connection) is currently connected to this interface. Note: to set ATM policy the atm.SapPvcConnection object has to be attached to this Service interface.

egressFilterId

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

egressFilterPointer

egressFilterType

egressFrameBaseAccounting

egressIpFilterId

egressIpv6FilterId

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

egressIpv6FilterPointer

egressMacFilterId

egressMcastGroupPointer The value specifies the Egress Multicast Group this SAP belongs to.

egressPolicyId

egressPolicyName Specifies the policy name corresponding to the service.AccessInterface.egressPolicyObjectPointer object. Please do not use this property to determine the policy name. Use the service.AccessInterface.egressPolicyObjectPointer to get the policy object, from that get the policy name.

egressPolicyObjectPointer

egressQinqMarkTopBitsOnly This property only applies to ports with an encapsulation type of QinQ and specifies whether only top bits should be marked (true), or both top and bottom bits should be marked (false).

egressSchedulerName

egressSchedulerObjectPointer

hostLockoutPolicyPointer Pointer to the host lockout Policy

access=read-only
hsmdaEgrQosPackByteOffOvrd Specifies the Packet Byte Offset of an hsmda egress policy for this service. The value -128 means that there is no override.

hsmdaEgrSecondaryShaper HSMDA Egress Secondary Shaper applicable to this service

ingressAtmPolicyId Reference to the ATM QoS Ingress Policy. Is only applicable if the encapsulation type is ATM otherwise it is ignored. The value can be zero only in two cases: 1) if encapsulation type is not ATM 2) if encapsulation type is ATM but no terminating port (PVC Connection) is currently connected to this interface. Note: to set ATM policy the atm.SapPvcConnection object has to be attached to this Service interface.

ingressFilterId

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

ingressFilterPointer

ingressFilterType

ingressIpFilterId

ingressIpv6FilterId

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

ingressIpv6FilterPointer

ingressMacFilterId

ingressMatchQinqDot1pBits

ingressPolicyId

ingressPolicyName Specifies the policy name corresponding to the service.AccessInterface.ingressPolicyObjectPointer object. Please do not use this property to determine the policy name. Use the service.AccessInterface.ingressPolicyObjectPointer to get the policy object, from that get the policy name.

ingressPolicyObjectPointer Specifies the SAP-Ingress QoS for the SAP. For L3 when changing the port the SAP will retain the originalSAP-Ingress QoS selected unless explicitly changed.

ingressSchedulerName

ingressSchedulerObjectPointer

outerEncapValue value 4096 is used by atm capture sap

serviceIdString A produce of the 7250 node; this attribute will store in a String format the service ID for this Service Site. The reason behind having this attribute is that the 7250 expects the service ID to be a service name (ie a String) that represents a number.

sharedQueueOn

default=true
todSuitePointer Pointer to the instance of the ToD Suite object.

 
Properties inherited from vpls.L2AccessInterface
aaApplicationProfile, aaGrpId, aaPartId, aapolicy.AaReporting-Set, bgpVplsMhSiteName, callingStationId, cardStatsTCAProfileId, cardStatsTCAProfilePointer, clear.ClearRequest-Set, connectionProfile, connectionProfileVlan, cos0BW, cos1BW, cos2BW, cos3BW, cos4BW, cos5BW, cos6BW, cos7BW, creationOrigin, egressDestMacRewriteIeeeAddress, egressMcastGroupName, egressMcastGroupPointer, enableEgressFwdCount, enableL2TPv3SessionConfig, enableShg, ethRingElementPointer, ethernetSwitchCardId, ethernetoam.AbstractAccessInterfaceMip-Set, ethring.EndpointBinding-Set, etreeLeafAccess, etreeLeafTag, etreeRootLeafTag, forceCtagVlanFwd, genericQosProfileId, genericne.MvAttachment-Set, hostLockoutPolicyName, hostLockoutPolicyPointer, l2fwd.RedundantSapConfiguration-Set, lightweightSap, llfEnabled, llfId, llfState, lmmCollectStats, lmmFcCollection, lmmFcCollectionInProfile, macSwapEnable, ossMetaData, outerEncapValue, overrides, pppoeCircuitId, priority, pssConnectionProfile, qinqInnerTranslationId, qinqOuterTranslationId, qinqVlanTranslation, ressubscr.HostLockoutInfo-Set, ressubscr.HostTrackingInfoPerSap-Set, rstpEnabled, sapSubType, service.L2TPv3SessionConfig-Set, service.LoopbackL2AccessInterface-Set, service.SapIpoeSessionCfg-Set, shgName, shgSitePointer, squelchIngressCtagLevel, squelchIngressLevel, transitSap, trustMode, unitId, vMepFilter, vlanRangeSap, vlanTranslation, vlanTranslationId, vpls.CaptureL2AccessInterfaceSpecifics-Set, vpls.SapIgmpHostTracking-Set, vpls.VplsFRfInterfaceSpecifics-Set, vplsMode
 
Properties inherited from vpls.AbstractL2AccessInterface
antispoof.L2AntiSpoofing-Set, arp.SapArpHostSpecs-Set, cesBackplanePortBindingPointer, cflowdType, defaultVlan, egressQtagManipulateAction, enableTableClassification, encapTagging, ingressInnerQtag, ingressOuterQtag, ingressQtagManipulateAction, l2fwd.AccessInterfaceFib-Set, memberOperGroupName, memberOperGroupPtr, monitorOperGroupName, monitorOperGroupPtr, multicastSource, redundantServiceId, ressubscr.SapSubMgmtCfg-Set, schedulerPolicyObjectPointer, service.OperGrpBindingMember-Set, service.OperGrpBindingMonitor-Set, service.SapTodMonitor-Set, shcvAction, shcvInterval, shcvPolicyIPv4Pointer, shcvRetryCount, shcvRetryTimeout, shcvSourceIpAddress, shcvSourceIpAddressType, shcvSourceMacAddress, vpls.InterfacePimSnooping-Set, vpls.InterfacePimSnoopingV6-Set, vpls.L2AccessInterfaceIgmpSnpgCfg-Set, vpls.L2AccessInterfaceMldMvrCfg-Set, vpls.L2AccessInterfaceMldSnpgCfg-Set, vpls.L2AccessInterfaceMvrCfg-Set, vpls.L2AccessItfDhcp6RelayCfg-Set, vpls.L2AccessItfDhcpRelayCfg-Set, vpls.McastCacLagPortDown-Set, vpls.McastCacLevel-Set, vpls.MldMcastCacLevel-Set
 
Properties inherited from vpls.AbstractTlsSap
bandwidth, bandwidthHi, bpduTransOper, bpduTranslation, description, ethTunnelControlSap, ethernetoam.SapMipEntry-Set, ethernettunnel.EthTunnelSapPath-Set, l2fwd.AccessInterfaceStp-Set, l2ptProtocol, l2ptTermination, lagLinkMapProfilePointer, mcLagPropHoldTimeRemain, mipEnabled, mipMacAddress, processCpmTrafficOnLagSapDown, ringNodeName, service.AccessPolicyMeterOverride-Set, service.EgressAccessPolicyQueueOverride-Set, service.EgressSchedulerPolicyEntryOverride-Set, service.HsmdaEgressAccessPolicyQueueOverride-Set, service.IngressAccessPolicyQueueOverride-Set, service.IngressSchedulerPolicyEntryOverride-Set, service.SASAccessPolicyQueueOverride-Set, service.SapEgrPolicerCtlOverride-Set, service.SapEgrQosHsWrrGroupOverride-Set, service.SapEgressPolicerOverride-Set, service.SapIngPolicerCtlOverride-Set, service.SapIngressPolicerOverride-Set, service.SapLagPerLinkHash-Set, testRole, testSource, testTarget, tunnelFaultNotification, usesMultipointShared
 
Properties inherited from service.L2AccessInterface
ancp.AncpStaticMap-Set, connectionProfileVlanTag, cpmProtEthCfmMonitorFlags, description, displayedName, enablePortRedundancy, ingressExtraTagDropCount, innerEncapValue, ipCriteriaOverrideTag, ipv6CriteriaOverrideTag, macMonitoring, outerEncapValue, portPointer, redundantSwitchState, sapEgressAggregateMeterBurst, sapEgressAggregateMeterEnableStats, sapEgressAggregateMeterRate, sapEgressInnerDot1p, sapEgressOuterDot1p, sapIngressAggregateMeterBurst, sapIngressAggregateMeterCBS, sapIngressAggregateMeterCIR, sapIngressAggregateMeterRate, sapIngressAggregatePlcrAlgoType, sapIngressAggregateShaperRateCIR, sapIngressAggregateShaperRatePIR, sapIngressWithAggregateMeter, sasEgressPolicyId, sasEgressPolicyName, sasEgressPolicyObjectPointer, sasIngressPolicyId, sasIngressPolicyName, sasIngressPolicyObjectPointer, securityPolicyBypass, serviceType, todSuitePointer, zoneId, zonePointer
 
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

requestClearMsap

Request clearing of this MSAP. 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.
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 vpls.L2AccessInterface
requestClearIgmpHostTracking
 
Methods inherited from service.L2AccessInterface
cleanupSAPsWithBadFdns, copyMoveSaps, copyMoveSapsWithSapList, findMcRingProtectedSaps, findMcRingProtectedSapsOnRing
 
Methods inherited from service.AccessInterface
findSitesFor, moveSapToAnotherService
 
Supported Network Elements
7450 ESS
7750 SR
7705 SAR Gen 2
7705 SAR Hm
Product Specifics
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 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