Overview Package Class Deprecated Help

aapolicy
AppQosPolicy

Represents an instance of an Application QoS Policy. Configuration or deletion of the local definitions for Application QoS Policy objects must use generic.GenericObject.configureInstance for the AAGroupPolicy class.

public class AppQosPolicy

Stats:
aapolicy.BsxAppQosPolicyStats aapolicy.BsxHttpEnrichStats aapolicy.BsxHttpErrorRedirectStats aapolicy.BsxHttpRedirectStats aapolicy.HttpNotifStats

Properties
aaSubOperator Logical operator to be used in relation to subscriber to match against to resolve an AQP action.

type=aapolicy.AALogicalOperator
default=none
Displayed(tab/group)=Subscriber Operator (Match Criteria.AA Subscriber)
aapolicy.AppQosFlowAttrEntry-Set type=Children-Set
aapolicy.AppQosPolicyCharEntry-Set type=Children-Set
abandonTcpOptm optimization will be abandoned after identification concludes.

type=generic.EnabledDisabled
default=disabled
Displayed(tab/group)=Abandon TCP Optimization (Action)
adminState Administrative state for the Application QoS policy.

type=aapolicy.AAAdminState
default=outOfService
Displayed(tab/group)=Administrative State
appGroupName The appGroupName specifies the particular application group to match against to resolve to an AQP action. If set to an empty string, no match on application group is done. If an attempt is made to set this object to a string that does not match a application group name value from the ApplicationGroup class, an error is returned.

type=string
default=
Displayed(tab/group)=Application Group Name (Match Criteria.General Attributes/Application Group)
appGroupOperator Logical operator to be used in relation to appGroupName to match against to resolve an AQP action.

type=aapolicy.AALogicalOperator
default=none
Displayed(tab/group)=Application Group Operator (Match Criteria.General Attributes/Application Group)
applicationName The applicationName specifies the particular application to match against to resolve to an AQP action. If set to an empty string, no match on application is done. If an attempt is made to set this object to a string that does not match a application name from the Application class, an error is returned.

type=string
default=
Displayed(tab/group)=Application Name (Match Criteria.General Attributes/Application)
applicationOperator Logical operator to be used in relation to applicationName to match against to resolve an AQP action.

type=aapolicy.AALogicalOperator
default=none
Displayed(tab/group)=Application Operator (Match Criteria.General Attributes/Application)
bwLimitPolicerName The value of bwLimitPolicerName specifies flows matching this policy are to be policed using the template defined in Policer table. If more than one AQP entry refers to the same policer, the same policer instances will be used. If an attempt is made to set this object to a string that does not match a Policer name value from the Policer table, an 'inconsistentValue' error is returned.

type=string
default=
Displayed(tab/group)=Bandwidth Limit Policer (Action)
characteristicName Used as the custom X-Header field value in ICAP Request messages for flows matching this policy. If set to an empty string the X-Header field value will not be set. This is a pointer to AppQosPolicyCharEntry.

type=string
default=
Displayed(tab/group)=ASO Characteristic Name (Action/URL Filter)
chargingGroup The value of chargingGroup along with chargingGroupOperator specifies the charging group and operation to match against to resolve to an AQP action. An empty value specifies no match on the charging group to be done.

type=string
default=
Displayed(tab/group)=Charging Group (Match Criteria.General Attributes/Charging Group)
chargingGroupOperator The value of chargingGroupOperator specifies the operator to apply in relation to chargingGroup to match against to resolve an AQP action.

type=aapolicy.AALogicalOperator
default=none
Displayed(tab/group)=Charging Group Operator (Match Criteria.General Attributes/Charging Group)
dnsIpCachePolicy Specifies a DNS IP Cache. When a cache is specified, all traffic is examined as described in the tmnxBsxDnsIpCacheTable. An empty value specifies no DNS IP cache will be associated.

type=string
default=
Displayed(tab/group)=DNS IP Cache (Action)
drop The value of drop specifies that flows matching this policy are to be dropped.

type=boolean
default=false
Displayed(tab/group)=Drop (Action)
dscp The value of dscp specifies the DSCP name to match to resolve to an AQP action. An empty string will allow all DHCP values to match.

