aapolicy
ApplicationFilter

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



public class ApplicationFilter

Stats:
aapolicy.BsxAaAppFilterStats

Properties
aapolicy.ApplicationFilterExpression-Set type=Children-Set
adminState Administrative state for the Application Filter policy.

type=aapolicy.AAAdminState
default=outOfService
Displayed(tab/group)=Administrative State

applicationName The displayed name for the Application which this Application Filter resolves to.

type=string
default=Unknown
minimum=1
maximum=32
Displayed(tab/group)=Application (Application)

applicationPointer The FDN for the Application defined with this Application Filter.

type=Pointer
access=read-only
default=

customProtocolName The name for the Application Assurance Custom Protocol that is used. The protocolName and customProtocolName are mutual exclusive, both can not set at the same time.

type=string
default=
Displayed(tab/group)=Custom Protocol (General Properties/Protocol)

dnsIpCacheName Specifies the DNS IP Cache to use when matching the server IP address to resolve to an application.

type=string
default=
Displayed(tab/group)=DNS IP Cache (General Properties/Server)

flowSetupDir Specifies the flow set-up direction.

type=aapolicy.AADirection
default=both
Displayed(tab/group)=Flow Set-up Direction (General Properties)

httpMatchAllReq

type=generic.EnabledDisabled
default=disabled
Displayed(tab/group)=HTTP Match All Requests (General Properties)

httpPort Specifies the low HTTP port number to match to resolve to an application, if the httpPortValueType is range.

type=int
default=0
minimum=0
maximum=65535
Displayed(tab/group)=HTTP Port/Low Value (General Properties/HTTP Port)

httpPortListName Specifies the AA Port List to use when matching the HTTP ports. Use the associated Select button to choose the required Port list.

type=string
default=
Displayed(tab/group)=HTTP Port List (General Properties/HTTP Port)

httpPortOperator Specifies the operator to apply in relation to the HTTP port to match against to resolve to an application.

type=aapolicy.AANumericalOperator
default=none
Displayed(tab/group)=HTTP Port Operator (General Properties/HTTP Port)

httpPortValueType Specifies the HTTP port value type. It is either single value or value in a range.

type=aapolicy.AAPortValueType
default=single
Displayed(tab/group)=HTTP Port Value Type (General Properties/HTTP Port)

ipProtocolNumber Specifies the IP protocol number to match to resolve to an application.

type=acl.Protocol
default=ALL
minimum=-2
maximum=255
Displayed(tab/group)=IP Protocol Number (General Properties/ IP Protocol)

ipProtocolNumberOperator Logical operator to be used in connection with the Network Address.

type=aapolicy.AALogicalOperator
default=none
Displayed(tab/group)=IP Protocol Operator (General Properties/ IP Protocol)

maskedIpAddr Specifies the masked IP address to match to resolve to an application

type=InetAddress
default=
Displayed(tab/group)=Masked IP Address (General Properties/Server)

maskedIpAddrMask Specifies the mask (or relevant bits) to match maskedIpAddr.

type=InetAddress
default=
Displayed(tab/group)=Masked IP Address Mask (General Properties/Server)

maskedIpAddrType Specifies the type of the masked IP address

type=rtr.InetAddressType
default=unknown

networkAddr Specifies the network address to match to resolve to an application

type=InetAddress
default=
Displayed(tab/group)=Network Address (General Properties/Network)

networkAddrLength Specifies the number of relevant bits of the network address

type=int
default=0
minimum=0
maximum=128
Displayed(tab/group)=Network Address Mask (General Properties/Network)

networkAddrOperator Specifies the logical operator to apply in relation to networkAddrType, networkAddr, and networkAddrLen to match against to resolve to an application.

type=aapolicy.AALogicalOperator
default=none
Displayed(tab/group)=Network Address Operator (General Properties/Network)

networkAddrType Specifies the type of the network address

type=rtr.InetAddressType
default=unknown

networkPrefixListName Specifies the prefix list to use when matching the network address to resolve to an application

type=string
default=
Displayed(tab/group)=Network Prefix List (General Properties/Network)

prefixListName Specifies the prefix list to use when matching the server address to resolve to an application.

type=string
default=
Displayed(tab/group)=Prefix List (General Properties/Server)

protocolName The name for the Application Assurance Protocol that is used. The protocolName and customProtocolName are mutual exclusive, both can not set at the same time.

type=string
default=
Displayed(tab/group)=Protocol (General Properties/Protocol)

protocolOperator Logical operator to be used in connection with the Protocol property

type=aapolicy.AALogicalOperator
default=none
Displayed(tab/group)=Protocol Operator (General Properties/Protocol)

serverAddr Specifies the server address to match to resolve to an application.

type=InetAddress
default=
Displayed(tab/group)=Server Address (General Properties/Server)

serverAddrOperator Logical operator to be used in connection with the server address.

type=aapolicy.AALogicalOperator
default=none
Displayed(tab/group)=Server Address Operator (General Properties/Server)

serverAddrPrefixLength Specifies the number of relevant bits of the server address.

type=int
default=0
minimum=0
maximum=128
Displayed(tab/group)=Server Address Mask (General Properties/Server)

serverAddrType

type=rtr.InetAddressType
default=unknown

serverPort Specifies the server TCP or UDP port number to match to resolve to an application. Specifies the low server TCP or UDP port number to match to resolve to an application, if the srcPortValueType is range.

type=int
default=0
minimum=0
maximum=65535
Displayed(tab/group)=Server Port/Low Value (General Properties/Server Port)

serverPortFpp Specifies the packet policy to apply for flows that match the serverPort and serverPortOperator.

type=aapolicy.AAFirstPacketPolicyType
default=none
Displayed(tab/group)=Server Port First Packet Policy (General Properties/Server Port)

serverPortHighValue Specifies the server port high value if the serverPortValueType is range.

type=int
default=0
minimum=0
maximum=65535
Displayed(tab/group)=Server Port High Value (General Properties/Server Port)

serverPortListName 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)=Server Port List (General Properties/Server Port)

serverPortOperator Specifies the operator to apply in relation to the server TCP or UDP port to match against to resolve to an application.

type=aapolicy.AANumericalOperator
default=none
Displayed(tab/group)=Server Port Operator (General Properties/Server Port)

serverPortValueType Specifies the server port value type. It is either single value or value in a range.

type=aapolicy.AAPortValueType
default=single
Displayed(tab/group)=Server Port Value Type (General Properties/Server Port)

 
Overridden Properties
description

id Application Filter 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
 
Methods

renumId

Re-numbering the application filter entry ID.
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 -
aInAaGroupId : int -
aInAaPartId : int -
aInOldId : int -
aInNewId : int -
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Exceptions:
aapolicy.ApplicationFilter.renumIdException

renumIds

Renumbering the application filter entry IDs. Renumbering happens to all the application filter entries from the specified start ID to the max existing ID.
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 -
aInAaGroupId : int -
aInAaPartId : int -
aInStartId : int -
aInEndId : int - (Optional)
aInFactor : aapolicy.RenumIdFactorType -
aInFactorValue : int -
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
Exceptions:
aapolicy.ApplicationFilter.renumIdsException
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
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
7750 SR 20.0
7750 SR 21.0
7750 SR 22.0
7750 SR 23.0
7750 SR 24.0
7750 SR 25.0