F5BigPePolicy Reference¶

The F5BigPePolicy Custom Resource (CR) configuration parameters. Each heading below represents the top-level parameter element. For example, to set the profile state, use spec.spec.

spec¶

Parameter	Description
`state`	Specifies the state of the F5BigPePolicy: Enabled (default) or Disabled.

spec.rule¶

Parameter	Description
`name`	Specifies the name of the F5BigPePolicy rule. A policy can contain multiple rules.
`precedence`	Specifies the precedence, or order for processing rules and actions: 1 to 1024.
`reportingProfile`	Specifies the F5BigLogProfile CR to reference by `metadata.name` parameter.
`publisher`	Specifies the F5BigLogHslpub CR to reference by `metadata.name` parameter.

spec.rule.action¶

Parameter	Description
`gate`	Specifies whether to allow (enabled) or deny (disabled) subscriber traffic that matches a PE rule: Enabled (default) or Disabled.
`tcpOptimizationUplink`	Specifies the F5BigTcpSetting CR applied to the uplink traffic that matches the rule.
`tcpOptimizationDownlink`	Specifies the F5BigTcpSetting CR applied to the downlink traffic that matches the rule.
`ratePacing.udp.enabled`	Enables UDP ratepacing: true or false (default).
`ratePacing.udp.sendBuffer`	Specifies the UDP send buffer size used to store the UDP packets when the maximum rate is exceeded: 0 to 4294967295. The default is 655350. UDP packets will be later transmitted when the rate of the flow allows. When the send buffer exceeds the specified value, UDP packet will be dropped.
`ratePacing.udp.maxRate`	Specifies the UDP max rate on a per flow basis: 0 (default) to 4294967295. A value of 0 disables rate limitation. When the maxRate 0 is called and some UDP packets are buffered in the send buffer, the packets will be output at the line rate and feature will be turned off.
`ratePacing.udp.debugUdpRatePacing`	Enables UDP rate pacing iRule logging: true or false (default).

spec.rule.filter.classification¶

_images/spk_warn.png Important: A F5BigClassificationprofile is required when using the classification feature.

Parameter	Description
`name`	Specifies the name of the classification.
`match`	Specifies a traffic matching criteria: match (default), or no-match.
`category`	Specifies the type of traffic: any (default), Web, Audio_Video, Encrypted, File_Download_Servers, Search_Engines, Network_Management_and_Services, News_and_Media, and Advertisements.
`application`	Specifies the application type: any (default), amazon, apple, tcp, udp, http, ssl, youtube, google, ftp, cnn, and amazon_adv.

spec.rule.filter.flow¶

This parameter set detects application traffic by specific source and destination IP addresses and ports, and also DSCP values.

Parameter	Description
`name`	Specifies the name of the flow filter.
`match`	Specifies a traffic matching criteria: match (default), or no-match.
`dscp`	Specifies the DSCP value for matching subscriber traffic: 0 (default) to 63.
`ecnDetection`	Enables ECN Detection, matching traffic with congestion encountered CE: true or false (default).
`protocol`	Specifies the protocol type for matching subscriber traffic: any (default), tcp, or udp.
`ipType`	Specifies the IP protocol type for matching subscriber traffic: any (default), ipv4, or ipv6.
`sourceVlan`	Specifies the source vlan for matching subscriber traffic. The default is any.
`sourceAddress`	Specifies the source IP address for matching subscriber traffic. The default is 0.0.0.0/0.
`sourcePort`	Specifies the source port for matching subscriber traffic. The default is 0.
`destinationAddress`	Specifies the destination IP address for matching subscriber traffic. The default is 0.0.0.0/0.
`destinationPort`	Specifies the destination port for matching subscriber traffic. The default is 0.

spec.rule.filter.url_catagorization¶

This parameter set detects application traffic by URL.

Parameter	Description
`name`	Specifies the name of the url_catagorization.
`match`	Specifies a traffic matching criteria: match (default), or no-match.
`category`	Specifies the URL category of the traffic. For example, adult or business-and-economy. The default is any. For a full list of categories, refer to F5BigPePolicy URL Categories.