about summary refs log tree commit diff
path: root/docs/api
diff options
context:
space:
mode:
Diffstat (limited to 'docs/api')
-rw-r--r--docs/api/Makefile.in1
-rw-r--r--docs/api/html/NetworkManager.conf.html2
-rw-r--r--docs/api/html/index.html2
-rw-r--r--docs/api/html/ix01.html2
-rw-r--r--docs/api/html/nm-settings-dbus.html19
-rw-r--r--docs/api/html/nm-settings-ifcfg-rh.html22
-rw-r--r--docs/api/html/nm-settings-nmcli.html20
-rw-r--r--docs/api/html/settings-bond-port.html12
-rw-r--r--docs/api/settings-spec.xml2
-rw-r--r--docs/api/version.xml2
10 files changed, 66 insertions, 18 deletions
diff --git a/docs/api/Makefile.in b/docs/api/Makefile.in
index 62582bcc..d7a09949 100644
--- a/docs/api/Makefile.in
+++ b/docs/api/Makefile.in
@@ -326,6 +326,7 @@ PKG_CONFIG = @PKG_CONFIG@
 PKG_CONFIG_LIBDIR = @PKG_CONFIG_LIBDIR@
 PKG_CONFIG_PATH = @PKG_CONFIG_PATH@
 POSUB = @POSUB@
+PPPD_CFLAGS = @PPPD_CFLAGS@
 PPPD_PATH = @PPPD_PATH@
 PPPD_PLUGIN_DIR = @PPPD_PLUGIN_DIR@
 PTHREAD_CC = @PTHREAD_CC@
diff --git a/docs/api/html/NetworkManager.conf.html b/docs/api/html/NetworkManager.conf.html
index 30d5660a..b4134352 100644
--- a/docs/api/html/NetworkManager.conf.html
+++ b/docs/api/html/NetworkManager.conf.html
@@ -1565,7 +1565,7 @@ enable=nm-version-max:1.2.6
               <code class="literal">NM_CONFIG_ENABLE_TAG</code>, like:
 </p>
 <pre class="programlisting">
-# always skip loading the file when running NetworkManager with
+# only load the file when running NetworkManager with
 # environment variable "NM_CONFIG_ENABLE_TAG=TAG1"
 [.config]
 enable=env:TAG1
diff --git a/docs/api/html/index.html b/docs/api/html/index.html
index 3ce39694..56e3108b 100644
--- a/docs/api/html/index.html
+++ b/docs/api/html/index.html
@@ -16,7 +16,7 @@
 <div>
 <div><table class="navigation" id="top" width="100%" cellpadding="2" cellspacing="0"><tr><th valign="middle"><p class="title">NetworkManager Reference Manual</p></th></tr></table></div>
 <div><p class="releaseinfo">
-      for NetworkManager 1.42.6
+      for NetworkManager 1.42.8
 
       The latest version of this documentation can be found on-line at
       <a class="ulink" href="https://networkmanager.dev/docs/api/latest/" target="_top">https://networkmanager.dev/docs/api/latest/</a>.
diff --git a/docs/api/html/ix01.html b/docs/api/html/ix01.html
index e087c18a..0a54382c 100644
--- a/docs/api/html/ix01.html
+++ b/docs/api/html/ix01.html
@@ -1343,7 +1343,7 @@
 </dt>
 <dt id="ientry-id-1.4.8.33.5.5.2">org.freedesktop.NetworkManager.PPP.SetState(), <a class="indexterm" href="gdbus-org.freedesktop.NetworkManager.PPP.html#gdbus-method-org-freedesktop-NetworkManager-PPP.SetState">The SetState() method</a>
 </dt>
-<dt id="ientry-id-1.3.3.36.2.2.1.1.2.5.1.1.1">prio, <a class="indexterm" href="settings-team-port.html">team-port</a>
+<dt id="ientry-id-1.3.3.36.2.2.1.1.2.5.1.1.1">prio, <a class="indexterm" href="settings-team-port.html">team-port</a>, <a class="indexterm" href="settings-bond-port.html">bond-port</a>
 </dt>
 <dt id="ientry-id-1.3.3.8.2.2.1.1.2.22.1.1.1">priority, <a class="indexterm" href="settings-bridge.html">bridge</a>, <a class="indexterm" href="settings-bridge-port.html">bridge-port</a>, <a class="indexterm" href="settings-hostname.html">hostname</a>
 </dt>
