1plotnetcfg-json(5)            File Formats Manual           plotnetcfg-json(5)
2
3
4

NAME

6       plotnetcfg - json output format
7

DESCRIPTION

9   Root object fields
10       format (number)  Currently 1. Will be increased if incompatible changes
11              are introduced.  A tool parsing the json  output  should  refuse
12              any format it's not aware of.  Note that adding of new fields is
13              not considered to be an incompatible change.
14
15
16       version
17              (string) Plotnetcfg version.
18
19
20       date   (string) Time and date when the data were gathered, in  ctime(3)
21              format.
22
23
24       namespaces
25              (array) Array of name space objects. The first one is always the
26              root name space.
27
28
29   Name space object fields
30       name   (string) Name of the name space suitable for  user  consumption.
31              This  in  general  cannot  be used for machine consumption, e.g.
32              switching to the name space. The root name space  has  an  empty
33              name.
34
35
36       interfaces
37              (array) Array of interface objects.
38
39
40       warnings
41              (array) If present, an array of strings. Contains error messages
42              encountered when gathering data in the given name space.
43
44
45   Interface object fields
46       id     (string) Unique identifier of the interface. This  is  an  arbi‐
47              trary opaque string and the consumer should not make any assump‐
48              tion of its contents (apart of not containing null  characters).
49              It should not be displayed to the user, the sole purpose of this
50              field is linking to other interfaces. The identifier is globally
51              unique,  it is safe to assume that interfaces with the same name
52              in different name spaces have a different id.
53
54
55       name   (string) User visible name of the interface.  Usually  (but  not
56              always)  the  name of the corresponding Linux interface. This is
57              not unique between name spaces.
58
59
60       driver (string) The kernel module (driver) behind the interface. May be
61              empty in some specific cases.
62
63
64       info   (array)  Array of strings. Contains additional information about
65              the interface, formatted. An example is  tunnel  endpoints.  The
66              exact content is dependent on the type of the interface.
67
68
69       addresses
70              (array) Array of address objects.
71
72
73       mtu    (number) Interface MTU.
74
75
76       type   (string)
77              "device": normal interface. Most interfaces are of this type.
78
79              "internal":  this  interface  is not backed up by a Linux inter‐
80              face. Can be often found with Open vSwitch.
81
82              Further types are  possible  with  future  plotnetcfg  versions.
83              Adding them will not be considered a format change.
84
85
86       state  (string)
87              "down": the interface is administratively disabled.
88
89              "up": the interface is up and operating.
90
91              "up_no_link": the interface is up but has no link.
92
93              "none":  state cannot be determined or is not applicable to this
94              kind of interface.
95
96              More states are possible to be added in future  plotnetcfg  ver‐
97              sions. Adding them will not be considered a format change.
98
99
100       warning
101              (bool)  There was a problem gathering data about this interface.
102              Details are in the name space warnings  field.  The  purpose  of
103              this  flag is for visual representation of this interface as not
104              having complete data available.  Not present  if  there  was  no
105              error.
106
107
108       parent (object)  The  parent  interface,  as  a  connection object. Not
109              present if there's no parent.
110
111
112       children
113              (array) Array of children interfaces, as connection objects. Not
114              present if there are no children.
115
116
117       peer   (object) The peer interface, as a connection object. Not present
118              if there's no peer.
119
120
121   Connection object fields
122       info   (array) Array of strings. Contains additional information  about
123              the  connection between the two interfaces, formatted. May be an
124              empty array.
125
126
127       target (string) Id of the interface that is being linked to.
128
129
130   Address object fields
131       family (string) Currently only "INET" or "INET6". More  types  will  be
132              added in the future (without considering it a format change).
133
134
135       address
136              (string) Address formatted for user consumption. May include net
137              mask. This field should be generally machine parseable.
138
139
140       peer   (object) If present, the  peer  address  corresponding  to  this
141              address.  It's  of  the  address  object type but cannot contain
142              futher peer field.
143
144

SEE ALSO

146       plotnetcfg(8)
147
148

AUTHOR

150       plotnetcfg was written and  is  maintained  by  Jiri  Benc  <jbenc@red‐
151       hat.com>.
152
153
154
155                                 10 June 2015               plotnetcfg-json(5)