service
L2AccessInterface

A L2AccessInterface identifies the customer interface point for a layer 2 service.



public abstract class L2AccessInterface

Stats:
service.CemSapADCStats service.CemSapStats 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
ancp.AncpStaticMap-Set type=Children-Set
connectionProfileVlanTag

type=int
access=read-create
default=unspecified
enums=
    0: unspecified - None (not selectable)
    1: inner - Inner
    2: outer - Outer

cpmProtEthCfmMonitorFlags

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

enablePortRedundancy Indicates whether to enable the backup port configuration for manual switching. Currently it is only applicable to Epipe and Cpipe on 7x50/7710/7705 node.

type=boolean
default=false
Displayed(tab/group)=Enable Port Redundancy (Port/Port Redundancy)

ingressExtraTagDropCount Indicates if we are counting the number of packets dropped because of number of tags in the ingress traffic packets did not match the sap configuration. Currently it is only applicable to VPLS and Epipe on 7210 network node.

type=boolean
default=false
Displayed(tab/group)=Ingress Extra Tag Drop Count (Accounting/7210 Specific)

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)

ipv6CriteriaOverrideTag This vlaue specifies the tag-id for theIPv6 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)

macMonitoring

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

redundantSwitchState Indicates the redundant state of this L2 Access Interface for manual switching.

type=service.ManualSwitchBackupState
access=read-only
default=none
Displayed(tab/group)=Manual Switch Backup State (Port/Port Redundancy)

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 Specifies to Enable or disable Egress AGgregate Meter Stats.

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=200000000
units=kbps
Displayed(tab/group)=Egress Meter Rate (QoS/Aggregate Rate Limit)

sapEgressInnerDot1p Allows user to override egress remarking values, to preserve the dot1p values of the ingress packet.

type=service.PreserveVlanTagForDot1p
default=none
Displayed(tab/group)=Inner Dot1p (QoS/Egress Dot1p Remarking)

sapEgressOuterDot1p Allows user to override egress remarking values, to preserve the dot1p values of the ingress packet.

type=service.PreserveVlanTagForDot1p
default=none
Displayed(tab/group)=Outer Dot1p (QoS/Egress Dot1p Remarking)

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)

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)

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)

todSuitePointer Pointer to the instance of the ToD Suite object.

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

zoneId

type=long
minimum=0
maximum=65535

zonePointer

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

 
Overridden Properties
description

displayedName

innerEncapValue Provisioned inner encap value. This value is propagated into: terminatedPortInnerEncapValue.

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.

portPointer

serviceType

 
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

cleanupSAPsWithBadFdns

For 14R4 SROS L2TPv3 feature there was no support in SAM 14R1. But due to CLI config we end up creating Saps with bad FDNs in SAM 14R1, On upgrade to SAM 14R5+ we end up creating valid SAPs. This Method is used to query and Delete the Saps with Bad FDNs (Epipe/Vpls/I-Vpls) which has Private Tunnel as its 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.
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false

copyMoveSaps

Copy or move the SAPs from the source port to destination port with a source SAP filter. Only Epipe, Ipipe, (B,I)VPLS and (B,I)MVPLS type of L2 SAPs, and IES, VPRN type of L3 SAPs(L3 Access Interface, L3 Service Access Point) on source port will be copied or moved.
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.
copyMoveStruct : service.SapCopyMoveStruct -
sourceSapFilter : 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:
resultList : List (service.SingleSapCopyMoveResultStruct) -
Exceptions:
service.L2AccessInterface.copyMoveSapsException

copyMoveSapsWithSapList

Copy or move the SAPs with passed in source SAP fullName list. Executing this method on the destination port instance. Only Epipe, Ipipe, (B,I)VPLS and (B,I)MVPLS type of L2 SAPs, and IES, VPRN type of L3 SAPs(L3 Access Interface, L3 Service Access Point) can be copied or moved.
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.
sapList : List (Pointer) -
destinationPortFdn : string -
outerEncapShiftOffset : int -
innerEncapShiftOffset : int -
isMoving : boolean -
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:
resultList : List (service.SingleSapCopyMoveResultStruct) -
Exceptions:
service.L2AccessInterface.copyMoveSapsWithSapListException

findMcRingProtectedSaps

Return the list of the Multi Chassis Ring protected L2 Access Interface on the ethernet port or LAG. This method will return all the SAPs managed by MC ring(s) if there are multiples rings on this port. The ring should be in administrative up state.
Input Parameters:
portFdn : string -
sapFilter : 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:
resultList : List (generic.CommonManagedEntityInformation) -

findMcRingProtectedSapsOnRing

Return the list of the Multi Chassis Ring protected L2 Access Interface on the ring. The ring should be in administrative up state.
Input Parameters:
ringFdn : string -
sapFilter : 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:
resultList : List (generic.CommonManagedEntityInformation) -
Methods inherited from service.AccessInterface
findSitesFor, moveSapToAnotherService
 
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
OS6850/6850E
OS6855
OS6400
OS6250
OS6450
OS6350
OS9700E/9800E
OS6860E/OS6860N
OS6870
OS6865
OS6560/OS6560E
OS6570M
OS6465
OS6360
OS6900
DC VSC
DC 7850
DC 210
DC VSA8
7950 XRS
Generic NE
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
Generic NE 1.0.0
OS6250 6.6.3
OS6250 6.6.4
OS6250 6.6.5
OS6250 6.7.1
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 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