diff --git a/docs/api/html/nm-settings-dbus.html b/docs/api/html/nm-settings-dbus.html
index f78c2612..778860e6 100644
--- a/docs/api/html/nm-settings-dbus.html
+++ b/docs/api/html/nm-settings-dbus.html
@@ -1609,7 +1609,11 @@ This property is deprecated since version 1.16.User-provided values for this set
 <a name="nm-settings-dbus.property.infiniband.p-key"></a>p-key</td>
 <td align="left">int32</td>
 <td align="left">-1</td>
-<td>The InfiniBand P_Key to use for this device. A value of -1 means to use the default P_Key (aka "the P_Key at index 0"). Otherwise, it is a 16-bit unsigned integer, whose high bit is set if it is a "full membership" P_Key.</td>
+<td>The InfiniBand p-key to use for this device. A value of -1 means to use the default p-key (aka "the p-key at index 0"). Otherwise, it is a 16-bit unsigned integer, whose high bit 0x8000 is set if it is a "full membership" p-key. The values 0 and 0x8000 are not allowed.
+
+With the p-key set, the interface name is always "$parent.$p_key". Setting "connection.interface-name" to another name is not supported.
+
+Note that kernel will internally always set the full membership bit, although the interface name does not reflect that. Usually the user would want to configure a full membership p-key with 0x8000 flag set.</td>
 </tr>
 <tr>
 <td align="left">
@@ -4672,13 +4676,22 @@ WPS can be disabled by setting this property to a value of 1.</td>
 <th>Default Value</th>
 <th>Value Description</th>
 </tr></thead>
-<tbody><tr>
+<tbody>
+<tr>
+<td align="left">
+<a name="nm-settings-dbus.property.bond-port.prio"></a>prio</td>
+<td align="left">int32</td>
+<td align="left">0</td>
+<td>The port priority for bond active port re-selection during failover. A higher number means a higher priority in selection. The primary port has the highest priority. This option is only compatible with active-backup, balance-tlb and balance-alb modes.</td>
+</tr>
+<tr>
 <td align="left">
 <a name="nm-settings-dbus.property.bond-port.queue-id"></a>queue-id</td>
 <td align="left">uint32</td>
 <td align="left">0</td>
 <td>The queue ID of this bond port. The maximum value of queue ID is the number of TX queues currently active in device.</td>
-</tr></tbody>
+</tr>
+</tbody>
 </table></div>
 </div>
 <hr>
diff --git a/docs/api/html/nm-settings-ifcfg-rh.html b/docs/api/html/nm-settings-ifcfg-rh.html
index a63ae165..f5674127 100644
--- a/docs/api/html/nm-settings-ifcfg-rh.html
+++ b/docs/api/html/nm-settings-ifcfg-rh.html
@@ -1101,14 +1101,26 @@ Example: </strong></span>BONDING_OPTS="miimon=100 mode=broadcast"</td>
 <th>Default</th>
 <th>Description</th>
 </tr></thead>
-<tbody><tr>
+<tbody>
+<tr>
 <td align="left">queue-id</td>
-<td align="left">BONDING_OPTS: queue-id=</td>
+<td align="left">BOND_PORT_QUEUE_ID<span class="emphasis"><em>(+)</em></span>
+</td>
 <td align="left">0</td>
 <td align="left">Queue ID.<span class="bold"><strong>
 
 Allowed values: </strong></span>0 - 65535</td>
-</tr></tbody>
+</tr>
+<tr>
+<td align="left">prio</td>
+<td align="left">BOND_PORT_PRIO<span class="emphasis"><em>(+)</em></span>
+</td>
+<td align="left">0</td>
+<td align="left">Port priority.<span class="bold"><strong>
+
+Allowed values: </strong></span>-2147483648 - 2147483647</td>
+</tr>
+</tbody>
 </table></div>
 </div>
 <br class="table-break"><div class="table">
@@ -1892,9 +1904,9 @@ Example: </strong></span>HWADDR=01:02:03:04:05:06:07:08:09:0A:01:02:03:04:05:06:
 </tr>
 <tr>
 <td align="left">p-key</td>
