man/org.freedesktop.network1.xml

   1 <?xml version="1.0"?>
   2 <!--*-nxml-*-->
   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" >
   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 = ...;
  90   };
  91   interface org.freedesktop.DBus.Peer { ... };
  92   interface org.freedesktop.DBus.Introspectable { ... };
  93   interface org.freedesktop.DBus.Properties { ... };
  94 };
  95     </programlisting>
  96
  97     <!--method ListLinks is not documented!-->
  98
  99     <!--method GetLinkByName is not documented!-->
 100
 101     <!--method GetLinkByIndex is not documented!-->
 102
 103     <!--method SetLinkNTP is not documented!-->
 104
 105     <!--method SetLinkDNS is not documented!-->
 106
 107     <!--method SetLinkDNSEx is not documented!-->
 108
 109     <!--method SetLinkDomains is not documented!-->
 110
 111     <!--method SetLinkDefaultRoute is not documented!-->
 112
 113     <!--method SetLinkLLMNR is not documented!-->
 114
 115     <!--method SetLinkMulticastDNS is not documented!-->
 116
 117     <!--method SetLinkDNSOverTLS is not documented!-->
 118
 119     <!--method SetLinkDNSSEC is not documented!-->
 120
 121     <!--method SetLinkDNSSECNegativeTrustAnchors is not documented!-->
 122
 123     <!--method RevertLinkNTP is not documented!-->
 124
 125     <!--method RevertLinkDNS is not documented!-->
 126
 127     <!--method RenewLink is not documented!-->
 128
 129     <!--method ForceRenewLink is not documented!-->
 130
 131     <!--method ReconfigureLink is not documented!-->
 132
 133     <!--method Reload is not documented!-->
 134
 135     <!--method DescribeLink is not documented!-->
 136
 137     <!--method Describe is not documented!-->
 138
 139     <!--property OperationalState is not documented!-->
 140
 141     <!--property CarrierState is not documented!-->
 142
 143     <!--property AddressState is not documented!-->
 144
 145     <!--property IPv4AddressState is not documented!-->
 146
 147     <!--property IPv6AddressState is not documented!-->
 148
 149     <!--property OnlineState is not documented!-->
 150
 151     <!--property NamespaceId is not documented!-->
 152
 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
 215     <!--End of Autogenerated section-->
 216
 217     <para>
 218       Provides information about the manager.
 219     </para>
 220   </refsect1>
 221
 222   <refsect1>
 223     <title>Link Object</title>
 224
 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 {
 228     methods:
 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);
 234       SetLLMNR(in  s mode);
 235       SetMulticastDNS(in  s mode);
 236       SetDNSOverTLS(in  s mode);
 237       SetDNSSEC(in  s mode);
 238       SetDNSSECNegativeTrustAnchors(in  as names);
 239       RevertNTP();
 240       RevertDNS();
 241       Renew();
 242       ForceRenew();
 243       Reconfigure();
 244       Describe(out s json);
 245     properties:
 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 = ...;
 255   };
 256   interface org.freedesktop.DBus.Peer { ... };
 257   interface org.freedesktop.DBus.Introspectable { ... };
 258   interface org.freedesktop.DBus.Properties { ... };
 259 };
 260     </programlisting>
 261
 262     <!--method SetNTP is not documented!-->
 263
 264     <!--method SetDNS is not documented!-->
 265
 266     <!--method SetDNSEx is not documented!-->
 267
 268     <!--method SetDomains is not documented!-->
 269
 270     <!--method SetDefaultRoute is not documented!-->
 271
 272     <!--method SetLLMNR is not documented!-->
 273
 274     <!--method SetMulticastDNS is not documented!-->
 275
 276     <!--method SetDNSOverTLS is not documented!-->
 277
 278     <!--method SetDNSSEC is not documented!-->
 279
 280     <!--method SetDNSSECNegativeTrustAnchors is not documented!-->
 281
 282     <!--method RevertNTP is not documented!-->
 283
 284     <!--method RevertDNS is not documented!-->
 285
 286     <!--method Renew is not documented!-->
 287
 288     <!--method ForceRenew is not documented!-->
 289
 290     <!--method Reconfigure is not documented!-->
 291
 292     <!--method Describe is not documented!-->
 293
 294     <!--property OperationalState is not documented!-->
 295
 296     <!--property CarrierState is not documented!-->
 297
 298     <!--property AddressState is not documented!-->
 299
 300     <!--property IPv4AddressState is not documented!-->
 301
 302     <!--property IPv6AddressState is not documented!-->
 303
 304     <!--property OnlineState is not documented!-->
 305
 306     <!--property AdministrativeState is not documented!-->
 307
 308     <!--property BitRates is not documented!-->
 309
 310     <!--Autogenerated cross-references for systemd.directives, do not edit-->
 311
 312     <variablelist class="dbus-interface" generated="True" extra-ref="org.freedesktop.network1.Link"/>
 313
 314     <variablelist class="dbus-interface" generated="True" extra-ref="org.freedesktop.network1.Link"/>
 315
 316     <variablelist class="dbus-method" generated="True" extra-ref="SetNTP()"/>
 317
 318     <variablelist class="dbus-method" generated="True" extra-ref="SetDNS()"/>
 319
 320     <variablelist class="dbus-method" generated="True" extra-ref="SetDNSEx()"/>
 321
 322     <variablelist class="dbus-method" generated="True" extra-ref="SetDomains()"/>
 323
 324     <variablelist class="dbus-method" generated="True" extra-ref="SetDefaultRoute()"/>
 325
 326     <variablelist class="dbus-method" generated="True" extra-ref="SetLLMNR()"/>
 327
 328     <variablelist class="dbus-method" generated="True" extra-ref="SetMulticastDNS()"/>
 329
 330     <variablelist class="dbus-method" generated="True" extra-ref="SetDNSOverTLS()"/>
 331
 332     <variablelist class="dbus-method" generated="True" extra-ref="SetDNSSEC()"/>
 333
 334     <variablelist class="dbus-method" generated="True" extra-ref="SetDNSSECNegativeTrustAnchors()"/>
 335
 336     <variablelist class="dbus-method" generated="True" extra-ref="RevertNTP()"/>
 337
 338     <variablelist class="dbus-method" generated="True" extra-ref="RevertDNS()"/>
 339
 340     <variablelist class="dbus-method" generated="True" extra-ref="Renew()"/>
 341
 342     <variablelist class="dbus-method" generated="True" extra-ref="ForceRenew()"/>
 343
 344     <variablelist class="dbus-method" generated="True" extra-ref="Reconfigure()"/>
 345
 346     <variablelist class="dbus-method" generated="True" extra-ref="Describe()"/>
 347
 348     <variablelist class="dbus-property" generated="True" extra-ref="OperationalState"/>
 349
 350     <variablelist class="dbus-property" generated="True" extra-ref="CarrierState"/>
 351
 352     <variablelist class="dbus-property" generated="True" extra-ref="AddressState"/>
 353
 354     <variablelist class="dbus-property" generated="True" extra-ref="IPv4AddressState"/>
 355
 356     <variablelist class="dbus-property" generated="True" extra-ref="IPv6AddressState"/>
 357
 358     <variablelist class="dbus-property" generated="True" extra-ref="OnlineState"/>
 359
 360     <variablelist class="dbus-property" generated="True" extra-ref="AdministrativeState"/>
 361
 362     <variablelist class="dbus-property" generated="True" extra-ref="BitRates"/>
 363
 364     <!--End of Autogenerated section-->
 365
 366     <para>
 367       Provides information about interfaces.
 368     </para>
 369   </refsect1>
 370
 371   <refsect1>
 372     <title>Network Object</title>
 373
 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 {
 377     properties:
 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 = ['...', ...];
 392   };
 393   interface org.freedesktop.DBus.Peer { ... };
 394   interface org.freedesktop.DBus.Introspectable { ... };
 395   interface org.freedesktop.DBus.Properties { ... };
 396 };
 397     </programlisting>
 398
 399     <!--property Description is not documented!-->
 400
 401     <!--property SourcePath is not documented!-->
 402
 403     <!--property MatchMAC is not documented!-->
 404
 405     <!--property MatchPath is not documented!-->
 406
 407     <!--property MatchDriver is not documented!-->
 408
 409     <!--property MatchType is not documented!-->
 410
 411     <!--property MatchName is not documented!-->
 412
 413     <!--Autogenerated cross-references for systemd.directives, do not edit-->
 414
 415     <variablelist class="dbus-interface" generated="True" extra-ref="org.freedesktop.network1.Network"/>
 416
 417     <variablelist class="dbus-interface" generated="True" extra-ref="org.freedesktop.network1.Network"/>
 418
 419     <variablelist class="dbus-property" generated="True" extra-ref="Description"/>
 420
 421     <variablelist class="dbus-property" generated="True" extra-ref="SourcePath"/>
 422
 423     <variablelist class="dbus-property" generated="True" extra-ref="MatchMAC"/>
 424
 425     <variablelist class="dbus-property" generated="True" extra-ref="MatchPath"/>
 426
 427     <variablelist class="dbus-property" generated="True" extra-ref="MatchDriver"/>
 428
 429     <variablelist class="dbus-property" generated="True" extra-ref="MatchType"/>
 430
 431     <variablelist class="dbus-property" generated="True" extra-ref="MatchName"/>
 432
 433     <!--End of Autogenerated section-->
 434
 435     <para>
 436       Provides information about .network files.
 437     </para>
 438   </refsect1>
 439
 440   <refsect1>
 441     <title>DHCP Server Object</title>
 442
 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 {
 446     properties:
 447       readonly a(uayayayayt) Leases = [...];
 448   };
 449   interface org.freedesktop.DBus.Peer { ... };
 450   interface org.freedesktop.DBus.Introspectable { ... };
 451   interface org.freedesktop.DBus.Properties { ... };
 452   interface org.freedesktop.network1.Link { ... };
 453 };
 454     </programlisting>
 455
 456     <!--property Leases is not documented!-->
 457
 458     <!--Autogenerated cross-references for systemd.directives, do not edit-->
 459
 460     <variablelist class="dbus-interface" generated="True" extra-ref="org.freedesktop.network1.Link"/>
 461
 462     <variablelist class="dbus-interface" generated="True" extra-ref="org.freedesktop.network1.DHCPServer"/>
 463
 464     <variablelist class="dbus-interface" generated="True" extra-ref="org.freedesktop.network1.Link"/>
 465
 466     <variablelist class="dbus-interface" generated="True" extra-ref="org.freedesktop.network1.DHCPServer"/>
 467
 468     <variablelist class="dbus-property" generated="True" extra-ref="Leases"/>
 469
 470     <!--End of Autogenerated section-->
 471
 472     <para>
 473       Provides information about leases.
 474     </para>
 475   </refsect1>
 476
 477   <refsect1>
 478     <title>DHCPv4 Client Object</title>
 479
 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 {
 483     properties:
 484       readonly s State = '...';
 485   };
 486   interface org.freedesktop.DBus.Peer { ... };
 487   interface org.freedesktop.DBus.Introspectable { ... };
 488   interface org.freedesktop.DBus.Properties { ... };
 489   interface org.freedesktop.network1.Link { ... };
 490 };
 491     </programlisting>
 492
 493     <!--property State is not documented!-->
 494
 495     <!--Autogenerated cross-references for systemd.directives, do not edit-->
 496
 497     <variablelist class="dbus-interface" generated="True" extra-ref="org.freedesktop.network1.Link"/>
 498
 499     <variablelist class="dbus-interface" generated="True" extra-ref="org.freedesktop.network1.DHCPv4Client"/>
 500
 501     <variablelist class="dbus-interface" generated="True" extra-ref="org.freedesktop.network1.Link"/>
 502
 503     <variablelist class="dbus-interface" generated="True" extra-ref="org.freedesktop.network1.DHCPv4Client"/>
 504
 505     <variablelist class="dbus-property" generated="True" extra-ref="State"/>
 506
 507     <!--End of Autogenerated section-->
 508
 509     <para>
 510       Provides information about DHCPv4 client status.
 511     </para>
 512   </refsect1>
 513
 514   <refsect1>
 515     <title>DHCPv6 Client Object</title>
 516
 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 {
 520     properties:
 521       readonly s State = '...';
 522   };
 523   interface org.freedesktop.DBus.Peer { ... };
 524   interface org.freedesktop.DBus.Introspectable { ... };
 525   interface org.freedesktop.DBus.Properties { ... };
 526   interface org.freedesktop.network1.Link { ... };
 527 };
 528     </programlisting>
 529
 530     <!--property State is not documented!-->
 531
 532     <!--Autogenerated cross-references for systemd.directives, do not edit-->
 533
 534     <variablelist class="dbus-interface" generated="True" extra-ref="org.freedesktop.network1.Link"/>
 535
 536     <variablelist class="dbus-interface" generated="True" extra-ref="org.freedesktop.network1.DHCPv6Client"/>
 537
 538     <variablelist class="dbus-interface" generated="True" extra-ref="org.freedesktop.network1.Link"/>
 539
 540     <variablelist class="dbus-interface" generated="True" extra-ref="org.freedesktop.network1.DHCPv6Client"/>
 541
 542     <variablelist class="dbus-property" generated="True" extra-ref="State"/>
 543
 544     <!--End of Autogenerated section-->
 545
 546     <para>
 547       Provides information about DHCPv6 client status.
 548     </para>
 549   </refsect1>
 550
 551   <refsect1>
 552     <title>Examples</title>
 553
 554     <example>
 555       <title>Introspect <interfacename>org.freedesktop.network1.Manager</interfacename> on the bus</title>
 556
 557       <programlisting>
 558 $ gdbus introspect --system \
 559   --dest org.freedesktop.network1 \
 560   --object-path /org/freedesktop/network1
 561       </programlisting>
 562     </example>
 563
 564     <example>
 565       <title>Introspect <interfacename>org.freedesktop.network1.Link</interfacename> on the bus</title>
 566
 567       <programlisting>
 568 $ gdbus introspect --system \
 569   --dest org.freedesktop.network1 \
 570   --object-path /org/freedesktop/network1/link/_11
 571       </programlisting>
 572     </example>
 573   </refsect1>
 574
 575   <xi:include href="org.freedesktop.locale1.xml" xpointer="versioning"/>
 576
 577   <refsect1>
 578     <title>History</title>
 579     <refsect2>
 580       <title>DHCPv4 Client Object</title>
 581       <para><varname>State</varname> was added in version 255.</para>
 582     </refsect2>
 583     <refsect2>
 584       <title>DHCPv6 Client Object</title>
 585       <para><varname>State</varname> was added in version 255.</para>
 586     </refsect2>
 587   </refsect1>
 588 </refentry>