F5BigLogProfile Reference¶

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

spec.targetRefs¶

Provides the list of references to target resources that the logging profile should target.

Parameter	Description
`group`	Specifies the API group to which the referenced target resource belongs. The maximum length is 255. The default value is `gateway.networking.k8s.io`.
`name`	Specifies the name of the target resource. The maximum length is 255. Note: This is a required field
`kind`	The type of the target resource. The maximum length is 255. The default value is `GatewayClass`

spec.firewall¶

Parameter	Description
`enabled`	Enables logging of firewall event messages: true or false (default).
`flowspec.publisher`	Specifies the name of the log publisher to be used for the flowspec route injector log messages.

spec.firewall.ipIntelligence¶

Parameter	Description
`publisher`	Specifies the name of the log publisher used for IP Intelligence log messages.
`geo`	Enables logging of geo location in shun IP Intelligence event: true or false (default).
`rtbh`	Enables logging of Remote Triggered Black Hole (RTBH) IP Intelligence events: true or false (default).
`scrubber`	Enables logging of scrubber IP Intelligence events: true or false (default).
`shun`	Enables logging of shun IP Intelligence events: true or false (default).
`translation`	Enables logging of translated server side fields in IP Intelligence log messages. Translated fields include Source Address/Port, Destination Address/Port, IP Protocol, Route Domain and Vlan: true or false (default).
`aggregateRate`	Specifies the rate limit of all combined ipIntelligence log messages per second: 0 to 4294967295. The default is 4294967295.

spec.firewall.trafficStats¶

Parameter	Description
`activeFlows`	Enables logging the number of active flows on client side: true or false.
`reapedFlows`	Enables logging the number of reaped flows on client side: true or false (default).
`missedFlows`	Enables logging the number of TCP packets (non SYN/ACK) were dropped because of the flow table lookup failed: true or false (default).
`synCookies`	Enables logging the number of syncookies generated, accepted and rejected in the context globally and per virtual server. These log messages will be generated periodically: true or false (default).
`syncookiesWhitelist`	Enables logging the number of syncookies whitelist hits, accepted and rejected in the context globally and per virtual server. These log messages will be generated periodically: true or false (default).
`publisher`	Specifies the name of the log publisher to be used for trafficStats log messages.

spec.firewall.network¶

Parameter	Description
`publisher`	Specifies the name of the log publisher to be used for network log messages.
`aggregateRate`	Specifies the rate limit of all combined network log messages per second. Beyond this rate limit, log messages are not logged until the threshold drops below the specified rate: 0 to 4294967295. The default is 4294967295.
`events.aclMatchAccept`	Enables logging the packets that match ACL rules configured with action = Accept or action = Accept Decisively: true or false (default).
`events.aclMatchDrop`	Enables logging the packets that match ACL rules configured with action = Drop: true or false (default).
`events.aclMatchReject`	Enables logging the packets that match ACL rules configured with action = Reject: true or false (default).
`events.ipErrors`	Enables logging of IP error packets: true or false (default).
`events.tcpErrors`	Enables logging of TCP error packets: true or false (default).
`events.tcpEvents`	Enables logging of open and close of TCP sessions: true or false (default).
`events.translationFields`	Enables logging of translated server side fields in ACL match and TCP events. Translated fields include Source Address/Port, Destination Address/Port, IP Protocol, Route Domain and Vlan: true or false (default).
`events.userAlways`	Enables logging of certain subscriber information: true or false (default).
`events.geoAlways`	Enables logging the Geographic IP Location information fields in ACL match and TCP logging. Geographic information includes the country code of Source Address and Destination Address: true or false (default).
`events.uuidField`	Enables logging the ACL rule UUID field in ACL match and TCP logging. If the acl_rule_uuid field is explicitly specified in field-list or user-defined formats, UUID value will be logged regardless of state of this option: true or false (default).
`events.aclToBoxDeny`	Enables logging of any packet that is dropped or denied by management port firewall rules: true or false (default).
`ratelimit.aclMatchAccept`	Specifies rate limits for the logging of packets that match ACL rules configured with action = Accept or action = Accept Decisively. This option is effective only if logging of this message type is enabled: 0 to 4294967295. The default is 4294967295.
`ratelimit.aclMatchDrop`	Specifies rate limits for the logging of packets that match ACL rules configured with action = Drop. This option is effective only if logging of this message type is enabled: 0 to 4294967295. The default is 4294967295.
`ratelimit.aclMatchReject`	Trate limits for the logging of packets that match ACL rules configured with action = Reject. This option is effective only if logging of this message type is enabled: 0 to 4294967295. The default is 4294967295.
`ratelimit.ipErrors`	Specifies rate limits for the logging of IP error packets. This option is effective only if logging of this message type is enabled: 0 to 4294967295. The default is 4294967295.
`ratelimit.tcpErrors`	Specifies rate limits for the logging of TCP error packets. This option is effective only if logging of this message type is enabled: 0 to 4294967295. The default is 4294967295.
`ratelimit.tcpEvents`	Specifies rate limits for the logging of TCP events on client side. This option is effective only if logging of this message type is enabled: 0 to 4294967295. The default is 4294967295.
`format.type`	Specifies the format type for log messages. The available values are none (default), field-list or user-defined.
`format.networkFieldList.items`	Specifies a set of fields in a specific order for logging messages. This option is valid when storage format type is field-list. Refer to networkFieldList to view the list of its available fields.
`format.networkFieldList.delimiter`	Specifies the delimiter string when storage format type is field-list. Special character $ should not be used in delimiter string as it is reserved for internal usage. The default value is ,.
`format.userDefinedFieldList`	Specifies the format of log message as a user-defined string. This option is valid when storage format type is user-defined. Refer to userDefinedFieldList to view the list of its available fields.

spec.firewall.portMisuse¶

Parameter	Description
`publisher`	Specifies the name of the log publisher to be used for portMisuse log messages.
`aggregateRate`	Specifies the rate limit of all combined portMisuse log messages per second. Beyond this rate limit, log messages are not logged until the threshold drops below the specified rate. The default value is 4294967295.