-<td align="left">PKEY_ID (and PKEY=yes)</td>
+<td align="left">PKEY_ID or PKEY_ID_NM(*) (requires PKEY=yes)</td>
 <td align="left">PKEY=no</td>
-<td align="left">InfiniBand P_Key. The value can be a hex number prefixed with "0x" or a decimal number. When PKEY_ID is specified, PHYSDEV and DEVICE also must be specified.<span class="bold"><strong>
+<td align="left">InfiniBand P_Key. The value can be a hex number prefixed with "0x" or a decimal number. When PKEY_ID is specified, PHYSDEV must be specified. Note that ifcfg-rh format will always automatically set the full membership flag 0x8000 for the PKEY_ID variable. To express IDs without the full membership flag, use PKEY_ID_NM. Note that kernel internally treats the interface as having the full membership flag set, this mainly affects the interface name. For the ifcfg file to be supported by initscripts' ifup-ib, the DEVICE= must always be set. NetworkManager does not require that.<span class="bold"><strong>
 
 Example: </strong></span>PKEY=yes PKEY_ID=2 PHYSDEV=mlx4_ib0 DEVICE=mlx4_ib0.8002</td>
 </tr>
diff --git a/docs/api/html/nm-settings-nmcli.html b/docs/api/html/nm-settings-nmcli.html
index 0f6798b4..139eac2f 100644
--- a/docs/api/html/nm-settings-nmcli.html
+++ b/docs/api/html/nm-settings-nmcli.html
@@ -1975,7 +1975,9 @@
 <td>
 <p>
             Alias: p-key</p>
-<p>The InfiniBand P_Key to use for this device. A value of -1 means to use the default P_Key (aka "the P_Key at index 0"). Otherwise, it is a 16-bit unsigned integer, whose high bit is set if it is a "full membership" P_Key.</p>
+<p>The InfiniBand p-key to use for this device. A value of -1 means to use the default p-key (aka "the p-key at index 0"). Otherwise, it is a 16-bit unsigned integer, whose high bit 0x8000 is set if it is a "full membership" p-key. The values 0 and 0x8000 are not allowed.</p>
+<p>With the p-key set, the interface name is always "$parent.$p_key". Setting "connection.interface-name" to another name is not supported.</p>
+<p>Note that kernel will internally always set the full membership bit, although the interface name does not reflect that. Usually the user would want to configure a full membership p-key with 0x8000 flag set.</p>
 <p>
             Format: int32</p>
 </td>
@@ -5485,7 +5487,18 @@ Linux traffic control subsystem
 <col align="left" valign="top">
 <col>
 </colgroup>
-<tbody><tr>
+<tbody>
+<tr>
+<td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.bond-port.prio"></a>prio</code></span></p></td>
+<td>
+<p>
+            Alias: prio</p>
+<p>The port priority for bond active port re-selection during failover. A higher number means a higher priority in selection. The primary port has the highest priority. This option is only compatible with active-backup, balance-tlb and balance-alb modes.</p>
+<p>
+            Format: int32</p>
+</td>
+</tr>
+<tr>
 <td><p><span class="term"><code class="option"><a name="nm-settings-nmcli.property.bond-port.queue-id"></a>queue-id</code></span></p></td>
 <td>
 <p>
@@ -5494,7 +5507,8 @@ Linux traffic control subsystem
 <p>
             Format: uint32</p>
 </td>
-</tr></tbody>
+</tr>
+</tbody>
 </table></div>
 </div>
 <hr>
diff --git a/docs/api/html/settings-bond-port.html b/docs/api/html/settings-bond-port.html
index 6daf9a3d..4cece6ef 100644
--- a/docs/api/html/settings-bond-port.html
+++ b/docs/api/html/settings-bond-port.html
@@ -52,12 +52,20 @@
 <th>Default Value</th>
 <th>Value Description</th>
 </tr></thead>
-<tbody><tr>
+<tbody>
+<tr>
+<td><pre class="screen">prio</pre></td>
+<td><pre class="screen">int32</pre></td>
+<td><pre class="screen">0</pre></td>
+<td> </td>
+</tr>
+<tr>
 <td><pre class="screen">queue-id</pre></td>
 <td><pre class="screen">uint32</pre></td>
 <td><pre class="screen">0</pre></td>
 <td> </td>
