| Overview | Package | Class | Deprecated | Help |
| 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 | |
|---|---|
| aaApplicationProfile |
Specifies the unique name of an application assurance's application profile.
access=read-only |
| accountingOn |
access=read-only default=false |
| accountingPolicyId | |
| accountingPolicyName | |
| accountingPolicyObjectPointer |
access=read-only |
| aggregation |
access=read-only |
| aggregationSchedulerName | |
| aggregationSchedulerObjectPointer |
access=read-only |
| antiSpoofing |
access=read-only |
| callingStationId |
access=read-only |
| description |
access=read-only |
| displayedName | |
| dosProtection |
Pointer specifies the DoS Protection Policy that's applicable to this interface.
access=read-only |
| egressAggRateLimit |
Specifies the maximum total rate of all egress queues for
this AccessInterface.
The value -1 means that there is no limit.
access=read-only |
| 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 |
access=read-only |
| egressFilterType | |
| egressFrameBaseAccounting |
access=read-only |
| 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 |
access=read-only |
| egressMacFilterId | |
| 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 |
access=read-only |
| 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).
access=read-only |
| egressSchedulerName | |
| egressSchedulerObjectPointer |
access=read-only |
| hostLockoutPolicyPointer |
Pointer to the host lockout Policy
access=read-only |
| hsmdaEgrSecondaryShaper |
HSMDA Egress Secondary Shaper applicable to this service
access=read-only |
| 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 |
access=read-only |
| 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 |
access=read-only |
| ingressMacFilterId | |
| ingressMatchQinqDot1pBits |
access=read-only |
| 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.
access=read-only |
| ingressSchedulerName | |
| ingressSchedulerObjectPointer |
access=read-only |
| innerEncapValue |
Provisioned inner encap value.
This value is propagated into: terminatedPortInnerEncapValue.
access=read-only |
| ipMonitoring |
access=read-only |
| macMonitoring |
access=read-only |
| 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.
access=read-only |
| 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 |
access=read-only default=true |
| 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.
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.
subscrIdent
: string - The subscriber ID used to determine the MSAP’s service ID
in the event the MSAP cannot be found in the NFM-P database
nodeId
: string - The site ID of the NE to query.
portName
: string - The port of the MSAP on which the subscriber is located.
The string should be set to a value in the ‘Port x/y/z’ format.
outerEncapValue
: int - The outer encapsulation of the MSAP on which the subscriber is located.
innerEncapValue
: int - The inner encapsulation of the MSAP on which the subscriber is located
isActive
: boolean - (Optional) The value "false" means that the MSAP exists in NFM-P database but not on NE.
timeout
: long - (Optional) (Optional)The number of milliseconds to wait before receiving the results.
If no results are received in the given time, the method returns.
shallowRetrieval
: boolean - (Optional) (Optional)If it is true, not all of the properties are retrieved for quick response
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
result
: generic.CommonManagedEntityInformation -
vprn.MSap.retrieveMsapException
| Methods inherited from vprn.ServiceAccessPoint |
|---|
| requestClearIgmpHostTracking |
| Methods inherited from service.AccessInterface |
|---|
| findSitesFor, moveSapToAnotherService |
| Supported Network Elements | |
|---|---|
| 7750 SR | |
| 7705 SAR Hm | |
| 7450 ESS |
Supported from 8.0.R1 until 10.0.R1
|
| 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 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 | |