Enforcement_Policy (object)¶
Configures policies for the Policy Enforcement Manager (PEM)
Properties (* = required):
name | type(s) | default | allowed values | description |
---|---|---|---|---|
allTransactions | boolean | false | true, false | Specifies, when set to true, that the system enables policy enforcement for each http transaction. When set to false, the system allows only policy enforcement of the first http transaction. |
class* | string | “Enforcement_Policy” | ||
enable | boolean | true | true, false | Specifies the current status of the policy |
label | string | “^[^x00-x1fx22#&*<>?x5b-x5d`x7f]*$” | Optional friendly name for this object. Allows 0-64 chars, excluding a few likely to cause trouble with string searching, JS, TCL, or HTML | |
remark | string | “^[^x00-x1fx22x5cx7f]*$” | Arbitrary (brief) text pertaining to this object. Allows 0-64 chars, excluding only control characters, double-quote, and backslash. This is permissive enough that you should worry about XSS attacks | |
rules | array | Enforcement policy rules |
Enforcement_Rule (object)¶
A rule to match traffic flows and apply actions
Properties (* = required):
name | type(s) | default | allowed values | description |
---|---|---|---|---|
classificationFilters | array | Classification filters to apply to the traffic | ||
dscpMarkingDownlink | “pass-through” | Specifies whether to set DSCP bits in the IP header of outgoing traffic to the subscriber | ||
dscpMarkingUplink | “pass-through” | Specifies whether to set DSCP bits in the IP header of outgoing traffic to the network | ||
DTOSTethering | object | {} | Specifies options for device type, operating system, and tethering detection | |
flowInfoFilters | array | Flow information filters to apply to the traffic | ||
forwarding | object | Manages the forwarding action and its attributes | ||
gateStatusEnabled | boolean | true | true, false | Specifies, when set to true, that the traffic can pass through the system without being changed. Select false to drop traffic that this rule applies to. |
insertContent | object | Specifies the action to insert content into the webpage | ||
interceptionEndpoint | object | Reference to a interception endpoint | ||
iRule | object | Reference to a enforcement iRule | ||
l2MarkingDownlink | “pass-through” | Set Layer-2 Quality of Service Marking in downlink traffic that matches a rule. Setting a L2 QoS Marking affects the packet delivery priority. The range is 0 to 7, or pass-through. The default value is pass-through, indicating the L2 QoS Marking of the packet will not be changed when the packet matches the rule. | ||
l2MarkingUplink | “pass-through” | Set Layer-2 Quality of Service Marking in uplink traffic that matches a rule. Setting a L2 QoS marking affects the packet delivery priority. The range is 0 to 7, or pass-through. The default value is pass-through, indicating the L2 QoS Marking of the packet will not be changed when the packet matches the rule. | ||
modifyHttpHeader | object | Specifies the action to modify the HTTP header when the traffic flow matches the rule matching criteria | ||
name* | string | The name of the policy rule. | ||
precedence* | integer | 1 - 4294967295 | Specifies an integer that indicates the precedence for the rule in relation to the other rules. Number 1 has the highest precedence. Rules with higher precedence (lower numbers) are evaluated before other rules with lower precedence (higher numbers). | |
qoeReporting | object | Specifies report destination and format | ||
qosBandwidthControllerDownlink | object | Specifies a previously configured bandwidth control policy to apply to traffic that matches this rule | ||
qosBandwidthControllerUplink | object | Specifies a previously configured bandwidth control policy to apply to traffic that matches this rule | ||
quota | object | Specify quota management options | ||
ranCongestion | object | Detect congestion in the Radio Access Network | ||
serviceChain | object | Reference to a service chain endpoint | ||
tclFilter | string | Specifies the tcl expression which uses iRule commands to filter the packet. It is a match if tclFilter returns TRUE/1 or nomatch if FALSE/0. | ||
tcpAnalyticsEnabled | boolean | false | true, false | Specifies the action to enable tcp analytics when the traffic flow matches the rule matching criteria |
tcpOptimizationDownlink | object | Reference to a TCP profile | ||
tcpOptimizationUplink | object | Reference to a TCP profile | ||
urlCategorizationFilters | array | URL categorization filters to apply to the traffic | ||
usageReporting | object | Send reporting data concerning traffic affected by this rule to either an external analytics system or to a PCRF over a Gx interface |
Enforcement_Rule.DTOSTethering (object)¶
Specifies options for device type, operating system, and tethering detection
Default: {}
Properties (* = required):
name | type(s) | default | allowed values | description |
---|---|---|---|---|
detectDtos | boolean | false | true, false | Specifies the detection of the subscriber’s device and the operating system |
detectTethering | boolean | false | true, false | Specifies if you want to enable detection of tethering |
reportDestinationHsl | object | Specifies report destination and format |
Enforcement_Rule.DTOSTethering.reportDestinationHsl (object)¶
Specifies report destination and format
Properties (* = required):
name | type(s) | default | allowed values | description |
---|---|---|---|---|
formatScript | object | Reference to a format script | ||
highSpeedLogPublisher | object | Reference to a log publisher,Reference for a BIG-IP or Use object |
Enforcement_Rule.DTOSTethering.reportDestinationHsl.formatScript (object)¶
Reference to a format script
Properties (* = required):
name | type(s) | default | allowed values | description |
---|---|---|---|---|
bigip | string | “f5bigip” formatted string | Pathname of existing BIG-IP format script | |
use | string | AS3 pointer to format script declaration |
Enforcement_Rule.DTOSTethering.reportDestinationHsl.highSpeedLogPublisher (object)¶
Reference to a log publisher Reference for a BIG-IP or Use object
Properties (* = required):
name | type(s) | default | allowed values | description |
---|---|---|---|---|
bigip | “f5bigip” formatted string | |||
use |
Enforcement_Rule.forwarding (object)¶
Manages the forwarding action and its attributes
Properties (* = required):
name | type(s) | default | allowed values | description |
---|---|---|---|---|
/*/ | ||||
fallbackAction | string | “drop” | “continue”, “drop” | Specifies if the connection can remain unchanged or should be dropped if the forwarding action fails for any reason |
type* | string | “icap”, “endpoint”, “route-to-network”, “http” | Specifies the type of forwarding action |
Enforcement_Rule.insertContent (object)¶
Specifies the action to insert content into the webpage
Properties (* = required):
name | type(s) | default | allowed values | description |
---|---|---|---|---|
duration | integer | 1 - 4294967295 | Specifies the periodicity of the insert action in seconds | |
frequency | string | “always” | “always”, “once”, “once-every” | Specifies the number of content insertion actions per transaction |
position | string | “append” | “append”, “prepend” | Specifies position with respect to the configured tagName |
tagName | string | Specifies the tag name to which the content is either appended or prepended | ||
valueContent | string | Specifies the value content to be inserted into the webpage | ||
valueType | string | “string” | “string”, “tcl-snippet” | Specifies the type of content format used in the valueContent option |
Enforcement_Rule.interceptionEndpoint (object)¶
Reference to a interception endpoint
Properties (* = required):
name | type(s) | default | allowed values | description |
---|---|---|---|---|
bigip | string | “f5bigip” formatted string | Pathname of existing BIG-IP interception endpoint | |
use | string | AS3 pointer to interception endpoint declaration |
Enforcement_Rule.iRule (object)¶
Reference to a enforcement iRule
Properties (* = required):
name | type(s) | default | allowed values | description |
---|---|---|---|---|
bigip | string | “f5bigip” formatted string | Pathname of existing BIG-IP PEM iRule | |
use | string | AS3 pointer to enforcement iRule declaration |
Enforcement_Rule.modifyHttpHeader (object)¶
Specifies the action to modify the HTTP header when the traffic flow matches the rule matching criteria
Properties (* = required):
name | type(s) | default | allowed values | description |
---|---|---|---|---|
headerName* | string | Specifies the HTTP header name used by the operation option to modify the HTTP header | ||
operation* | string | “insert”, “remove” | Specifies the operation used to modify the HTTP header | |
valueContent | string | Specifies the HTTP header value content used by the insert operation to modify the HTTP header | ||
valueType | string | “string” | “string”, “tcl-snippet” | Specifies the type of content format used in the valueContent option |
Enforcement_Rule.qoeReporting (object)¶
Specifies report destination and format
Properties (* = required):
name | type(s) | default | allowed values | description |
---|---|---|---|---|
formatScript | object | Reference to a format script | ||
highSpeedLogPublisher | object | Reference to a log publisher,Reference for a BIG-IP or Use object |
Enforcement_Rule.qoeReporting.formatScript (object)¶
Reference to a format script
Properties (* = required):
name | type(s) | default | allowed values | description |
---|---|---|---|---|
bigip | string | “f5bigip” formatted string | Pathname of existing BIG-IP format script | |
use | string | AS3 pointer to format script declaration |
Enforcement_Rule.qoeReporting.highSpeedLogPublisher (object)¶
Reference to a log publisher Reference for a BIG-IP or Use object
Properties (* = required):
name | type(s) | default | allowed values | description |
---|---|---|---|---|
bigip | “f5bigip” formatted string | |||
use |
Enforcement_Rule.qosBandwidthControllerDownlink (object)¶
Specifies a previously configured bandwidth control policy to apply to traffic that matches this rule
Properties (* = required):
name | type(s) | default | allowed values | description |
---|---|---|---|---|
category | string | Specifies a category of traffic within the bandwidth control policy to which to apply the rule. This option provides more specific rate control to a certain type of traffic. The category must be defined in the selected bandwidth control policy. | ||
policy* | object | Reference to a bandwidth control policy |
Enforcement_Rule.qosBandwidthControllerDownlink.policy (object)¶
Reference to a bandwidth control policy
Properties (* = required):
name | type(s) | default | allowed values | description |
---|---|---|---|---|
bigip | string | “f5bigip” formatted string | Pathname of existing BIG-IP bandwidth control policy | |
use | string | AS3 pointer to bandwidth control policy declaration |
Enforcement_Rule.qosBandwidthControllerUplink (object)¶
Specifies a previously configured bandwidth control policy to apply to traffic that matches this rule
Properties (* = required):
name | type(s) | default | allowed values | description |
---|---|---|---|---|
category | string | Specifies a category of traffic within the bandwidth control policy to which to apply the rule. This option provides more specific rate control to a certain type of traffic. The category must be defined in the selected bandwidth control policy. | ||
policy* | object | Reference to a bandwidth control policy |
Enforcement_Rule.qosBandwidthControllerUplink.policy (object)¶
Reference to a bandwidth control policy
Properties (* = required):
name | type(s) | default | allowed values | description |
---|---|---|---|---|
bigip | string | “f5bigip” formatted string | Pathname of existing BIG-IP bandwidth control policy | |
use | string | AS3 pointer to bandwidth control policy declaration |
Enforcement_Rule.quota (object)¶
Specify quota management options
Properties (* = required):
name | type(s) | default | allowed values | description |
---|---|---|---|---|
ratingGroup | object | Reference to a quota rating group | ||
reportingLevel | string | “rating-group” | “rating-group”, “service-id” | Specifies the quota reporting level |
Enforcement_Rule.quota.ratingGroup (object)¶
Reference to a quota rating group
Properties (* = required):
name | type(s) | default | allowed values | description |
---|---|---|---|---|
bigip | string | “f5bigip” formatted string | Pathname of existing BIG-IP quota rating group |
Enforcement_Rule.ranCongestion (object)¶
Detect congestion in the Radio Access Network
Properties (* = required):
name | type(s) | default | allowed values | description |
---|---|---|---|---|
reportDestinationHsl | object | Specifies report destination and format | ||
threshold | integer | 1000 | 0 - 2147483647 | Specifies lower threshold bandwidth (in kbps) for a session to be marked as congested |
Enforcement_Rule.ranCongestion.reportDestinationHsl (object)¶
Specifies report destination and format
Properties (* = required):
name | type(s) | default | allowed values | description |
---|---|---|---|---|
formatScript | object | Reference to a format script | ||
highSpeedLogPublisher | object | Reference to a log publisher,Reference for a BIG-IP or Use object |
Enforcement_Rule.ranCongestion.reportDestinationHsl.formatScript (object)¶
Reference to a format script
Properties (* = required):
name | type(s) | default | allowed values | description |
---|---|---|---|---|
bigip | string | “f5bigip” formatted string | Pathname of existing BIG-IP format script | |
use | string | AS3 pointer to format script declaration |
Enforcement_Rule.ranCongestion.reportDestinationHsl.highSpeedLogPublisher (object)¶
Reference to a log publisher Reference for a BIG-IP or Use object
Properties (* = required):
name | type(s) | default | allowed values | description |
---|---|---|---|---|
bigip | “f5bigip” formatted string | |||
use |
Enforcement_Rule.serviceChain (object)¶
Reference to a service chain endpoint
Properties (* = required):
name | type(s) | default | allowed values | description |
---|---|---|---|---|
bigip | string | “f5bigip” formatted string | Pathname of existing BIG-IP service chain endpoint | |
use | string | AS3 pointer to service chain endpoint declaration |
Enforcement_Rule.tcpOptimizationDownlink (object)¶
Reference to a TCP profile
Properties (* = required):
name | type(s) | default | allowed values | description |
---|---|---|---|---|
bigip | string | “f5bigip” formatted string | Pathname of existing BIG-IP TCP profile | |
use | string | AS3 pointer to TCP profile declaration |
Enforcement_Rule.tcpOptimizationUplink (object)¶
Reference to a TCP profile
Properties (* = required):
name | type(s) | default | allowed values | description |
---|---|---|---|---|
bigip | string | “f5bigip” formatted string | Pathname of existing BIG-IP TCP profile | |
use | string | AS3 pointer to TCP profile declaration |
Enforcement_Rule.usageReporting (object)¶
Send reporting data concerning traffic affected by this rule to either an external analytics system or to a PCRF over a Gx interface
Properties (* = required):
name | type(s) | default | allowed values | description |
---|---|---|---|---|
/*/ | ||||
destination* | string | “gx”, “sd”, “hsl”, “radius-accounting” | Specifies where to send the usage monitoring data | |
granularity | string | “session” | “flow”, “session”, “transaction” | Specifies the type of reporting that will be generated when the policy applies |
interval | integer | 0 | 0 - ∞ | Specifies the time interval when the report will be generated, in seconds. A value of 0 indicates this feature is disabled. |
transaction | object | Specifies policy enforcement configuration on transaction report for each HTTP transaction | ||
volume | object | Configures volume threshold settings |
Enforcement_Rule.usageReporting.transaction (object)¶
Specifies policy enforcement configuration on transaction report for each HTTP transaction
Properties (* = required):
name | type(s) | default | allowed values | description |
---|---|---|---|---|
hostname | integer | 0 | 0 - 65535 | Specifies the maximum HTTP hostname string length option to include in the HTTP transaction report |
uri | integer | 256 | 0 - 65535 | Specifies the maximum HTTP URI string length option to include in the HTTP transaction report |
userAgent | integer | 0 | 0 - 65535 | Specifies the maximum HTTP user agent string length to include in the HTTP transaction report |
Enforcement_Rule.usageReporting.volume (object)¶
Configures volume threshold settings
Properties (* = required):
name | type(s) | default | allowed values | description |
---|---|---|---|---|
downlink | integer | 0 | 0 - ∞ | Send reporting data if the number of octets to the client exceeds the threshold. A value of 0 indicates this feature is disabled. |
total | integer | 0 | 0 - ∞ | Send reporting data if the total number of octets both to and from the client exceeds the threshold. A value of 0 indicates this feature is disabled. |
uplink | integer | 0 | 0 - ∞ | Send reporting data if the number of octets from the client exceeds the threshold. A value of 0 indicates this feature is disabled. |
Enforcement_Rule_Classification_Filter (object)¶
Defines the category or application (Layer 7) conditions that the traffic must meet (or not meet) for this enforcement policy rule to apply
Properties (* = required):
name | type(s) | default | allowed values | description |
---|---|---|---|---|
application | object | Reference to a application classification | ||
category | object | Reference to a category classification | ||
invertMatch | boolean | false | true, false | Specifies that a traffic flow should not match the condition |
name* | string | The name of the classification filter. |
Enforcement_Rule_Classification_Filter.application (object)¶
Reference to a application classification
Properties (* = required):
name | type(s) | default | allowed values | description |
---|---|---|---|---|
bigip | string | “f5bigip” formatted string | Pathname of existing BIG-IP application classification |
Enforcement_Rule_Classification_Filter.category (object)¶
Reference to a category classification
Properties (* = required):
name | type(s) | default | allowed values | description |
---|---|---|---|---|
bigip | string | “f5bigip” formatted string | Pathname of existing BIG-IP category classification |
Enforcement_Rule_DTOS_Tethering (object)¶
Specifies options for device type, operating system, and tethering detection
Properties (* = required):
name | type(s) | default | allowed values | description |
---|---|---|---|---|
detectDtos | boolean | false | true, false | Specifies the detection of the subscriber’s device and the operating system |
detectTethering | boolean | false | true, false | Specifies if you want to enable detection of tethering |
reportDestinationHsl | object | Specifies report destination and format |
Enforcement_Rule_DTOS_Tethering.reportDestinationHsl (object)¶
Specifies report destination and format
Properties (* = required):
name | type(s) | default | allowed values | description |
---|---|---|---|---|
formatScript | object | Reference to a format script | ||
highSpeedLogPublisher | object | Reference to a log publisher,Reference for a BIG-IP or Use object |
Enforcement_Rule_DTOS_Tethering.reportDestinationHsl.formatScript (object)¶
Reference to a format script
Properties (* = required):
name | type(s) | default | allowed values | description |
---|---|---|---|---|
bigip | string | “f5bigip” formatted string | Pathname of existing BIG-IP format script | |
use | string | AS3 pointer to format script declaration |
Enforcement_Rule_DTOS_Tethering.reportDestinationHsl.highSpeedLogPublisher (object)¶
Reference to a log publisher Reference for a BIG-IP or Use object
Properties (* = required):
name | type(s) | default | allowed values | description |
---|---|---|---|---|
bigip | “f5bigip” formatted string | |||
use |
Enforcement_Rule_Flow_Filter (object)¶
Defines the flow conditions (Layer 4) that the traffic must meet (or not meet) for this enforcement policy rule to apply
Properties (* = required):
name | type(s) | default | allowed values | description |
---|---|---|---|---|
destinationAddress | string | “0.0.0.0/0” | Matches traffic going to a destination address or network | |
destinationPort | integer | 0 | 0 - 65535 | Matches traffic headed to a destination port |
dscpMarking | “disabled” | Matches incoming traffic based on a value in the DSCP field in the IP header | ||
invertMatch | boolean | false | true, false | Specifies that a traffic flow should not match the condition |
ipAddressType | string | “any” | “any”, “ipv4”, “ipv6” | Specifies the IP address type that this rule applies to |
name* | string | The name of the flow filter. | ||
protocol | string | “any” | “any”, “tcp”, “udp” | Specifies the protocol of the traffic to which the rule applies |
sourceAddress | string | “0.0.0.0/32” | Matches traffic coming from a source address or network | |
sourcePort | integer | 0 | 0 - 65535 | Matches traffic coming from a source port |
sourceVlan | object | Matches incoming traffic from a VLAN,Reference to a VLAN |
Enforcement_Rule_Flow_Filter.sourceVlan (object)¶
Matches incoming traffic from a VLAN Reference to a VLAN
Properties (* = required):
name | type(s) | default | allowed values | description |
---|---|---|---|---|
bigip | string | “f5bigip” formatted string | Pathname of existing BIG-IP VLAN |
Enforcement_Rule_Forwarding (object)¶
Manages the forwarding action and its attributes
Properties (* = required):
name | type(s) | default | allowed values | description |
---|---|---|---|---|
/*/ | ||||
fallbackAction | string | “drop” | “continue”, “drop” | Specifies if the connection can remain unchanged or should be dropped if the forwarding action fails for any reason |
type* | string | “icap”, “endpoint”, “route-to-network”, “http” | Specifies the type of forwarding action |
Enforcement_Rule_Forwarding_Endpoint (object)¶
Specifies that the flow steers to a different destination
Properties (* = required):
name | type(s) | default | allowed values | description |
---|---|---|---|---|
/*/ | ||||
endpoint* | object | Reference to a forwarding endpoint |
Enforcement_Rule_Forwarding_Endpoint.endpoint (object)¶
Reference to a forwarding endpoint
Properties (* = required):
name | type(s) | default | allowed values | description |
---|---|---|---|---|
bigip | string | “f5bigip” formatted string | Pathname of existing BIG-IP forwarding endpoint | |
use | string | AS3 pointer to forwarding endpoint declaration |
Enforcement_Rule_Forwarding_HTTP (object)¶
Specifies that traffic affected by this rule should be redirected to the specified URL
Properties (* = required):
name | type(s) | default | allowed values | description |
---|---|---|---|---|
/*/ | ||||
redirectUrl* | string | Specifies that traffic affected by this rule should be redirected to the specified URL |
Enforcement_Rule_Forwarding_ICAP (object)¶
Specifies that the flow forwards to the ICAP virtual server
Properties (* = required):
name | type(s) | default | allowed values | description |
---|---|---|---|---|
/*/ | ||||
icapService* | object | ICAP service to route to,Reference to a service | ||
icapType* | string | “request”, “response”, “both” | Specifies the ICAP adaptation type |
Enforcement_Rule_Forwarding_ICAP.icapService (object)¶
ICAP service to route to Reference to a service
Properties (* = required):
name | type(s) | default | allowed values | description |
---|---|---|---|---|
bigip | string | “f5bigip” formatted string | Pathname of existing BIG-IP virtual server | |
use | string | AS3 pointer to service declaration |
Enforcement_Rule_Forwarding_Route_To_Network (object)¶
Specifies that the system forwards the flow to the default destination
Enforcement_Rule_Insert_Content (object)¶
Specifies the action to insert content into the webpage
Properties (* = required):
name | type(s) | default | allowed values | description |
---|---|---|---|---|
duration | integer | 1 - 4294967295 | Specifies the periodicity of the insert action in seconds | |
frequency | string | “always” | “always”, “once”, “once-every” | Specifies the number of content insertion actions per transaction |
position | string | “append” | “append”, “prepend” | Specifies position with respect to the configured tagName |
tagName | string | Specifies the tag name to which the content is either appended or prepended | ||
valueContent | string | Specifies the value content to be inserted into the webpage | ||
valueType | string | “string” | “string”, “tcl-snippet” | Specifies the type of content format used in the valueContent option |
Enforcement_Rule_Modify_HTTP_Header (object)¶
Specifies the action to modify the HTTP header when the traffic flow matches the rule matching criteria
Properties (* = required):
name | type(s) | default | allowed values | description |
---|---|---|---|---|
headerName* | string | Specifies the HTTP header name used by the operation option to modify the HTTP header | ||
operation* | string | “insert”, “remove” | Specifies the operation used to modify the HTTP header | |
valueContent | string | Specifies the HTTP header value content used by the insert operation to modify the HTTP header | ||
valueType | string | “string” | “string”, “tcl-snippet” | Specifies the type of content format used in the valueContent option |
Enforcement_Rule_QOS (object)¶
Specifies a previously configured bandwidth control policy to apply to traffic that matches this rule
Properties (* = required):
name | type(s) | default | allowed values | description |
---|---|---|---|---|
category | string | Specifies a category of traffic within the bandwidth control policy to which to apply the rule. This option provides more specific rate control to a certain type of traffic. The category must be defined in the selected bandwidth control policy. | ||
policy* | object | Reference to a bandwidth control policy |
Enforcement_Rule_QOS.policy (object)¶
Reference to a bandwidth control policy
Properties (* = required):
name | type(s) | default | allowed values | description |
---|---|---|---|---|
bigip | string | “f5bigip” formatted string | Pathname of existing BIG-IP bandwidth control policy | |
use | string | AS3 pointer to bandwidth control policy declaration |
Enforcement_Rule_Quota (object)¶
Specify quota management options
Properties (* = required):
name | type(s) | default | allowed values | description |
---|---|---|---|---|
ratingGroup | object | Reference to a quota rating group | ||
reportingLevel | string | “rating-group” | “rating-group”, “service-id” | Specifies the quota reporting level |
Enforcement_Rule_Quota.ratingGroup (object)¶
Reference to a quota rating group
Properties (* = required):
name | type(s) | default | allowed values | description |
---|---|---|---|---|
bigip | string | “f5bigip” formatted string | Pathname of existing BIG-IP quota rating group |
Enforcement_Rule_Ran_Congestion (object)¶
Detect congestion in the Radio Access Network
Properties (* = required):
name | type(s) | default | allowed values | description |
---|---|---|---|---|
reportDestinationHsl | object | Specifies report destination and format | ||
threshold | integer | 1000 | 0 - 2147483647 | Specifies lower threshold bandwidth (in kbps) for a session to be marked as congested |
Enforcement_Rule_Ran_Congestion.reportDestinationHsl (object)¶
Specifies report destination and format
Properties (* = required):
name | type(s) | default | allowed values | description |
---|---|---|---|---|
formatScript | object | Reference to a format script | ||
highSpeedLogPublisher | object | Reference to a log publisher,Reference for a BIG-IP or Use object |
Enforcement_Rule_Ran_Congestion.reportDestinationHsl.formatScript (object)¶
Reference to a format script
Properties (* = required):
name | type(s) | default | allowed values | description |
---|---|---|---|---|
bigip | string | “f5bigip” formatted string | Pathname of existing BIG-IP format script | |
use | string | AS3 pointer to format script declaration |
Enforcement_Rule_Ran_Congestion.reportDestinationHsl.highSpeedLogPublisher (object)¶
Reference to a log publisher Reference for a BIG-IP or Use object
Properties (* = required):
name | type(s) | default | allowed values | description |
---|---|---|---|---|
bigip | “f5bigip” formatted string | |||
use |
Enforcement_Rule_Report_Destination_HSL (object)¶
Specifies report destination and format
Properties (* = required):
name | type(s) | default | allowed values | description |
---|---|---|---|---|
formatScript | object | Reference to a format script | ||
highSpeedLogPublisher | object | Reference to a log publisher,Reference for a BIG-IP or Use object |
Enforcement_Rule_Report_Destination_HSL.formatScript (object)¶
Reference to a format script
Properties (* = required):
name | type(s) | default | allowed values | description |
---|---|---|---|---|
bigip | string | “f5bigip” formatted string | Pathname of existing BIG-IP format script | |
use | string | AS3 pointer to format script declaration |
Enforcement_Rule_Report_Destination_HSL.highSpeedLogPublisher (object)¶
Reference to a log publisher Reference for a BIG-IP or Use object
Properties (* = required):
name | type(s) | default | allowed values | description |
---|---|---|---|---|
bigip | “f5bigip” formatted string | |||
use |
Enforcement_Rule_URL_Categorization_Filter (object)¶
Defines the category of URL, which provides information about the content type requested by the subscriber
Properties (* = required):
name | type(s) | default | allowed values | description |
---|---|---|---|---|
category* | object | Specifies which type of URL category you want the rule to affect,Reference to a category classification | ||
invertMatch | boolean | false | true, false | Specifies that a traffic flow should not match the condition |
name* | string | The name of the URL categorization filter. |
Enforcement_Rule_URL_Categorization_Filter.category (object)¶
Specifies which type of URL category you want the rule to affect Reference to a category classification
Properties (* = required):
name | type(s) | default | allowed values | description |
---|---|---|---|---|
bigip | string | “f5bigip” formatted string | Pathname of existing BIG-IP category classification |
Enforcement_Rule_Usage_Gx (object)¶
Sends usage monitoring data to a PCRF over a Gx interface
Properties (* = required):
name | type(s) | default | allowed values | description |
---|---|---|---|---|
/*/ | ||||
applicationReportingEnabled | boolean | false | true, false | Report APPLICATION_START and APPLICATION_END Event-Triggers when the application start/stop is detected |
monitoringKey | string | Specifies a string to use for usage monitoring indicating the portion of traffic that is accounted for in this dynamic policy and charging control (PCC) rule |
Enforcement_Rule_Usage_Hsl (object)¶
Sends reporting data to remote HSL servers
Properties (* = required):
name | type(s) | default | allowed values | description |
---|---|---|---|---|
/*/ | ||||
flowReportingFields | array | Specifies the flow fields and their order based on which messages should be published | ||
formatScript | object | Reference to a format script | ||
publisher* | object | Reference to a log publisher,Reference for a BIG-IP or Use object | ||
sessionReportingFields | array | Specifies the session fields and their order based on which messages should be published | ||
transactionReportingFields | array | Specifies the transaction fields and their order based on which messages should be published |
Enforcement_Rule_Usage_Hsl.formatScript (object)¶
Reference to a format script
Properties (* = required):
name | type(s) | default | allowed values | description |
---|---|---|---|---|
bigip | string | “f5bigip” formatted string | Pathname of existing BIG-IP format script | |
use | string | AS3 pointer to format script declaration |
Enforcement_Rule_Usage_Hsl.publisher (object)¶
Reference to a log publisher Reference for a BIG-IP or Use object
Properties (* = required):
name | type(s) | default | allowed values | description |
---|---|---|---|---|
bigip | “f5bigip” formatted string | |||
use |
Enforcement_Rule_Usage_Radius (object)¶
Specifies a RADIUS internal virtual server as a reporting destination
Properties (* = required):
name | type(s) | default | allowed values | description |
---|---|---|---|---|
/*/ | ||||
radiusAAAService* | object | Reference to a service |
Enforcement_Rule_Usage_Radius.radiusAAAService (object)¶
Reference to a service
Properties (* = required):
name | type(s) | default | allowed values | description |
---|---|---|---|---|
bigip | string | “f5bigip” formatted string | Pathname of existing BIG-IP virtual server | |
use | string | AS3 pointer to service declaration |
Enforcement_Rule_Usage_Reporting (object)¶
Send reporting data concerning traffic affected by this rule to either an external analytics system or to a PCRF over a Gx interface
Properties (* = required):
name | type(s) | default | allowed values | description |
---|---|---|---|---|
/*/ | ||||
destination* | string | “gx”, “sd”, “hsl”, “radius-accounting” | Specifies where to send the usage monitoring data | |
granularity | string | “session” | “flow”, “session”, “transaction” | Specifies the type of reporting that will be generated when the policy applies |
interval | integer | 0 | 0 - ∞ | Specifies the time interval when the report will be generated, in seconds. A value of 0 indicates this feature is disabled. |
transaction | object | Specifies policy enforcement configuration on transaction report for each HTTP transaction | ||
volume | object | Configures volume threshold settings |
Enforcement_Rule_Usage_Reporting.transaction (object)¶
Specifies policy enforcement configuration on transaction report for each HTTP transaction
Properties (* = required):
name | type(s) | default | allowed values | description |
---|---|---|---|---|
hostname | integer | 0 | 0 - 65535 | Specifies the maximum HTTP hostname string length option to include in the HTTP transaction report |
uri | integer | 256 | 0 - 65535 | Specifies the maximum HTTP URI string length option to include in the HTTP transaction report |
userAgent | integer | 0 | 0 - 65535 | Specifies the maximum HTTP user agent string length to include in the HTTP transaction report |
Enforcement_Rule_Usage_Reporting.volume (object)¶
Configures volume threshold settings
Properties (* = required):
name | type(s) | default | allowed values | description |
---|---|---|---|---|
downlink | integer | 0 | 0 - ∞ | Send reporting data if the number of octets to the client exceeds the threshold. A value of 0 indicates this feature is disabled. |
total | integer | 0 | 0 - ∞ | Send reporting data if the total number of octets both to and from the client exceeds the threshold. A value of 0 indicates this feature is disabled. |
uplink | integer | 0 | 0 - ∞ | Send reporting data if the number of octets from the client exceeds the threshold. A value of 0 indicates this feature is disabled. |
Enforcement_Rule_Usage_Reporting_Transaction (object)¶
Specifies policy enforcement configuration on transaction report for each HTTP transaction
Properties (* = required):
name | type(s) | default | allowed values | description |
---|---|---|---|---|
hostname | integer | 0 | 0 - 65535 | Specifies the maximum HTTP hostname string length option to include in the HTTP transaction report |
uri | integer | 256 | 0 - 65535 | Specifies the maximum HTTP URI string length option to include in the HTTP transaction report |
userAgent | integer | 0 | 0 - 65535 | Specifies the maximum HTTP user agent string length to include in the HTTP transaction report |
Enforcement_Rule_Usage_Reporting_Volume (object)¶
Configures volume threshold settings
Properties (* = required):
name | type(s) | default | allowed values | description |
---|---|---|---|---|
downlink | integer | 0 | 0 - ∞ | Send reporting data if the number of octets to the client exceeds the threshold. A value of 0 indicates this feature is disabled. |
total | integer | 0 | 0 - ∞ | Send reporting data if the total number of octets both to and from the client exceeds the threshold. A value of 0 indicates this feature is disabled. |
uplink | integer | 0 | 0 - ∞ | Send reporting data if the number of octets from the client exceeds the threshold. A value of 0 indicates this feature is disabled. |
Enforcement_Rule_Usage_Sd (object)¶
Sends usage monitoring data to a PCRF over a Sd interface
Properties (* = required):
name | type(s) | default | allowed values | description |
---|---|---|---|---|
/*/ | ||||
applicationReportingEnabled | boolean | false | true, false | Report APPLICATION_START and APPLICATION_END Event-Triggers when the application start/stop is detected |
monitoringKey* | string | Specifies a string to use for usage monitoring indicating the portion of traffic that is accounted for in this dynamic policy and charging control (PCC) rule |