msappolicy
Policy

Defines the MSAP policy configuration.



public class Policy

Properties
associatedMsaps Indicates the number of MSAPs associated with this MSAP policy

type=long
access=read-only
Displayed(tab/group)=Number of MSAPs Associated

atmOamAlarmCellHandling Specifies the administrative state of the OAM Alarm Cell handling

type=generic.EnabledDisabled
default=enabled
Displayed(tab/group)=ATM OAM Alarm Cell Handling (ATM)

dCpuProtectionPolicy The value of dCpuProtectionPolicy associates Distributed CPU Protection Policy with a MSAP policy.

type=string
default=
minimum=0
maximum=32
Displayed(tab/group)=NE DDoS Protection Policy (Security)

defInterDestId Specifies what will be used as the default intermediate destination identifier applicable on the MSAP. This value is used in case no other source (like Radius) provides an intermediate destination identifier. If the value of this object is set to 'useString', the value of defInterDestIdStr will be used as the default intermediate destination identifier. In this case, an empty msapPlcySubMgmtDefInterDestIdStr means that there is no default intermediate destination identifier configured. If the value of this object is set to 'useTopQTag', the top q-tag of the MSAP will be used as the default intermediate destination identifier. In this case, msapPlcySubMgmtDefInterDestIdStr must contain the empty string.

type=ressubscr.DefInterDestIdType
default=none
Displayed(tab/group)=Default Intermediate Destination ID Type (Subscriber Management)

defInterDestIdStr Specifies the default subscriber identification string applicable on this MSAP

type=string
default=
minimum=0
maximum=32
Displayed(tab/group)=Default Intermediate Destination ID (Subscriber Management)

defaultApplicationProfile Specifies the default application profile name applicable on the MSAP

type=string
default=
minimum=0
maximum=32
Displayed(tab/group)=Displayed Name (Subscriber Management/Default Application Profile)

defaultSlaProfile Pointer specifies the default SLA profile applicable on the SAP created using this MSAP policy

type=Pointer
default=
Displayed(tab/group)=Default SLA Profile (Subscriber Management/Policies)

defaultSubIdent Specifies the if value of subMgmtDefSubIdStr or SAP id is used for subscriber identification string if no other source provides it.

type=ressubscr.DefaultSubscriberIdType
default=none
Displayed(tab/group)=Default Subscriber Identification Type (Subscriber Management)

defaultSubIdentPolicy Pointer specifies the subscriber identification policy applicable on the SAP created using this MSAP policy

type=Pointer
default=
Displayed(tab/group)=Subscriber Identification Policy (Subscriber Management/Policies)

defaultSubIdentStr Specifies the default subscriber identification string that shall be used for residential subscribers that are created on an MSAP created using the policy

type=string
default=
minimum=0
maximum=32
Displayed(tab/group)=Default Subscriber ID (Subscriber Management)

defaultSubProfile Pointer specifies the default subscriber profile applicable on the SAP created using this MSAP policy

type=Pointer
default=
Displayed(tab/group)=Default Subscriber Profile (Subscriber Management/Policies)

dosProtectionMonitorIP Specifies IP Src monitoring

type=boolean
default=false
Displayed(tab/group)=IP Src Monitoring (Security/NE DoS Protection)

dosProtectionMonitorMac Specifies MAC monitoring

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

dosProtectionPolicyPointer Pointer specifies the DoS Protection Policy that's applicable to this interface.

type=Pointer
default=NE DoS Protection:254
Displayed(tab/group)=NE DoS Protection Policy (Security/NE DoS Protection)

egressAtmPolicyId

type=long
access=read-only
default=1

egressAtmPolicyPointer Pointer to the Egress ATM QoS Policy object (Egress Traffic Descriptor).

type=Pointer
default=ATM QoS Policy:1
Displayed(tab/group)=Egress ATM Policy (ATM)

igmpTrkExpiryTime Specifies time that the system continues to track inactive hosts.

type=int
default=0
minimum=0
maximum=65535
units=seconds
Displayed(tab/group)=Expiry Time (IGMP Host Tracking)

igmpTrkImportPlcy Specifies the policy statement that is applied to all incoming IGMP messages on the MSAP.

type=string
default=
minimum=0
maximum=32
Displayed(tab/group)=Import Policy (IGMP Host Tracking)

igmpTrkMaxNbrGrpSrcs Specifies how many group source addresses are allowed per group address for this SAP.

type=int
default=0
minimum=0
maximum=32000
Displayed(tab/group)=Maximum Number of Group Sources (IGMP Host Tracking)

igmpTrkMaxNbrGrps Specifies how many multicast groups are allowed to be tracked. Number (0..1000) is valid for pre-11.0.R1 NE versions. Number (0..16000) is valid for NE 11.0.R1 version and onwards.

