]>
Commit | Line | Data |
---|---|---|
558434a4 YW |
1 | <?xml version="1.0"?> |
2 | <!--*-nxml-*--> | |
3 | <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" | |
eea10b26 | 4 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ |
558434a4 YW |
5 | <!ENTITY % entities SYSTEM "custom-entities.ent" > |
6 | %entities; | |
7 | ]> | |
8 | <!-- SPDX-License-Identifier: LGPL-2.1-or-later --> | |
9 | ||
10 | <refentry id="org.freedesktop.network1" conditional='ENABLE_NETWORKD' | |
11 | xmlns:xi="http://www.w3.org/2001/XInclude"> | |
12 | <refentryinfo> | |
13 | <title>org.freedesktop.network1</title> | |
14 | <productname>systemd</productname> | |
15 | </refentryinfo> | |
16 | ||
17 | <refmeta> | |
18 | <refentrytitle>org.freedesktop.network1</refentrytitle> | |
19 | <manvolnum>5</manvolnum> | |
20 | </refmeta> | |
21 | ||
22 | <refnamediv> | |
23 | <refname>org.freedesktop.network1</refname> | |
24 | <refpurpose>The D-Bus interface of systemd-networkd</refpurpose> | |
25 | </refnamediv> | |
26 | ||
27 | <refsect1> | |
28 | <title>Introduction</title> | |
29 | ||
30 | <para> | |
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 | |
33 | interface.</para> | |
34 | </refsect1> | |
35 | ||
36 | <refsect1> | |
37 | <title>The Manager Object</title> | |
38 | ||
39 | <para>The service exposes the following interfaces on the Manager object on the bus:</para> | |
40 | ||
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 { | |
44 | methods: | |
45 | ListLinks(out a(iso) links); | |
46 | GetLinkByName(in s name, | |
47 | out i ifindex, | |
48 | out o path); | |
49 | GetLinkByIndex(in i ifindex, | |
50 | out s name, | |
51 | out o path); | |
52 | SetLinkNTP(in i ifindex, | |
53 | in as servers); | |
54 | SetLinkDNS(in i ifindex, | |
55 | in a(iay) addresses); | |
56 | SetLinkDNSEx(in i ifindex, | |
57 | in a(iayqs) addresses); | |
58 | SetLinkDomains(in i ifindex, | |
59 | in a(sb) domains); | |
60 | SetLinkDefaultRoute(in i ifindex, | |
61 | in b enable); | |
62 | SetLinkLLMNR(in i ifindex, | |
63 | in s mode); | |
64 | SetLinkMulticastDNS(in i ifindex, | |
65 | in s mode); | |
66 | SetLinkDNSOverTLS(in i ifindex, | |
67 | in s mode); | |
68 | SetLinkDNSSEC(in i ifindex, | |
69 | in s mode); | |
70 | SetLinkDNSSECNegativeTrustAnchors(in i ifindex, | |
71 | in as names); | |
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); | |
77 | Reload(); | |
78 | DescribeLink(in i ifindex, | |
79 | out s json); | |
80 | Describe(out s json); | |
81 | properties: | |
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 = ...; | |
535252dc LP |
90 | @org.freedesktop.DBus.Property.EmitsChangedSignal("false") |
91 | readonly u NamespaceNSID = ...; | |
558434a4 YW |
92 | }; |
93 | interface org.freedesktop.DBus.Peer { ... }; | |
94 | interface org.freedesktop.DBus.Introspectable { ... }; | |
95 | interface org.freedesktop.DBus.Properties { ... }; | |
96 | }; | |
97 | </programlisting> | |
98 | ||
99 | <!--method ListLinks is not documented!--> | |
100 | ||
101 | <!--method GetLinkByName is not documented!--> | |
102 | ||
103 | <!--method GetLinkByIndex is not documented!--> | |
104 | ||
105 | <!--method SetLinkNTP is not documented!--> | |
106 | ||
107 | <!--method SetLinkDNS is not documented!--> | |
108 | ||
109 | <!--method SetLinkDNSEx is not documented!--> | |
110 | ||
111 | <!--method SetLinkDomains is not documented!--> | |
112 | ||
113 | <!--method SetLinkDefaultRoute is not documented!--> | |
114 | ||
115 | <!--method SetLinkLLMNR is not documented!--> | |
116 | ||
117 | <!--method SetLinkMulticastDNS is not documented!--> | |
118 | ||
119 | <!--method SetLinkDNSOverTLS is not documented!--> | |
120 | ||
121 | <!--method SetLinkDNSSEC is not documented!--> | |
122 | ||
123 | <!--method SetLinkDNSSECNegativeTrustAnchors is not documented!--> | |
124 | ||
125 | <!--method RevertLinkNTP is not documented!--> | |
126 | ||
127 | <!--method RevertLinkDNS is not documented!--> | |
128 | ||
129 | <!--method RenewLink is not documented!--> | |
130 | ||
131 | <!--method ForceRenewLink is not documented!--> | |
132 | ||
133 | <!--method ReconfigureLink is not documented!--> | |
134 | ||
135 | <!--method Reload is not documented!--> | |
136 | ||
137 | <!--method DescribeLink is not documented!--> | |
138 | ||
139 | <!--method Describe is not documented!--> | |
140 | ||
141 | <!--property OperationalState is not documented!--> | |
142 | ||
143 | <!--property CarrierState is not documented!--> | |
144 | ||
145 | <!--property AddressState is not documented!--> | |
146 | ||
147 | <!--property IPv4AddressState is not documented!--> | |
148 | ||
149 | <!--property IPv6AddressState is not documented!--> | |
150 | ||
151 | <!--property OnlineState is not documented!--> | |
152 | ||
558434a4 YW |
153 | <!--Autogenerated cross-references for systemd.directives, do not edit--> |
154 | ||
155 | <variablelist class="dbus-interface" generated="True" extra-ref="org.freedesktop.network1.Manager"/> | |
156 | ||
157 | <variablelist class="dbus-interface" generated="True" extra-ref="org.freedesktop.network1.Manager"/> | |
158 | ||
159 | <variablelist class="dbus-method" generated="True" extra-ref="ListLinks()"/> | |
160 | ||
161 | <variablelist class="dbus-method" generated="True" extra-ref="GetLinkByName()"/> | |
162 | ||
163 | <variablelist class="dbus-method" generated="True" extra-ref="GetLinkByIndex()"/> | |
164 | ||
165 | <variablelist class="dbus-method" generated="True" extra-ref="SetLinkNTP()"/> | |
166 | ||
167 | <variablelist class="dbus-method" generated="True" extra-ref="SetLinkDNS()"/> | |
168 | ||
169 | <variablelist class="dbus-method" generated="True" extra-ref="SetLinkDNSEx()"/> | |
170 | ||
171 | <variablelist class="dbus-method" generated="True" extra-ref="SetLinkDomains()"/> | |
172 | ||
173 | <variablelist class="dbus-method" generated="True" extra-ref="SetLinkDefaultRoute()"/> | |
174 | ||
175 | <variablelist class="dbus-method" generated="True" extra-ref="SetLinkLLMNR()"/> | |
176 | ||
177 | <variablelist class="dbus-method" generated="True" extra-ref="SetLinkMulticastDNS()"/> | |
178 | ||
179 | <variablelist class="dbus-method" generated="True" extra-ref="SetLinkDNSOverTLS()"/> | |
180 | ||
181 | <variablelist class="dbus-method" generated="True" extra-ref="SetLinkDNSSEC()"/> | |
182 | ||
183 | <variablelist class="dbus-method" generated="True" extra-ref="SetLinkDNSSECNegativeTrustAnchors()"/> | |
184 | ||
185 | <variablelist class="dbus-method" generated="True" extra-ref="RevertLinkNTP()"/> | |
186 | ||
187 | <variablelist class="dbus-method" generated="True" extra-ref="RevertLinkDNS()"/> | |
188 | ||
189 | <variablelist class="dbus-method" generated="True" extra-ref="RenewLink()"/> | |
190 | ||
191 | <variablelist class="dbus-method" generated="True" extra-ref="ForceRenewLink()"/> | |
192 | ||
193 | <variablelist class="dbus-method" generated="True" extra-ref="ReconfigureLink()"/> | |
194 | ||
195 | <variablelist class="dbus-method" generated="True" extra-ref="Reload()"/> | |
196 | ||
197 | <variablelist class="dbus-method" generated="True" extra-ref="DescribeLink()"/> | |
198 | ||
199 | <variablelist class="dbus-method" generated="True" extra-ref="Describe()"/> | |
200 | ||
201 | <variablelist class="dbus-property" generated="True" extra-ref="OperationalState"/> | |
202 | ||
203 | <variablelist class="dbus-property" generated="True" extra-ref="CarrierState"/> | |
204 | ||
205 | <variablelist class="dbus-property" generated="True" extra-ref="AddressState"/> | |
206 | ||
207 | <variablelist class="dbus-property" generated="True" extra-ref="IPv4AddressState"/> | |
208 | ||
209 | <variablelist class="dbus-property" generated="True" extra-ref="IPv6AddressState"/> | |
210 | ||
211 | <variablelist class="dbus-property" generated="True" extra-ref="OnlineState"/> | |
212 | ||
213 | <variablelist class="dbus-property" generated="True" extra-ref="NamespaceId"/> | |
214 | ||
535252dc LP |
215 | <variablelist class="dbus-property" generated="True" extra-ref="NamespaceNSID"/> |
216 | ||
558434a4 YW |
217 | <!--End of Autogenerated section--> |
218 | ||
219 | <para> | |
220 | Provides information about the manager. | |
221 | </para> | |
535252dc LP |
222 | |
223 | <refsect2> | |
224 | <title>Properties</title> | |
225 | ||
226 | <para><varname>NamespaceId</varname> contains the inode number of the network namespace that the | |
227 | network service runs in. A client may compare this with the inode number of its own network namespace | |
228 | to verify whether the service manages the same network namespace.</para> | |
229 | ||
230 | <para><varname>NamespaceNSID</varname> contains the "nsid" identifier the kernel maintains for the | |
231 | network namespace, if there's one assigned.</para> | |
232 | </refsect2> | |
558434a4 YW |
233 | </refsect1> |
234 | ||
235 | <refsect1> | |
236 | <title>Link Object</title> | |
237 | ||
238 | <programlisting executable="systemd-networkd" node="/org/freedesktop/network1/link/_1" interface="org.freedesktop.network1.Link"> | |
239 | node /org/freedesktop/network1/link/_1 { | |
240 | interface org.freedesktop.network1.Link { | |
241 | methods: | |
242 | SetNTP(in as servers); | |
243 | SetDNS(in a(iay) addresses); | |
244 | SetDNSEx(in a(iayqs) addresses); | |
245 | SetDomains(in a(sb) domains); | |
246 | SetDefaultRoute(in b enable); | |
247 | SetLLMNR(in s mode); | |
248 | SetMulticastDNS(in s mode); | |
249 | SetDNSOverTLS(in s mode); | |
250 | SetDNSSEC(in s mode); | |
251 | SetDNSSECNegativeTrustAnchors(in as names); | |
252 | RevertNTP(); | |
253 | RevertDNS(); | |
254 | Renew(); | |
255 | ForceRenew(); | |
256 | Reconfigure(); | |
257 | Describe(out s json); | |
258 | properties: | |
259 | readonly s OperationalState = '...'; | |
260 | readonly s CarrierState = '...'; | |
261 | readonly s AddressState = '...'; | |
262 | readonly s IPv4AddressState = '...'; | |
263 | readonly s IPv6AddressState = '...'; | |
264 | readonly s OnlineState = '...'; | |
265 | readonly s AdministrativeState = '...'; | |
266 | @org.freedesktop.DBus.Property.EmitsChangedSignal("false") | |
267 | readonly (tt) BitRates = ...; | |
268 | }; | |
269 | interface org.freedesktop.DBus.Peer { ... }; | |
270 | interface org.freedesktop.DBus.Introspectable { ... }; | |
271 | interface org.freedesktop.DBus.Properties { ... }; | |
558434a4 YW |
272 | }; |
273 | </programlisting> | |
274 | ||
275 | <!--method SetNTP is not documented!--> | |
276 | ||
277 | <!--method SetDNS is not documented!--> | |
278 | ||
279 | <!--method SetDNSEx is not documented!--> | |
280 | ||
281 | <!--method SetDomains is not documented!--> | |
282 | ||
283 | <!--method SetDefaultRoute is not documented!--> | |
284 | ||
285 | <!--method SetLLMNR is not documented!--> | |
286 | ||
287 | <!--method SetMulticastDNS is not documented!--> | |
288 | ||
289 | <!--method SetDNSOverTLS is not documented!--> | |
290 | ||
291 | <!--method SetDNSSEC is not documented!--> | |
292 | ||
293 | <!--method SetDNSSECNegativeTrustAnchors is not documented!--> | |
294 | ||
295 | <!--method RevertNTP is not documented!--> | |
296 | ||
297 | <!--method RevertDNS is not documented!--> | |
298 | ||
299 | <!--method Renew is not documented!--> | |
300 | ||
301 | <!--method ForceRenew is not documented!--> | |
302 | ||
303 | <!--method Reconfigure is not documented!--> | |
304 | ||
305 | <!--method Describe is not documented!--> | |
306 | ||
307 | <!--property OperationalState is not documented!--> | |
308 | ||
309 | <!--property CarrierState is not documented!--> | |
310 | ||
311 | <!--property AddressState is not documented!--> | |
312 | ||
313 | <!--property IPv4AddressState is not documented!--> | |
314 | ||
315 | <!--property IPv6AddressState is not documented!--> | |
316 | ||
317 | <!--property OnlineState is not documented!--> | |
318 | ||
319 | <!--property AdministrativeState is not documented!--> | |
320 | ||
321 | <!--property BitRates is not documented!--> | |
322 | ||
323 | <!--Autogenerated cross-references for systemd.directives, do not edit--> | |
324 | ||
558434a4 YW |
325 | <variablelist class="dbus-interface" generated="True" extra-ref="org.freedesktop.network1.Link"/> |
326 | ||
558434a4 YW |
327 | <variablelist class="dbus-interface" generated="True" extra-ref="org.freedesktop.network1.Link"/> |
328 | ||
329 | <variablelist class="dbus-method" generated="True" extra-ref="SetNTP()"/> | |
330 | ||
331 | <variablelist class="dbus-method" generated="True" extra-ref="SetDNS()"/> | |
332 | ||
333 | <variablelist class="dbus-method" generated="True" extra-ref="SetDNSEx()"/> | |
334 | ||
335 | <variablelist class="dbus-method" generated="True" extra-ref="SetDomains()"/> | |
336 | ||
337 | <variablelist class="dbus-method" generated="True" extra-ref="SetDefaultRoute()"/> | |
338 | ||
339 | <variablelist class="dbus-method" generated="True" extra-ref="SetLLMNR()"/> | |
340 | ||
341 | <variablelist class="dbus-method" generated="True" extra-ref="SetMulticastDNS()"/> | |
342 | ||
343 | <variablelist class="dbus-method" generated="True" extra-ref="SetDNSOverTLS()"/> | |
344 | ||
345 | <variablelist class="dbus-method" generated="True" extra-ref="SetDNSSEC()"/> | |
346 | ||
347 | <variablelist class="dbus-method" generated="True" extra-ref="SetDNSSECNegativeTrustAnchors()"/> | |
348 | ||
349 | <variablelist class="dbus-method" generated="True" extra-ref="RevertNTP()"/> | |
350 | ||
351 | <variablelist class="dbus-method" generated="True" extra-ref="RevertDNS()"/> | |
352 | ||
353 | <variablelist class="dbus-method" generated="True" extra-ref="Renew()"/> | |
354 | ||
355 | <variablelist class="dbus-method" generated="True" extra-ref="ForceRenew()"/> | |
356 | ||
357 | <variablelist class="dbus-method" generated="True" extra-ref="Reconfigure()"/> | |
358 | ||
359 | <variablelist class="dbus-method" generated="True" extra-ref="Describe()"/> | |
360 | ||
361 | <variablelist class="dbus-property" generated="True" extra-ref="OperationalState"/> | |
362 | ||
363 | <variablelist class="dbus-property" generated="True" extra-ref="CarrierState"/> | |
364 | ||
365 | <variablelist class="dbus-property" generated="True" extra-ref="AddressState"/> | |
366 | ||
367 | <variablelist class="dbus-property" generated="True" extra-ref="IPv4AddressState"/> | |
368 | ||
369 | <variablelist class="dbus-property" generated="True" extra-ref="IPv6AddressState"/> | |
370 | ||
371 | <variablelist class="dbus-property" generated="True" extra-ref="OnlineState"/> | |
372 | ||
373 | <variablelist class="dbus-property" generated="True" extra-ref="AdministrativeState"/> | |
374 | ||
375 | <variablelist class="dbus-property" generated="True" extra-ref="BitRates"/> | |
376 | ||
377 | <!--End of Autogenerated section--> | |
378 | ||
379 | <para> | |
380 | Provides information about interfaces. | |
381 | </para> | |
382 | </refsect1> | |
383 | ||
384 | <refsect1> | |
385 | <title>Network Object</title> | |
386 | ||
387 | <programlisting executable="systemd-networkd" node="/org/freedesktop/network1/network/_1" interface="org.freedesktop.network1.Network"> | |
388 | node /org/freedesktop/network1/network/_1 { | |
389 | interface org.freedesktop.network1.Network { | |
390 | properties: | |
391 | @org.freedesktop.DBus.Property.EmitsChangedSignal("const") | |
392 | readonly s Description = '...'; | |
393 | @org.freedesktop.DBus.Property.EmitsChangedSignal("const") | |
394 | readonly s SourcePath = '...'; | |
395 | @org.freedesktop.DBus.Property.EmitsChangedSignal("const") | |
396 | readonly as MatchMAC = ['...', ...]; | |
397 | @org.freedesktop.DBus.Property.EmitsChangedSignal("const") | |
398 | readonly as MatchPath = ['...', ...]; | |
399 | @org.freedesktop.DBus.Property.EmitsChangedSignal("const") | |
400 | readonly as MatchDriver = ['...', ...]; | |
401 | @org.freedesktop.DBus.Property.EmitsChangedSignal("const") | |
402 | readonly as MatchType = ['...', ...]; | |
403 | @org.freedesktop.DBus.Property.EmitsChangedSignal("const") | |
404 | readonly as MatchName = ['...', ...]; | |
405 | }; | |
406 | interface org.freedesktop.DBus.Peer { ... }; | |
407 | interface org.freedesktop.DBus.Introspectable { ... }; | |
408 | interface org.freedesktop.DBus.Properties { ... }; | |
409 | }; | |
410 | </programlisting> | |
411 | ||
412 | <!--property Description is not documented!--> | |
413 | ||
414 | <!--property SourcePath is not documented!--> | |
415 | ||
416 | <!--property MatchMAC is not documented!--> | |
417 | ||
418 | <!--property MatchPath is not documented!--> | |
419 | ||
420 | <!--property MatchDriver is not documented!--> | |
421 | ||
422 | <!--property MatchType is not documented!--> | |
423 | ||
424 | <!--property MatchName is not documented!--> | |
425 | ||
426 | <!--Autogenerated cross-references for systemd.directives, do not edit--> | |
427 | ||
428 | <variablelist class="dbus-interface" generated="True" extra-ref="org.freedesktop.network1.Network"/> | |
429 | ||
430 | <variablelist class="dbus-interface" generated="True" extra-ref="org.freedesktop.network1.Network"/> | |
431 | ||
432 | <variablelist class="dbus-property" generated="True" extra-ref="Description"/> | |
433 | ||
434 | <variablelist class="dbus-property" generated="True" extra-ref="SourcePath"/> | |
435 | ||
436 | <variablelist class="dbus-property" generated="True" extra-ref="MatchMAC"/> | |
437 | ||
438 | <variablelist class="dbus-property" generated="True" extra-ref="MatchPath"/> | |
439 | ||
440 | <variablelist class="dbus-property" generated="True" extra-ref="MatchDriver"/> | |
441 | ||
442 | <variablelist class="dbus-property" generated="True" extra-ref="MatchType"/> | |
443 | ||
444 | <variablelist class="dbus-property" generated="True" extra-ref="MatchName"/> | |
445 | ||
446 | <!--End of Autogenerated section--> | |
447 | ||
448 | <para> | |
449 | Provides information about .network files. | |
450 | </para> | |
451 | </refsect1> | |
452 | ||
453 | <refsect1> | |
454 | <title>DHCP Server Object</title> | |
455 | ||
456 | <programlisting executable="systemd-networkd" node="/org/freedesktop/network1/link/_1" interface="org.freedesktop.network1.DHCPServer"> | |
457 | node /org/freedesktop/network1/link/_1 { | |
458 | interface org.freedesktop.network1.DHCPServer { | |
459 | properties: | |
460 | readonly a(uayayayayt) Leases = [...]; | |
461 | }; | |
462 | interface org.freedesktop.DBus.Peer { ... }; | |
463 | interface org.freedesktop.DBus.Introspectable { ... }; | |
464 | interface org.freedesktop.DBus.Properties { ... }; | |
53dff954 | 465 | interface org.freedesktop.network1.Link { ... }; |
558434a4 YW |
466 | }; |
467 | </programlisting> | |
468 | ||
469 | <!--property Leases is not documented!--> | |
470 | ||
471 | <!--Autogenerated cross-references for systemd.directives, do not edit--> | |
472 | ||
53dff954 YW |
473 | <variablelist class="dbus-interface" generated="True" extra-ref="org.freedesktop.network1.Link"/> |
474 | ||
558434a4 YW |
475 | <variablelist class="dbus-interface" generated="True" extra-ref="org.freedesktop.network1.DHCPServer"/> |
476 | ||
53dff954 YW |
477 | <variablelist class="dbus-interface" generated="True" extra-ref="org.freedesktop.network1.Link"/> |
478 | ||
558434a4 YW |
479 | <variablelist class="dbus-interface" generated="True" extra-ref="org.freedesktop.network1.DHCPServer"/> |
480 | ||
481 | <variablelist class="dbus-property" generated="True" extra-ref="Leases"/> | |
482 | ||
483 | <!--End of Autogenerated section--> | |
484 | ||
485 | <para> | |
486 | Provides information about leases. | |
487 | </para> | |
488 | </refsect1> | |
489 | ||
1d5db7b9 YW |
490 | <refsect1> |
491 | <title>DHCPv4 Client Object</title> | |
492 | ||
493 | <programlisting executable="systemd-networkd" node="/org/freedesktop/network1/link/_1" interface="org.freedesktop.network1.DHCPv4Client"> | |
494 | node /org/freedesktop/network1/link/_1 { | |
495 | interface org.freedesktop.network1.DHCPv4Client { | |
496 | properties: | |
497 | readonly s State = '...'; | |
498 | }; | |
499 | interface org.freedesktop.DBus.Peer { ... }; | |
500 | interface org.freedesktop.DBus.Introspectable { ... }; | |
501 | interface org.freedesktop.DBus.Properties { ... }; | |
502 | interface org.freedesktop.network1.Link { ... }; | |
503 | }; | |
504 | </programlisting> | |
505 | ||
506 | <!--property State is not documented!--> | |
507 | ||
508 | <!--Autogenerated cross-references for systemd.directives, do not edit--> | |
509 | ||
510 | <variablelist class="dbus-interface" generated="True" extra-ref="org.freedesktop.network1.Link"/> | |
511 | ||
512 | <variablelist class="dbus-interface" generated="True" extra-ref="org.freedesktop.network1.DHCPv4Client"/> | |
513 | ||
514 | <variablelist class="dbus-interface" generated="True" extra-ref="org.freedesktop.network1.Link"/> | |
515 | ||
516 | <variablelist class="dbus-interface" generated="True" extra-ref="org.freedesktop.network1.DHCPv4Client"/> | |
517 | ||
518 | <variablelist class="dbus-property" generated="True" extra-ref="State"/> | |
519 | ||
520 | <!--End of Autogenerated section--> | |
521 | ||
522 | <para> | |
523 | Provides information about DHCPv4 client status. | |
524 | </para> | |
525 | </refsect1> | |
526 | ||
527 | <refsect1> | |
528 | <title>DHCPv6 Client Object</title> | |
529 | ||
530 | <programlisting executable="systemd-networkd" node="/org/freedesktop/network1/link/_1" interface="org.freedesktop.network1.DHCPv6Client"> | |
531 | node /org/freedesktop/network1/link/_1 { | |
532 | interface org.freedesktop.network1.DHCPv6Client { | |
533 | properties: | |
534 | readonly s State = '...'; | |
535 | }; | |
536 | interface org.freedesktop.DBus.Peer { ... }; | |
537 | interface org.freedesktop.DBus.Introspectable { ... }; | |
538 | interface org.freedesktop.DBus.Properties { ... }; | |
539 | interface org.freedesktop.network1.Link { ... }; | |
540 | }; | |
541 | </programlisting> | |
542 | ||
543 | <!--property State is not documented!--> | |
544 | ||
545 | <!--Autogenerated cross-references for systemd.directives, do not edit--> | |
546 | ||
547 | <variablelist class="dbus-interface" generated="True" extra-ref="org.freedesktop.network1.Link"/> | |
548 | ||
549 | <variablelist class="dbus-interface" generated="True" extra-ref="org.freedesktop.network1.DHCPv6Client"/> | |
550 | ||
551 | <variablelist class="dbus-interface" generated="True" extra-ref="org.freedesktop.network1.Link"/> | |
552 | ||
553 | <variablelist class="dbus-interface" generated="True" extra-ref="org.freedesktop.network1.DHCPv6Client"/> | |
554 | ||
555 | <variablelist class="dbus-property" generated="True" extra-ref="State"/> | |
556 | ||
557 | <!--End of Autogenerated section--> | |
558 | ||
559 | <para> | |
560 | Provides information about DHCPv6 client status. | |
561 | </para> | |
562 | </refsect1> | |
563 | ||
558434a4 YW |
564 | <refsect1> |
565 | <title>Examples</title> | |
566 | ||
567 | <example> | |
568 | <title>Introspect <interfacename>org.freedesktop.network1.Manager</interfacename> on the bus</title> | |
569 | ||
570 | <programlisting> | |
571 | $ gdbus introspect --system \ | |
572 | --dest org.freedesktop.network1 \ | |
573 | --object-path /org/freedesktop/network1 | |
574 | </programlisting> | |
575 | </example> | |
576 | ||
577 | <example> | |
578 | <title>Introspect <interfacename>org.freedesktop.network1.Link</interfacename> on the bus</title> | |
579 | ||
580 | <programlisting> | |
581 | $ gdbus introspect --system \ | |
582 | --dest org.freedesktop.network1 \ | |
583 | --object-path /org/freedesktop/network1/link/_11 | |
584 | </programlisting> | |
585 | </example> | |
586 | </refsect1> | |
587 | ||
e4239a34 | 588 | <xi:include href="org.freedesktop.locale1.xml" xpointer="versioning"/> |
d9d2d16a AK |
589 | |
590 | <refsect1> | |
591 | <title>History</title> | |
592 | <refsect2> | |
593 | <title>DHCPv4 Client Object</title> | |
594 | <para><varname>State</varname> was added in version 255.</para> | |
595 | </refsect2> | |
596 | <refsect2> | |
597 | <title>DHCPv6 Client Object</title> | |
598 | <para><varname>State</varname> was added in version 255.</para> | |
599 | </refsect2> | |
535252dc LP |
600 | <refsect2> |
601 | <title>Manager Object</title> | |
602 | <para><varname>NamespaceNSID</varname> was added in version 256.</para> | |
603 | </refsect2> | |
d9d2d16a | 604 | </refsect1> |
558434a4 | 605 | </refentry> |