F5BigLogHslpub

Overview

Function

Declares a high-speed logging (HSL) publisher for a CNE instance, defining the logging pools, endpoints, and syslog and IPFIX destinations that receive log messages.

Names

Singular name	Plural name	Short name
f5-big-log-hslpub	f5-big-log-hslpubs	—

API group and version

k8s.f5net.com/v2

Scope

Namespace

Specification

spec

Field	Required	Default	Description
loadBalancingMethod string	No	ROUND_ROBIN	Load balancing mode used to distribute traffic across pool members. Accepted values: ROUND_ROBIN, RATIO_LEAST_CONN_MEMBER, RATIO_MEMBER, RATIO_SESSION.
pool array	No	[]	List of logging pools that receive log messages. Must contain no more than 64 items.
syslog array	No	[]	List of syslog configurations for logging destinations. Each pool value must match a name in spec.pool. Must contain no more than 64 items.
ipfix array	No	[]	List of IPFIX configurations for logging destinations. Each pool value must match a name in spec.pool. Must contain no more than 64 items.

spec.pool[]

Each pool must specify either endpoint or members, but not both.

Field	Required	Default	Description
name string	Yes	—	User-defined name for the HSL logging pool. Must be 1 to 255 characters.
minActiveMembers integer	No	0	Minimum number of members that must be available in one priority group. When the minimum isn’t met, the system selects the next priority group. Accepted values: 0 to 65535.
endpoint array	No	—	List of logging endpoints, each a valid IPv4 or IPv6 address with a port formatted as IP:PORT, for example 192.0.2.1:514 or [2001:db8::1]:514. Must contain at least one item.
members array	No	—	List of logging endpoints defined as address, port, and priority group. Must contain at least one item.
monitors object	No	{}	Monitors used to check pool members. Supports TCP and ICMP.

spec.pool[].members[]

Field	Required	Default	Description
address string	No	::	Address of the service to which the system sends log messages. Must be a valid IPv4 or IPv6 address. Must be 2 to 39 characters.
port integer	No	0	Port of the service to which the system sends log messages. Accepted values: 0 to 65535.
priorityGroup integer	No	0	Priority group that determines the order in which the system selects pool members. Accepted values: 0 to 8.

spec.pool[].monitors

Field	Required	Default	Description
icmp array	No	[]	List of ICMP monitors for the pool members.
tcp array	No	[]	List of TCP monitors for the pool members.

spec.pool[].monitors.icmp[]

Field	Required	Default	Description
interval integer	No	5	Frequency, in seconds, at which the system issues the monitor check when the resource is down or its status is unknown. Accepted values: 0 to 4294967295.
timeout integer	No	16	Number of seconds the target has to respond to the monitor request. Must be equal to or less than interval. Accepted values: 0 to 4294967295.

spec.pool[].monitors.tcp[]

Field	Required	Default	Description
interval integer	No	5	Frequency, in seconds, at which the system issues the monitor check when the resource is down or its status is unknown. Accepted values: 0 to 4294967295.
timeout integer	No	16	Number of seconds the target has to respond to the monitor request. Must be equal to or less than interval. Accepted values: 0 to 4294967295.

spec.syslog[]

Field	Required	Default	Description
name string	Yes	—	User-defined name for the syslog configuration. Must be 1 to 255 characters.
pool string	Yes	—	Logging pool that receives log messages. Must match a name in spec.pool. Must be 1 to 255 characters.
format string	No	rfc5424	Syslog message format for the output log data. Accepted values: rfc5424, rfc3164, legacy-bigip.
protocol string	No	udp	Protocol used to connect to the logging endpoint. Accepted values: udp, tcp.
distribution string	No	adaptive	Distribution method used to send messages to pool members. adaptive adds connections to pool members as needed for logging bandwidth. balanced sends each successive log to a new pool member per the pool’s load balancing method. replicate copies each log to all pool members for redundancy. Accepted values: replicate, balanced, adaptive.

spec.ipfix[]

Field	Required	Default	Description
name string	Yes	—	User-defined name for the IPFIX configuration. Must be 1 to 255 characters.
pool string	Yes	—	Logging pool that receives log messages. Must match a name in spec.pool. Must be 1 to 255 characters.
templateRetransmitInterval integer	No	30	Interval, in seconds, at which the logging destination retransmits all of its IPFIX templates. Useful for the UDP protocol. Accepted values: 0 to 4294967295.
protocolVersion string	No	netflow-9	Protocol version, based on the type of collectors in the pool. Accepted values: ipfix, netflow-9.
profileName object	No	{"udpProfileName": "sys-default-udp"}	TCP or UDP profile for the IPFIX logging. Set either tcpProfileName or udpProfileName, but not both.

spec.ipfix[].profileName

Field	Required	Default	Description
tcpProfileName string	No	—	Name of the F5BigTcpSetting resource used to log the IPFIX messages. Maximum length is 255 characters.
udpProfileName string	No	—	Name of the F5BigUdpSetting resource used to log the IPFIX messages. Maximum length is 255 characters.