summaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorThomas Haller <thaller@redhat.com>2023-01-19 15:34:42 +0100
committerFernando Fernandez Mancera <ffmancera@riseup.net>2023-01-19 16:11:19 +0100
commit5be942eac5fe18004d4de704eba52c790fc97b2c (patch)
tree47b45ddc26781859d2b4392adedd20b83c08db56 /src
parentd02be1c123d0c029f6f1c4739e274e61b593402f (diff)
libnm/doc: document "weight" attribute for IPv4 routes
Diffstat (limited to 'src')
-rw-r--r--src/libnm-core-impl/nm-setting-ip4-config.c7
1 files changed, 7 insertions, 0 deletions
diff --git a/src/libnm-core-impl/nm-setting-ip4-config.c b/src/libnm-core-impl/nm-setting-ip4-config.c
index e9fb6d64e8..db1416483b 100644
--- a/src/libnm-core-impl/nm-setting-ip4-config.c
+++ b/src/libnm-core-impl/nm-setting-ip4-config.c
@@ -1143,6 +1143,13 @@ nm_setting_ip4_config_class_init(NMSettingIP4ConfigClass *klass)
* The default is <literal>unicast</literal>.</para>
* </listitem>
* <listitem>
+ * <para><literal>"weight"</literal> - an unsigned 32 bit integer ranging from 0 to 256. This indicates
+ * that the IPv4 route is a ECMP route and is only allowed for routes that specify a next-hop.
+ * NetworkManager will automatically merge compatible routes into ECMP multi-hop routes.
+ * Setting to zero or omitting the attribute configures single hop routes that won't get
+ * merged. If the route finds no merge partner, it is configured as single hop route.</para>
+ * </listitem>
+ * <listitem>
* <para><literal>"window"</literal> - an unsigned 32 bit integer.</para>
* </listitem>
* </itemizedlist>