ROUTE::bandwidth

Description

This command 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 <destination IP address>
ROUTE::bandwidth <destination IP address> <gateway IP address>

ROUTE::bandwidth <destination IP address>

  • The average bandwidth estimate for connections to the given destination IP address.

ROUTE::bandwidth <destination IP address> <gateway IP address>

  • The average bandwidth estimate for connections to the given destination IP address reached through the given gateway.

Examples

when CLIENT_ACCEPTED {
   log local0. "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. "bandwidth is: [ROUTE::bandwidth [IP::remote_addr] $Gateway]"
}