'\"! tbl | mmdoc
'\"macro stdmacro
.\"
.\" Copyright (c) 2023 Oracle and/or its affiliates.
.\" DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
.\"
.\" This program is free software; you can redistribute it and/or modify it
.\" under the terms of the GNU General Public License as published by the
.\" Free Software Foundation; either version 2 of the License, or (at your
.\" option) any later version.
.\"
.\" This program is distributed in the hope that it will be useful, but
.\" WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
.\" or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
.\" for more details.
.\"
.TH PCP-NETSTAT 1 "PCP" "Performance Co-Pilot"
.SH NAME
\f3pcp-netstat\f1 \- Report statistics for different network protocols and network interfaces.
.SH SYNOPSIS
\f3pcp\f1
[\f2pcp\ options\f1]
\f3netstat\f1
[\f3\--statistics\f1]
[\f3\-p\f1 \f2[TCP|IP|UDP|ICMP]\f1]
[\f3\-i\f1]
[\f3\-s\f1 \f2samples\f1]
[\f3\-a\f1 \f2archive\f1]
[\f3\-S\f1 \f2start_time\f1]
[\f3\-T\f1 \f2end_time\f1]

.SH DESCRIPTION
The
.B pcp-netstat
command is used for viewing the different kinds of statistics related to the network protocols and the network interfaces. This tool is useful for checking the status of your network interfaces, network connections and for troubleshooting network issues.
This tool can also be used to analyze network statistics for all available protocols, including TCP, UDP, ICMP, and IP protocols.
.PP
By default
.B pcp-netstat
reports live data for the local host. It has the capabilities to analyze the data on the archives as well.
.SH OPTIONS
.TP
\fB\-\-statistics\fR
shows output similar to netstat -s, which displays summary statistics for each protocol
.TP
\fB\-i\fR
shows output similar to netstat -i -a -n, which displays a table of all network interfaces
.TP
\fB\-p\fR, \fB\-\-TCP|IP|UDP|ICMP\fR
filter network statistics specific to a protocol
.TP
\fB\-a\fR \fIfile\fR, \fB\-\-archive\fR=\fIfile\fR
Fetch /proc/netstat for a specified archive \fIfile\fR
.TP
\fB\-s\fR \fIcount\fR, \fB\-\-samples\fR=\fIcount\fR
Get the network statistics for specified number of samples \fIcount\fR
.TP
\fB\-S\fR, \fB\-\-start\fR=\fItime\fR
Filter the samples from the archive from the given \fItime\fR
.TP
\fB\-T\fR, \fB\-\-finish=time\fR
Filter the samples from the archive until the given \fItime\fR
.TP
\fB\-V\fR, \fB\-\-version\fR
Display version number and exit.
.TP
\fB\-?\fR, \fB\-\-help\fR
Display usage message and exit.
.SH PCP ENVIRONMENT
Environment variables with the prefix \fBPCP_\fP are used to parameterize
the file and directory names used by PCP.
On each installation, the
file \fI/etc/pcp.conf\fP contains the local values for these variables.
The \fB$PCP_CONF\fP variable may be used to specify an alternative
configuration file, as described in \fBpcp.conf\fP(5).
.PP
For environment variables affecting PCP tools, see \fBpmGetOptions\fP(3).
.SH SEE ALSO
.BR PCPIntro (1),
.BR pcp (1),
.BR pmParseInterval (3)
and
.BR environ (7).