netplan-dbus(8) netplan-dbus(8)
NAME
netplan-dbus - daemon to access netplan's functionality via a DBus API
SYNOPSIS
netplan-dbus
DESCRIPTION
netplan-dbus is a DBus daemon, providing io.netplan.Netplan on the sys-
tem bus. The /io/netplan/Netplan object provides an io.netplan.Netplan
interface, offering the following methods:
• Apply() -> b: calls netplan apply and returns a success or failure
status.
• Generate() -> b: calls netplan generate and returns a success or
failure status.
• Info() -> a(sv): returns a dict "Features -> as", containing an array
of all available feature flags.
• Config() -> o: prepares a new config object as /io/netplan/Net-
plan/config/<ID>, by copying the current state from
/{etc,run,lib}/netplan/*.yaml
The /io/netplan/Netplan/config/<ID> objects provide a io.netplan.Net-
plan.Config interface, offering the following methods:
• Get() -> s: calls netplan get --root-dir=/run/netplan/config-ID all
and returns the merged YAML config of the the given config object's
state
• Set(s:CONFIG_DELTA, s:ORIGIN_HINT) -> b: calls netplan set --root-
dir=/run/netplan/config-ID --origin-hint=ORIGIN_HINT CONFIG_DELTA
CONFIG_DELTA can be something like: network.ethernets.eth0.dhcp4=true
and ORIGIN_HINT can be something like: 70-snapd (it will then write
the config to 70-snapd.yaml). Once Set() is called on a config ob-
ject, all other current and future config objects are being invali-
dated and cannot Set() or Try()/Apply() anymore, due to this pending
dirty state. After the dirty config object is rejected via Cancel(),
the other config objects are valid again. If the dirty config object
is accepted via Apply(), newly created config objects will be valid,
while the older states will stay invalid.
• Try(u:TIMEOUT_SEC) -> b: replaces the main netplan configuration with
this config object's state and calls netplan try --timeout=TIME-
OUT_SEC
• Cancel() -> b: rejects a currently running Try() attempt on this con-
fig object and/or discards the config object
• Apply() -> b: replaces the main netplan configuration with this con-
fig object's state and calls netplan apply
For information about the Apply()/Try()/Get()/Set() functionality, see
netplan-apply(8)/netplan-try(8)/netplan-get(8)/netplan-set(8) accord-
ingly. For details of the configuration file format, see netplan(5).
SEE ALSO
netplan(5), netplan-apply(8), netplan-try(8), netplan-get(8), netplan-
set(8)
AUTHORS
Lukas Märdian (<lukas.maerdian@canonical.com>).
netplan-dbus(8)
Generated by dwww version 1.14 on Sat Apr 19 21:37:23 CEST 2025.