type=qos.DscpEnum
default=default
Displayed(tab/group)=DSCP (Match Criteria.General Attributes/DSCP)
dscpOperator Logical operator to be used in relation to dscp to match against to resolve an AQP action.

type=aapolicy.AALogicalOperator
default=none
Displayed(tab/group)=DSCP Operator (Match Criteria.General Attributes/DSCP)
dstAddr Specifies the destination address to match to resolve to an AQP action.

type=InetAddress
default=
Displayed(tab/group)=Address (Match Criteria.Source and Destination/Destination Address)
dstAddrLength Specifies the number of relevant bits of the destination address.

type=int
default=0
minimum=0
maximum=128
Displayed(tab/group)=Address Length (Match Criteria.Source and Destination/Destination Address)
dstAddrOperator Logical operator to be used in connection with the dstAddrType, dstAddr and dstAddrLength.

type=aapolicy.AALogicalOperator
default=none
Displayed(tab/group)=Address Operator (Match Criteria.Source and Destination/Destination Address)
dstAddrType Specifies the type of address contained in dstAddr. A value of 'unknown (0)' specifies that no matching is to be done to resolve to an AQP action.

type=rtr.InetAddressType
default=unknown
dstPfxList Specifies the prefix list to use when matching the destination address.

type=string
default=
Displayed(tab/group)=Prefix List (Match Criteria.Source and Destination/Destination Address)
dstPortHighValue Specifies the destination port high value if the dstPortValueType is range.

type=int
default=0
minimum=0
maximum=65535
Displayed(tab/group)=Port High Value (Match Criteria.Source and Destination/Destination Port)
dstPortListName Specifies the AA Port List to use when matching the TCP/UDP source and destination ports. Use the associated Select button to choose the required Port list.

type=string
default=
Displayed(tab/group)=Port List (Match Criteria.Source and Destination/Destination Port)
dstPortLowValue Specifies the destination port low value if the dstPortValueType is range.

type=int
default=0
minimum=0
maximum=65535
Displayed(tab/group)=Port Value/Low Value (Match Criteria.Source and Destination/Destination Port)
dstPortOperator Specifies the operator to apply in relation to the destination port value to match against to resolve to an application.

type=aapolicy.AALogicalOperator
default=none
Displayed(tab/group)=Port Operator (Match Criteria.Source and Destination/Destination Port)
dstPortValueType Specifies the destination port value type. It is either single value or value in a range.

type=aapolicy.AAPortValueType
default=single
Displayed(tab/group)=Port Value Type (Match Criteria.Source and Destination/Destination Port)
errorDrop Specifies if all errored frames (such as bad IP checksums, invalid tcp/udp port, etc.) should be dropped as the information cannot be trusted and a flow record cannot be reliably found.

type=generic.TruthValue
default=false
Displayed(tab/group)=Error Drop (Action)
esmSubscriberHost The value of subscriber host specifies the particular host to match against to resolve to an AQP action. If the subscriber does not exist in the NFM-P, no error is returned. Instead, no match will be done on the subscriber until the entry is populated. If set to an empty string, no match on subscriber is done.

type=string
default=
minimum=0
maximum=32
Displayed(tab/group)=ESM Subscriber Host (Match Criteria.AA Subscriber/ESM Subscriber Host)
flowCountPolicerName The value of flowCountPolicerName specifies flows matching this policy are to be policed using the template defined in Policer table. If more than one AQP entry refers to the same policer, the same policer instances will be used. If an attempt is made to set this object to a string that does not match a Policer name value from the Policer table, an 'inconsistentValue' error is returned.

type=string
default=
Displayed(tab/group)=Flow Count Limit Policer (Action)
flowRatePolicerName The value of flowRatePolicerName specifies flows matching this policy are to be policed using the template defined in Policer table. If more than one AQP entry refers to the same policer, the same policer instances will be used. If an attempt is made to set this object to a string that does not match a Policer name value from the Policer table, an 'inconsistentValue' error is returned.

type=string
default=
Displayed(tab/group)=Flow Rate Limit Policer (Action)
fragDrop Specifies the action to apply to IP fragments. none (0) - no action will be taken all (1) - all fragments will be dropped outOfOrder (2) - all out of order fragments will be dropped as its flow record cannot be found due to lack of TCP/UDP ports"

