.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" ======================================================================== .\" .IX Title "Parse::Netstat::linux 3pm" .TH Parse::Netstat::linux 3pm "2023-01-15" "perl v5.36.0" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" Parse::Netstat::linux \- Parse the output of Linux "netstat" command .SH "VERSION" .IX Header "VERSION" This document describes version 0.150 of Parse::Netstat::linux (from Perl distribution Parse-Netstat), released on 2022\-12\-04. .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 2 \& use Parse::Netstat qw(parse_netstat); \& my $res = parse_netstat(output=>join("", \`netstat \-anp\`), flavor=>"linux"); .Ve .PP Sample `netstat \-anp` output: .PP .Vb 10 \& Active Internet connections (servers and established) \& Proto Recv\-Q Send\-Q Local Address Foreign Address State PID/Program name \& tcp 0 0 127.0.0.1:1027 0.0.0.0:* LISTEN \- \& tcp 0 0 builder.localdomain:1028 *:* LISTEN \& tcp 0 0 127.0.0.1:58159 0.0.0.0:* LISTEN \- \& tcp 0 0 127.0.0.1:58160 0.0.0.0:* LISTEN \- \& tcp 0 0 127.0.0.1:7634 0.0.0.0:* LISTEN \- \& tcp 0 0 0.0.0.0:22 0.0.0.0:* LISTEN \- \& tcp 0 0 0.0.0.0:631 0.0.0.0:* LISTEN \- \& tcp 0 0 127.0.0.1:25 0.0.0.0:* LISTEN 1234/program with space \& tcp 0 0 192.168.0.103:44922 1.2.3.4:143 ESTABLISHED 25820/thunderbird\-b \& tcp6 0 0 ::1:1028 :::* LISTEN \- \& udp 0 0 0.0.0.0:631 0.0.0.0:* \- \& udp 0 0 192.168.0.103:56668 0.0.0.0:* \- \& udp 0 0 192.168.0.103:52753 0.0.0.0:* 8888/opera \& udp6 0 0 :::42069 :::* \- \& Active UNIX domain sockets (servers and established) \& Proto RefCnt Flags Type State I\-Node PID/Program name Path \& unix 2 [ ] DGRAM 6906 \- /var/spool/postfix/dev/log \& unix 2 [ ACC ] STREAM LISTENING 650654 \- /tmp/orbit\-t1/linc\-76ff\-0\-3fc1dd3f2f2 \& unix 2 [ ACC ] STREAM LISTENING 1121541 16933/kate 123 /tmp/orbit\-s1/linc\-4225\-0\-267d23358095e .Ve .PP Sample result: .PP .Vb 10 \& [ \& 200, \& "OK", \& { \& active_conns => [ \& { \& foreign_host => "0.0.0.0", \& foreign_port => "*", \& local_host => "127.0.0.1", \& local_port => 1027, \& proto => "tcp", \& recvq => 0, \& sendq => 0, \& state => "LISTEN", \& }, \& { \& foreign_host => "*", \& foreign_port => "*", \& local_host => "builder.localdomain", \& local_port => 1028, \& proto => "tcp", \& recvq => 0, \& sendq => 0, \& state => "LISTEN", \& }, \& { \& foreign_host => "0.0.0.0", \& foreign_port => "*", \& local_host => "127.0.0.1", \& local_port => 58159, \& proto => "tcp", \& recvq => 0, \& sendq => 0, \& state => "LISTEN", \& }, \& { \& foreign_host => "0.0.0.0", \& foreign_port => "*", \& local_host => "127.0.0.1", \& local_port => 58160, \& proto => "tcp", \& recvq => 0, \& sendq => 0, \& state => "LISTEN", \& }, \& { \& foreign_host => "0.0.0.0", \& foreign_port => "*", \& local_host => "127.0.0.1", \& local_port => 7634, \& proto => "tcp", \& recvq => 0, \& sendq => 0, \& state => "LISTEN", \& }, \& { \& foreign_host => "0.0.0.0", \& foreign_port => "*", \& local_host => "0.0.0.0", \& local_port => 22, \& proto => "tcp", \& recvq => 0, \& sendq => 0, \& state => "LISTEN", \& }, \& { \& foreign_host => "0.0.0.0", \& foreign_port => "*", \& local_host => "0.0.0.0", \& local_port => 631, \& proto => "tcp", \& recvq => 0, \& sendq => 0, \& state => "LISTEN", \& }, \& { \& foreign_host => "0.0.0.0", \& foreign_port => "*", \& local_host => "127.0.0.1", \& local_port => 25, \& pid => 1234, \& program => "program with space", \& proto => "tcp", \& recvq => 0, \& sendq => 0, \& state => "LISTEN", \& }, \& { \& foreign_host => "1.2.3.4", \& foreign_port => 143, \& local_host => "192.168.0.103", \& local_port => 44922, \& pid => 25820, \& program => "thunderbird\-b", \& proto => "tcp", \& recvq => 0, \& sendq => 0, \& state => "ESTABLISHED", \& }, \& { \& foreign_host => "::", \& foreign_port => "*", \& local_host => "::1", \& local_port => 1028, \& proto => "tcp6", \& recvq => 0, \& sendq => 0, \& state => "LISTEN", \& }, \& { \& foreign_host => "0.0.0.0", \& foreign_port => "*", \& local_host => "0.0.0.0", \& local_port => 631, \& proto => "udp", \& recvq => 0, \& sendq => 0, \& state => "\-", \& }, \& { \& foreign_host => "0.0.0.0", \& foreign_port => "*", \& local_host => "192.168.0.103", \& local_port => 56668, \& proto => "udp", \& recvq => 0, \& sendq => 0, \& state => "\-", \& }, \& { \& foreign_host => "0.0.0.0", \& foreign_port => "*", \& local_host => "192.168.0.103", \& local_port => 52753, \& proto => "udp", \& recvq => 0, \& sendq => 0, \& state => "8888/opera", \& }, \& { \& foreign_host => "::", \& foreign_port => "*", \& local_host => "::", \& local_port => 42069, \& proto => "udp6", \& recvq => 0, \& sendq => 0, \& state => "\-", \& }, \& { \& flags => "", \& inode => 6906, \& path => "/var/spool/postfix/dev/log", \& proto => "unix", \& refcnt => 2, \& state => " ", \& type => "DGRAM", \& }, \& { \& flags => "ACC", \& inode => 650654, \& path => "/tmp/orbit\-t1/linc\-76ff\-0\-3fc1dd3f2f2", \& proto => "unix", \& refcnt => 2, \& state => "LISTENING", \& type => "STREAM", \& }, \& { \& flags => "ACC", \& inode => 1121541, \& path => "123 /tmp/orbit\-s1/linc\-4225\-0\-267d23358095e", \& pid => 16933, \& program => "kate", \& proto => "unix", \& refcnt => 2, \& state => "LISTENING", \& type => "STREAM", \& }, \& ], \& }, \& ] .Ve .SH "FUNCTIONS" .IX Header "FUNCTIONS" .SS "parse_netstat" .IX Subsection "parse_netstat" Usage: .PP .Vb 1 \& parse_netstat(%args) \-> [$status_code, $reason, $payload, \e%result_meta] .Ve .PP Parse the output of Linux \*(L"netstat\*(R" command. .PP Netstat can be called with \f(CW\*(C`\-n\*(C'\fR (show raw \s-1IP\s0 addresses and port numbers instead of hostnames or port names) or without. It can be called with \f(CW\*(C`\-a\*(C'\fR (show all listening and non-listening socket) option or without. And can be called with \&\f(CW\*(C`\-p\*(C'\fR (show PID/program names) or without. .PP This function is not exported by default, but exportable. .PP Arguments ('*' denotes required arguments): .IP "\(bu" 4 \&\fBoutput\fR* => \fIstr\fR .Sp Output of netstat command. .IP "\(bu" 4 \&\fBtcp\fR => \fIbool\fR (default: 1) .Sp Whether to parse \s-1TCP\s0 (and \s-1TCP6\s0) connections. .IP "\(bu" 4 \&\fBudp\fR => \fIbool\fR (default: 1) .Sp Whether to parse \s-1UDP\s0 (and \s-1UDP6\s0) connections. .IP "\(bu" 4 \&\fBunix\fR => \fIbool\fR (default: 1) .Sp Whether to parse Unix socket connections. .PP Returns an enveloped result (an array). .PP First element ($status_code) is an integer containing HTTP-like status code (200 means \s-1OK,\s0 4xx caller error, 5xx function error). Second element ($reason) is a string containing error message, or something like \*(L"\s-1OK\*(R"\s0 if status is 200. Third element ($payload) is the actual result, but usually not present when enveloped result is an error response ($status_code is not 2xx). Fourth element (%result_meta) is called result metadata and is optional, a hash that contains extra information, much like how \s-1HTTP\s0 response headers provide additional metadata. .PP Return value: (any) .SH "HOMEPAGE" .IX Header "HOMEPAGE" Please visit the project's homepage at . .SH "SOURCE" .IX Header "SOURCE" Source repository is at . .SH "AUTHOR" .IX Header "AUTHOR" perlancar .SH "CONTRIBUTING" .IX Header "CONTRIBUTING" To contribute, you can send patches by email/via \s-1RT,\s0 or send pull requests on GitHub. .PP Most of the time, you don't need to build the distribution yourself. You can simply modify the code, then test via: .PP .Vb 1 \& % prove \-l .Ve .PP If you want to build the distribution (e.g. to try to install it locally on your system), you can install Dist::Zilla, Dist::Zilla::PluginBundle::Author::PERLANCAR, Pod::Weaver::PluginBundle::Author::PERLANCAR, and sometimes one or two other Dist::Zilla\- and/or Pod::Weaver plugins. Any additional steps required beyond that are considered a bug and can be reported to me. .SH "COPYRIGHT AND LICENSE" .IX Header "COPYRIGHT AND LICENSE" This software is copyright (c) 2022, 2017, 2015, 2014, 2012, 2011 by perlancar . .PP This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself. .SH "BUGS" .IX Header "BUGS" Please report any bugs or feature requests on the bugtracker website .PP When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature.