| Overview | Package | Class | Deprecated | Help |
| Properties | |
|---|---|
| aarpPointer |
Specifies a pointer to the AARP Interface to be associated with this SAP.
type=Pointer default= |
| aarpServRefType |
type=aapolicy.AarpServRefTypeType default=none |
| accountingOn |
type=boolean default=true Displayed(tab/group)=Collect Accounting Statistics (Accounting) |
| accountingPolicyId |
type=long access=read-only default=0 |
| accountingPolicyName |
type=string access=read-only default= maximum=80 |
| accountingPolicyObjectPointer |
type=Pointer default= Displayed(tab/group)=Accounting Policy (Accounting) |
| aggregation |
type=int default=off Displayed(tab/group)=Aggregation (Schedulers) enums= 1: off - Off 2: on - On |
| aggregationSchedulerName |
type=string access=read-only default= maximum=80 |
| aggregationSchedulerObjectPointer |
type=Pointer default= Displayed(tab/group)=Aggregation Scheduler (Schedulers/Aggregation Scheduler) |
| alarmProfile |
DEPRECATED: 23.4 - No longer applicable to any supported nodes type=string access=read-only default= |
| atm.SapAtmConfiguration-Set |
type=Children-Set |
| ccagSnmpPortId |
This attribute will be set to the SNMP ID of the port this SAP
is pointing to is actually a CCAG Virtual Port. This will
facilitate the creation of Service Connectors and the
search for this specific type of Access Interfaces.
type=long access=read-only default=0 |
| dCpuProtectionPolicyPointer |
Pointer specifies the DDoS Protection Policy that's applicable to this interface.
type=Pointer default= |
| dependantOlcState |
type=generic.OLCStates access=read-only default=inService |
| dosProtection |
Pointer specifies the DoS Protection Policy that's applicable to this interface.
type=Pointer default=NE DoS Protection:254 |
| egressAggCIR |
Specifies the CIR of all egress queues for this SAP.
This cannot be modified from its default value on a SAP with egress scheduler mode being four-priority.
type=int default=-1 minimum=-1 maximum=400000000 units=kbps Displayed(tab/group)=Aggregate CIR (Schedulers/Egress Aggregate Rate Limit), Aggregate CIR (Schedulers/Egress Aggregate Rate Limit/Rate) |
| egressAggRateLUB |
Specifies whether to limit the unused bandwidth and allow a tighter control in allocation of bandwidth by
HQos.
type=boolean default=false Displayed(tab/group)=Limit Unused Bandwidth (Schedulers/Egress Aggregate Rate Limit) |
| egressAggRateLimit |
Specifies the maximum total rate of all egress queues for
this AccessInterface.
The value -1 means that there is no limit.
type=long default=-1 minimum=-1 maximum=100000000 units=kbps Displayed(tab/group)=Aggregate Rate Limit (Schedulers/Egress Aggregate Rate Limit), Aggregate Rate Limit (Schedulers/Egress Aggregate Rate Limit/Rate) |
| egressAggRateLimitCIR |
Specifies Aggregate Rate Limit CIR value on this site.
type=int default=0 minimum=0 maximum=100000000 units=kbps Displayed(tab/group)=Egress Aggregate Rate Limit CIR (Schedulers/Egress Aggregate Rate Limit) |
| egressAggRateLimitEnabled |
Specifies whether Aggregate Rate Limit is enabled on this site.
type=boolean default=false Displayed(tab/group)=Enable Aggregate Rate Limit (Schedulers/Egress Aggregate Rate Limit) |
| egressAggRateLimitPIR |
Specifies Aggregate Rate Limit PIR value on this site.
type=int default=-1 minimum=-1 maximum=10000000 units=kbps Displayed(tab/group)=Egress Aggregate Rate Limit PIR (Schedulers/Egress Aggregate Rate Limit) |
| egressAggregateFilterId |
type=long access=read-only default=0 minimum=0 maximum=65535 |
| egressAggregateFilterName |
type=string access=read-only default= minimum=0 maximum=32 |
| 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.
type=long access=read-only default=0 |
| egressCirPercent |
The administrative CIR percentage, in hundredths of a percent.
type=float default=0 minimum=0 maximum=100 units=% Displayed(tab/group)=CIR (Schedulers/Egress Aggregate Rate Limit/Percent Rate) |
| egressFilterId |
type=long access=read-only default=0 minimum=0 maximum=65535 |
| 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.
type=string access=read-only default= minimum=0 maximum=32 |
| egressFilterPointer |
type=Pointer default= Displayed(tab/group)=Egress Filter (ACL/IP Filter) |
| egressFilterType |
type=acl.FilterType access=read-only default=none |
| egressFrameBaseAccounting |
type=boolean default=false Displayed(tab/group)=Frame-Based Accounting (Schedulers/Egress Aggregate Rate Limit) |
| egressIpFilterId |
type=long access=read-only default=0 minimum=0 maximum=65535 |
| egressIpv6FilterId |
type=long access=read-only default=0 minimum=0 maximum=65535 |
| 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.
type=string access=read-only default= minimum=0 maximum=32 |
| egressIpv6FilterPointer |
type=Pointer default= |
| egressMacFilterId |
type=long access=read-only default=0 minimum=0 maximum=65535 |
| egressPirPercent |
The administrative PIR percentage, in hundredths of a percent.
type=float default=100 minimum=0.01 maximum=100 units=% Displayed(tab/group)=PIR (Schedulers/Egress Aggregate Rate Limit/Percent Rate) |
| egressPolicerPolicyPointer |
Hierarchical Policing Policy applicable to this service
type=Pointer default= Displayed(tab/group)=Policer Control Policy (Schedulers/Egress Policer Control Policy) |
| egressPolicyId |
type=long access=read-only default=1 |
| 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.
type=string access=read-only default= maximum=80 |
| egressPolicyObjectPointer |
type=Pointer default=Access Egress:1 Displayed(tab/group)=Egress Policy (QoS) |
| egressPortQueueGroupPointer |
Specifies the egress access port queue-group policy pointer for this SAP.
type=Pointer default= Displayed(tab/group)=Egress Queue Group Template Policy (QoS/Port Redirect) |
| 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).
type=boolean default=false Displayed(tab/group)=Egress Mark QinQ Top Bits Only (QoS) |
| egressQueueAccountingOn |
type=boolean default=false Displayed(tab/group)=Collect Egress Queue Statistics (Accounting) |
| egressRedirectListQueueGroup |
specifies the queue-group redirect list applied to the egress SAP.
type=string default= Displayed(tab/group)=Egress Queue Group Template Policy (QoS/Egress SAP Queue Group Redirect List) |
| egressRemarkPolicyObjectPointer |
type=Pointer default=EgressRemarkPolicy7250SROS:default |
| egressRemarkingPolicyObjectPointer |
type=Pointer default=egressRemark:1 |
| egressSchedulerMode |
Specifies the mode that the egress scheduler is provisioned for this SAP to operate in.
All MDAs can support four-priority mode, but not all MDAs can support sixteen-priority mode.
type=service.SchedulerMode default=fourPriority Displayed(tab/group)=Scheduler Mode (Schedulers/Egress Scheduler) |
| egressSchedulerName |
type=string access=read-only default= maximum=80 |
| egressSchedulerObjectPointer |
type=Pointer default= Displayed(tab/group)=Egress Scheduler (Schedulers/Egress Scheduler) |
| egressShaperGrpName |
egressShaperGrpName is one of the shaper groups defined within the
shaper policy associated with the access egress port object aluExtPortEtherAccEgrShaper.
If aluExtPortEtherAccEgrShaper is a an empty string or aluSapEgressSchedulerMode of
the SAP is four-priority, egressShaperGrpName is set to empty string and it cannot be
modified.
type=string access=read-only minimum=1 maximum=32 |
| egressShaperGrpPointer |
egressShaperGrpPointer is one of the shaper groups full distinguished name defined within the
shaper policy associated with the access egress port object aluExtPortEtherAccEgrShaper.
If aluExtPortEtherAccEgrShaper is a an empty string or aluSapEgressSchedulerMode of
the SAP is four-priority, egressShaperGrpPointer is set to empty string and it cannot be
modified.
type=Pointer default= |
| egressVlanQosPolicyObjectPointer |
type=Pointer default=VlanQosPolicy7250SROS:default |
| hsEgrSecondaryShaper |
Specifies HS Egress Secondary Shaper applied to this SAP.
The value must correspond to HS Secondary Shaper policy on the port where this SAP resides.
If the empty string (default value) is specified, then the default secondary shaper will be used.
type=string default= Displayed(tab/group)=HS Secondary Shaper (QoS/HS Overrides) |
| hsmdaEgrQosPackByteOffOvrd |
Specifies the Packet Byte Offset of an hsmda egress policy for
this service.
The value -128 means that there is no override.
type=int default=-128 minimum=-128 maximum=31 Displayed(tab/group)=Packet Byte Offset (bytes) (QoS/Egress HSMDA Override) |
| hsmdaEgrQosWrrPlcyOvrd |
HSMDA WRR Policy is the Weighted Round Robin (WRR) policy
type=Pointer default= Displayed(tab/group)=WRR Policy (QoS/Egress HSMDA Override) |
| hsmdaEgrSecondaryShaper |
HSMDA Egress Secondary Shaper applicable to this service
type=string default= Displayed(tab/group)=Displayed Name (QoS/Egress HSMDA Override/Secondary Shaper) |
| ingressAggCIR |
Specifies the CIR of all ingress queues for this SAP.
This cannot be modified from its default value on a SAP with ingress scheduler mode being four-priority.
type=int default=-1 minimum=-1 maximum=10000000 units=kbps Displayed(tab/group)=Aggregate CIR (Schedulers/Ingress Aggregate Rate Limit) |
| ingressAggRateLimit |
Specifies the maximum total rate of all ingress queues for this SAP.
The value '-1' means that there is no limit.
type=int default=-1 minimum=-1 maximum=100000000 units=kbps Displayed(tab/group)=Aggregate Rate Limit (Schedulers/Ingress Aggregate Rate Limit) |
| ingressAggregateFilterId |
type=long access=read-only default=0 minimum=0 maximum=65535 |
| ingressAggregateFilterName |
type=string access=read-only default= minimum=0 maximum=32 |
| 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.
type=long access=read-only default=0 |
| ingressFilterId |
type=long access=read-only default=0 minimum=0 maximum=65535 |
| 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.
type=string access=read-only default= minimum=0 maximum=32 |
| ingressFilterPointer |
type=Pointer default= Displayed(tab/group)=Ingress Filter (ACL/IP Filter) |
| ingressFilterType |
type=acl.FilterType access=read-only default=none |
| ingressInstanceId |
Specifies the instance id of the forwarding-plane queue group instance for this SAP.
For L3 when changing the port the SAP will retain the original instance id
selected unless explicitly changed.
type=long default=0 minimum=0 maximum=65535 Displayed(tab/group)=Instance ID (QoS/Forwarding Plane Redirect) |
| ingressIpFilterId |
type=long access=read-only default=0 minimum=0 maximum=65535 |
| ingressIpv6FilterId |
type=long access=read-only default=0 minimum=0 maximum=65535 |
| 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.
type=string access=read-only default= minimum=0 maximum=32 |
| ingressIpv6FilterPointer |
type=Pointer default= |
| ingressMacFilterId |
type=long access=read-only default=0 minimum=0 maximum=65535 |
| ingressMatchQinqDot1pBits |
type=rtr.MatchQinqDot1pBitsType default=none Displayed(tab/group)=Ingress Match QinQ Dot1P (QoS) |
| ingressPolicerAccountingOn |
type=boolean default=false Displayed(tab/group)=Collect Ingress Policer Statistics (Accounting) |
| ingressPolicerPolicyPointer |
Hierarchical Policing Policy applicable to this service
type=Pointer default= Displayed(tab/group)=Policer Control Policy (Schedulers/Ingress Policer Control Policy) |
| ingressPolicyId |
type=long access=read-only default=1 |
| 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.
type=string access=read-only default= maximum=80 |
| 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.
type=Pointer default=Access Ingress:1 Displayed(tab/group)=Ingress Policy (QoS) |
| ingressQueueGroupName |
Specifies the forwarding-plane queue group instance for this SAP.
For L3 when changing the port the SAP will retain the original forwarding-plane queue group
instance selected unless explicitly changed.
type=string default= Displayed(tab/group)=Ingress Queue Group Template Policy (QoS/Forwarding Plane Redirect) |
| ingressRedirectListQueueGroup |
specifies the queue-group redirect list applied to the ingress SAP.
type=string default= Displayed(tab/group)=Ingress Queue Group Template Policy (QoS/Ingress SAP Queue Group Redirect List) |
| ingressSchedulerMode |
Specifies the mode that the ingress scheduler is provisioned for this SAP to operate in.
All MDAs can support four-priority mode, but not all MDAs can support sixteen-priority mode.
type=service.SchedulerMode default=fourPriority Displayed(tab/group)=Scheduler Mode (Schedulers/Ingress Scheduler) |
| ingressSchedulerName |
type=string access=read-only default= maximum=80 |
| ingressSchedulerObjectPointer |
type=Pointer default= Displayed(tab/group)=Ingress Scheduler (Schedulers/Ingress Scheduler) |
| ingressShaperGrpName |
ingressShaperGrpName is one of the shaper groups defined within the
shaper policy associated with the access ingress MDA object aluExtTmnxMDAAccessIngShaperPolicy.
If aluExtTmnxMDAAccessIngShaperPolicy of the MDA is a an empty string or aluSapIngressSchedulerMode
of the SAP is four-priority, aluSapIngressShaperGroup is set to empty string and it cannot be
modified.
type=string access=read-only minimum=1 maximum=32 |
| ingressShaperGrpPointer |
ingressShaperGrpPointer is one of the shaper groups defined within the
shaper policy associated with the access ingress MDA object aluExtTmnxMDAAccessIngShaperPolicy.
If aluExtTmnxMDAAccessIngShaperPolicy of the MDA is a an empty string or aluSapIngressSchedulerMode
of the SAP is four-priority, aluSapIngressShaperGroup is set to empty string and it cannot be
modified.
type=Pointer default= |
| lockOlcState |
This is used to lock the OLC State while in OLC Maintenance State only.
type=boolean default=false Displayed(tab/group)=Lock OLC State (/OLC) |
| macLearnOptions |
The value of macLearnOptions applies to the
static hosts of the SAP.
When the 'singleMac' option is set, this system ensures that
there is at any time only a single MAC address per SAP, learned through ICMPv6.
When the 'dataTriggered' option is set, MAC learning is also triggered
by data packets, as opposed to only by subscriber control plane packets
such as DHCP or ARP.
A bit in this object can only be set for a SAP in a group interface,
type=service.SapStatHostMacLearnOptions default=0 |
| mirrorStatus |
type=long access=read-only default=disabled enums= 0: disabled 1: ingressEnabled 2: egressEnabled 3: bothEnabled |
| mprvlanId |
The VLAN ID assigned to this interface.
type=int default=0 minimum=2 maximum=4080 |
| olcState |
Object Life Cycle can be set using generic.GenericObject.updateUserObjectLifecycleStates().
type=generic.OLCStates access=read-only default=inService Displayed(tab/group)=Current OLC State (/OLC) |
| operationalFlags |
Specifies all the conditions that affect the operating status of this access interface.
type=service.SapOperFlags access=read-only Displayed(tab/group)=State Cause |
| pmonPolicy |
DEPRECATED: 23.4 - No longer applicable to any supported nodes type=Pointer default= |
| pmonPolicyId |
DEPRECATED: 23.4 - No longer applicable to any supported nodes type=int access=read-only |
| portDescription |
type=string access=read-only default= minimum=0 maximum=256 Displayed(tab/group)=Port Description (Port) |
| rateType |
type=service.RateType default=kbps Displayed(tab/group)=Rate Type (Schedulers/Egress Aggregate Rate Limit) |
| rowStatus |
This attribute is here to make Service SAP compatible with the 7250
SNMP framework that is requiring the creation to be done using CreateAndWait
instead of CreateAndGo.
DEPRECATED: 11.0 R1 - No longer supported by any NE types supported in SAM type=int access=read-only default=1 |
| sapEgressAggregateShaperRate |
type=int default=-1 minimum=-1 maximum=10000000 units=kbps |
| sapEgressStatsEnable |
type=boolean default=false Displayed(tab/group)=Enable Egress Forwarding (Accounting/7210 Specific) |
| sapEgressStatsPktsMode |
type=boolean default=false Displayed(tab/group)=Enable Egress Packets Forwarding (Accounting/7210 Specific) |
| sapEgressVlanQosPlcyPortRedirect |
The value of sapEgressVlanQosPlcyPortRedirect specifies whether port redirect is enabled with the vlan qos policy.
sapEgressVlanQosPlcyPortRedirect should always be set to true when scheduler mode is set to Vlan Qos in a lag which is associated to a sap.
type=generic.TruthValue default=false |
| sapIngressAggregateShaperRate |
type=int default=-1 minimum=-1 maximum=20000000 units=kbps |
| sapIngressCounterMode |
type=service.SapIngressCounterMode default=packet Displayed(tab/group)=Ingress Counter Mode (Accounting/7210 Specific) |
| sapIngressCounterType |
Specifies the type of statistics counters to be used for traffic received on SAP ingress.
When the In Out Profile Count option is selected, one counter counts the total in-profile packets or octets and one counter counts the total out-of-profile packets or octets.
When the Forward Drop Count option is selected, one counter counts the total forwarded packets or octets and one counter counts the total dropped packets or octets.
type=service.SapIngressCounterType default=inOutProfileCount Displayed(tab/group)=Ingress Counter Type (Accounting/7210 Specific) |
| sapIngressStatsEnable |
type=boolean default=false Displayed(tab/group)=Enable Ingress Forwarding (Accounting/7210 Specific) |
| scpPointer |
DEPRECATED: 9.0.R5 - OBSOLETE: Use service.AccessInterface.scpPointers instead. type=Pointer access=read-only default= |
| scpPointers |
type=Set (Pointer) access=read-only |
| serviceDescription |
type=string access=read-only default= minimum=0 maximum=80 Displayed(tab/group)=Service Description (/Service) |
| serviceId |
type=long access=read-only default=0 Displayed(tab/group)=Service ID (/Service) |
| 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.
DEPRECATED: 11.0 R1 - No longer supported by any NE types supported in SAM type=string access=read-only maximum=252 |
| serviceName |
type=string access=read-only default= minimum=0 maximum=64 Displayed(tab/group)=Service Name (/Service) |
| serviceType |
type=service.ServiceType access=read-only default=unknown |
| sharedPolicerPolicyObjectPointer |
type=Pointer |
| sharedQueueOn |
type=boolean default=false Displayed(tab/group)=Use Shared Queue (QoS/Shared Queue) |
| subscriberId |
type=long access=read-only default=1 Displayed(tab/group)=Customer ID (/Customer) |
| subscriberName |
type=string access=read-only default= maximum=255 Displayed(tab/group)=Customer Name (/Customer) |
| svcComponentId |
type=long access=read-only default=0 Displayed(tab/group)=SVC Mgr Service ID (/Service) |
| templateVersionPointer |
Pointer to the template if this object was created from a template.
type=Pointer default= Displayed(tab/group)=Associated Template (Template/Associated Template) |
| transitIpPolicyPointer |
Specifies a pointer to the transit IP policy to be associated with this SAP. The value must either
be "" indicating an invalid transit IP policy or the specified transit IP policy needs to exist
type=Pointer default= |
| transitPrefixPolicyPointer |
Specifies a pointer to the transit prefix policy to be associated with this SAP. The value must either
be "" indicating an invalid transit prefix policy or the specified transit prefix policy needs to exist
type=Pointer default= |
| vPortName |
"The value of sapEgressVirtualPort specifies the name of the virtual
port that is shaping and parenting on this service sap".
type=string default= Displayed(tab/group)=Virtual Port Name (Virtual Port Name/Egress Virtual Port Name) |
| 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 |
|---|
filter
: FilterHolder -
expandChildren
: 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
infoList
: List (generic.CommonManagedEntityInformation) -
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.
sourceSapFdn
: string -
destSiteFdn
: string -
continueOnFailure
: continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
destSapFdn
: string -
service.AccessInterface.moveSapToAnotherServiceException