.\" Automatically generated by Pandoc 3.1.12.1
.\"
.TH "NETPLAN\-DBUS" "8" "" "" ""
.SH NAME
\f[CR]netplan\-dbus\f[R] \- daemon to access Netplan functionality via a
D\-Bus API
.SH SYNOPSIS
\f[B]\f[CB]netplan\-dbus\f[B]\f[R]
.SH DESCRIPTION
\f[B]\f[CB]netplan\-dbus\f[B]\f[R] is a D\-Bus 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[CR]netplan apply\f[R] and returns a
success or failure status.
.IP \[bu] 2
\f[CR]Generate() \-> b\f[R]: calls \f[CR]netplan generate\f[R] and
returns a success or failure status.
.IP \[bu] 2
\f[CR]Info() \-> a(sv)\f[R]: returns a dictionary \[dq]Features \->
as\[dq], containing an array of all available feature flags.
.IP \[bu] 2
\f[CR]Config() \-> o\f[R]: prepares a new configuration 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[CR]netplan get \-\-root\-dir=/run/netplan/config\-ID all\f[R] and
returns the merged YAML configuration of the the given configuration
object\[aq]s state
.IP \[bu] 2
\f[CR]Set(s:CONFIG_DELTA, s:ORIGIN_HINT) \-> b\f[R]: calls
\f[CR]netplan set \-\-root\-dir=/run/netplan/config\-ID \-\-origin\-hint=ORIGIN_HINT CONFIG_DELTA\f[R]
.RS 2
.PP
\f[CR]CONFIG_DELTA\f[R] can be something like:
\f[CR]network.ethernets.eth0.dhcp4=true\f[R] and \f[CR]ORIGIN_HINT\f[R]
can be something like: \f[CR]70\-snapd\f[R] (it will then write the
configuration to \f[CR]70\-snapd.yaml\f[R]).
Once \f[CR]Set()\f[R] is called on a configuration object, all other
current and future configuration 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 configuration object is rejected via
\f[CR]Cancel()\f[R], the other configuration objects are valid again.
If the dirty configuration object is accepted via \f[CR]Apply()\f[R],
newly created configuration 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 configuration object\[aq]s state and calls
\f[CR]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 configuration object and/or discards the configuration
object.
.IP \[bu] 2
\f[CR]Apply() \-> b\f[R]: replaces the main Netplan configuration with
this configuration object\[aq]s state and calls
\f[CR]netplan apply\f[R].
.PP
For information about the
\f[CR]Apply()\f[R]/\f[CR]Try()\f[R]/\f[CR]Get()\f[R]/\f[CR]Set()\f[R]
functionality, see
\f[B]\f[CB]netplan\-apply\f[B]\f[R](8)/\f[B]\f[CB]netplan\-try\f[B]\f[R](8)/\f[B]\f[CB]netplan\-get\f[B]\f[R](8)/\f[B]\f[CB]netplan\-set\f[B]\f[R](8)
accordingly.
For details of the configuration file format, see
\f[B]\f[CB]netplan\f[B]\f[R](5).
.SH SEE ALSO
\f[B]\f[CB]netplan\f[B]\f[R](5), \f[B]\f[CB]netplan\-apply\f[B]\f[R](8),
\f[B]\f[CB]netplan\-try\f[B]\f[R](8),
\f[B]\f[CB]netplan\-get\f[B]\f[R](8),
\f[B]\f[CB]netplan\-set\f[B]\f[R](8)
.SH AUTHORS
Lukas Märdian (\c
.MT lukas.maerdian@canonical.com
.ME \c
).