Blame man/man8/ip-tcp_metrics.8

Packit Service 3880ab
.TH "IP\-TCP_METRICS" 8 "23 Aug 2012" "iproute2" "Linux"
Packit Service 3880ab
.SH "NAME"
Packit Service 3880ab
ip-tcp_metrics \- management for TCP Metrics
Packit Service 3880ab
.SH "SYNOPSIS"
Packit Service 3880ab
.sp
Packit Service 3880ab
.ad l
Packit Service 3880ab
.in +8
Packit Service 3880ab
.ti -8
Packit Service 3880ab
.B ip
Packit Service 3880ab
.RI "[ " OPTIONS " ]"
Packit Service 3880ab
.B tcp_metrics
Packit Service 3880ab
.RI "{ " COMMAND " | "
Packit Service 3880ab
.BR help " }"
Packit Service 3880ab
.sp
Packit Service 3880ab
Packit Service 3880ab
.ti -8
Packit Service 3880ab
.BR "ip tcp_metrics" " { " show " | " flush " }
Packit Service 3880ab
.IR SELECTOR
Packit Service 3880ab
Packit Service 3880ab
.ti -8
Packit Service 3880ab
.BR "ip tcp_metrics delete " [ " address " ]
Packit Service 3880ab
.IR ADDRESS
Packit Service 3880ab
Packit Service 3880ab
.ti -8
Packit Service 3880ab
.IR SELECTOR " := "
Packit Service 3880ab
.RB "[ [ " address " ] "
Packit Service 3880ab
.IR PREFIX " ]"
Packit Service 3880ab
Packit Service 3880ab
.SH "DESCRIPTION"
Packit Service 3880ab
.B ip tcp_metrics
Packit Service 3880ab
is used to manipulate entries in the kernel that keep TCP information
Packit Service 3880ab
for IPv4 and IPv6 destinations. The entries are created when
Packit Service 3880ab
TCP sockets want to share information for destinations and are
Packit Service 3880ab
stored in a cache keyed by the destination address. The saved
Packit Service 3880ab
information may include values for metrics (initially obtained from
Packit Service 3880ab
routes), recent TSVAL for TIME-WAIT recycling purposes, state for the
Packit Service 3880ab
Fast Open feature, etc.
Packit Service 3880ab
For performance reasons the cache can not grow above configured limit
Packit Service 3880ab
and the older entries are replaced with fresh information, sometimes
Packit Service 3880ab
reclaimed and used for new destinations. The kernel never removes
Packit Service 3880ab
entries, they can be flushed only with this tool.
Packit Service 3880ab
Packit Service 3880ab
.SS ip tcp_metrics show - show cached entries
Packit Service 3880ab
Packit Service 3880ab
.TP
Packit Service 3880ab
.BI address " PREFIX " (default)
Packit Service 3880ab
IPv4/IPv6 prefix or address. If no prefix is provided all entries are shown.
Packit Service 3880ab
Packit Service 3880ab
.LP
Packit Service 3880ab
The output may contain the following information:
Packit Service 3880ab
Packit Service 3880ab
.BI age " <S.MMM>" sec
Packit Service 3880ab
- time after the entry was created, reset or updated with metrics
Packit Service 3880ab
from sockets. The entry is reset and refreshed on use with metrics from
Packit Service 3880ab
route if the metrics are not updated in last hour. Not all cached values
Packit Service 3880ab
reset the age on update.
Packit Service 3880ab
Packit Service 3880ab
.BI cwnd " <N>"
Packit Service 3880ab
- CWND metric value
Packit Service 3880ab
Packit Service 3880ab
.BI fo_cookie " <HEX-STRING>"
Packit Service 3880ab
- Cookie value received in SYN-ACK to be used by Fast Open for next SYNs
Packit Service 3880ab
Packit Service 3880ab
.BI fo_mss " <N>"
Packit Service 3880ab
- MSS value received in SYN-ACK to be used by Fast Open for next SYNs
Packit Service 3880ab
Packit Service 3880ab
.BI fo_syn_drops " <N>/<S.MMM>" "sec ago"
Packit Service 3880ab
- Number of drops of initial outgoing Fast Open SYNs with data
Packit Service 3880ab
detected by monitoring the received SYN-ACK after SYN retransmission.
Packit Service 3880ab
The seconds show the time after last SYN drop and together with
Packit Service 3880ab
the drop count can be used to disable Fast Open for some time.
Packit Service 3880ab
Packit Service 3880ab
.BI reordering " <N>"
Packit Service 3880ab
- Reordering metric value
Packit Service 3880ab
Packit Service 3880ab
.BI rtt " <N>" us
Packit Service 3880ab
- RTT metric value
Packit Service 3880ab
Packit Service 3880ab
.BI rttvar " <N>" us
Packit Service 3880ab
- RTTVAR metric value
Packit Service 3880ab
Packit Service 3880ab
.BI ssthresh " <SSTHRESH>"
Packit Service 3880ab
- SSTHRESH metric value
Packit Service 3880ab
Packit Service 3880ab
.BI tw_ts " <TSVAL>/<SEC>" "sec ago"
Packit Service 3880ab
- recent TSVAL and the seconds after saving it into TIME-WAIT socket
Packit Service 3880ab
Packit Service 3880ab
.SS ip tcp_metrics delete - delete single entry
Packit Service 3880ab
Packit Service 3880ab
.TP
Packit Service 3880ab
.BI address " ADDRESS " (default)
Packit Service 3880ab
IPv4/IPv6 address. The address is a required argument.
Packit Service 3880ab
Packit Service 3880ab
.SS ip tcp_metrics flush - flush entries
Packit Service 3880ab
This command flushes the entries selected by some criteria.
Packit Service 3880ab
Packit Service 3880ab
.PP
Packit Service 3880ab
This command has the same arguments as
Packit Service 3880ab
.B show.
Packit Service 3880ab
Packit Service 3880ab
.SH "EXAMPLES"
Packit Service 3880ab
.PP
Packit Service 3880ab
ip tcp_metrics show address 192.168.0.0/24
Packit Service 3880ab
.RS 4
Packit Service 3880ab
Shows the entries for destinations from subnet
Packit Service 3880ab
.RE
Packit Service 3880ab
.PP
Packit Service 3880ab
ip tcp_metrics show 192.168.0.0/24
Packit Service 3880ab
.RS 4
Packit Service 3880ab
The same but address keyword is optional
Packit Service 3880ab
.RE
Packit Service 3880ab
.PP
Packit Service 3880ab
ip tcp_metrics
Packit Service 3880ab
.RS 4
Packit Service 3880ab
Show all is the default action
Packit Service 3880ab
.RE
Packit Service 3880ab
.PP
Packit Service 3880ab
ip tcp_metrics delete 192.168.0.1
Packit Service 3880ab
.RS 4
Packit Service 3880ab
Removes the entry for 192.168.0.1 from cache.
Packit Service 3880ab
.RE
Packit Service 3880ab
.PP
Packit Service 3880ab
ip tcp_metrics flush 192.168.0.0/24
Packit Service 3880ab
.RS 4
Packit Service 3880ab
Removes entries for destinations from subnet
Packit Service 3880ab
.RE
Packit Service 3880ab
.PP
Packit Service 3880ab
ip tcp_metrics flush all
Packit Service 3880ab
.RS 4
Packit Service 3880ab
Removes all entries from cache
Packit Service 3880ab
.RE
Packit Service 3880ab
.PP
Packit Service 3880ab
ip -6 tcp_metrics flush all
Packit Service 3880ab
.RS 4
Packit Service 3880ab
Removes all IPv6 entries from cache keeping the IPv4 entries.
Packit Service 3880ab
.RE
Packit Service 3880ab
Packit Service 3880ab
.SH SEE ALSO
Packit Service 3880ab
.br
Packit Service 3880ab
.BR ip (8)
Packit Service 3880ab
Packit Service 3880ab
.SH AUTHOR
Packit Service 3880ab
Original Manpage by Julian Anastasov <ja@ssi.bg>