ltm rule command ROUTE bandwidth
iRule(1) BIG-IP TMSH Manual iRule(1)
ROUTE::bandwidth
Returns a bandwidth estimate for a destination derived from entries in
the congestion metrics cache.
SYNOPSIS
ROUTE::bandwidth DESTINATION_IP_ADDRESS (GATEWAY_IP_ADDRESS)?
DESCRIPTION
Returns a bandwidth estimate for a destination derived from entries in
the congestion metrics cache.
As of v12.0, divides the cached congestion window (cwnd) value by the
cached round-trip-time (RTT ) to obtain a bandwidth estimate in kbps.
If there is no entry, it returns 0.
Note: The return value only applies to the TMM executing the command.
It does not consider cache entries on other TMMs.
Syntax
ROUTE::bandwidth
* The bandwidth estimate to the given destination IP address.
ROUTE::bandwidth
* The bandwidth estimate to the given destination IP address via
the given gateway.
RETURN VALUE
The bandwidth estimate to the destination and/or gateway in kbps.
VALID DURING
EXAMPLES
when CLIENT_ACCEPTED {
if { [ROUTE::bandwidth [IP::remote_addr]] > 0 } {
log local0. "cached bandwidth is: [ROUTE::bandwidth [IP::remote_addr]]"
}
}
when CLIENT_ACCEPTED {
set Gateway 10.3.1.11
# assume that $Gateway is the gateway address for [IP::remote_addr]
log local0. "cached bandwidth is: [ROUTE::bandwidth [IP::remote_addr] $Gateway]"
}
HINTS
If no TCP profile has cmetrics cache enabled, there will be no values
to return.
SEE ALSO
CHANGE LOG
@BIGIP-9.0.0 --First introduced the command. @BIGIP-12.0.0
--Implementation changed to devide the cached congestion window (cwnd)
by the cached round-trip-time (RTT)
BIG-IP 2017-01-31 iRule(1)