aapolicy
AAUrlFilter

Represents an instance of URL Filter.



public class AAUrlFilter

Stats:
aapolicy.AAUrlFilterStats

Properties
aapolicy.AAIcapServer-Set type=Children-Set
aapolicy.AAUrlFltrWSClassOvrd-Set type=Children-Set
aapolicy.AAUrlList-Set type=Children-Set
aapolicy.UrlFltrWebServProfile-Set type=Children-Set
adminState Administrative state for the URL Filter policy.

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

applyFuncBehavior Specifies whether function-specific or common url-filter level behaviours are applied. This can be used to provide function specific feedback to users for blocked URLs. It dictates the default action, default action HTTP redirect, and HTTP redirect that will be applied for all URL filter function types (i.e. web-service, ICAP, or local filtering URL list).

type=generic.TruthValue
default=false
Displayed(tab/group)=Apply Specific Functional Behavior

defaultAction Default Action for the URL Filter policy.

type=aapolicy.AAUrlFilterDefaultAction
default=allow
Displayed(tab/group)=Default Action

groupId It represents a group of ISA MDAs and has a valid range from 1..255.

type=int
access=read-create
default=1
minimum=1
maximum=255
Displayed(tab/group)=ISA-AA Group ID (/Application Assurance Configuration)

httpRedirectName Specifies the HTTP redirect that will be applied.

type=string
default=
minimum=0
maximum=32
Displayed(tab/group)=Block HTTP Redirect Name

httpReqFilter Specifies the filtering of the URL of all or the first HTTP request in a TCP session.

type=aapolicy.HttpRequestFitlerType
default=all
Displayed(tab/group)=HTTP Request Filtering

icapCustXHeader Specifies the ICAP custom X-Header name used when emitting traffic.

type=string
default=
minimum=0
maximum=32
Displayed(tab/group)=Custom X-Header (/ICAP)

icapDefAction Specifies the default action to take when the ICAP server is out of service. A icapHttpRedirObj must be specified if icapDefAction has a value of 'blockHttpRedirect(1)'. This object can be changed when ICAP is configured (i.e. vlanId is not the default value).

type=aapolicy.AAUrlFilterDefaultAction
default=blockAll
Displayed(tab/group)=ICAP Default Action (/ICAP)

icapDefHttpRedir Specifies the HTTP redirect that will be applied. An empty value specifies no HTTP redirect. A icapDefAction must have a value of 'blockHttpRedirect(1)' if icapDefHttpRedir is not an empty string. This object can be changed when ICAP is configured (i.e. vlanId is not the default value).

type=string
default=
minimum=0
maximum=32
Displayed(tab/group)=ICAP Block HTTP Redirect Name (/ICAP)

icapHttpRedirObj Specifies the HTTP redirect that will be applied when the ICAP server blocks an HTTP request. An empty value specifies no HTTP redirect. This object can be changed when ICAP is configured (i.e. vlanId is not the default value).

type=string
default=
minimum=0
maximum=32
Displayed(tab/group)=ICAP HTTP Redirect Name (/ICAP)

icaphttpRedirectName Specifies the HTTP redirect that will be applied when the ICAP server blocks an HTTP request.

type=string
default=
minimum=0
maximum=32
Displayed(tab/group)=HTTP Redirect Name

operFlags This value indicates the different conditions that affect the operating status of the URL Filter.

type=aapolicy.UrlFilterOperFlags
access=read-only
Displayed(tab/group)=Operational Flags

operState This value indicates the operational state of the URL Filter.

type=netw.OperationalState
access=read-only
default=tmnxOutOfService
Displayed(tab/group)=Operational State

urlAllowList Specifies the local filtering URL allow-list name. An empty value specifies no URL allow-list.

type=string
default=
minimum=0
maximum=32
Displayed(tab/group)=Allow List (/Local Filtering)

vlanId VLAN Id on which the ISA-AA is expected to be emitting traffic.

type=int
default=0
minimum=0
maximum=4094
Displayed(tab/group)=VLAN ID (/ICAP)

webDefAction Specifies the default action to take when the web service is out of service. A webDefHttpRedir must be specified if icapDefAction has a value of 'blockHttpRedirect(1)'. This object can be changed when web service is configured (i.e. wsClassifyId is not the default value).

type=aapolicy.AAUrlFilterDefaultAction
default=blockAll
Displayed(tab/group)=Web Service Default Action (/Web Service)

webDefHttpRedir Specifies the HTTP redirect that will be applied. An empty value specifies no HTTP redirect. A webDefAction must have a value of 'blockHttpRedirect(1)' if webDefHttpRedir is not an empty string. This object can be changed when web service is configured (i.e. wsClassifyId is not the default value).

type=string
default=
minimum=0
maximum=32
Displayed(tab/group)=Web Service Block HTTP Redirect Name (/Web Service)

webSerHttpRedir Specifies the HTTP redirect that will be applied when the web service blocks an HTTP request. An empty value specifies no HTTP redirect. This object can be changed when web service is configured (i.e. wsClassifyId is not the default value).

type=string
default=
minimum=0
maximum=32
Displayed(tab/group)=Web Service HTTP Redirect Name (/Web Service)

wsCategorySetId Specifies the web service category set Id.

type=int
default=0
minimum=0
maximum=65535
Displayed(tab/group)=Category Set ID (/Web Service)

wsClassifyId Specifies the web service classifier Id.

type=aapolicy.WebServClassifierId
Displayed(tab/group)=Classify ID (/Web Service)

wsDefProfile Specifies the default web service profile, which should be one of the profiles specified in UrlFltrWebServProfile, or empty.

type=string
default=
minimum=0
maximum=32
Displayed(tab/group)=Default Profile (/Web Service)

wsDnsAddr Specifies the IP address of the DNS to use for resolving wsFqdn.

type=InetAddress
default=
Displayed(tab/group)=DNS Server Address (/Web Service)

wsDnsAddrType Specifies the type of address stored in wsDnsAddr.

type=rtr.InetAddressType
default=unknown

wsDnsOperFlags This value indicates the different conditions that affect the operating status of the URL Web Service DNS Server.

type=aapolicy.WebSvDnsOperFlags
access=read-only
Displayed(tab/group)=Operational Flags (/Web Service)

wsDnsOperState This value indicates the operational state of the URL Web Service DNS Server.

type=netw.OperationalState
access=read-only
default=tmnxOutOfService
Displayed(tab/group)=Operational State (/Web Service)

wsFqdn Specifies the web service fully qualified domain name.

type=string
default=
minimum=0
maximum=255
Displayed(tab/group)=FQDN (/Web Service)

wsVlanId Specifies the VLAN ID on which the ISA-AA is expected to be emitting traffic for web-service.

type=int
default=0
minimum=0
maximum=4094
Displayed(tab/group)=DNS VLAN ID (/Web Service)

 
Overridden Properties
description A user-provided description for a Filter.

displayedName URL Filter 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

resyncToUpdateOperStatus

Method to invoke resync AAUrlFilter to get most updated oper status.
Input Parameters:
siteId : string - Network Element site IP address.
groupId : long - The ISA-AA Group Index.
urlFilterName : string - AA URL Filter name.
continueOnFailure : continueOnFailure - (Optional) Continue processing requests in this stream if an exception occurs, unless the request is invalid. Default: false
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 Supported from 11.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 from 11.0.R4
  • 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