summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBeniamino Galvani <bgalvani@redhat.com>2021-04-29 11:13:34 +0200
committerBeniamino Galvani <bgalvani@redhat.com>2021-05-03 22:13:36 +0200
commit43fc98498968ef64edb270c5488c04ad94bdd232 (patch)
tree251053511225e0652d91eba55f087fc715af3b72
parentfa1f628bce9f82bd4c753d75709203c72fff310c (diff)
downloadNetworkManager-43fc98498968ef64edb270c5488c04ad94bdd232.tar.gz
man: document the 'nmcli general reload' command
-rw-r--r--man/nmcli.xml61
-rw-r--r--src/nmcli/general.c3
2 files changed, 63 insertions, 1 deletions
diff --git a/man/nmcli.xml b/man/nmcli.xml
index b0665efd69..bc72c3110b 100644
--- a/man/nmcli.xml
+++ b/man/nmcli.xml
@@ -356,6 +356,7 @@
<arg choice='plain'><command>hostname</command></arg>
<arg choice='plain'><command>permissions</command></arg>
<arg choice='plain'><command>logging</command></arg>
+ <arg choice='plain'><command>reload</command></arg>
</group>
<arg rep='repeat'><replaceable>ARGUMENTS</replaceable></arg>
</cmdsynopsis>
@@ -419,6 +420,66 @@
for available level and domain values.</para>
</listitem>
</varlistentry>
+
+ <varlistentry>
+ <term>
+ <command>reload</command>
+ <arg rep='repeat'><replaceable>flags</replaceable></arg>
+ </term>
+
+ <listitem>
+ <para>
+ Reload NetworkManager's configuration and perform certain
+ updates, like flushing caches or rewriting external state to
+ disk. This is similar to sending SIGHUP to NetworkManager
+ but it allows for more fine-grained control over what to
+ reload through the flags argument. It also allows non-root
+ access via PolicyKit and contrary to signals it is
+ synchronous. Available flags are:
+ </para>
+ <variablelist>
+ <varlistentry>
+ <term><option>conf</option></term>
+ <listitem><para>
+ Reload the NetworkManager.conf configuration from
+ disk. Note that this does not include connections, which
+ can be reloaded through <command>nmcli connection
+ reload</command> instead.
+ </para></listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>dns-rc</option></term>
+ <listitem><para>
+ Update DNS configuration, which usually involves writing
+ /etc/resolv.conf anew. This is equivalent to sending the
+ SIGUSR1 signal to the NetworkManager process.
+ </para></listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term><option>dns-full</option></term>
+ <listitem><para>
+ Restart the DNS plugin. This is for example useful when
+ using dnsmasq plugin, which uses additional
+ configuration in
+ <filename>/etc/NetworkManager/dnsmasq.d</filename>. If
+ you edit those files, you can restart the DNS
+ plugin. This action shortly interrupts name resolution.
+ </para></listitem>
+ </varlistentry>
+ </variablelist>
+ <para>
+ With no flags, everything that is supported is reloaded,
+ which is identical to sending a SIGHUP. See
+ <citerefentry>
+ <refentrytitle>NetworkManager</refentrytitle>
+ <manvolnum>8</manvolnum>
+ </citerefentry>
+ for more details about signals.
+ </para>
+ </listitem>
+ </varlistentry>
</variablelist>
</refsect1>
diff --git a/src/nmcli/general.c b/src/nmcli/general.c
index f0b4309e59..e40f39e527 100644
--- a/src/nmcli/general.c
+++ b/src/nmcli/general.c
@@ -344,7 +344,8 @@ usage_general_reload(void)
" can be reloaded through 'nmcli connection reload' instead.\n"
"\n"
" 'dns-rc' Update DNS configuration, which usually involves writing\n"
- " /etc/resolv.conf anew.\n"
+ " /etc/resolv.conf anew. This is equivalent to sending the\n"
+ " SIGUSR1 signal to the NetworkManager process.\n"
"\n"
" 'dns-full' Restart the DNS plugin. This is for example useful when\n"
" using dnsmasq plugin, which uses additional configuration\n"