-</tr></tbody>
+</tr>
+</tbody>
 </table></div>
 </div>
 <p><br class="table-break"></p>
diff --git a/docs/api/settings-spec.xml b/docs/api/settings-spec.xml
index e12bab3c..ee0b1a61 100644
--- a/docs/api/settings-spec.xml
+++ b/docs/api/settings-spec.xml
@@ -98,7 +98,7 @@
             Properties
         </title><para><table><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry><screen>channel<indexterm zone="settings-wpan"><primary sortas="channel">channel</primary></indexterm></screen></entry><entry><screen>int32</screen></entry><entry><screen>-1</screen></entry><entry/></row><row><entry><screen>mac-address<indexterm zone="settings-wpan"><primary sortas="mac-address">mac-address</primary></indexterm></screen></entry><entry><screen>string</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>page<indexterm zone="settings-wpan"><primary sortas="page">page</primary></indexterm></screen></entry><entry><screen>int32</screen></entry><entry><screen>-1</screen></entry><entry/></row><row><entry><screen>pan-id<indexterm zone="settings-wpan"><primary sortas="pan-id">pan-id</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>65535</screen></entry><entry/></row><row><entry><screen>short-address<indexterm zone="settings-wpan"><primary sortas="short-address">short-address</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>65535</screen></entry><entry/></row></tbody></tgroup></table></para></refsect1></refentry><refentry id="settings-bond-port"><refnamediv><refname>bond-port</refname><refpurpose>Bond Port Settings</refpurpose></refnamediv><refsect1 role="properties"><title id="settings-bond-port.properties">
             Properties
-        </title><para><table><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry><screen>queue-id<indexterm zone="settings-bond-port"><primary sortas="queue-id">queue-id</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry/></row></tbody></tgroup></table></para></refsect1></refentry><refentry id="settings-hostname"><refnamediv><refname>hostname</refname><refpurpose>Hostname settings</refpurpose></refnamediv><refsect1 role="properties"><title id="settings-hostname.properties">
+        </title><para><table><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry><screen>prio<indexterm zone="settings-bond-port"><primary sortas="prio">prio</primary></indexterm></screen></entry><entry><screen>int32</screen></entry><entry><screen>0</screen></entry><entry/></row><row><entry><screen>queue-id<indexterm zone="settings-bond-port"><primary sortas="queue-id">queue-id</primary></indexterm></screen></entry><entry><screen>uint32</screen></entry><entry><screen>0</screen></entry><entry/></row></tbody></tgroup></table></para></refsect1></refentry><refentry id="settings-hostname"><refnamediv><refname>hostname</refname><refpurpose>Hostname settings</refpurpose></refnamediv><refsect1 role="properties"><title id="settings-hostname.properties">
             Properties
         </title><para><table><tgroup cols="4"><thead><row><entry>Key Name</entry><entry>Value Type</entry><entry>Default Value</entry><entry>Value Description</entry></row></thead><tbody><row><entry><screen>from-dhcp<indexterm zone="settings-hostname"><primary sortas="from-dhcp">from-dhcp</primary></indexterm></screen></entry><entry><screen>NMTernary (int32)</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>from-dns-lookup<indexterm zone="settings-hostname"><primary sortas="from-dns-lookup">from-dns-lookup</primary></indexterm></screen></entry><entry><screen>NMTernary (int32)</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>only-from-default<indexterm zone="settings-hostname"><primary sortas="only-from-default">only-from-default</primary></indexterm></screen></entry><entry><screen>NMTernary (int32)</screen></entry><entry><screen/></entry><entry/></row><row><entry><screen>priority<indexterm zone="settings-hostname"><primary sortas="priority">priority</primary></indexterm></screen></entry><entry><screen>int32</screen></entry><entry><screen>0</screen></entry><entry/></row></tbody></tgroup></table></para></refsect1></refentry><refentry id="settings-loopback"><refnamediv><refname>loopback</refname><refpurpose>Loopback Link Settings</refpurpose></refnamediv><refsect1 role="properties"><title id="settings-loopback.properties">
             Properties
diff --git a/docs/api/version.xml b/docs/api/version.xml
index 5f1d262b..31ffe251 100644
--- a/docs/api/version.xml
+++ b/docs/api/version.xml
@@ -1 +1 @@
-1.42.6
+1.42.8