| 1. | the usual interface versioning guidelines |
NAME
org.freedesktop.network1 - The D-Bus interface of systemd-networkd
INTRODUCTION
systemd-networkd.service(8) is a system service that manages and configures network interfaces. This page describes the D-Bus interface.
THE MANAGER OBJECT
The service exposes the following interfaces on the Manager object on the bus:
node /org/freedesktop/network1 {
\n
interface org.freedesktop.network1.Manager {
\n
methods:
\n
ListLinks(out a(iso) links);
\n
GetLinkByName(in s name,
\n
out i ifindex,
\n
out o path);
\n
GetLinkByIndex(in i ifindex,
\n
out s name,
\n
out o path);
\n
SetLinkNTP(in i ifindex,
\n
in as servers);
\n
SetLinkDNS(in i ifindex,
\n
in a(iay) addresses);
\n
SetLinkDNSEx(in i ifindex,
\n
in a(iayqs) addresses);
\n
SetLinkDomains(in i ifindex,
\n
in a(sb) domains);
\n
SetLinkDefaultRoute(in i ifindex,
\n
in b enable);
\n
SetLinkLLMNR(in i ifindex,
\n
in s mode);
\n
SetLinkMulticastDNS(in i ifindex,
\n
in s mode);
\n
SetLinkDNSOverTLS(in i ifindex,
\n
in s mode);
\n
SetLinkDNSSEC(in i ifindex,
\n
in s mode);
\n
SetLinkDNSSECNegativeTrustAnchors(in i ifindex,
\n
in as names);
\n
RevertLinkNTP(in i ifindex);
\n
RevertLinkDNS(in i ifindex);
\n
RenewLink(in i ifindex);
\n
ForceRenewLink(in i ifindex);
\n
ReconfigureLink(in i ifindex);
\n
Reload();
\n
DescribeLink(in i ifindex,
\n
out s json);
\n
Describe(out s json);
\n
properties:
\n
readonly s OperationalState = '...';
\n
readonly s CarrierState = '...';
\n
readonly s AddressState = '...';
\n
readonly s IPv4AddressState = '...';
\n
readonly s IPv6AddressState = '...';
\n
readonly s OnlineState = '...';
\n
@org.freedesktop.DBus.Property.EmitsChangedSignal("const")
\n
readonly t NamespaceId = ...;
\n
@org.freedesktop.DBus.Property.EmitsChangedSignal("false")
\n
readonly u NamespaceNSID = ...;
\n
};
\n
interface org.freedesktop.DBus.Peer { ... };
\n
interface org.freedesktop.DBus.Introspectable { ... };
\n
interface org.freedesktop.DBus.Properties { ... };
};Provides information about the manager.
Properties
NamespaceId 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.
NamespaceNSID contains the "nsid" identifier the kernel maintains for the network namespace, if there's one assigned.
LINK OBJECT
node /org/freedesktop/network1/link/_1 {
\n
interface org.freedesktop.network1.Link {
\n
methods:
\n
SetNTP(in as servers);
\n
SetDNS(in a(iay) addresses);
\n
SetDNSEx(in a(iayqs) addresses);
\n
SetDomains(in a(sb) domains);
\n
SetDefaultRoute(in b enable);
\n
SetLLMNR(in s mode);
\n
SetMulticastDNS(in s mode);
\n
SetDNSOverTLS(in s mode);
\n
SetDNSSEC(in s mode);
\n
SetDNSSECNegativeTrustAnchors(in as names);
\n
RevertNTP();
\n
RevertDNS();
\n
Renew();
\n
ForceRenew();
\n
Reconfigure();
\n
Describe(out s json);
\n
properties:
\n
readonly s OperationalState = '...';
\n
readonly s CarrierState = '...';
\n
readonly s AddressState = '...';
\n
readonly s IPv4AddressState = '...';
\n
readonly s IPv6AddressState = '...';
\n
readonly s OnlineState = '...';
\n
readonly s AdministrativeState = '...';
\n
@org.freedesktop.DBus.Property.EmitsChangedSignal("false")
\n
readonly (tt) BitRates = ...;
\n
};
\n
interface org.freedesktop.DBus.Peer { ... };
\n
interface org.freedesktop.DBus.Introspectable { ... };
\n
interface org.freedesktop.DBus.Properties { ... };
};Provides information about interfaces.
NETWORK OBJECT
node /org/freedesktop/network1/network/_1 {
\n
interface org.freedesktop.network1.Network {
\n
properties:
\n
@org.freedesktop.DBus.Property.EmitsChangedSignal("const")
\n
readonly s Description = '...';
\n
@org.freedesktop.DBus.Property.EmitsChangedSignal("const")
\n
readonly s SourcePath = '...';
\n
@org.freedesktop.DBus.Property.EmitsChangedSignal("const")
\n
readonly as MatchMAC = ['...', ...];
\n
@org.freedesktop.DBus.Property.EmitsChangedSignal("const")
\n
readonly as MatchPath = ['...', ...];
\n
@org.freedesktop.DBus.Property.EmitsChangedSignal("const")
\n
readonly as MatchDriver = ['...', ...];
\n
@org.freedesktop.DBus.Property.EmitsChangedSignal("const")
\n
readonly as MatchType = ['...', ...];
\n
@org.freedesktop.DBus.Property.EmitsChangedSignal("const")
\n
readonly as MatchName = ['...', ...];
\n
};
\n
interface org.freedesktop.DBus.Peer { ... };
\n
interface org.freedesktop.DBus.Introspectable { ... };
\n
interface org.freedesktop.DBus.Properties { ... };
};Provides information about .network files.
DHCP SERVER OBJECT
node /org/freedesktop/network1/link/_1 {
\n
interface org.freedesktop.network1.DHCPServer {
\n
properties:
\n
readonly a(uayayayayt) Leases = [...];
\n
};
\n
interface org.freedesktop.DBus.Peer { ... };
\n
interface org.freedesktop.DBus.Introspectable { ... };
\n
interface org.freedesktop.DBus.Properties { ... };
\n
interface org.freedesktop.network1.Link { ... };
};Provides information about leases.
DHCPV4 CLIENT OBJECT
node /org/freedesktop/network1/link/_1 {
\n
interface org.freedesktop.network1.DHCPv4Client {
\n
properties:
\n
readonly s State = '...';
\n
};
\n
interface org.freedesktop.DBus.Peer { ... };
\n
interface org.freedesktop.DBus.Introspectable { ... };
\n
interface org.freedesktop.DBus.Properties { ... };
\n
interface org.freedesktop.network1.Link { ... };
};Provides information about DHCPv4 client status.
DHCPV6 CLIENT OBJECT
node /org/freedesktop/network1/link/_1 {
\n
interface org.freedesktop.network1.DHCPv6Client {
\n
properties:
\n
readonly s State = '...';
\n
};
\n
interface org.freedesktop.DBus.Peer { ... };
\n
interface org.freedesktop.DBus.Introspectable { ... };
\n
interface org.freedesktop.DBus.Properties { ... };
\n
interface org.freedesktop.network1.Link { ... };
};Provides information about DHCPv6 client status.
EXAMPLES
Example 1. Introspect org.freedesktop.network1.Manager on the bus
$ gdbus introspect --system \
\n
--dest org.freedesktop.network1 \
\n
--object-path /org/freedesktop/network1Example 2. Introspect org.freedesktop.network1.Link on the bus
$ gdbus introspect --system \
\n
--dest org.freedesktop.network1 \
\n
--object-path /org/freedesktop/network1/link/_11VERSIONING
These D-Bus interfaces follow the usual interface versioning guidelines[1].
HISTORY
DHCPv4 Client Object
State was added in version 255.
DHCPv6 Client Object
State was added in version 255.
Manager Object
NamespaceNSID was added in version 256.
SEE ALSO
systemd(1), systemd-networkd.service(8), networkctl(1)
NOTES
- 1.
the usual interface versioning guidelines