Overview Package Class Deprecated Help

service
VplsSapTemplate

public class VplsSapTemplate

Properties
adminStatus The value of this property specifies whether this SAP participates in the TLS's Spanning Tree Protocol.

type=service.AgingType
default=enabled
Displayed(tab/group)=Administrative Status (/STP)
autoEdge The value of this property specifies whether this SAP is enabled for auto-edge detection as defined by Rapid Spanning Tree Protocol.

type=service.AgingType
default=enabled
Displayed(tab/group)=Auto Edge (/STP)
bpduEncap The value of this property specifies the type of encapsulation used on BPDUs sent out and received on this SAP.

type=service.BdpuEncapType
default=dynamic
bpduTranslation The value of this property specifies whether received L2 Protocol Tunnel PDU's are translated before being sent out on this port or sap.

type=vpls.BpduTranslation
default=disabled
Displayed(tab/group)=BPDU Translation
cfmMip The value of this property specifies whether Maintance Intermediate Points (MIP) will be created.

type=boolean
default=false
Displayed(tab/group)=ETH CFM MIP
collectStats When the value of this object is 'true' the agent collects accounting statistics on this SAP.

type=boolean
default=false
Displayed(tab/group)=Collect Statistics
cpmProtectionPolicyId The value of this property specifies associates a CPM Protection policy with a SAP. A value of '-1' specifies that the system will determine the CPM Protection policy for this SAP.

type=string
default=
Displayed(tab/group)=DoS Protection Policy (/DoS Protection)
dCpuProtPolicy Specifies the assocaited Distributed CPU Protection Policy name with a SAP template.

type=string
default=
Displayed(tab/group)=DDoS Protection Policy (/DDoS Protection)
discardUnknownSource The value of this property specifies packets with unknown source MAC will be dropped in stead.

type=service.AgingType
default=disabled
Displayed(tab/group)=Discard Unknown Source
discardedEthCfmCtagLevel The value of discardedEthCfmCtagLevel specifies the ETH-CFM level or levels of the ETH-CFM PDUs that are silently discarded using additional VLAN space immediately following ingress service delineation. Any received ETH-CFM PDU matching a level that has been set will be dropped without regard for the vlan-id in that additional space. No statistical information or drop count will be available for any ETH-CFM PDU that is silently discarded by this option.

type=ethernetoam.SquelchIngressLevelType
default=none
Displayed(tab/group)=ETH CFM Squelch Ctag Level
discardedEthCfmLevel The value of this property 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. No statistical information or drop count will be available for any ETH-CFM PDU that is silently discarded by this option.

type=ethernetoam.SquelchIngressLevelType
default=none
Displayed(tab/group)=ETH CFM Squelch Level
egressAggRateLUB The value of this property specifies whether to limit the unused bandwidth and allow a tighter control in allocation of bandwidth by HQos. When the value of this property is set to 'true', HQos algorithm distributes any unused aggregate bandwidth between queues operating below their fair share rates. This allows a simplified aggregate rate protection while allocating bandwidth by HQos scheduling algorithm.

type=boolean
default=false
Displayed(tab/group)=Limit Unused Bandwidth (Egress/Aggregate Rate)
egressAggRateLimit The value of this property specifies the maximum total rate of all egress queues for this SAP. The value '-1' means that there is no limit.

type=long
default=4294967295
minimum=1
maximum=6400000000
units=Kbps
Displayed(tab/group)=Rate Limit (Egress/Aggregate Rate)
egressFrameBasedAcctg The value of this property specifies whether to use frame-based accounting when evaluating egressAggRateLimit for all egress queues for this SAP. If the value is 'false', the default packet-based accounting method will be used.

type=boolean
default=false
Displayed(tab/group)=Frame-Based Accounting (Egress/Aggregate Rate)
egressPolicerPolicy The value of this property specifies the egress policer control policy applicable.

type=string
default=
Displayed(tab/group)=Policer Control Policy (Egress)
egressQinQMarkTopOnly When the encapsulation type of the access port where this SAP is defined is Q in Q, the value of this property specifies which P-bits to mark during packet egress. When the value is false both set of P-bits are marked. When the value is true, only the P-bits in the top Q-tag are marked.

type=boolean
default=false
Displayed(tab/group)=QinQ Mark Top (Egress)
egressQosSchedulerPolicy The value of this property specifies the egress QoS scheduler for this SAP.

type=string
default=
Displayed(tab/group)=QoS Scheduler Policy (Egress)
ethCfmMonitoring The value of this property specifies whether or not to apply rate limiting to Ethernet Connectivity Fault Management (Eth-CFM) packets served by a SAP created using this template.

type=service.EthCfmMonitorFlag
Displayed(tab/group)=ETH CFM Monitoring (/DoS Protection)
ingressMatchQinQDot1PBits Applies only to SAP's defined on a port configured for Q in Q service encapsulation. It indicates which 802.1P bits will be used to match a QoS or a MAC filter policy when a double-tagged frame is received on this SAP.

type=int
default=default
Displayed(tab/group)=Match QinQ Dot1p Bits (Ingress)
enums=
    1: default - Default
    2: top - Top
    3: bottom - Bottom
ingressPolicerPolicy The value of this property specifies specifies the ingress policer control policy applicable.

type=string
default=
Displayed(tab/group)=Policer Control Policy (Ingress)
ingressQosSchedulerPolicy The value of this property specifies indicates the ingress QoS scheduler for this SAP.

type=string
default=
Displayed(tab/group)=QoS Scheduler Policy (Ingress)
l2ptProtocol The value of this property specifies which L2 Protocol Tunnel PDU's are terminated on this port or sap.

