Debian Codegraph @

upstream/debian-unstable/man5/org.freedesktop.network1.5

raw
1 '\" t
2 .TH "ORG\&.FREEDESKTOP\&.NETWORK1" "5" "" "systemd 261~rc3" "org.freedesktop.network1"
3 .\" -----------------------------------------------------------------
4 .\" * Define some portability stuff
5 .\" -----------------------------------------------------------------
6 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
7 .\" http://bugs.debian.org/507673
8 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
9 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
10 .ie \n(.g .ds Aq \(aq
11 .el .ds Aq '
12 .\" -----------------------------------------------------------------
13 .\" * set default formatting
14 .\" -----------------------------------------------------------------
15 .\" disable hyphenation
16 .nh
17 .\" disable justification (adjust text to left margin only)
18 .ad l
19 .\" -----------------------------------------------------------------
20 .\" * MAIN CONTENT STARTS HERE *
21 .\" -----------------------------------------------------------------
22 .SH "NAME"
23 org.freedesktop.network1 \- The D\-Bus interface of systemd\-networkd
24 .SH "INTRODUCTION"
25 .PP
26 \fBsystemd-networkd.service\fR(8)
27 is a system service that manages and configures network interfaces\&. This page describes the D\-Bus interface\&.
28 .SH "THE MANAGER OBJECT"
29 .PP
30 The service exposes the following interfaces on the Manager object on the bus:
31 .sp
32 .if n \{\
33 .RS 4
34 .\}
35 .nf
36 node /org/freedesktop/network1 {
37 interface org\&.freedesktop\&.network1\&.Manager {
38 methods:
39 ListLinks(out a(iso) links);
40 GetLinkByName(in s name,
41 out i ifindex,
42 out o path);
43 GetLinkByIndex(in i ifindex,
44 out s name,
45 out o path);
46 SetLinkNTP(in i ifindex,
47 in as servers);
48 SetLinkDNS(in i ifindex,
49 in a(iay) addresses);
50 SetLinkDNSEx(in i ifindex,
51 in a(iayqs) addresses);
52 SetLinkDomains(in i ifindex,
53 in a(sb) domains);
54 SetLinkDefaultRoute(in i ifindex,
55 in b enable);
56 SetLinkLLMNR(in i ifindex,
57 in s mode);
58 SetLinkMulticastDNS(in i ifindex,
59 in s mode);
60 SetLinkDNSOverTLS(in i ifindex,
61 in s mode);
62 SetLinkDNSSEC(in i ifindex,
63 in s mode);
64 SetLinkDNSSECNegativeTrustAnchors(in i ifindex,
65 in as names);
66 RevertLinkNTP(in i ifindex);
67 RevertLinkDNS(in i ifindex);
68 RenewLink(in i ifindex);
69 ForceRenewLink(in i ifindex);
70 ReconfigureLink(in i ifindex);
71 Reload();
72 DescribeLink(in i ifindex,
73 out s json);
74 Describe(out s json);
75 properties:
76 readonly s OperationalState = \*(Aq\&.\&.\&.\*(Aq;
77 readonly s CarrierState = \*(Aq\&.\&.\&.\*(Aq;
78 readonly s AddressState = \*(Aq\&.\&.\&.\*(Aq;
79 readonly s IPv4AddressState = \*(Aq\&.\&.\&.\*(Aq;
80 readonly s IPv6AddressState = \*(Aq\&.\&.\&.\*(Aq;
81 readonly s OnlineState = \*(Aq\&.\&.\&.\*(Aq;
82 @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("const")
83 readonly t NamespaceId = \&.\&.\&.;
84 @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false")
85 readonly u NamespaceNSID = \&.\&.\&.;
86 };
87 interface org\&.freedesktop\&.DBus\&.Peer { \&.\&.\&. };
88 interface org\&.freedesktop\&.DBus\&.Introspectable { \&.\&.\&. };
89 interface org\&.freedesktop\&.DBus\&.Properties { \&.\&.\&. };
90 };
91 .fi
92 .if n \{\
93 .RE
94 .\}
95 .sp
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126 .PP
127 Provides information about the manager\&.
128 .SS "Properties"
129 .PP
130 \fINamespaceId\fR
131 contains the inode number of the network namespace that the network service runs in\&. A client may compare this with the inode number of its own network namespace to verify whether the service manages the same network namespace\&.
132 .PP
133 \fINamespaceNSID\fR
134 contains the "nsid" identifier the kernel maintains for the network namespace, if there\*(Aqs one assigned\&.
135 .SH "LINK OBJECT"
136 .sp
137 .if n \{\
138 .RS 4
139 .\}
140 .nf
141 node /org/freedesktop/network1/link/_1 {
142 interface org\&.freedesktop\&.network1\&.Link {
143 methods:
144 SetNTP(in as servers);
145 SetDNS(in a(iay) addresses);
146 SetDNSEx(in a(iayqs) addresses);
147 SetDomains(in a(sb) domains);
148 SetDefaultRoute(in b enable);
149 SetLLMNR(in s mode);
150 SetMulticastDNS(in s mode);
151 SetDNSOverTLS(in s mode);
152 SetDNSSEC(in s mode);
153 SetDNSSECNegativeTrustAnchors(in as names);
154 RevertNTP();
155 RevertDNS();
156 Renew();
157 ForceRenew();
158 Reconfigure();
159 Describe(out s json);
160 properties:
161 readonly s OperationalState = \*(Aq\&.\&.\&.\*(Aq;
162 readonly s CarrierState = \*(Aq\&.\&.\&.\*(Aq;
163 readonly s AddressState = \*(Aq\&.\&.\&.\*(Aq;
164 readonly s IPv4AddressState = \*(Aq\&.\&.\&.\*(Aq;
165 readonly s IPv6AddressState = \*(Aq\&.\&.\&.\*(Aq;
166 readonly s OnlineState = \*(Aq\&.\&.\&.\*(Aq;
167 readonly s AdministrativeState = \*(Aq\&.\&.\&.\*(Aq;
168 @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("false")
169 readonly (tt) BitRates = \&.\&.\&.;
170 };
171 interface org\&.freedesktop\&.DBus\&.Peer { \&.\&.\&. };
172 interface org\&.freedesktop\&.DBus\&.Introspectable { \&.\&.\&. };
173 interface org\&.freedesktop\&.DBus\&.Properties { \&.\&.\&. };
174 };
175 .fi
176 .if n \{\
177 .RE
178 .\}
179 .sp
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205 .PP
206 Provides information about interfaces\&.
207 .SH "NETWORK OBJECT"
208 .sp
209 .if n \{\
210 .RS 4
211 .\}
212 .nf
213 node /org/freedesktop/network1/network/_1 {
214 interface org\&.freedesktop\&.network1\&.Network {
215 properties:
216 @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("const")
217 readonly s Description = \*(Aq\&.\&.\&.\*(Aq;
218 @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("const")
219 readonly s SourcePath = \*(Aq\&.\&.\&.\*(Aq;
220 @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("const")
221 readonly as MatchMAC = [\*(Aq\&.\&.\&.\*(Aq, \&.\&.\&.];
222 @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("const")
223 readonly as MatchPath = [\*(Aq\&.\&.\&.\*(Aq, \&.\&.\&.];
224 @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("const")
225 readonly as MatchDriver = [\*(Aq\&.\&.\&.\*(Aq, \&.\&.\&.];
226 @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("const")
227 readonly as MatchType = [\*(Aq\&.\&.\&.\*(Aq, \&.\&.\&.];
228 @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("const")
229 readonly as MatchName = [\*(Aq\&.\&.\&.\*(Aq, \&.\&.\&.];
230 };
231 interface org\&.freedesktop\&.DBus\&.Peer { \&.\&.\&. };
232 interface org\&.freedesktop\&.DBus\&.Introspectable { \&.\&.\&. };
233 interface org\&.freedesktop\&.DBus\&.Properties { \&.\&.\&. };
234 };
235 .fi
236 .if n \{\
237 .RE
238 .\}
239 .sp
240
241
242
243
244
245
246
247
248 .PP
249 Provides information about \&.network files\&.
250 .SH "DHCP SERVER OBJECT"
251 .sp
252 .if n \{\
253 .RS 4
254 .\}
255 .nf
256 node /org/freedesktop/network1/link/_1 {
257 interface org\&.freedesktop\&.network1\&.DHCPServer {
258 properties:
259 readonly a(uayayayayt) Leases = [\&.\&.\&.];
260 @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("const")
261 readonly u PoolSize = \&.\&.\&.;
262 @org\&.freedesktop\&.DBus\&.Property\&.EmitsChangedSignal("const")
263 readonly u PoolOffset = \&.\&.\&.;
264 };
265 interface org\&.freedesktop\&.DBus\&.Peer { \&.\&.\&. };
266 interface org\&.freedesktop\&.DBus\&.Introspectable { \&.\&.\&. };
267 interface org\&.freedesktop\&.DBus\&.Properties { \&.\&.\&. };
268 interface org\&.freedesktop\&.network1\&.Link { \&.\&.\&. };
269 };
270 .fi
271 .if n \{\
272 .RE
273 .\}
274 .sp
275
276
277
278
279
280
281 .PP
282 Provides information about the DHCP server\&. The
283 \fILeases\fR
284 property contains the currently active leases\&. The
285 \fIPoolSize\fR
286 property contains the total number of addresses in the dynamic address pool\&. The
287 \fIPoolOffset\fR
288 property contains the offset from the subnet base address where the pool starts\&. These correspond to the
289 \fIPoolSize=\fR
290 and
291 \fIPoolOffset=\fR
292 settings in
293 \fBsystemd.network\fR(5)\&.
294 \fBUINT32_MAX\fR
295 is used as a sentinel value for
296 \fIPoolSize\fR
297 and
298 \fIPoolOffset\fR
299 to indicate that the information is unavailable (i\&.e\&. no DHCP server is configured or the link is in relay mode), rather than a valid pool size or offset\&.
300 .SH "DHCPV4 CLIENT OBJECT"
301 .sp
302 .if n \{\
303 .RS 4
304 .\}
305 .nf
306 node /org/freedesktop/network1/link/_1 {
307 interface org\&.freedesktop\&.network1\&.DHCPv4Client {
308 properties:
309 readonly s State = \*(Aq\&.\&.\&.\*(Aq;
310 };
311 interface org\&.freedesktop\&.DBus\&.Peer { \&.\&.\&. };
312 interface org\&.freedesktop\&.DBus\&.Introspectable { \&.\&.\&. };
313 interface org\&.freedesktop\&.DBus\&.Properties { \&.\&.\&. };
314 interface org\&.freedesktop\&.network1\&.Link { \&.\&.\&. };
315 };
316 .fi
317 .if n \{\
318 .RE
319 .\}
320 .sp
321
322
323
324
325 .PP
326 Provides information about DHCPv4 client status\&.
327 .SH "DHCPV6 CLIENT OBJECT"
328 .sp
329 .if n \{\
330 .RS 4
331 .\}
332 .nf
333 node /org/freedesktop/network1/link/_1 {
334 interface org\&.freedesktop\&.network1\&.DHCPv6Client {
335 properties:
336 readonly s State = \*(Aq\&.\&.\&.\*(Aq;
337 };
338 interface org\&.freedesktop\&.DBus\&.Peer { \&.\&.\&. };
339 interface org\&.freedesktop\&.DBus\&.Introspectable { \&.\&.\&. };
340 interface org\&.freedesktop\&.DBus\&.Properties { \&.\&.\&. };
341 interface org\&.freedesktop\&.network1\&.Link { \&.\&.\&. };
342 };
343 .fi
344 .if n \{\
345 .RE
346 .\}
347 .sp
348
349
350
351
352 .PP
353 Provides information about DHCPv6 client status\&.
354 .SH "EXAMPLES"
355 .PP
356 \fBExample\ \&1.\ \&Introspect org\&.freedesktop\&.network1\&.Manager on the bus\fR
357 .sp
358 .if n \{\
359 .RS 4
360 .\}
361 .nf
362 $ gdbus introspect \-\-system \e
363 \-\-dest org\&.freedesktop\&.network1 \e
364 \-\-object\-path /org/freedesktop/network1
365 .fi
366 .if n \{\
367 .RE
368 .\}
369 .PP
370 \fBExample\ \&2.\ \&Introspect org\&.freedesktop\&.network1\&.Link on the bus\fR
371 .sp
372 .if n \{\
373 .RS 4
374 .\}
375 .nf
376 $ gdbus introspect \-\-system \e
377 \-\-dest org\&.freedesktop\&.network1 \e
378 \-\-object\-path /org/freedesktop/network1/link/_11
379 .fi
380 .if n \{\
381 .RE
382 .\}
383 .SH "VERSIONING"
384 .PP
385 These D\-Bus interfaces follow
386 \m[blue]\fBthe usual interface versioning guidelines\fR\m[]\&\s-2\u[1]\d\s+2\&.
387 .SH "HISTORY"
388 .SS "DHCP Server Object"
389 .PP
390 \fIPoolSize\fR
391 and
392 \fIPoolOffset\fR
393 were added in version 261\&.
394 .SS "DHCPv4 Client Object"
395 .PP
396 \fIState\fR
397 was added in version 255\&.
398 .SS "DHCPv6 Client Object"
399 .PP
400 \fIState\fR
401 was added in version 255\&.
402 .SS "Manager Object"
403 .PP
404 \fINamespaceNSID\fR
405 was added in version 256\&.
406 .SH "SEE ALSO"
407 .PP
408 \fBsystemd\fR(1), \fBsystemd-networkd.service\fR(8), \fBnetworkctl\fR(1)
409 .SH "NOTES"
410 .IP " 1." 4
411 the usual interface versioning guidelines
412 .RS 4
413 \%https://0pointer.de/blog/projects/versioning-dbus.html
414 .RE