APIRef_tm_pem_policy_rules¶
mgmt/tm/pem/policy/rules
Adds, deletes, or replaces a set of the rules.
REST Endpoints
- Collection URI
/mgmt/tm/pem/policy/rules- Collection Methods
OPTIONS, GET- Resource URI
/mgmt/tm/pem/policy/rules/~resource id- Resource Methods
OPTIONS, GET, PUT, PATCH, DELETE, POST- Resource Natural Key
name, partition, subPath
Properties
| Name | Type | Default Value | Required | Access | Description |
|---|---|---|---|---|---|
appService |
string | optional | read/write | Specifies the application service that the object belongs to. | |
dscpMarkingDownlink |
string | 64 | optional | read/write | Specifies the action to modify the DSCP code in the downlink packets when the traffic flow matches the rule matching criteria. The range is 0 to 63, or pass-through. The default value is pass-through, indicating the DSCP code of the downlink packets will not be changed when the traffic flow matches the rule. |
dscpMarkingUplink |
string | 64 | optional | read/write | Specifies the action to modify the DSCP code in the uplink packets when the traffic flow matches the rule matching criteria. The range is 0 to 63, or pass-through. The default value is pass-through, indicating the DSCP code of the uplink packets will not be changed when the traffic flow matches the rule. |
gateStatus |
string | enabled | optional | read/write | Specifies, when set to enabled, that the traffic can pass through the system without being changed. Set disabled to drop traffic that this rule applies to. The default is enabled. |
intercept |
string | optional | read/write | Specifies the intercept endpoint name. | |
irule |
string | optional | read/write | Specifies the irules used for this pem rule. | |
l2MarkingDownlink |
string | 8 | optional | read/write | Sets Layer 2 Quality of Service level in the downlink packets for the traffic flow that matches a rule. Setting Layer 2 QoS level affects the packet delivery priority. The range is 0 to 7, or pass-through. The default value is pass-through, indicating the L2 QoS level of the packet will not be changed when the traffic flow matches the rule. |
l2MarkingUplink |
string | 8 | optional | read/write | Sets Layer 2 Quality of Service level in the uplink packets for the traffic flow that matches a rule. Setting Layer 2 QoS level affects the packet delivery priority. The range is 0 to 7, or pass-through. The default value is pass-through, indicating the L2 QoS level of the packet will not be changed when the traffic flow matches the rule. |
precedence |
integer | required | read/write | Specifies the precedence for the rule in relation to the other rules. The range is 1 to 4294967295 where 1 has the highest precedence. A rule with high precedence is evaluated at a high priority. It is mandatory to specify precedence when creating a rule in a policy. | |
qosRatePirDownlink |
string | optional | read/write | Specifies the configured bandwidth control policy to apply to the downlink traffic when the traffic flow matches this rule. | |
qosRatePirUplink |
string | optional | read/write | Specifies the configured bandwidth control policy to apply to the uplink traffic when the traffic flow matches this rule. | |
serviceChain |
string | optional | read/write | Specifies the service chain endpoint name. | |
tclFilter |
string | optional | read/write | Specifies the tcl expression which uses iRule commands to filter the packet. It is a match if tcl-filter returns TRUE/1 or nomatch if FALSE/0. All configured filters (flow-info-filters, classification-filters, URL-categorization-filters and tcl-filter) must match before rule actions are applied. | |
tcpAnalyticsEnable |
string | disabled | optional | read/write | Enable/Disable tcp analytics on flow matching the rule. |
tcpOptimizationDownlink |
string | optional | read/write | Specifies tcp optimization profile to apply to the downlink flow matching the rule. | |
tcpOptimizationUplink |
string | optional | read/write | Specifies tcp optimization profile to apply to the uplink flow matching the rule. |
Subcollections
| Name | Type | Default Value | Required | Access | Description |
|---|---|---|---|---|---|
flow-info-filters |
array_structure | optional | read/write | Specifies the flow info filter. |
Structures
| Name | Type | Default Value | Required | Access | Description |
|---|---|---|---|---|---|
/dtos-tethering |
array_structure | optional | read/write | ||
/dtos-tethering/dtos-detect |
string | disabled | optional | read/write | Specifies the device type & OS detection to be enabled or disabled. Default is disabled. |
/dtos-tethering/tethering-detect |
string | disabled | optional | read/write | Specifies the tethering detection to be enabled or disabled. Default is disabled. |
/dtos-tethering/report |
array_structure | optional | read/write | ||
/dtos-tethering/report/dest |
array_structure | optional | read/write | ||
/dtos-tethering/report/dest/hsl |
array_structure | optional | read/write | ||
/dtos-tethering/report/dest/hsl/format-script |
string | optional | read/write | Specifies the format-script used in dtos-tethering hsl reporting. | |
/dtos-tethering/report/dest/hsl/publisher |
string | optional | read/write | Specifies the publisher for dtos-tethering hsl reporting. | |
/dtos-tethering/report/dest/hsl/format-script |
string | optional | read/write | Specifies the format-script used in dtos-tethering hsl reporting. | |
/dtos-tethering/report/dest/hsl/publisher |
string | optional | read/write | Specifies the publisher for dtos-tethering hsl reporting. | |
/dtos-tethering/dtos-detect |
string | disabled | optional | read/write | Specifies the device type & OS detection to be enabled or disabled. Default is disabled. |
/dtos-tethering/tethering-detect |
string | disabled | optional | read/write | Specifies the tethering detection to be enabled or disabled. Default is disabled. |
/forwarding |
array_structure | optional | read/write | ||
/forwarding/endpoint |
string | optional | read/write | Specifies the forwarding action’s endpoint name. | |
/forwarding/fallback-action |
string | drop | optional | read/write | Specifies whether the connection should continue unchanged or should be dropped in the event the forwarding action fails for any reason. The options are: drop or continue, and the default is drop. |
/forwarding/icap-type |
string | none | optional | read/write | Defines the ICAP adaptation type: request only adaptation, request and response adaptation or both types of adaptations combined. |
/forwarding/internal-virtual |
string | optional | read/write | Specifies the internal virtual server field if the type chosen is icap. | |
/forwarding/type |
string | none | optional | read/write | Specifies the forwarding action type. The default value is None. It can take Route-To-Network if the traffic is to be forwarded to the network. If the service need to be forwarded to ICAP server it can set icap and if the forwarding is to a pool then choose pool. |
/forwarding/endpoint |
string | optional | read/write | Specifies the forwarding action’s endpoint name. | |
/forwarding/fallback-action |
string | drop | optional | read/write | Specifies whether the connection should continue unchanged or should be dropped in the event the forwarding action fails for any reason. The options are: drop or continue, and the default is drop. |
/forwarding/icap-type |
string | none | optional | read/write | Defines the ICAP adaptation type: request only adaptation, request and response adaptation or both types of adaptations combined. |
/forwarding/internal-virtual |
string | optional | read/write | Specifies the internal virtual server field if the type chosen is icap. | |
/forwarding/type |
string | none | optional | read/write | Specifies the forwarding action type. The default value is None. It can take Route-To-Network if the traffic is to be forwarded to the network. If the service need to be forwarded to ICAP server it can set icap and if the forwarding is to a pool then choose pool. |
/http-redirect |
array_structure | optional | read/write | ||
/http-redirect/fallback-action |
string | drop | optional | read/write | Specifies whether the connection should continue unchanged or should be dropped in the event the HTTP redirect action fails for any reason. The options are: drop or continue, where the default action is drop. |
/http-redirect/redirect-url |
string | optional | read/write | Specifies the HTTP redirection URL. | |
/http-redirect/fallback-action |
string | drop | optional | read/write | Specifies whether the connection should continue unchanged or should be dropped in the event the HTTP redirect action fails for any reason. The options are: drop or continue, where the default action is drop. |
/http-redirect/redirect-url |
string | optional | read/write | Specifies the HTTP redirection URL. | |
/insert-content |
array_structure | optional | read/write | ||
/insert-content/duration |
integer | optional | read/write | Specifies the periodicity of the insert action when the frequency is set to once-every. | |
/insert-content/frequency |
string | always | optional | read/write | Specifies the frequency of the application of the insert content action per subscriber. |
/insert-content/position |
string | append | optional | read/write | Specifies the position with respect to the tag name. |
/insert-content/tag-name |
string | optional | read/write | Specifies the tag in the html web page where the content is going to be inserted. | |
/insert-content/value-content |
string | optional | read/write | Specifies the value content to be inserted into the web page. | |
/insert-content/value-type |
string | string | optional | read/write | Specifies the type of content format used in the value-content field. |
/insert-content/duration |
integer | optional | read/write | Specifies the periodicity of the insert action when the frequency is set to once-every. | |
/insert-content/frequency |
string | always | optional | read/write | Specifies the frequency of the application of the insert content action per subscriber. |
/insert-content/position |
string | append | optional | read/write | Specifies the position with respect to the tag name. |
/insert-content/tag-name |
string | optional | read/write | Specifies the tag in the html web page where the content is going to be inserted. | |
/insert-content/value-content |
string | optional | read/write | Specifies the value content to be inserted into the web page. | |
/insert-content/value-type |
string | string | optional | read/write | Specifies the type of content format used in the value-content field. |
/modify-http-hdr |
array_structure | optional | read/write | ||
/modify-http-hdr/name |
string | optional | read/write | Specifies the HTTP header name used in the operation to modify the HTTP header. | |
/modify-http-hdr/operation |
string | none | optional | read/write | Specifies the operation used to modify the HTTP header. |
/modify-http-hdr/value-content |
string | optional | read/write | Specifies the HTTP header value content used in the operation to modify the HTTP header. | |
/modify-http-hdr/value-type |
string | string | optional | read/write | Specifies the type of content format used in the value-content field. |
/modify-http-hdr/name |
string | optional | read/write | Specifies the HTTP header name used in the operation to modify the HTTP header. | |
/modify-http-hdr/operation |
string | none | optional | read/write | Specifies the operation used to modify the HTTP header. |
/modify-http-hdr/value-content |
string | optional | read/write | Specifies the HTTP header value content used in the operation to modify the HTTP header. | |
/modify-http-hdr/value-type |
string | string | optional | read/write | Specifies the type of content format used in the value-content field. |
/qoe-reporting |
array_structure | optional | read/write | ||
/qoe-reporting/dest |
array_structure | optional | read/write | ||
/qoe-reporting/dest/hsl |
array_structure | optional | read/write | ||
/qoe-reporting/dest/hsl/format-script |
string | optional | read/write | Specifies the format script name to customize the usage record format. | |
/qoe-reporting/dest/hsl/publisher |
string | optional | read/write | Specifies the hsl publisher name. | |
/qoe-reporting/dest/hsl/format-script |
string | optional | read/write | Specifies the format script name to customize the usage record format. | |
/qoe-reporting/dest/hsl/publisher |
string | optional | read/write | Specifies the hsl publisher name. | |
/quota |
array_structure | optional | read/write | ||
/quota/rating-group |
string | optional | read/write | Specifies the rating-group name. | |
/quota/reporting-level |
string | rating-group | optional | read/write | Specifies the quota report granularity. |
/quota/rating-group |
string | optional | read/write | Specifies the rating-group name. | |
/quota/reporting-level |
string | rating-group | optional | read/write | Specifies the quota report granularity. |
/ran-congestion |
array_structure | optional | read/write | ||
/ran-congestion/detect |
string | disabled | optional | read/write | |
/ran-congestion/lowerthreshold-bw |
integer | 1000 | optional | read/write | |
/ran-congestion/report |
array_structure | optional | read/write | ||
/ran-congestion/report/dest |
array_structure | optional | read/write | ||
/ran-congestion/report/dest/hsl |
array_structure | optional | read/write | ||
/ran-congestion/report/dest/hsl/format-script |
string | optional | read/write | ||
/ran-congestion/report/dest/hsl/publisher |
string | optional | read/write | ||
/ran-congestion/report/dest/hsl/format-script |
string | optional | read/write | ||
/ran-congestion/report/dest/hsl/publisher |
string | optional | read/write | ||
/ran-congestion/detect |
string | disabled | optional | read/write | |
/ran-congestion/lowerthreshold-bw |
integer | 1000 | optional | read/write | |
/reporting |
array_structure | optional | read/write | ||
/reporting/granularity |
string | session | optional | read/write | Specifies the granularity of the report. The options are session, flow, and transaction. The default is session. |
/reporting/interval |
integer | optional | read/write | Specifies the reporting interval in seconds. | |
/reporting/dest |
array_structure | optional | read/write | ||
/reporting/dest/gx |
array_structure | optional | read/write | ||
/reporting/dest/gx/application-reporting |
string | disabled | optional | read/write | Specifies whether the application reporting is enabled. |
/reporting/dest/gx/monitoring-key |
string | optional | read/write | Specifies the gx monitoring-key. | |
/reporting/dest/gx/application-reporting |
string | disabled | optional | read/write | Specifies whether the application reporting is enabled. |
/reporting/dest/gx/monitoring-key |
string | optional | read/write | Specifies the gx monitoring-key. | |
/reporting/dest/hsl |
array_structure | optional | read/write | ||
/reporting/dest/hsl/flow-reporting-fields |
string | optional | read/write | Specifies the fields to customize the flow reporting format. | |
/reporting/dest/hsl/format-script |
string | optional | read/write | Specifies the format script name to customize the usage record format. | |
/reporting/dest/hsl/publisher |
string | optional | read/write | ||
/reporting/dest/hsl/session-reporting-fields |
string | optional | read/write | Specifies the fields to customize the session reporting format. | |
/reporting/dest/hsl/transaction-reporting-fields |
string | optional | read/write | Specifies the fields to customize the transaction reporting format. | |
/reporting/dest/hsl/flow-reporting-fields |
string | optional | read/write | Specifies the fields to customize the flow reporting format. | |
/reporting/dest/hsl/format-script |
string | optional | read/write | Specifies the format script name to customize the usage record format. | |
/reporting/dest/hsl/publisher |
string | optional | read/write | ||
/reporting/dest/hsl/session-reporting-fields |
string | optional | read/write | Specifies the fields to customize the session reporting format. | |
/reporting/dest/hsl/transaction-reporting-fields |
string | optional | read/write | Specifies the fields to customize the transaction reporting format. | |
/reporting/dest/radius-accounting |
array_structure | optional | read/write | ||
/reporting/dest/radius-accounting/radius-aaa-virtual |
string | optional | read/write | Specifies the radius-aaa virtual server. | |
/reporting/dest/radius-accounting/radius-aaa-virtual |
string | optional | read/write | Specifies the radius-aaa virtual server. | |
/reporting/dest/sd |
array_structure | optional | read/write | ||
/reporting/dest/sd/application-reporting |
string | disabled | optional | read/write | Specifies whether the application reporting is enabled. |
/reporting/dest/sd/monitoring-key |
string | optional | read/write | Specifies the sd monitoring-key. | |
/reporting/dest/sd/application-reporting |
string | disabled | optional | read/write | Specifies whether the application reporting is enabled. |
/reporting/dest/sd/monitoring-key |
string | optional | read/write | Specifies the sd monitoring-key. | |
/reporting/transaction |
array_structure | optional | read/write | ||
/reporting/transaction/http |
array_structure | optional | read/write | ||
/reporting/transaction/http/hostname-len |
integer | 0 | optional | read/write | Specifies the maximum HTTP hostname string length to include in the HTTP transaction report. The range is 0 to 65535 |
/reporting/transaction/http/uri-len |
integer | 256 | optional | read/write | Specifies the maximum HTTP URI string length to include in the HTTP transaction report. The range is 0 to 65535 |
/reporting/transaction/http/user-agent-len |
integer | 0 | optional | read/write | Specifies the maximum HTTP user agent string length to include in the HTTP transaction report. The range is 0 to 65535 |
/reporting/transaction/http/hostname-len |
integer | 0 | optional | read/write | Specifies the maximum HTTP hostname string length to include in the HTTP transaction report. The range is 0 to 65535 |
/reporting/transaction/http/uri-len |
integer | 256 | optional | read/write | Specifies the maximum HTTP URI string length to include in the HTTP transaction report. The range is 0 to 65535 |
/reporting/transaction/http/user-agent-len |
integer | 0 | optional | read/write | Specifies the maximum HTTP user agent string length to include in the HTTP transaction report. The range is 0 to 65535 |
/reporting/volume |
array_structure | optional | read/write | ||
/reporting/volume/downlink |
integer | optional | read/write | Specifies the threshold of downlink traffic in bytes when the report is generated. | |
/reporting/volume/total |
integer | optional | read/write | Specifies the threshold of total traffic in bytes when the report is generated. | |
/reporting/volume/uplink |
integer | optional | read/write | Specifies the threshold of uplink traffic in bytes when the report is generated. | |
/reporting/volume/downlink |
integer | optional | read/write | Specifies the threshold of downlink traffic in bytes when the report is generated. | |
/reporting/volume/total |
integer | optional | read/write | Specifies the threshold of total traffic in bytes when the report is generated. | |
/reporting/volume/uplink |
integer | optional | read/write | Specifies the threshold of uplink traffic in bytes when the report is generated. | |
/reporting/granularity |
string | session | optional | read/write | Specifies the granularity of the report. The options are session, flow, and transaction. The default is session. |
/reporting/interval |
integer | optional | read/write | Specifies the reporting interval in seconds. |
Array Structures
| Name | Type | Default Value | Required | Access | Description |
|---|---|---|---|---|---|
/classification-filters |
array_structure | optional | read/write | PEM classification filter | |
/classification-filters/app-service |
string | optional | read/write | The application service that the object belongs to. | |
/classification-filters/application |
string | optional | read/write | Specifies the name of the application where the rule applies to the traffic. The default value is none. | |
/classification-filters/category |
string | optional | read/write | Specifies the name of the category of applications where the rule applies to the traffic. The default value is none. | |
/classification-filters/operation |
string | match | optional | read/write | The options match and nomatch indicate the traffic flow must match or not match the condition specified in the classification filter. |
/url-categorization-filters |
array_structure | optional | read/write | PEM URL categorization filter | |
/url-categorization-filters/app-service |
string | optional | read/write | ||
/url-categorization-filters/operation |
string | match | optional | read/write | The options match and nomatch indicate the traffic flow must match or not match the condition specified in the URL categorization filter. |
/url-categorization-filters/url-category |
string | optional | read/write |
Copyright (c) 2016, F5 Networks Inc. All Rights Reserved.
The BIG-IP API Reference documentation contains community-contributed content. F5 does not monitor or control community code contributions. We make no guarantees or warranties regarding the available code, and it may contain errors, defects, bugs, inaccuracies, or security vulnerabilities. Your access to and use of any code available in the BIG-IP API reference guides is solely at your own risk.