.\" Automatically generated by Pandoc 3.1.8
.\"
.TH "netplan-dbus" "8" "" "" ""
.SH NAME
netplan-dbus - daemon to access netplan\[aq]s functionality via a DBus
API
.SH SYNOPSIS
\f[B]netplan-dbus\f[R]
.SH DESCRIPTION
\f[B]netplan-dbus\f[R] is a DBus daemon, providing
\f[CR]io.netplan.Netplan\f[R] on the system bus.
The \f[CR]/io/netplan/Netplan\f[R] object provides an
\f[CR]io.netplan.Netplan\f[R] interface, offering the following methods:
.IP \[bu] 2
\f[CR]Apply() -> b\f[R]: calls \f[B]netplan apply\f[R] and returns a
success or failure status.
.IP \[bu] 2
\f[CR]Generate() -> b\f[R]: calls \f[B]netplan generate\f[R] and returns
a success or failure status.
.IP \[bu] 2
\f[CR]Info() -> a(sv)\f[R]: returns a dict \[dq]Features -> as\[dq],
containing an array of all available feature flags.
.IP \[bu] 2
\f[CR]Config() -> o\f[R]: prepares a new config object as
\f[CR]/io/netplan/Netplan/config/<ID>\f[R], by copying the current state
from \f[CR]/{etc,run,lib}/netplan/*.yaml\f[R]
.PP
The \f[CR]/io/netplan/Netplan/config/<ID>\f[R] objects provide a
\f[CR]io.netplan.Netplan.Config\f[R] interface, offering the following
methods:
.IP \[bu] 2
\f[CR]Get() -> s\f[R]: calls \f[B]netplan get
--root-dir=/run/netplan/config-ID all\f[R] and returns the merged YAML
config of the the given config object\[aq]s state
.IP \[bu] 2
\f[CR]Set(s:CONFIG_DELTA, s:ORIGIN_HINT) -> b\f[R]: calls \f[B]netplan
set --root-dir=/run/netplan/config-ID --origin-hint=ORIGIN_HINT
CONFIG_DELTA\f[R]
.RS 2
.PP
CONFIG_DELTA can be something like:
\f[CR]network.ethernets.eth0.dhcp4=true\f[R] and ORIGIN_HINT can be
something like: \f[CR]70-snapd\f[R] (it will then write the config to
\f[CR]70-snapd.yaml\f[R]).
Once \f[CR]Set()\f[R] is called on a config object, all other current
and future config objects are being invalidated and cannot
\f[CR]Set()\f[R] or \f[CR]Try()/Apply()\f[R] anymore, due to this
pending dirty state.
After the dirty config object is rejected via \f[CR]Cancel()\f[R], the
other config objects are valid again.
If the dirty config object is accepted via \f[CR]Apply()\f[R], newly
created config objects will be valid, while the older states will stay
invalid.
.RE
.IP \[bu] 2
\f[CR]Try(u:TIMEOUT_SEC) -> b\f[R]: replaces the main netplan
configuration with this config object\[aq]s state and calls \f[B]netplan
try --timeout=TIMEOUT_SEC\f[R]
.IP \[bu] 2
\f[CR]Cancel() -> b\f[R]: rejects a currently running \f[CR]Try()\f[R]
attempt on this config object and/or discards the config object
.IP \[bu] 2
\f[CR]Apply() -> b\f[R]: replaces the main netplan configuration with
this config object\[aq]s state and calls \f[B]netplan apply\f[R]
.PP
For information about the Apply()/Try()/Get()/Set() functionality, see
\f[B]netplan-apply\f[R](8)/\f[B]netplan-try\f[R](8)/\f[B]netplan-get\f[R](8)/\f[B]netplan-set\f[R](8)
accordingly.
For details of the configuration file format, see \f[B]netplan\f[R](5).
.SH SEE ALSO
\f[B]netplan\f[R](5), \f[B]netplan-apply\f[R](8),
\f[B]netplan-try\f[R](8), \f[B]netplan-get\f[R](8),
\f[B]netplan-set\f[R](8)
.SH AUTHORS
Lukas Märdian (<lukas.maerdian@canonical.com>).