type=vpls.L2PtProtocol
default=stp
Displayed(tab/group)=L2PT Protocol
l2ptTermination The value of this property specifies whether received Layer 2 Protocol Tunnel (L2PT) PDU's are terminated on this port or sap.

type=service.AgingType
default=disabled
Displayed(tab/group)=L2PT Termination
limitMacMove When the value of this property is set to 'blockable' the agent will monitor the MAC re-learn rate on this SAP, and it will block it when the re-learn rate specified by SiteFib.macMoveFrequency is exceeded. When the value is 'nonBlockable' this SAP will not be blocked, and another blockable SAP will be blocked instead.

type=l2fwd.LimitMacMove
default=blockable
Displayed(tab/group)=Limit (/MAC Move)
limitMacMoveLevel The value of this property specifies the hierarchy in which SAPs are blocked when a MAC-move limit is exceeded. When a MAC is moving among multiple SAPs or spoke-SDPs, the SAP bind or spoke-SDP bind with the lower level is blocked first

type=l2fwd.MacMoveLevel
default=tertiary
Displayed(tab/group)=Limit Level (/MAC Move)
macAddressLimit The value of this property specifies the maximum number of learned and static entries allowed in the FDB of this SAP. The value 0 means: no limit for this SAP.

type=int
default=0
minimum=0
maximum=511999
Displayed(tab/group)=MAC Address Limit
macAging The value of this property specifies whether the MAC aging process is enabled for this SAP template. The value will be ignored if MAC aging is disabled on service level.

type=service.AgingType
default=enabled
Displayed(tab/group)=MAC Aging
macLearning The value of this property specifies whether the MAC learning process is enabled for this SAP. The value is ignored if MAC learning is disabled on service level.

type=service.AgingType
default=enabled
Displayed(tab/group)=MAC Learning
macMonitoring If the value of this property is 'true', the per-source rate limit must be applied. Value of this property will be ignored if the system derived CPM Protection Policy is set to 'zero' for the instantiated SAP.

type=boolean
default=false
Displayed(tab/group)=CPM Monitor MAC (/DoS Protection)
pathCost The value of this property specifies the contribution of this port to the path cost of paths towards the spanning tree root which include this port.

type=long
default=10
minimum=1
maximum=200000000
Displayed(tab/group)=Port Path Cost (/STP)
pointToPointStatus The value of this property specifies the administrative point-to-point status of the LAN segment attached to this sap. The value 'forceTrue' means that this port should always be treated as if it is connected to a point-to-point link. The value of 'forceFalse' means that this port should be treated as having a shared media connection.

type=int
default=forceTrue
Displayed(tab/group)=Link Type (/STP)
enums=
    0: forceTrue - Point To Point
    1: forceFalse - Shared
priority The value of this property specifies the value of the port priority field which is contained in the most significant 4 bits of the 16-bit Port ID associated with this SAP. As only the most significant 4 bits of the value are used, the actual value of this object is limited to multiples of 16: e.g. the agent rounds down the value to one of: 0, 16, 32, .. , 224, 240.

type=int
default=128
minimum=0
maximum=255
Displayed(tab/group)=Port Priority (/STP)
rapidStart The value of this property specifies whether Rapid Start is enabled on this SAP. When the value is 'enabled' the Spanning Tree Protocol state transitions on this SAP are driven by the value of the 'HelloTime' instead of the value of 'ForwardDelay', thus allowing a faster transition into the forwarding state. This parameter is also referred to as 'adminEdge'.

type=service.AgingType
default=disabled
Displayed(tab/group)=Administrative Edge (/STP)
rootGuard The value of this property specifies whether this port is allowed to become STP root port. It corresponds to the parameter 'restrictedRole' in 802.1Q. If set, it can cause lack of spanning tree connectivity.

type=generic.TruthValue
default=false
Displayed(tab/group)=Root Guard (/STP)
  
Properties inherited from service.AbstractSapTemplate
displayedName, eggressIpv6FilterName, eggressMacFiltername, egressIpFilterId, egressIpFilterName, egressIpv6FilterId, egressMacFilterId, egressQosPolicyId, egressQosPolicyName, ingressIpFilterId, ingressIpFilterName, ingressIpv6FilterId, ingressIpv6FilterName, ingressMacFilterId, ingressMacFiltername, ingressQosPolicyId, ingressQosPolicyName, ingressUsesMultipointShared, sapCount, serviceType, sharedQueueOn
 
Properties inherited from policy.PolicyDefinition
configurationAction, configurationMode, discoveryState, displayedName, distributionMode, isMaster, lastSyncTime, numberOfUnderlyingPolicyItems, origin, policyMode, policySyncGroupPointer, policyType
 
Properties inherited from policy.PolicyObject
description, displayedName, globalPolicy, id, isLocal, policyType, siteId, siteName, templateObject
 
Properties inherited from ManagedObject
actionMask, children-Set, deploymentState, isFaultSquelched, name, objectFullName, selfAlarmed
 
Methods inherited from policy.PolicyDefinition
distribute, distributeUsingGroups, distributeV2, evaluatePolicy, findGlobal, findLocal, findReleased, getSyncTaskResult, resetToReleasedPolicy, setConfigurationModeToDraft, setConfigurationModeToReleased, setDistributionModeToLocalEditOnly, setDistributionModeToSyncWithGlobal, syncTo, syncToLocalWithResync
 
Supported Network Elements
7750 SR Supported from 13.0.R1
  • Excluded chassis types: 7750-SRc4, 7750-SRc12
7705 SAR Gen 2
7705 SAR Hm
Product Specifics
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