3 <!DOCTYPE refentry PUBLIC
"-//OASIS//DTD DocBook XML V4.5//EN"
4 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
5 <!ENTITY % entities SYSTEM
"custom-entities.ent" >
8 <!-- SPDX-License-Identifier: LGPL-2.1-or-later -->
10 <refentry id=
"org.freedesktop.network1" conditional='ENABLE_NETWORKD'
11 xmlns:
xi=
"http://www.w3.org/2001/XInclude">
13 <title>org.freedesktop.network1
</title>
14 <productname>systemd
</productname>
18 <refentrytitle>org.freedesktop.network1
</refentrytitle>
19 <manvolnum>5</manvolnum>
23 <refname>org.freedesktop.network1
</refname>
24 <refpurpose>The D-Bus interface of systemd-networkd
</refpurpose>
28 <title>Introduction
</title>
31 <citerefentry><refentrytitle>systemd-networkd.service
</refentrytitle><manvolnum>8</manvolnum></citerefentry>
32 is a system service that manages and configures network interfaces. This page describes the D-Bus
37 <title>The Manager Object
</title>
39 <para>The service exposes the following interfaces on the Manager object on the bus:
</para>
41 <programlisting executable=
"systemd-networkd" node=
"/org/freedesktop/network1" interface=
"org.freedesktop.network1.Manager">
42 node /org/freedesktop/network1 {
43 interface org.freedesktop.network1.Manager {
45 ListLinks(out a(iso) links);
46 GetLinkByName(in s name,
49 GetLinkByIndex(in i ifindex,
52 SetLinkNTP(in i ifindex,
54 SetLinkDNS(in i ifindex,
56 SetLinkDNSEx(in i ifindex,
57 in a(iayqs) addresses);
58 SetLinkDomains(in i ifindex,
60 SetLinkDefaultRoute(in i ifindex,
62 SetLinkLLMNR(in i ifindex,
64 SetLinkMulticastDNS(in i ifindex,
66 SetLinkDNSOverTLS(in i ifindex,
68 SetLinkDNSSEC(in i ifindex,
70 SetLinkDNSSECNegativeTrustAnchors(in i ifindex,
72 RevertLinkNTP(in i ifindex);
73 RevertLinkDNS(in i ifindex);
74 RenewLink(in i ifindex);
75 ForceRenewLink(in i ifindex);
76 ReconfigureLink(in i ifindex);
78 DescribeLink(in i ifindex,
82 readonly s OperationalState = '...';
83 readonly s CarrierState = '...';
84 readonly s AddressState = '...';
85 readonly s IPv4AddressState = '...';
86 readonly s IPv6AddressState = '...';
87 readonly s OnlineState = '...';
88 @org.freedesktop.DBus.Property.EmitsChangedSignal(
"const")
89 readonly t NamespaceId = ...;
91 interface org.freedesktop.DBus.Peer { ... };
92 interface org.freedesktop.DBus.Introspectable { ... };
93 interface org.freedesktop.DBus.Properties { ... };
97 <!--method ListLinks is not documented!-->
99 <!--method GetLinkByName is not documented!-->
101 <!--method GetLinkByIndex is not documented!-->
103 <!--method SetLinkNTP is not documented!-->
105 <!--method SetLinkDNS is not documented!-->
107 <!--method SetLinkDNSEx is not documented!-->
109 <!--method SetLinkDomains is not documented!-->
111 <!--method SetLinkDefaultRoute is not documented!-->
113 <!--method SetLinkLLMNR is not documented!-->
115 <!--method SetLinkMulticastDNS is not documented!-->
117 <!--method SetLinkDNSOverTLS is not documented!-->
119 <!--method SetLinkDNSSEC is not documented!-->
121 <!--method SetLinkDNSSECNegativeTrustAnchors is not documented!-->
123 <!--method RevertLinkNTP is not documented!-->
125 <!--method RevertLinkDNS is not documented!-->
127 <!--method RenewLink is not documented!-->
129 <!--method ForceRenewLink is not documented!-->
131 <!--method ReconfigureLink is not documented!-->
133 <!--method Reload is not documented!-->
135 <!--method DescribeLink is not documented!-->
137 <!--method Describe is not documented!-->
139 <!--property OperationalState is not documented!-->
141 <!--property CarrierState is not documented!-->
143 <!--property AddressState is not documented!-->
145 <!--property IPv4AddressState is not documented!-->
147 <!--property IPv6AddressState is not documented!-->
149 <!--property OnlineState is not documented!-->
151 <!--property NamespaceId is not documented!-->
153 <!--Autogenerated cross-references for systemd.directives, do not edit-->
155 <variablelist class=
"dbus-interface" generated=
"True" extra-ref=
"org.freedesktop.network1.Manager"/>
157 <variablelist class=
"dbus-interface" generated=
"True" extra-ref=
"org.freedesktop.network1.Manager"/>
159 <variablelist class=
"dbus-method" generated=
"True" extra-ref=
"ListLinks()"/>
161 <variablelist class=
"dbus-method" generated=
"True" extra-ref=
"GetLinkByName()"/>
163 <variablelist class=
"dbus-method" generated=
"True" extra-ref=
"GetLinkByIndex()"/>
165 <variablelist class=
"dbus-method" generated=
"True" extra-ref=
"SetLinkNTP()"/>
167 <variablelist class=
"dbus-method" generated=
"True" extra-ref=
"SetLinkDNS()"/>
169 <variablelist class=
"dbus-method" generated=
"True" extra-ref=
"SetLinkDNSEx()"/>
171 <variablelist class=
"dbus-method" generated=
"True" extra-ref=
"SetLinkDomains()"/>
173 <variablelist class=
"dbus-method" generated=
"True" extra-ref=
"SetLinkDefaultRoute()"/>
175 <variablelist class=
"dbus-method" generated=
"True" extra-ref=
"SetLinkLLMNR()"/>
177 <variablelist class=
"dbus-method" generated=
"True" extra-ref=
"SetLinkMulticastDNS()"/>
179 <variablelist class=
"dbus-method" generated=
"True" extra-ref=
"SetLinkDNSOverTLS()"/>
181 <variablelist class=
"dbus-method" generated=
"True" extra-ref=
"SetLinkDNSSEC()"/>
183 <variablelist class=
"dbus-method" generated=
"True" extra-ref=
"SetLinkDNSSECNegativeTrustAnchors()"/>
185 <variablelist class=
"dbus-method" generated=
"True" extra-ref=
"RevertLinkNTP()"/>
187 <variablelist class=
"dbus-method" generated=
"True" extra-ref=
"RevertLinkDNS()"/>
189 <variablelist class=
"dbus-method" generated=
"True" extra-ref=
"RenewLink()"/>
191 <variablelist class=
"dbus-method" generated=
"True" extra-ref=
"ForceRenewLink()"/>
193 <variablelist class=
"dbus-method" generated=
"True" extra-ref=
"ReconfigureLink()"/>
195 <variablelist class=
"dbus-method" generated=
"True" extra-ref=
"Reload()"/>
197 <variablelist class=
"dbus-method" generated=
"True" extra-ref=
"DescribeLink()"/>
199 <variablelist class=
"dbus-method" generated=
"True" extra-ref=
"Describe()"/>
201 <variablelist class=
"dbus-property" generated=
"True" extra-ref=
"OperationalState"/>
203 <variablelist class=
"dbus-property" generated=
"True" extra-ref=
"CarrierState"/>
205 <variablelist class=
"dbus-property" generated=
"True" extra-ref=
"AddressState"/>
207 <variablelist class=
"dbus-property" generated=
"True" extra-ref=
"IPv4AddressState"/>
209 <variablelist class=
"dbus-property" generated=
"True" extra-ref=
"IPv6AddressState"/>
211 <variablelist class=
"dbus-property" generated=
"True" extra-ref=
"OnlineState"/>
213 <variablelist class=
"dbus-property" generated=
"True" extra-ref=
"NamespaceId"/>
215 <!--End of Autogenerated section-->
218 Provides information about the manager.
223 <title>Link Object
</title>
225 <programlisting executable=
"systemd-networkd" node=
"/org/freedesktop/network1/link/_1" interface=
"org.freedesktop.network1.Link">
226 node /org/freedesktop/network1/link/_1 {
227 interface org.freedesktop.network1.Link {
229 SetNTP(in as servers);
230 SetDNS(in a(iay) addresses);
231 SetDNSEx(in a(iayqs) addresses);
232 SetDomains(in a(sb) domains);
233 SetDefaultRoute(in b enable);
235 SetMulticastDNS(in s mode);
236 SetDNSOverTLS(in s mode);
237 SetDNSSEC(in s mode);
238 SetDNSSECNegativeTrustAnchors(in as names);
244 Describe(out s json);
246 readonly s OperationalState = '...';
247 readonly s CarrierState = '...';
248 readonly s AddressState = '...';
249 readonly s IPv4AddressState = '...';
250 readonly s IPv6AddressState = '...';
251 readonly s OnlineState = '...';
252 readonly s AdministrativeState = '...';
253 @org.freedesktop.DBus.Property.EmitsChangedSignal(
"false")
254 readonly (tt) BitRates = ...;
256 interface org.freedesktop.DBus.Peer { ... };
257 interface org.freedesktop.DBus.Introspectable { ... };
258 interface org.freedesktop.DBus.Properties { ... };
262 <!--method SetNTP is not documented!-->
264 <!--method SetDNS is not documented!-->
266 <!--method SetDNSEx is not documented!-->
268 <!--method SetDomains is not documented!-->
270 <!--method SetDefaultRoute is not documented!-->
272 <!--method SetLLMNR is not documented!-->
274 <!--method SetMulticastDNS is not documented!-->
276 <!--method SetDNSOverTLS is not documented!-->
278 <!--method SetDNSSEC is not documented!-->
280 <!--method SetDNSSECNegativeTrustAnchors is not documented!-->
282 <!--method RevertNTP is not documented!-->
284 <!--method RevertDNS is not documented!-->
286 <!--method Renew is not documented!-->
288 <!--method ForceRenew is not documented!-->
290 <!--method Reconfigure is not documented!-->
292 <!--method Describe is not documented!-->
294 <!--property OperationalState is not documented!-->
296 <!--property CarrierState is not documented!-->
298 <!--property AddressState is not documented!-->
300 <!--property IPv4AddressState is not documented!-->
302 <!--property IPv6AddressState is not documented!-->
304 <!--property OnlineState is not documented!-->
306 <!--property AdministrativeState is not documented!-->
308 <!--property BitRates is not documented!-->
310 <!--Autogenerated cross-references for systemd.directives, do not edit-->
312 <variablelist class=
"dbus-interface" generated=
"True" extra-ref=
"org.freedesktop.network1.Link"/>
314 <variablelist class=
"dbus-interface" generated=
"True" extra-ref=
"org.freedesktop.network1.Link"/>
316 <variablelist class=
"dbus-method" generated=
"True" extra-ref=
"SetNTP()"/>
318 <variablelist class=
"dbus-method" generated=
"True" extra-ref=
"SetDNS()"/>
320 <variablelist class=
"dbus-method" generated=
"True" extra-ref=
"SetDNSEx()"/>
322 <variablelist class=
"dbus-method" generated=
"True" extra-ref=
"SetDomains()"/>
324 <variablelist class=
"dbus-method" generated=
"True" extra-ref=
"SetDefaultRoute()"/>
326 <variablelist class=
"dbus-method" generated=
"True" extra-ref=
"SetLLMNR()"/>
328 <variablelist class=
"dbus-method" generated=
"True" extra-ref=
"SetMulticastDNS()"/>
330 <variablelist class=
"dbus-method" generated=
"True" extra-ref=
"SetDNSOverTLS()"/>
332 <variablelist class=
"dbus-method" generated=
"True" extra-ref=
"SetDNSSEC()"/>
334 <variablelist class=
"dbus-method" generated=
"True" extra-ref=
"SetDNSSECNegativeTrustAnchors()"/>
336 <variablelist class=
"dbus-method" generated=
"True" extra-ref=
"RevertNTP()"/>
338 <variablelist class=
"dbus-method" generated=
"True" extra-ref=
"RevertDNS()"/>
340 <variablelist class=
"dbus-method" generated=
"True" extra-ref=
"Renew()"/>
342 <variablelist class=
"dbus-method" generated=
"True" extra-ref=
"ForceRenew()"/>
344 <variablelist class=
"dbus-method" generated=
"True" extra-ref=
"Reconfigure()"/>
346 <variablelist class=
"dbus-method" generated=
"True" extra-ref=
"Describe()"/>
348 <variablelist class=
"dbus-property" generated=
"True" extra-ref=
"OperationalState"/>
350 <variablelist class=
"dbus-property" generated=
"True" extra-ref=
"CarrierState"/>
352 <variablelist class=
"dbus-property" generated=
"True" extra-ref=
"AddressState"/>
354 <variablelist class=
"dbus-property" generated=
"True" extra-ref=
"IPv4AddressState"/>
356 <variablelist class=
"dbus-property" generated=
"True" extra-ref=
"IPv6AddressState"/>
358 <variablelist class=
"dbus-property" generated=
"True" extra-ref=
"OnlineState"/>
360 <variablelist class=
"dbus-property" generated=
"True" extra-ref=
"AdministrativeState"/>
362 <variablelist class=
"dbus-property" generated=
"True" extra-ref=
"BitRates"/>
364 <!--End of Autogenerated section-->
367 Provides information about interfaces.
372 <title>Network Object
</title>
374 <programlisting executable=
"systemd-networkd" node=
"/org/freedesktop/network1/network/_1" interface=
"org.freedesktop.network1.Network">
375 node /org/freedesktop/network1/network/_1 {
376 interface org.freedesktop.network1.Network {
378 @org.freedesktop.DBus.Property.EmitsChangedSignal(
"const")
379 readonly s Description = '...';
380 @org.freedesktop.DBus.Property.EmitsChangedSignal(
"const")
381 readonly s SourcePath = '...';
382 @org.freedesktop.DBus.Property.EmitsChangedSignal(
"const")
383 readonly as MatchMAC = ['...', ...];
384 @org.freedesktop.DBus.Property.EmitsChangedSignal(
"const")
385 readonly as MatchPath = ['...', ...];
386 @org.freedesktop.DBus.Property.EmitsChangedSignal(
"const")
387 readonly as MatchDriver = ['...', ...];
388 @org.freedesktop.DBus.Property.EmitsChangedSignal(
"const")
389 readonly as MatchType = ['...', ...];
390 @org.freedesktop.DBus.Property.EmitsChangedSignal(
"const")
391 readonly as MatchName = ['...', ...];
393 interface org.freedesktop.DBus.Peer { ... };
394 interface org.freedesktop.DBus.Introspectable { ... };
395 interface org.freedesktop.DBus.Properties { ... };
399 <!--property Description is not documented!-->
401 <!--property SourcePath is not documented!-->
403 <!--property MatchMAC is not documented!-->
405 <!--property MatchPath is not documented!-->
407 <!--property MatchDriver is not documented!-->
409 <!--property MatchType is not documented!-->
411 <!--property MatchName is not documented!-->
413 <!--Autogenerated cross-references for systemd.directives, do not edit-->
415 <variablelist class=
"dbus-interface" generated=
"True" extra-ref=
"org.freedesktop.network1.Network"/>
417 <variablelist class=
"dbus-interface" generated=
"True" extra-ref=
"org.freedesktop.network1.Network"/>
419 <variablelist class=
"dbus-property" generated=
"True" extra-ref=
"Description"/>
421 <variablelist class=
"dbus-property" generated=
"True" extra-ref=
"SourcePath"/>
423 <variablelist class=
"dbus-property" generated=
"True" extra-ref=
"MatchMAC"/>
425 <variablelist class=
"dbus-property" generated=
"True" extra-ref=
"MatchPath"/>
427 <variablelist class=
"dbus-property" generated=
"True" extra-ref=
"MatchDriver"/>
429 <variablelist class=
"dbus-property" generated=
"True" extra-ref=
"MatchType"/>
431 <variablelist class=
"dbus-property" generated=
"True" extra-ref=
"MatchName"/>
433 <!--End of Autogenerated section-->
436 Provides information about .network files.
441 <title>DHCP Server Object
</title>
443 <programlisting executable=
"systemd-networkd" node=
"/org/freedesktop/network1/link/_1" interface=
"org.freedesktop.network1.DHCPServer">
444 node /org/freedesktop/network1/link/_1 {
445 interface org.freedesktop.network1.DHCPServer {
447 readonly a(uayayayayt) Leases = [...];
449 interface org.freedesktop.DBus.Peer { ... };
450 interface org.freedesktop.DBus.Introspectable { ... };
451 interface org.freedesktop.DBus.Properties { ... };
452 interface org.freedesktop.network1.Link { ... };
456 <!--property Leases is not documented!-->
458 <!--Autogenerated cross-references for systemd.directives, do not edit-->
460 <variablelist class=
"dbus-interface" generated=
"True" extra-ref=
"org.freedesktop.network1.Link"/>
462 <variablelist class=
"dbus-interface" generated=
"True" extra-ref=
"org.freedesktop.network1.DHCPServer"/>
464 <variablelist class=
"dbus-interface" generated=
"True" extra-ref=
"org.freedesktop.network1.Link"/>
466 <variablelist class=
"dbus-interface" generated=
"True" extra-ref=
"org.freedesktop.network1.DHCPServer"/>
468 <variablelist class=
"dbus-property" generated=
"True" extra-ref=
"Leases"/>
470 <!--End of Autogenerated section-->
473 Provides information about leases.
478 <title>DHCPv4 Client Object
</title>
480 <programlisting executable=
"systemd-networkd" node=
"/org/freedesktop/network1/link/_1" interface=
"org.freedesktop.network1.DHCPv4Client">
481 node /org/freedesktop/network1/link/_1 {
482 interface org.freedesktop.network1.DHCPv4Client {
484 readonly s State = '...';
486 interface org.freedesktop.DBus.Peer { ... };
487 interface org.freedesktop.DBus.Introspectable { ... };
488 interface org.freedesktop.DBus.Properties { ... };
489 interface org.freedesktop.network1.Link { ... };
493 <!--property State is not documented!-->
495 <!--Autogenerated cross-references for systemd.directives, do not edit-->
497 <variablelist class=
"dbus-interface" generated=
"True" extra-ref=
"org.freedesktop.network1.Link"/>
499 <variablelist class=
"dbus-interface" generated=
"True" extra-ref=
"org.freedesktop.network1.DHCPv4Client"/>
501 <variablelist class=
"dbus-interface" generated=
"True" extra-ref=
"org.freedesktop.network1.Link"/>
503 <variablelist class=
"dbus-interface" generated=
"True" extra-ref=
"org.freedesktop.network1.DHCPv4Client"/>
505 <variablelist class=
"dbus-property" generated=
"True" extra-ref=
"State"/>
507 <!--End of Autogenerated section-->
510 Provides information about DHCPv4 client status.
515 <title>DHCPv6 Client Object
</title>
517 <programlisting executable=
"systemd-networkd" node=
"/org/freedesktop/network1/link/_1" interface=
"org.freedesktop.network1.DHCPv6Client">
518 node /org/freedesktop/network1/link/_1 {
519 interface org.freedesktop.network1.DHCPv6Client {
521 readonly s State = '...';
523 interface org.freedesktop.DBus.Peer { ... };
524 interface org.freedesktop.DBus.Introspectable { ... };
525 interface org.freedesktop.DBus.Properties { ... };
526 interface org.freedesktop.network1.Link { ... };
530 <!--property State is not documented!-->
532 <!--Autogenerated cross-references for systemd.directives, do not edit-->
534 <variablelist class=
"dbus-interface" generated=
"True" extra-ref=
"org.freedesktop.network1.Link"/>
536 <variablelist class=
"dbus-interface" generated=
"True" extra-ref=
"org.freedesktop.network1.DHCPv6Client"/>
538 <variablelist class=
"dbus-interface" generated=
"True" extra-ref=
"org.freedesktop.network1.Link"/>
540 <variablelist class=
"dbus-interface" generated=
"True" extra-ref=
"org.freedesktop.network1.DHCPv6Client"/>
542 <variablelist class=
"dbus-property" generated=
"True" extra-ref=
"State"/>
544 <!--End of Autogenerated section-->
547 Provides information about DHCPv6 client status.
552 <title>Examples
</title>
555 <title>Introspect
<interfacename>org.freedesktop.network1.Manager
</interfacename> on the bus
</title>
558 $ gdbus introspect --system \
559 --dest org.freedesktop.network1 \
560 --object-path /org/freedesktop/network1
565 <title>Introspect
<interfacename>org.freedesktop.network1.Link
</interfacename> on the bus
</title>
568 $ gdbus introspect --system \
569 --dest org.freedesktop.network1 \
570 --object-path /org/freedesktop/network1/link/_11
575 <xi:include href=
"org.freedesktop.locale1.xml" xpointer=
"versioning"/>