type=aapolicy.ActFragDrop
default=none
Displayed(tab/group)=Frag Drop (Action)
gtpFilterName Specifies a GTP filter. When a filter is specified, all traffic is examined as described in the tmnxBsxGtpFltrTable. An empty value specifies no GTP filter will be associated.

type=string
default=
Displayed(tab/group)=GTP Filter (Action)
httpEnrichName The value of httpEnrichName specifies the HTTP enrichment that will be applied as defined in the HttpEnrich. An empty value specifies no HTTP enrichment.

type=string
default=
Displayed(tab/group)=HTTP Enrichment (Action)
httpErrorRedirectName The value of httpErrorRedirectName specifies the HTTP error redirect that will be applied as defined in the HttpErrorRedirect. An empty value specifies no HTTP error redirect.

type=string
default=
Displayed(tab/group)=HTTP Error Redirect (Action)
httpNotifName The value of httpNotifName specifies the Application-Assurance Http Notification that will be applied as defined in the tmnxBsxHttpNotifTable. An empty value specifies no HTTP notification will occur.

type=string
default=
Displayed(tab/group)=HTTP Notification (Action)
httpRedirFlowType The value of httpRedirFlowType specifies the type of flow that will be redirected. A httpRedirectName must be specified if httpRedirFlowType has a value other than 0.

type=aapolicy.AqpHttpRedirFlowType
default=none
Displayed(tab/group)=Flow Type (Action/HTTP Redirect)
httpRedirectName The value of httpRedirectName specifies the HTTP redirect that will be applied as defined in the HttpRedirect. An empty value specifies no HTTP redirect. A httpRedirFlowType must have a value other than 0 if httpRedirectName is not an empty string.

type=string
default=
Displayed(tab/group)=HTTP Redirect (Action/HTTP Redirect)
ipProtocolNumber The value of ipProtocolNumber along with ipOperator specifies the IP protocol number to match to resolve to an AQP action.

type=acl.Protocol
default=ALL
minimum=-2
maximum=255
Displayed(tab/group)=IP Protocol Number (Match Criteria.General Attributes/IP Protocol)
ipProtocolNumberOperator The value of ipProtocolNumberOperator specifies the operator to apply in relation to ipProtocolNumber to match against to resolve an AQP action.

type=aapolicy.AALogicalOperator
default=none
Displayed(tab/group)=IP Protocol Operator (Match Criteria.General Attributes/IP Protocol)
mirrorSourcePointer A pointer to a mirror service.

type=Pointer
default=
Displayed(tab/group)=Mirror Service (Action/Mirror Source)
mirrorSrcAllInclusive Specifies that all flows matching the subscriber default policy will be mirrored until the protocol is identified. The mirrorSource must be set to a valid mirror.

type=boolean
default=false
Displayed(tab/group)=All Inclusive (Action/Mirror Source)
mpTcpProxyName Specifies the name of a Multi-Path TCP proxy.

DEPRECATED: 23.4 - No longer applicable to any supported nodes
type=string
default=
mpTcpSchedPlcyOvrd Specifies the Multi-Path TCP scheduling policy override for the traffic proxied using a Multi-Path TCP proxy

type=aapolicy.MpTcpSchedPolicy
default=none
Displayed(tab/group)=Multi-path TCP Scheduling Policy Override (Action/Multi-Path TCP Proxy)
overloadDrop Specifies if all traffic for which the system is unable to create a required flow record should be dropped.

type=generic.TruthValue
default=false
Displayed(tab/group)=Overload Drop (Action)
remarkDscpInProfile The value of remarkDscpInProfile specifies the DSCP name to use to remark in-profile flows that match this policy. An empty string value specifies no modification to the DSCP value.

type=qos.DscpEnum
default=default
Displayed(tab/group)=Remark DSCP In Profile (Action/Remark)
remarkDscpOutProfile The value of remarkDscpOutProfile specifies the DSCP name to use to remark out-of-profile flows that match this policy. An empty string value specifies no modification to the DSCP value.

