1plotnetcfg(8)               System Manager's Manual              plotnetcfg(8)
2
3
4

NAME

6       plotnetcfg - plot diagram of network configuration
7

SYNOPSIS

9       plotnetcfg [options]
10

DESCRIPTION

12       plotnetcfg is a tool that scans networking configuration on the machine
13       and outputs a diagram of the configuration hierarchy.
14
15       By default, the output is in the dot language. The output can  be  con‐
16       verted  by  the dot(1) tool from graphviz(7) package to various formats
17       such as PDF, PostScript or SVG.
18
19       plotnetcfg is able to scan different network name spaces and figure out
20       relations  that  span  name  spaces.  It  supports all kinds of network
21       interfaces and understands specifics of VLANs, bridges, veth pairs  and
22       Open vSwitch.
23
24       The  tool  has  to  be  run  under  root or with both CAP_SYS_ADMIN and
25       CAP_NET_ADMIN capabilities. See capabilities(7) for details.
26
27       plotnetcfg is lightweight with as few library dependencies as possible.
28       Currently,  the only dependencies are libc and libjansson.  Optionally,
29       it can be statically linked against the latter which allows  the  plot‐
30       netcfg  binary to be copied to a target machine and run there (provided
31       it has the same or newer version of glibc as  plotnetcfg  was  compiled
32       against).
33
34       See EXAMPLES for typical plotnetcfg usage.
35
36

OPTIONS

38       -f, --format=FORMAT
39              Set output format. When not specified, dot is used.
40
41       -F, --list-formats
42              Print available output formats.
43
44       -D, --ovs-db=PATH
45              Path  to  the socket used to communicate with Open vSwitch data‐
46              base server.  Only UNIX sockets are supported.  The  default  is
47              /var/run/openvswitch/db.sock.
48
49       -h, --help
50              Print short help and exit.
51
52       --version
53              Print program version and exit.
54
55

EXAMPLES

57       Display network configuration of the local machine:
58              plotnetcfg | dot -Tpdf | okular -
59
60       Save network configuration to a file for later analysis:
61              plotnetcfg > file
62
63       Create PDF with network configuration of a remote machine:
64              scp /usr/sbin/plotnetcfg root@target:
65              ssh root@target ./plotnetcfg | dot -Tpdf > file.pdf
66
67

SEE ALSO

69       dot(1), graphviz(7), plotnetcfg-json(5)
70
71

AUTHOR

73       plotnetcfg  was  written  and  is  maintained  by Jiri Benc <jbenc@red‐
74       hat.com>.
75
76
77
78                                 9 April 2015                    plotnetcfg(8)