type=int
default=0
minimum=0
maximum=16000
Displayed(tab/group)=Maximum Number of Groups (IGMP Host Tracking)

igmpTrkMaxNbrSrcs Specifies how many multicast sources are allowed to be tracked per group.

type=int
default=0
minimum=0
maximum=1000
Displayed(tab/group)=Maximum Number of Sources (IGMP Host Tracking)

ingressAtmPolicyId

type=long
access=read-only
default=1

ingressAtmPolicyPointer Pointer to the Ingress ATM QoS Policy object (Ingress Traffic Descriptor).

type=Pointer
default=ATM QoS Policy:1
Displayed(tab/group)=Ingress ATM Policy (ATM)

isSticky Specifies if the associated managed SAPs are sticky. The system does not remove a sticky managed SAP automatically. A sticky managed SAP is only removed upon explicit request of a management client.

type=boolean
default=false
Displayed(tab/group)=Sticky MSAPs

lagLinkMapProfile ID for a LAG Link Mapping Profile

type=int
default=0
minimum=0
maximum=32
Displayed(tab/group)=LAG Link Map Profile

msappolicy.L3MsapConfiguration-Set type=Children-Set
msappolicy.VplsMsapConfiguration-Set type=Children-Set
nonSubTrafficAppProfile Specifies the application profile name applicable on the MSAP for all non-subscriber traffic

type=string
default=
minimum=0
maximum=32
Displayed(tab/group)=Displayed Name (Subscriber Management/Non-Subscriber Traffic Application Profile)

nonSubTrafficSlaProfile Pointer specifies the SLA profile applicable on this SAP for all non-subscriber traffic

type=Pointer
default=
Displayed(tab/group)=Non-Subscriber Traffic SLA Profile (Subscriber Management/Single Subscriber Configuration)

nonSubTrafficSubIdent Specifies the subscriber identification applicable on this SAP for all non-subscriber traffic

type=string
default=
minimum=0
maximum=32
Displayed(tab/group)=Non-Subscriber Traffic Subscriber Identification (Subscriber Management/Single Subscriber Configuration)

nonSubTrafficSubProfile Pointer specifies the subscriber profile applicable on this SAP for all non-subscriber traffic

type=Pointer
default=
Displayed(tab/group)=Non-Subscriber Traffic Subscriber Profile (Subscriber Management/Single Subscriber Configuration)

periodicAtmOamLoopBack Specifies if the MSAP will run periodic OAM loopbacks

type=generic.EnabledDisabled
default=disabled
Displayed(tab/group)=Periodic ATM OAM Loopback (ATM)

profiledTrafficOnly Specifies whether only profiled traffic is applicable for this SAP

type=generic.TruthValue
default=false
Displayed(tab/group)=Profiled Traffic Only (Subscriber Management/Single Subscriber Configuration)

subscriberLimit Specifies the maximum number of subscribers allowed for this SAP. If the value is 0, there is no limit. Only if the value is 1, the properties "profiledTrafficOnly", "nonSubTrafficIdent", "nonSubTrafficProfile", "nonSubTrafficSlaProfile" are meaningful

type=long
default=1
minimum=0
maximum=131071
Displayed(tab/group)=Subscriber Limit (Subscriber Management)

 
Overridden Properties
description

displayedName Unique MSAP policy name

access=read-create
minimum=1
maximum=32

 
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

requestClearIdleOnlyMsaps

Request clearing of idle MSAPs using this local policy. When this method returns resources for the clear have been allocated but the clear has not been performed yet. To retrieve the result eventually, use the returned request handle as input param of the retrieveClearRequest method of the clear.ClearCommandManager.
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.
aInSiteId : string - Specifies the Network Element on which the MSAP Policy resides. This parameter must be set.
aInPolicyName : string - Specifies the MSAP Policy name. This parameter must be set.
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:
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.
Exceptions:
msappolicy.Policy.requestClearIdleOnlyMsapsException

requestClearMsaps

Request clearing of MSAPs using this local policy. When this method returns resources for the clear have been allocated but the clear has not been performed yet. To retrieve the result eventually, use the returned request handle as input param of the retrieveClearRequest method of the clear.ClearCommandManager.
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.
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
Output Parameters:
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 policy.PolicyDefinition
distribute, distributeUsingGroups, distributeV2, evaluatePolicy, findGlobal, findLocal, findReleased, getSyncTaskResult, resetToReleasedPolicy, setConfigurationModeToDraft, setConfigurationModeToReleased, setDistributionModeToLocalEditOnly, setDistributionModeToSyncWithGlobal, syncTo, syncToLocalWithResync
 
Supported Network Elements
7750 SR
7705 SAR Gen 2
7705 SAR Hm
7450 ESS
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 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