ltm rule command TCP bandwidth

iRule(1)						BIG-IP TMSH Manual						  iRule(1)

TCP::bandwidth
       Returns the estimated bandwidth of the connection.

SYNOPSIS
       TCP::bandwidth

DESCRIPTION
       Returns the estimated bandwidth measured as "congestion window" / "the measured round trip time".  The values returned are
       only estimates, and can vary even during the connection.

       Note: Starting with BIG-IP v9.4.2, client bandwidth calculations are unavailable, always returning 0. Starting with BIG-IP
       v12.0 nonzero values are returned.

       Syntax

       TCP::bandwidth

	    * Returns the estimated bandwidth in kilobits per second.

RETURN VALUE
       The estimated bandwidth in kilobits per second.

VALID DURING
       CLIENT_ACCEPTED, CLIENT_CLOSED, CLIENT_DATA, SERVER_CLOSED, SERVER_CONNECTED, SERVER_DATA, SIP_REQUEST, SIP_REQUEST_SEND,
       SIP_RESPONSE, STREAM_MATCHED

EXAMPLES
	when CLIENT_DATA {
	if {[HTTP::uri] starts_with "/xxx.css"}{
	      set bandwidth [TCP::bandwidth]
	      if {$bandwidth < XXX} {
		 HTTP::uri "/boring-xxx.css"
	      }
	   }
	}

HINTS
SEE ALSO
       ROUTE::bandwidth TCP::rtt

CHANGE LOG
       @BIGIP-9.0.5 --First introduced the command.  @BIGIP-9.4.2 --Command always returning zero @BIGIP-12.0.0 --Command returns
       nonzero bandwidth estimate

BIG-IP							    2022-04-12							  iRule(1)