1ORG.FREEDESKTOP.NETWORK1(5)org.freedesktop.network1ORG.FREEDESKTOP.NETWORK1(5)
2
3
4

NAME

6       org.freedesktop.network1 - The D-Bus interface of systemd-networkd
7

INTRODUCTION

9       systemd-networkd.service(8) is a system service that manages and
10       configures network interfaces. This page describes the D-Bus interface.
11

THE MANAGER OBJECT

13       The service exposes the following interfaces on the Manager object on
14       the bus:
15
16           node /org/freedesktop/network1 {
17             interface org.freedesktop.network1.Manager {
18               methods:
19                 ListLinks(out a(iso) links);
20                 GetLinkByName(in  s name,
21                               out i ifindex,
22                               out o path);
23                 GetLinkByIndex(in  i ifindex,
24                                out s name,
25                                out o path);
26                 SetLinkNTP(in  i ifindex,
27                            in  as servers);
28                 SetLinkDNS(in  i ifindex,
29                            in  a(iay) addresses);
30                 SetLinkDNSEx(in  i ifindex,
31                              in  a(iayqs) addresses);
32                 SetLinkDomains(in  i ifindex,
33                                in  a(sb) domains);
34                 SetLinkDefaultRoute(in  i ifindex,
35                                     in  b enable);
36                 SetLinkLLMNR(in  i ifindex,
37                              in  s mode);
38                 SetLinkMulticastDNS(in  i ifindex,
39                                     in  s mode);
40                 SetLinkDNSOverTLS(in  i ifindex,
41                                   in  s mode);
42                 SetLinkDNSSEC(in  i ifindex,
43                               in  s mode);
44                 SetLinkDNSSECNegativeTrustAnchors(in  i ifindex,
45                                                   in  as names);
46                 RevertLinkNTP(in  i ifindex);
47                 RevertLinkDNS(in  i ifindex);
48                 RenewLink(in  i ifindex);
49                 ForceRenewLink(in  i ifindex);
50                 ReconfigureLink(in  i ifindex);
51                 Reload();
52                 DescribeLink(in  i ifindex,
53                              out s json);
54                 Describe(out s json);
55               properties:
56                 readonly s OperationalState = '...';
57                 readonly s CarrierState = '...';
58                 readonly s AddressState = '...';
59                 readonly s IPv4AddressState = '...';
60                 readonly s IPv6AddressState = '...';
61                 readonly s OnlineState = '...';
62                 @org.freedesktop.DBus.Property.EmitsChangedSignal("const")
63                 readonly t NamespaceId = ...;
64             };
65             interface org.freedesktop.DBus.Peer { ... };
66             interface org.freedesktop.DBus.Introspectable { ... };
67             interface org.freedesktop.DBus.Properties { ... };
68           };
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101       Provides information about the manager.
102
104           node /org/freedesktop/network1/link/_1 {
105             interface org.freedesktop.network1.Link {
106               methods:
107                 SetNTP(in  as servers);
108                 SetDNS(in  a(iay) addresses);
109                 SetDNSEx(in  a(iayqs) addresses);
110                 SetDomains(in  a(sb) domains);
111                 SetDefaultRoute(in  b enable);
112                 SetLLMNR(in  s mode);
113                 SetMulticastDNS(in  s mode);
114                 SetDNSOverTLS(in  s mode);
115                 SetDNSSEC(in  s mode);
116                 SetDNSSECNegativeTrustAnchors(in  as names);
117                 RevertNTP();
118                 RevertDNS();
119                 Renew();
120                 ForceRenew();
121                 Reconfigure();
122                 Describe(out s json);
123               properties:
124                 readonly s OperationalState = '...';
125                 readonly s CarrierState = '...';
126                 readonly s AddressState = '...';
127                 readonly s IPv4AddressState = '...';
128                 readonly s IPv6AddressState = '...';
129                 readonly s OnlineState = '...';
130                 readonly s AdministrativeState = '...';
131                 @org.freedesktop.DBus.Property.EmitsChangedSignal("false")
132                 readonly (tt) BitRates = ...;
133             };
134             interface org.freedesktop.DBus.Peer { ... };
135             interface org.freedesktop.DBus.Introspectable { ... };
136             interface org.freedesktop.DBus.Properties { ... };
137             interface org.freedesktop.network1.DHCPServer { ... };
138           };
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169       Provides information about interfaces.
170

NETWORK OBJECT

172           node /org/freedesktop/network1/network/_1 {
173             interface org.freedesktop.network1.Network {
174               properties:
175                 @org.freedesktop.DBus.Property.EmitsChangedSignal("const")
176                 readonly s Description = '...';
177                 @org.freedesktop.DBus.Property.EmitsChangedSignal("const")
178                 readonly s SourcePath = '...';
179                 @org.freedesktop.DBus.Property.EmitsChangedSignal("const")
180                 readonly as MatchMAC = ['...', ...];
181                 @org.freedesktop.DBus.Property.EmitsChangedSignal("const")
182                 readonly as MatchPath = ['...', ...];
183                 @org.freedesktop.DBus.Property.EmitsChangedSignal("const")
184                 readonly as MatchDriver = ['...', ...];
185                 @org.freedesktop.DBus.Property.EmitsChangedSignal("const")
186                 readonly as MatchType = ['...', ...];
187                 @org.freedesktop.DBus.Property.EmitsChangedSignal("const")
188                 readonly as MatchName = ['...', ...];
189             };
190             interface org.freedesktop.DBus.Peer { ... };
191             interface org.freedesktop.DBus.Introspectable { ... };
192             interface org.freedesktop.DBus.Properties { ... };
193           };
194
195
196
197
198
199
200
201
202
203
204
205       Provides information about .network files.
206

DHCP SERVER OBJECT

208           node /org/freedesktop/network1/link/_1 {
209             interface org.freedesktop.network1.DHCPServer {
210               properties:
211                 readonly a(uayayayayt) Leases = [...];
212             };
213             interface org.freedesktop.DBus.Peer { ... };
214             interface org.freedesktop.DBus.Introspectable { ... };
215             interface org.freedesktop.DBus.Properties { ... };
216           };
217
218
219
220
221
222       Provides information about leases.
223

EXAMPLES

225       Example 1. Introspect org.freedesktop.network1.Manager on the bus
226
227           $ gdbus introspect --system \
228             --dest org.freedesktop.network1 \
229             --object-path /org/freedesktop/network1
230
231
232       Example 2. Introspect org.freedesktop.network1.Link on the bus
233
234           $ gdbus introspect --system \
235             --dest org.freedesktop.network1 \
236             --object-path /org/freedesktop/network1/link/_11
237
238

VERSIONING

240       These D-Bus interfaces follow the usual interface versioning
241       guidelines[1].
242

NOTES

244        1. the usual interface versioning guidelines
245           https://0pointer.de/blog/projects/versioning-dbus.html
246
247
248
249systemd 254                                        ORG.FREEDESKTOP.NETWORK1(5)
Impressum