122 lines
4.0 KiB
HTML
122 lines
4.0 KiB
HTML
|
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
<HTML><HEAD><TITLE>Man page of netplan-dbus</TITLE>
|
|
</HEAD><BODY>
|
|
<H1>netplan-dbus</H1>
|
|
Section: (8)<BR>Updated: <BR><A HREF="#index">Index</A>
|
|
<A HREF="/cgi-bin/man/man2html">Return to Main Contents</A><HR>
|
|
|
|
|
|
<A NAME="lbAB"> </A>
|
|
<H2>NAME</H2>
|
|
|
|
<P>
|
|
|
|
netplan-dbus - daemon to access netplan's functionality via a DBus
|
|
API
|
|
<A NAME="lbAC"> </A>
|
|
<H2>SYNOPSIS</H2>
|
|
|
|
<P>
|
|
|
|
netplan-dbus
|
|
<A NAME="lbAD"> </A>
|
|
<H2>DESCRIPTION</H2>
|
|
|
|
<P>
|
|
|
|
netplan-dbus is a DBus daemon, providing
|
|
io.netplan.Netplan on the system bus.
|
|
The /io/netplan/Netplan object provides an
|
|
io.netplan.Netplan interface, offering the following methods:
|
|
<DL COMPACT>
|
|
<DT id="1">•<DD>
|
|
Apply() -> b: calls netplan apply and returns a
|
|
success or failure status.
|
|
<DT id="2">•<DD>
|
|
Info() -> a(sv): returns a dict "Features -> as",
|
|
containing an array of all available feature flags.
|
|
<DT id="3">•<DD>
|
|
Config() -> o: prepares a new config object as
|
|
/io/netplan/Netplan/config/<ID>, by copying the current state
|
|
from /{etc,run,lib}/netplan/*.yaml
|
|
</DL>
|
|
<P>
|
|
|
|
The /io/netplan/Netplan/config/<ID> objects provide a
|
|
io.netplan.Netplan.Config interface, offering the following
|
|
methods:
|
|
<DL COMPACT>
|
|
<DT id="4">•<DD>
|
|
Get() -> s: calls netplan get
|
|
-root-dir=/tmp/netplan-config-ID all and returns the merged
|
|
YAML config of the the given config object's state
|
|
<DT id="5">•<DD>
|
|
Set(s:CONFIG_DELTA, s:ORIGIN_HINT) -> b: calls netplan
|
|
set -root-dir=/tmp/netplan-config-ID
|
|
-origin-hint=ORIGIN_HINT CONFIG_DELTA
|
|
<DL COMPACT><DT id="6"><DD>
|
|
<P>
|
|
|
|
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 object, all other current and
|
|
future config objects are being invalidated 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.
|
|
</DL>
|
|
|
|
<DT id="7">•<DD>
|
|
Try(u:TIMEOUT_SEC) -> b: replaces the main netplan
|
|
configuration with this config object's state and calls netplan
|
|
try -timeout=TIMEOUT_SEC
|
|
<DT id="8">•<DD>
|
|
Cancel() -> b: rejects a currently running Try()
|
|
attempt on this config object and/or discards the config object
|
|
<DT id="9">•<DD>
|
|
Apply() -> b: replaces the main netplan configuration with
|
|
this config object's state and calls netplan apply
|
|
</DL>
|
|
<P>
|
|
|
|
For information about the Apply()/Try()/Get()/Set() functionality, see
|
|
<A HREF="/cgi-bin/man/man2html?8+netplan-apply">netplan-apply</A>(8)/<A HREF="/cgi-bin/man/man2html?8+netplan-try">netplan-try</A>(8)/<A HREF="/cgi-bin/man/man2html?8+netplan-get">netplan-get</A>(8)/<A HREF="/cgi-bin/man/man2html?8+netplan-set">netplan-set</A>(8)
|
|
accordingly.
|
|
For details of the configuration file format, see <A HREF="/cgi-bin/man/man2html?5+netplan">netplan</A>(5).
|
|
<A NAME="lbAE"> </A>
|
|
<H2>SEE ALSO</H2>
|
|
|
|
<P>
|
|
|
|
<A HREF="/cgi-bin/man/man2html?5+netplan">netplan</A>(5), <A HREF="/cgi-bin/man/man2html?8+netplan-apply">netplan-apply</A>(8),
|
|
<A HREF="/cgi-bin/man/man2html?8+netplan-try">netplan-try</A>(8), <A HREF="/cgi-bin/man/man2html?8+netplan-get">netplan-get</A>(8),
|
|
<A HREF="/cgi-bin/man/man2html?8+netplan-set">netplan-set</A>(8)
|
|
<A NAME="lbAF"> </A>
|
|
<H2>AUTHORS</H2>
|
|
|
|
Lukas Märdian (<<A HREF="mailto:lukas.maerdian@canonical.com">lukas.maerdian@canonical.com</A>>).
|
|
<P>
|
|
|
|
<HR>
|
|
<A NAME="index"> </A><H2>Index</H2>
|
|
<DL>
|
|
<DT id="10"><A HREF="#lbAB">NAME</A><DD>
|
|
<DT id="11"><A HREF="#lbAC">SYNOPSIS</A><DD>
|
|
<DT id="12"><A HREF="#lbAD">DESCRIPTION</A><DD>
|
|
<DT id="13"><A HREF="#lbAE">SEE ALSO</A><DD>
|
|
<DT id="14"><A HREF="#lbAF">AUTHORS</A><DD>
|
|
</DL>
|
|
<HR>
|
|
This document was created by
|
|
<A HREF="/cgi-bin/man/man2html">man2html</A>,
|
|
using the manual pages.<BR>
|
|
Time: 00:06:14 GMT, March 31, 2021
|
|
</BODY>
|
|
</HTML>
|