| Overview | Package | Class | Deprecated | Help |
| 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 |
| bgpVplsMhSiteName |
The name of the BGP Multi-homing VPLS site that this SAP associated with.
type=string access=read-only default= Displayed(tab/group)=Assigned to Multi-homing Site (/BGP Multi-homing) |
| callingStationId |
type=string default= minimum=0 maximum=64 Displayed(tab/group)=Calling Station ID |
| cardStatsTCAProfileId |
type=int access=read-only |
| cardStatsTCAProfilePointer |
>
DEPRECATED: 23.4 - No longer applicable to any supported nodes type=Pointer default= |
| clear.ClearRequest-Set |
type=Children-Set |
| connectionProfile |
type=Pointer default= Displayed(tab/group)=Connection Profile (Port/Connection Profile) |
| connectionProfileVlan |
type=Pointer default= Displayed(tab/group)=VLAN Connection Profile (Port/VLAN Connection Profile) |
| cos0BW |
Specifies the Bandwidth for this Class Of Service. The bandwidth is specified in Mbps by default.
The bandwidth can be converted to Kbps by executing "Convert to Kbps" action from System Preferences.
The bandwidth cannot be converted back to Mbps from Kbps.
type=long access=read-only default=0 minimum=0 maximum=100000000 Displayed(tab/group)=CoS 0 Bandwidth (Mbps) (Bandwidth) |
| cos1BW |
Specifies the Bandwidth for this Class Of Service. The bandwidth is specified in Mbps by default.
The bandwidth can be converted to Kbps by executing "Convert to Kbps" action from System Preferences.
The bandwidth cannot be converted back to Mbps from Kbps.
type=long access=read-only default=0 minimum=0 maximum=100000000 Displayed(tab/group)=CoS 1 Bandwidth (Mbps) (Bandwidth) |
| cos2BW |
Specifies the Bandwidth for this Class Of Service. The bandwidth is specified in Mbps by default.
The bandwidth can be converted to Kbps by executing "Convert to Kbps" action from System Preferences.
The bandwidth cannot be converted back to Mbps from Kbps.
type=long access=read-only default=0 minimum=0 maximum=100000000 Displayed(tab/group)=CoS 2 Bandwidth (Mbps) (Bandwidth) |
| cos3BW |
Specifies the Bandwidth for this Class Of Service. The bandwidth is specified in Mbps by default.
The bandwidth can be converted to Kbps by executing "Convert to Kbps" action from System Preferences.
The bandwidth cannot be converted back to Mbps from Kbps.
type=long access=read-only default=0 minimum=0 maximum=100000000 Displayed(tab/group)=CoS 3 Bandwidth (Mbps) (Bandwidth) |
| cos4BW |
Specifies the Bandwidth for this Class Of Service. The bandwidth is specified in Mbps by default.
The bandwidth can be converted to Kbps by executing "Convert to Kbps" action from System Preferences.
The bandwidth cannot be converted back to Mbps from Kbps.
type=long access=read-only default=0 minimum=0 maximum=100000000 Displayed(tab/group)=CoS 4 Bandwidth (Mbps) (Bandwidth) |
| cos5BW |
Specifies the Bandwidth for this Class Of Service. The bandwidth is specified in Mbps by default.
The bandwidth can be converted to Kbps by executing "Convert to Kbps" action from System Preferences.
The bandwidth cannot be converted back to Mbps from Kbps.
type=long access=read-only default=0 minimum=0 maximum=100000000 Displayed(tab/group)=CoS 5 Bandwidth (Mbps) (Bandwidth) |
| cos6BW |
Specifies the Bandwidth for this Class Of Service. The bandwidth is specified in Mbps by default.
The bandwidth can be converted to Kbps by executing "Convert to Kbps" action from System Preferences.
The bandwidth cannot be converted back to Mbps from Kbps.
type=long access=read-only default=0 minimum=0 maximum=100000000 Displayed(tab/group)=CoS 6 Bandwidth (Mbps) (Bandwidth) |
| cos7BW |
Specifies the Bandwidth for this Class Of Service. The bandwidth is specified in Mbps by default.
The bandwidth can be converted to Kbps by executing "Convert to Kbps" action from System Preferences.
The bandwidth cannot be converted back to Mbps from Kbps.
type=long access=read-only default=0 minimum=0 maximum=100000000 Displayed(tab/group)=CoS 7 Bandwidth (Mbps) (Bandwidth) |
| creationOrigin |
type=svt.L2RouteOriginType access=read-create default=manual |
| egressDestMacRewriteIeeeAddress |
This parameter specifies whether the Destination MAC address should be rewritten and to what value it should be rewritten.
type=MacAddress default=00-00-00-00-00-00 Displayed(tab/group)=IEEE Address (QoS/Egress Destination MAC Overwrite) |
| egressMcastGroupName |
DEPRECATED: 17.3 - No longer supported on SR 15.0R1 type=string access=read-only default= maximum=32 |
| egressMcastGroupPointer |
The value specifies the Egress Multicast Group this SAP belongs to.
DEPRECATED: 17.3 - No longer supported on SR 15.0R1 type=Pointer default= Displayed(tab/group)=Egress Multicast Group (Egress Multicast Group) |
| enableEgressFwdCount |
This parameter allows a user to associate a counter for the number of forwarded packets and octets that egress an L2 interface configured in a Routed VPLS service.
type=boolean default=false Displayed(tab/group)=Egress Forwarded-Count (Accounting/7210 Specific) |
| enableL2TPv3SessionConfig |
Indicates whether to enable L2TPV3 session configuration on L2 Access Interface.
type=boolean default=false Displayed(tab/group)=Enable L2TPv3 Session Config (L2TPv3.General) |
| enableShg |
type=boolean access=read-create default=false Displayed(tab/group)=Enable Split Horizon (Port/Ethernet Ring) |
| ethRingElementPointer |
type=Pointer access=read-create default= Mandatory on create Displayed(tab/group)=Element (Port/Ethernet Ring) |
| ethernetSwitchCardId |
This attribute is the hardware index of the card pointed to by ethernetSwitchCardPointer on the
site this interface is on.
type=long access=read-only default=0 |
| ethernetoam.AbstractAccessInterfaceMip-Set |
type=Children-Set |
| ethring.EndpointBinding-Set |
type=Children-Set |
| etreeLeafAccess |
Specifies whether or not this SAP is an e-tree leaf access circuit
type=boolean access=read-create default=false Displayed(tab/group)=Leaf Access (/Etree) applicable=false (Where parent is one of (vpls.AbstractEvpnSite)) |
| etreeLeafTag |
Specifies the VLAN tag to be used for e-tree leaf traffic
type=int access=read-create default=0 minimum=0 maximum=4094 Displayed(tab/group)=Leaf Tag (/Etree) |
| etreeRootLeafTag |
Specifies whether or not this SAP is e-tree tagging, with the first
VLAN tag in the SAP identifier being the VLAN tag for e-tree root traffic
type=boolean access=read-create default=false Displayed(tab/group)=Root Leaf Tag (/Etree) applicable=false (Where parent is one of (vpls.AbstractEvpnSite)) |
| forceCtagVlanFwd |
type=boolean default=false Displayed(tab/group)=Force ctag Vlan Forwarding (/Force ctag VLAN Forwarding) |
| genericQosProfileId |
Specifies the ID of the policy.GenericQosProfile to be used by this SAP.
When this attribute is set to greater than 0 the values of
service.AccessInterface.ingressPolicyObjectPointer, service.AccessInterface.egressPolicyObjectPointer,
service.L2AccessInterface.sasIngressPolicyObjectPointer, service.L2AccessInterface.sasEgressPolicyObjectPointer,
service.L3AccessInterface.sasIngressPolicyObjectPointer, service.L3AccessInterface.sasEgressPolicyObjectPointer,
genericne.MvAttachment.inputPolicy, genericne.MvAttachment.outputPolicy
will be set according to the QoS profile identified by this ID.
When this attribute is set to 0 the values of
service.AccessInterface.ingressPolicyObjectPointer, service.AccessInterface.egressPolicyObjectPointer,
service.L2AccessInterface.sasIngressPolicyObjectPointer, service.L2AccessInterface.sasEgressPolicyObjectPointer,
service.L3AccessInterface.sasIngressPolicyObjectPointer, service.L3AccessInterface.sasEgressPolicyObjectPointer,
genericne.MvAttachment.inputPolicy, genericne.MvAttachment.outputPolicy
will be set to their default values.
When this attribute is set to -1 then none of the attributes will be modified
(this is the default value and it means there is no GenericQosProfile associated with this object).
type=long default=-1 minimum=-1 maximum=4294967295 |
| genericne.MvAttachment-Set |
type=Children-Set |
| 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) |
| l2fwd.RedundantSapConfiguration-Set |
type=Children-Set |
| lightweightSap |
A SAP is considered Lightweight if it is associated to a SHG Site that is Residential :
- tlsShgResidential indicates whether or not the
split-horizon-group is residential. In a
Residential Split Horizon Group (RSHG) there is
no downstream broadcast, and all saps in the
group will share the default ingress queue. The
value can be specified during row-creation,
cannot be changed later on.
type=boolean access=read-only default=false Displayed(tab/group)=Lightweight SAP (/Split Horizon Group) |
| llfEnabled |
Is Link Loss Forwarding enabled on this sap.
It only applies to 1830 VPLS services.
type=int default=Disabled Displayed(tab/group)=LLF Enabled (Port/Link Loss Forwarding) enums= 1: Enabled - Enabled 2: Disabled - Disabled |
| llfId |
Setting the LLF ID to 0 disables LLF.
type=int default=0 minimum=0 maximum=5 Displayed(tab/group)=LLF ID (Port/Link Loss Forwarding) |
| llfState |
Link Loss Forward state. It only applies to 1830 VPLS services (See name binding behavior items).
type=int access=read-only default=Clear Displayed(tab/group)=LLF Status (Port/Link Loss Forwarding) enums= 1: Fault - Fault 2: Clear - Clear |
| 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) |
| macSwapEnable |
Specifies that the NE auto-configures MAC-swap properties
type=boolean default=false Displayed(tab/group)=MAC-Swap-Enable |
| ossMetaData |
type=string default= minimum=0 maximum=300 Displayed(tab/group)=OSS Meta Data (OSS Meta Data) |
| overrides |
Map of overrides of default custom property values.
type=Map (Pointer to string) |
| pppoeCircuitId |
type=boolean default=false Displayed(tab/group)=PPPoE Circuit ID (/PPPoe Circuit) |
| priority |
type=int default=0 minimum=0 maximum=7 Displayed(tab/group)=Priority (Port) |
| pssConnectionProfile |
DEPRECATED: 23.4 - No longer applicable to any supported nodes type=Pointer default= |
| qinqInnerTranslationId |
Specifies the inner ingress QinQ vlan translation for two service delimiting vlan values.
type=long default=-1 minimum=-1 maximum=4095 Displayed(tab/group)=Inner Translation ID (Port/QinQ VLAN Translation) |
| qinqOuterTranslationId |
Specifies the outer ingress QinQ vlan translation for two service delimiting vlan values.
type=long default=-1 minimum=-1 maximum=4094 Displayed(tab/group)=Outer Translation ID (Port/QinQ VLAN Translation) |
| qinqVlanTranslation |
Specifies the desired Ingress QinQ Vlan Translation. A value of 'qinqIds' specifies that the value of
qinqInnerTranslationId and qinqOuterTranslationId is to be used to overwrite the preserved qinq id's in the packet.
type=int default=none Displayed(tab/group)=Translation (Port/QinQ VLAN Translation) enums= 1: none - None 2: qinqIds - QinQ IDs |
| ressubscr.HostLockoutInfo-Set |
type=Children-Set |
| ressubscr.HostTrackingInfoPerSap-Set |
type=Children-Set |
| rstpEnabled |
type=boolean default=false |
| sapSubType |
Indicates the sub-type for this Access Interface.
type=service.SapSubType access=read-create default=regular Displayed(tab/group)=SAP Sub Type (/SAP Sub Type) |
| service.L2TPv3SessionConfig-Set |
type=Children-Set |
| service.LoopbackL2AccessInterface-Set |
type=Children-Set |
| service.SapIpoeSessionCfg-Set |
type=Children-Set |
| shgName |
type=string access=read-create default= maximum=32 Mandatory on create |
| shgSitePointer |
Pointer to the Split Horizon Group Site.
type=Pointer default= Displayed(tab/group)=Split Horizon Group Name (/Split Horizon Group) |
| squelchIngressCtagLevel |
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.
type=ethernetoam.SquelchIngressCtagLevelType default=none Displayed(tab/group)=Squelch Ingress Ctag Level (OAM.ETH-CFM/Squelch Ingress Level) |
| 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) |
| transitSap |
type=boolean access=read-create default=false Displayed(tab/group)=Transit SAP (Port) |
| trustMode |
type=boolean default=true Displayed(tab/group)=Trust Mode (Port) |
| unitId |
The name of the logical unit under physical port.
The logical unit name is typically a numeric value, but the format depends on the actual NE.
This value can only be set during creation. If the value is left blank and the
object is being created from NFM-P then the value will be set automatically by NFM-P
to the same value as the outerEncapValue.
type=string default= minimum=0 maximum=64 Displayed(tab/group)=Port Unit Name (Port) |
| vMepFilter |
The value of vMepFilter specifies whether ETH-CFM PDUs egressing the sap at the same level or
lower than that of the configured service MEP (the virtual MEP) should be discarded or continue
to egress.
type=boolean default=false Displayed(tab/group)=Enable Virtual MEP Filter (OAM.ETH-CFM/Virtual MEPs) |
| vlanRangeSap |
Specifies, when enabled, that the configured SAP is a VLAN Range SAP.
type=boolean access=read-create default=false Displayed(tab/group)=VLAN Range SAP (Port) |
| vlanTranslation |
Specifies the desired Ingress Vlan Translation.
It only applies to EPIPE service.
type=int default=None Displayed(tab/group)=Translation (Port/VLAN Translation) enums= 1: None - None 2: VlanId - VLAN ID 3: CopyOuter - Copy Outer |
| vlanTranslationId |
Specifies the VLAN id to be used to overwrite the preserved VLAN id
in the packet. It only applies to EPIPE service.
type=long default=-1 minimum=-1 maximum=4094 Displayed(tab/group)=Translation ID (Port/VLAN Translation) |
| vpls.CaptureL2AccessInterfaceSpecifics-Set |
type=Children-Set |
| vpls.SapIgmpHostTracking-Set |
type=Children-Set |
| vpls.VplsFRfInterfaceSpecifics-Set |
type=Children-Set |
| vplsMode |
Applicable to Telco 7250 only.
The mode of the VPLS service being configured on this SAP. The current
applicable values are Qualified and Unqualified. This attribute is only
valid on the 7250 ES node.
DEPRECATED: 11.0 R1 - No longer supported by any NE types supported in SAM type=netw.VplsMode access=read-create default=none |
| Overridden Properties | |
|---|---|
| outerEncapValue | value 4096 is used by atm capture sap |
| 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.LogicalInterface |
|---|
| application, description, displayedName, domain, nodeId, nodeName |
| Properties inherited from ManagedObject |
|---|
| actionMask, children-Set, deploymentState, isFaultSquelched, name, objectFullName, selfAlarmed |
| Methods |
|---|
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
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.L2AccessInterface |
|---|
| cleanupSAPsWithBadFdns, copyMoveSaps, copyMoveSapsWithSapList, findMcRingProtectedSaps, findMcRingProtectedSapsOnRing |
| Methods inherited from service.AccessInterface |
|---|
| findSitesFor, moveSapToAnotherService |