Parse::Netstat::linux - Parse the output of Linux "netstat" command
This document describes version 0.12 of Parse::Netstat::linux (from Perl distribution Parse-Netstat), released on 2015-09-03.
use Parse::Netstat qw(parse_netstat); my $res = parse_netstat(output=>join("", `netstat -anp`), flavor=>"linux");
Sample `netstat -anp` output:
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
Sample result:
[ 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", }, ], }, ]
Parse the output of Linux "netstat" command.
Netstat can be called with -n (show raw IP addresses and port numbers instead of hostnames or port names) or without. It can be called with -a (show all listening and non-listening socket) option or without. And can be called with -p (show PID/program names) or without.
-n
-a
-p
Arguments ('*' denotes required arguments):
output* => str
Output of netstat command.
tcp => bool (default: 1)
Whether to parse TCP (and TCP6) connections.
udp => bool (default: 1)
Whether to parse UDP (and UDP6) connections.
unix => bool (default: 1)
Whether to parse Unix socket connections.
Returns an enveloped result (an array).
First element (status) is an integer containing HTTP status code (200 means OK, 4xx caller error, 5xx function error). Second element (msg) is a string containing error message, or 'OK' if status is 200. Third element (result) is optional, the actual result. Fourth element (meta) is called result metadata and is optional, a hash that contains extra information.
Return value: (any)
Please visit the project's homepage at https://metacpan.org/release/Parse-Netstat.
Source repository is at https://github.com/perlancar/perl-Parse-Netstat.
Please report any bugs or feature requests on the bugtracker website https://rt.cpan.org/Public/Dist/Display.html?Name=Parse-Netstat
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.
perlancar <perlancar@cpan.org>
This software is copyright (c) 2015 by perlancar@cpan.org.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.
To install Parse::Netstat, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Parse::Netstat
CPAN shell
perl -MCPAN -e shell install Parse::Netstat
For more information on module installation, please visit the detailed CPAN module installation guide.