type=qos.DscpEnum
default=default
Displayed(tab/group)=Remark DSCP Out Profile (Action/Remark)
remarkFc The value of remarkFc specifies the name of the forwarding class to use to remark flows that match this policy. An empty string value specifies no modification to the forwarding class.

type=qos.FcEnumOrDefault
default=
Displayed(tab/group)=Forwarding Class (Action/Remark)
remarkPriority The value of remarkPriority specifies the priority to use to remark flows that match this policy. A value of 'default' specifies no modification to the priority.

type=aapolicy.PriorityOrDefault
default=default
Displayed(tab/group)=Priority (Action/Remark)
sapSubscrPointer Pointer to the instance of service access point for subscriber.

type=Pointer
default=
Displayed(tab/group)=SAP Subscriber (Match Criteria.AA Subscriber/SAP Subscriber)
sctpFilterName Specifies a SCTP filter. When a filter is specified, all traffic is examined as described in the tmnxBsxSctpFltrTable. An empty value specifies no SCTP filter will be associated.

type=string
default=
Displayed(tab/group)=SCTP Filter (Action)
sessionFilter The value of sessionFilter specifies the Application-Assurance session filter that will be evaluated. An empty value specifies no session filters will be evaluated.

type=string
default=
Displayed(tab/group)=Session Filter (Action)
spokeSdpSubscrPointer Pointer to the instance of Spoke SDP Binding point for subscriber.

type=Pointer
default=
Displayed(tab/group)=Spoke SDP Binding Subscriber (Match Criteria.AA Subscriber/Spoke SDP Binding Subscriber)
srcAddr Specifies the source address to match to resolve to an AQP action.

type=InetAddress
default=
Displayed(tab/group)=Address (Match Criteria.Source and Destination/Source Address)
srcAddrLength Specifies the number of relevant bits of the source address.

type=int
default=0
minimum=0
maximum=128
Displayed(tab/group)=Address Length (Match Criteria.Source and Destination/Source Address)
srcAddrOperator Logical operator to be used in connection with the srcAddrType, srcAddr and srcAddrLength.

type=aapolicy.AALogicalOperator
default=none
Displayed(tab/group)=Address Operator (Match Criteria.Source and Destination/Source Address)
srcAddrType Specifies the type of address contained in srcAddr. A value of 'unknown (0)' specifies that no matching is to be done to resolve to an AQP action.

type=rtr.InetAddressType
default=unknown
srcPfxList Specifies the prefix list to use when matching the source address.

type=string
default=
Displayed(tab/group)=Prefix List (Match Criteria.Source and Destination/Source Address)
srcPortHighValue Specifies the source port high value if the srcPortValueType is range. application.

type=int
default=0
minimum=0
maximum=65535
Displayed(tab/group)=Port High Value (Match Criteria.Source and Destination/Source Port)
srcPortListName Specifies the AA Port List to use when matching the TCP/UDP source and destination ports. Use the associated Select button to choose the required Port list.

type=string
default=
Displayed(tab/group)=Port List (Match Criteria.Source and Destination/Source Port)
srcPortLowValue Specifies the source port low value if the srcPortValueType is range.

type=int
default=0
minimum=0
maximum=65535
Displayed(tab/group)=Port Value/Low Value (Match Criteria.Source and Destination/Source Port)
srcPortOperator Specifies the operator to apply in relation to the source port value to match against to resolve to an application.

type=aapolicy.AALogicalOperator
default=none
Displayed(tab/group)=Port Operator (Match Criteria.Source and Destination/Source Port)
srcPortValueType Specifies the source port value type. It is either single value or value in a range.

type=aapolicy.AAPortValueType
default=single
Displayed(tab/group)=Port Value Type (Match Criteria.Source and Destination/Source Port)
subCutThru The value of subCutThru specifies the action that will be applied to traffic which is cut-through in one or both directions of traffic flow based on the match criteria.

type=aapolicy.AqpActionType
default=allow
Displayed(tab/group)=Subscriber Cut Through (Action)
subTetherState The value of subTetherState specifies the tethering state of an Application Assurance Subscriber to match against to resolve an AQP action.

type=aapolicy.TetherState
default=notApplicable
Displayed(tab/group)=Subscriber Tether State (Match Criteria.AA Subscriber)
subscriber The value of subscriber specifies the particular subscriber to match against to resolve to an AQP action. If the subscriber does not exist in the NFM-P, no error is returned. Instead, no match will be done on the subscriber until the entry is populated. If set to an empty string, no match on subscriber is done.

type=string
default=
minimum=0
maximum=32
Displayed(tab/group)=ESM Subscriber (Match Criteria.AA Subscriber/ESM Subscriber)
subscriberType The type of the subscriber.

type=aapolicy.AASubsType
default=unknown
Displayed(tab/group)=SubscriberType (Match Criteria.AA Subscriber)

suppress enums=mobile (Where parent is one of (aapolicy.AAGroupPolicy))
tcpMaxSegSize "The value of tcpMaxSegSize specifies the intended value for the Maximum Segment Size (MSS) option in transmitted TCP headers containing the SYN flag. The value zero specifies that no MSS adjustment is performed. If the MSS option is present and its value is less than or equal to the value of tcpMaxSegSize, no MSS adjustment is performed. If the MSS option is present and its value is greater than the value of tcpMaxSegSize, the value of MSS is replaced with tcpMaxSegSize. If the MSS option is not present, one is inserted with a value of tcpMaxSegSize."

type=long
default=0
minimum=0
maximum=10240
Displayed(tab/group)=Value (Action/TCP Maximum Segment Size)
tcpValidationName Specifies specifies a TCP validation template. When a template is specified, all traffic is examined as described in the tmnxBsxTcpValTable. An empty value specifies no TCP validation will be performed.

type=string
default=
Displayed(tab/group)=TCP Validation (Action)
tlsEnrichName Specifies the enrichment template that will be applied as defined in HttpEnrich. An empty value specifies no TLS enrichment template.

type=string
default=
Displayed(tab/group)=TLS Enrichment (Action)
trafficDir The value of trafficDir specifies the traffic directions to match against to resolve to an AQP action. This allows different policer bandwidths to apply in each direction.

type=aapolicy.AADirection
default=both
Displayed(tab/group)=Traffic Direction (Match Criteria.General Attributes)
transitSubscriber The value of subscriber specifies the particular subscriber to match against to resolve to an AQP action. If the subscriber does not exist in the NFM-P, no error is returned. Instead, no match will be done on the subscriber until the entry is populated. If set to an empty string, no match on subscriber is done.

type=string
default=
minimum=0
maximum=32
Displayed(tab/group)=Transit Subscriber (Match Criteria.AA Subscriber/Transit Subscriber)
urlFilterName The value of urlFilterName specifies the Application-Assurance URL filter that will be evaluated. An empty value specifies no URL filters will be evaluated.

type=string
default=
Displayed(tab/group)=URL Filter (Action/URL Filter)
 
Overridden Properties
description Application QoS Policy description.

id Application QoS Policy identifier.

minimum=1
maximum=65535
 
Properties inherited from aapolicy.ApplicationAssurancePolicyItemDefinition
aaPolicyVersion, aaProfileId, groupId, partitionId
 
Properties inherited from policy.PolicyItemDefinition
containingPolicyDisplayedName, containingPolicyId
 
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
 
Supported Network Elements
7750 SR Supported from 10.0.R1 until 13.0.R8
  • Excluded chassis types: 7750-SR1, 7750-SRa4, 7750-SRa8, 7750 SR-1e, 7750 SR-2e, 7750 SR-3e, 7750-SR1 Fixed CFM, 7750 SR-14s, 7750 SR-7s, 7750 SR-1s, 7750 SR-2s
Supported from 13.0.R8 until 20.5.R1
  • Excluded chassis types: 7750-SR1, 7750-SRa4, 7750-SRa8, 7750-SR1 Fixed CFM, 7750 SR-14s, 7750 SR-7s, 7750 SR-1s, 7750 SR-2s
Supported from 20.5.R1
  • Excluded chassis types: 7750-SR1, 7750-SRa4, 7750-SRa8
7450 ESS Supported for all versions
  • Excluded chassis types: 7450-ESS1
7705 SAR Hm Supported from 23.10.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 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