summaryrefslogtreecommitdiffhomepage
path: root/documentation/api/modules/luci.ip.html
diff options
context:
space:
mode:
authorJo-Philipp Wich <jo@mein.io>2019-11-05 09:31:27 +0100
committerJo-Philipp Wich <jo@mein.io>2019-11-05 09:37:52 +0100
commitd80dd2291ff01d264dfa802b769fa19756f07821 (patch)
treedfe7d9dc3cd772f635bdd8a4d29d55822d846149 /documentation/api/modules/luci.ip.html
parent3942789dc62d6a0e7fcfb0a935bfe5c8d372245b (diff)
documentation: update Lua API docs
Signed-off-by: Jo-Philipp Wich <jo@mein.io> (cherry picked from commit 2ae6e3c6b3c3b65cd955bb10fb9065beebc5ffd2)
Diffstat (limited to 'documentation/api/modules/luci.ip.html')
-rw-r--r--documentation/api/modules/luci.ip.html13
1 files changed, 9 insertions, 4 deletions
diff --git a/documentation/api/modules/luci.ip.html b/documentation/api/modules/luci.ip.html
index fc13e31e58..0599396b6f 100644
--- a/documentation/api/modules/luci.ip.html
+++ b/documentation/api/modules/luci.ip.html
@@ -256,7 +256,7 @@ Verify an ethernet MAC address.</td>
</tr>
<tr>
- <td class="name" nowrap><a href="#route">route</a>&nbsp;(address)</td>
+ <td class="name" nowrap><a href="#route">route</a>&nbsp;(address, source)</td>
<td class="summary">
Determine the route leading to the given destination.</td>
@@ -729,7 +729,7 @@ A string representing the given MAC address.
-<dt><a name="route"></a><strong>route</strong>&nbsp;(address)</dt>
+<dt><a name="route"></a><strong>route</strong>&nbsp;(address, source)</dt>
<dd>
@@ -744,6 +744,11 @@ Determine the route leading to the given destination.
a valid IPv4 or IPv6 range as specified by <code>luci.ip.new()</code>.
</li>
+ <li>
+ source: A <code>luci.ip.cidr</code> instance or a string containing
+the preferred source address for route selection (optional).
+ </li>
+
</ul>
@@ -879,7 +884,7 @@ Fetch all routes, optionally matching the given criteria.
<li>
filter: <p>Table containing one or more of the possible filter
-critera described below (optional)</p><table>
+criteria described below (optional)</p><table>
<tr><th>Field</th><th>Description</th></tr>
<tr><td><code>family</code></td><td>
Number describing the address family to return - <code>4</code> selects
@@ -994,7 +999,7 @@ Fetches entries from the IPv4 ARP and IPv6 neighbour kernel table
<li>
filter: <p>Table containing one or more of the possible filter
-critera described below (optional)</p><table>
+criteria described below (optional)</p><table>
<tr><th>Field</th><th>Description</th></tr>
<tr><td><code>family</code></td><td>
Number describing the address family to return - <code>4</code> selects