1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
2 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
5 <title>Reference</title>
6 <link rel="stylesheet" href="../luadoc.css" type="text/css" />
7 <!--meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/-->
14 <div id="product_logo"></div>
15 <div id="product_name"><big><b></b></big></div>
16 <div id="product_description"></div>
17 </div> <!-- id="product" -->
27 <li><a href="../index.html">Index</a></li>
38 <a href="../modules/luci.dispatcher.html">luci.dispatcher</a>
42 <a href="../modules/luci.http.html">luci.http</a>
46 <a href="../modules/luci.http.protocol.html">luci.http.protocol</a>
50 <a href="../modules/luci.http.protocol.conditionals.html">luci.http.protocol.conditionals</a>
54 <a href="../modules/luci.http.protocol.date.html">luci.http.protocol.date</a>
58 <a href="../modules/luci.http.protocol.mime.html">luci.http.protocol.mime</a>
62 <a href="../modules/luci.i18n.html">luci.i18n</a>
65 <li><strong>luci.ip</strong></li>
68 <a href="../modules/luci.ip.cidr.html">luci.ip.cidr</a>
72 <a href="../modules/luci.json.html">luci.json</a>
76 <a href="../modules/luci.jsonc.html">luci.jsonc</a>
80 <a href="../modules/luci.jsonc.parser.html">luci.jsonc.parser</a>
84 <a href="../modules/luci.model.ipkg.html">luci.model.ipkg</a>
88 <a href="../modules/luci.model.uci.html">luci.model.uci</a>
92 <a href="../modules/luci.rpcc.html">luci.rpcc</a>
96 <a href="../modules/luci.rpcc.ruci.html">luci.rpcc.ruci</a>
100 <a href="../modules/luci.sys.html">luci.sys</a>
104 <a href="../modules/luci.sys.init.html">luci.sys.init</a>
108 <a href="../modules/luci.sys.iptparser.html">luci.sys.iptparser</a>
112 <a href="../modules/luci.sys.net.html">luci.sys.net</a>
116 <a href="../modules/luci.sys.process.html">luci.sys.process</a>
120 <a href="../modules/luci.sys.user.html">luci.sys.user</a>
124 <a href="../modules/luci.sys.wifi.html">luci.sys.wifi</a>
128 <a href="../modules/luci.util.html">luci.util</a>
132 <a href="../modules/nixio.html">nixio</a>
136 <a href="../modules/nixio.CHANGELOG.html">nixio.CHANGELOG</a>
140 <a href="../modules/nixio.CryptoHash.html">nixio.CryptoHash</a>
144 <a href="../modules/nixio.File.html">nixio.File</a>
148 <a href="../modules/nixio.README.html">nixio.README</a>
152 <a href="../modules/nixio.Socket.html">nixio.Socket</a>
156 <a href="../modules/nixio.TLSContext.html">nixio.TLSContext</a>
160 <a href="../modules/nixio.TLSSocket.html">nixio.TLSSocket</a>
164 <a href="../modules/nixio.UnifiedIO.html">nixio.UnifiedIO</a>
168 <a href="../modules/nixio.bin.html">nixio.bin</a>
172 <a href="../modules/nixio.bit.html">nixio.bit</a>
176 <a href="../modules/nixio.crypto.html">nixio.crypto</a>
180 <a href="../modules/nixio.fs.html">nixio.fs</a>
195 </div><!-- id="navigation" -->
199 <h1>Class <code>luci.ip</code></h1>
202 LuCI IP calculation and netlink access library.</p>
211 <table class="function_list">
214 <td class="name" nowrap><a href="#new">new</a> (address, netmask)</td>
217 Construct a new luci.ip.cidr instance and autodetect the address family.</td>
221 <td class="name" nowrap><a href="#IPv4">IPv4</a> (address, netmask)</td>
224 Construct a new IPv4 luci.ip.cidr instance.</td>
228 <td class="name" nowrap><a href="#IPv6">IPv6</a> (address, netmask)</td>
231 Construct a new IPv6 luci.ip.cidr instance.</td>
235 <td class="name" nowrap><a href="#route">route</a> (address)</td>
238 Determine the route leading to the given destination.</td>
242 <td class="name" nowrap><a href="#routes">routes</a> (filter, callback)</td>
245 Fetch all routes, optionally matching the given criteria.</td>
249 <td class="name" nowrap><a href="#neighbors">neighbors</a> (filter, callback)</td>
252 Fetches entries from the IPv4 ARP and IPv6 neighbour kernel table </td>
256 <td class="name" nowrap><a href="#link">link</a> (device)</td>
259 Fetch basic device information </td>
273 <h2><a name="functions"></a>Functions</h2>
274 <dl class="function">
278 <dt><a name="new"></a><strong>new</strong> (address, netmask)</dt>
282 Construct a new luci.ip.cidr instance and autodetect the address family.
283 Throws an error if the given strings do not represent a valid address or
284 if the given optional netmask is of a different family.
291 address: String containing a valid IPv4 or IPv6 address, optionally
292 with prefix size (CIDR notation) or netmask separated by slash.
296 netmask: String containing a valid IPv4 or IPv6 netmask or number
297 containing a prefix size in bits (<code>0..32</code> for IPv4,
298 <code>0..128</code> for IPv6). Overrides mask embedded in the first argument
299 if specified. (optional)
308 <pre>addr = luci.ip.new("10.24.0.1/24")
309 addr = luci.ip.new("10.24.0.1/255.255.255.0")
310 addr = luci.ip.new("10.24.0.1", "255.255.255.0") -- separate netmask
311 addr = luci.ip.new("10.24.0.1/24", 16) -- override netmask
313 addr6 = luci.ip.new("fe80::221:63ff:fe75:aa17/64")
314 addr6 = luci.ip.new("fe80::221:63ff:fe75:aa17/ffff:ffff:ffff:ffff::")
315 addr6 = luci.ip.new("fe80::221:63ff:fe75:aa17", "ffff:ffff:ffff:ffff::")
316 addr6 = luci.ip.new("fe80::221:63ff:fe75:aa17/64", 128) -- override netmask</pre>
320 <h3>Return value:</h3>
321 A <code>luci.ip.cidr</code> object representing the given
344 <dt><a name="IPv4"></a><strong>IPv4</strong> (address, netmask)</dt>
348 Construct a new IPv4 luci.ip.cidr instance.
349 Throws an error if the given string does not represent a valid IPv4 address or
350 if the given optional netmask is of a different family.
357 address: String containing a valid IPv4, optionally with prefix size
358 (CIDR notation) or netmask separated by slash.
362 netmask: String containing a valid IPv4 netmask or number
363 containing a prefix size between <code>0</code> and <code>32</code> bit.
364 Overrides mask embedded in the first argument if specified. (optional)
373 <pre>addr = luci.ip.IPv4("10.24.0.1/24")
374 addr = luci.ip.IPv4("10.24.0.1/255.255.255.0")
375 addr = luci.ip.IPv4("10.24.0.1", "255.255.255.0") -- separate netmask
376 addr = luci.ip.IPv4("10.24.0.1/24", 16) -- override netmask</pre>
380 <h3>Return value:</h3>
381 A <code>luci.ip.cidr</code> object representing the given IPv4 range.
399 <dt><a name="IPv6"></a><strong>IPv6</strong> (address, netmask)</dt>
403 Construct a new IPv6 luci.ip.cidr instance.
404 Throws an error if the given string does not represent a valid IPv6 address or
405 if the given optional netmask is of a different family.
412 address: String containing a valid IPv6, optionally with prefix size
413 (CIDR notation) or netmask separated by slash.
417 netmask: String containing a valid IPv4 netmask or number
418 containing a prefix size between <code>0</code> and <code>128</code> bit.
419 Overrides mask embedded in the first argument if specified. (optional)
428 <pre>addr6 = luci.ip.IPv6("fe80::221:63ff:fe75:aa17/64")
429 addr6 = luci.ip.IPv6("fe80::221:63ff:fe75:aa17/ffff:ffff:ffff:ffff::")
430 addr6 = luci.ip.IPv6("fe80::221:63ff:fe75:aa17", "ffff:ffff:ffff:ffff::")
431 addr6 = luci.ip.IPv6("fe80::221:63ff:fe75:aa17/64", 128) -- override netmask</pre>
435 <h3>Return value:</h3>
436 A <code>luci.ip.cidr</code> object representing the given IPv6 range.
454 <dt><a name="route"></a><strong>route</strong> (address)</dt>
458 Determine the route leading to the given destination.
465 address: A <code>luci.ip.cidr</code> instance or a string containing
466 a valid IPv4 or IPv6 range as specified by <code>luci.ip.new()</code>.
476 <li>Find default gateway by getting route to Google's public NS server
477 <pre>rt = luci.ip.route("8.8.8.8")
479 print("gateway is", rt.gw)
481 <li>Determine IPv6 upstream interface <pre>rt = luci.ip.route("2001::/7")
483 print("ipv6 upstream device is", rt.dev)
489 <h3>Return value:</h3>
490 <p>Table containing the fields described below.</p>
491 <table id="routetable">
492 <tr><th>Field</th><th>Description</th></tr>
493 <tr><td><code>type</code><td>
494 <p>Route type with one of the following numeric values:</p>
497 <td><code>1</code></td>
498 <td><code>RTN_UNICAST</code> - Gateway or direct route</td>
501 <td><code>2</code></td>
502 <td><code>RTN_LOCAL</code> - Accept locally</td>
505 <td><code>3</code></td>
506 <td><code>RTN_BROADCAST</code> -
507 Accept locally as broadcast send as broadcast</td>
510 <td><code>4</code></td>
511 <td><code>RTN_ANYCAST</code> -
512 Accept locally as broadcast but send as unicast</td>
515 <td><code>5</code></td>
516 <td><code>RTN_MULTICAST</code> - Multicast route</td>
521 <td><code>family</code></td>
522 <td>Number containing the route family, <code>4</code> for IPv4 or
523 <code>6</code> for IPv6</td>
526 <td><code>dest</code></td>
527 <td>Destination <code>luci.ip.cidr</code> instance</td>
530 <td><code>gw</code></td>
531 <td>Gateway <code>luci.ip.cidr</code> instance (optional)</td>
534 <td><code>from</code></td>
535 <td>Source address <code>luci.ip.cidr</code> instance (optional)</td>
538 <td><code>src</code></td>
539 <td>Preferred source <code>luci.ip.cidr</code> instance (optional)</td>
542 <td><code>dev</code></td>
543 <td>String containing the name of the outgoing interface</td>
546 <td><code>iif</code></td>
547 <td>String containing the name of the incoming interface (optional)</td>
550 <td><code>table</code></td>
551 <td>Number of the associated routing table (<code>0..65535</code>)</td>
554 <td><code>proto</code></td>
555 <td>Number of the associated routing protocol</td>
558 <td><code>scope</code></td>
559 <td>Number describing the scope of the route, most commonly
560 <code>0</code> for global or <code>253</code> for on-link</td>
563 <td><code>metric</code></td>
564 <td>Number describing the route metric (optional)</td>
567 <td><code>expires</code></td>
568 <td>Number of seconds the prefix is valid (IPv6 only, optional)</td>
571 <td><code>error</code></td>
572 <td>Route destination error code (optional)</td>
581 <li><a href="#routes">
592 <dt><a name="routes"></a><strong>routes</strong> (filter, callback)</dt>
596 Fetch all routes, optionally matching the given criteria.
603 filter: <p>Table containing one or more of the possible filter
604 critera described below (optional)</p><table>
605 <tr><th>Field</th><th>Description</th></tr>
606 <tr><td><code>family</code></td><td>
607 Number describing the address family to return - <code>4</code> selects
608 IPv4 routes, <code>6</code> IPv6 ones. Any other value selects both.
610 <tr><td><code>iif</code></td><td>
611 String containing the incoming route interface to match.
613 <tr><td><code>oif</code></td><td>
614 String containing the outgoing route interface to match.
616 <tr><td><code>type</code></td><td>
617 Numeric type to match, e.g. <code>1</code> for unicast.
619 <tr><td><code>scope</code></td><td>
620 Numeric scope to match, e.g. <code>253</code> for onlink.
622 <tr><td><code>proto</code></td><td>
623 Numeric protocol to match, e.g. <code>2</code> for boot.
625 <tr><td><code>table</code></td><td>
626 Numeric routing table to match (<code>0..65535</code>).
628 <tr><td><code>gw</code></td><td>
629 String containing the gateway address to match. Can be in any notation
630 specified by <code>luci.ip.new()</code>. Prefix matching is performed when
631 comparing the routes, e.g. "192.168.1.0/24" would select routes with gateway
632 addresses <code>192.168.1.1 .. 192.168.1.255</code>.
634 <tr><td><code>dest</code></td><td>
635 String containing the destination to match. Prefix matching is performed.
637 <tr><td><code>from</code></td><td>
638 String containing the source address to match. Prefix matching is performed.
640 <tr><td><code>src</code></td><td>
641 String containing the preferred source address to match.
642 Prefix matching is performed.
644 <tr><td><code>dest_exact</code></td><td>
645 String containing the destination to match. Exact matching is performed,
646 e.g. <code>dest = "0.0.0.0/0"</code> would match <em>any</em> IPv4 route
647 while <code>dest_exact = "0.0.0.0/0"</code> will <em>only</em> match the
650 <tr><td><code>from_exact</code></td><td>
651 String containing the source address to match. Exact matching is performed.
657 callback: <p>Callback function to invoke for each found route
658 instead of returning one table of route objects (optional)</p>
668 <li>Find all IPv4 default routes:
669 <pre>luci.ip.routes({ dest_exact = "0.0.0.0/0" }, function(rt)
670 print(rt.type, rt.gw, rt.dev)
672 <li>Find all global IPv6 prefixes on the current system:
673 <pre>luci.ip.routes({ from = "2001::/7" }, function(rt)
676 <li>Fetch all IPv4 routes:
677 <pre>routes = luci.ip.routes({ family = 4 })
678 for _, rt in ipairs(routes) do
679 print(rt.dest, rt.gw, rt.dev)
685 <h3>Return value:</h3>
686 If no callback function is provided, a table of routes
687 <a href="#routetable">as specified by <code>luci.ip.route()</code></a>
688 is returned. If a callback function is given, it is invoked for each route
689 and nothing is returned.
696 <li><a href="#route">
707 <dt><a name="neighbors"></a><strong>neighbors</strong> (filter, callback)</dt>
711 Fetches entries from the IPv4 ARP and IPv6 neighbour kernel table
718 filter: <p>Table containing one or more of the possible filter
719 critera described below (optional)</p><table>
720 <tr><th>Field</th><th>Description</th></tr>
721 <tr><td><code>family</code></td><td>
722 Number describing the address family to return - <code>4</code> selects
723 IPv4 ARP, <code>6</code> select IPv6 neighbour entries. Any other value
726 <tr><td><code>dev</code></td><td>
727 String containing the associated interface to match.
729 <tr><td><code>dest</code></td><td>
730 String containing the associated address to match. Can be in any notation
731 specified by <code>luci.ip.new()</code>. Prefix matching is performed when
732 comparing the addresses, e.g. "192.168.1.0/24" would select ARP entries
733 for <code>192.168.1.1 .. 192.168.1.255</code>.
735 <tr><td><code>mac</code></td><td>
736 String containing MAC address to match.
742 callback: <p>Callback function to invoke for each found neighbour
743 entry instead of returning one table of neighbour entries (optional)</p>
753 <li>Find all ARP neighbours in the LAN:
754 <pre>luci.ip.neighbors({ dest = "192.168.0.0/16" }, function(n)
757 <li>Find all active IPv6 addresses of host with given MAC:
758 <pre>luci.ip.neighbors({ family = 6, mac = "00:21:63:75:aa:17" },
766 <h3>Return value:</h3>
767 If no callback function is provided, a table of neighbour entries
768 is returned. If a callback function is given, it is invoked for each entry
769 and nothing is returned.
771 A neighbour entry is a table containing the following fields:
774 <tr><th>Field</th><th>Description</th></tr>
776 <td><code>family</code></td>
777 <td>Number containing the neighbour entry family, <code>4</code> for IPv4
778 ARP or <code>6</code> for IPv6 NDP</td>
781 <td><code>dev</code></td>
782 <td>String containing the associated device of the neighbour entry</td>
785 <td><code>dest</code></td>
786 <td>IP address <code>luci.ip.cidr</code> instance</td>
789 <td><code>mac</code></td>
790 <td>String containing the associated MAC address</td>
793 <td><code>router</code></td>
794 <td>Boolean "true" if the neighbour entry is a router (IPv6, optional)</td>
797 <td><code>proxy</code></td>
798 <td>Boolean "true" if this is a proxy entry (optional)</td>
801 <td><code>incomplete</code></td>
802 <td>Boolean "true" if the entry is in incomplete state (optional)</td>
805 <td><code>reachable</code></td>
806 <td>Boolean "true" if the entry is in reachable state (optional)</td>
809 <td><code>stale</code></td>
810 <td>Boolean "true" if the entry is stale (optional)</td>
813 <td><code>delay</code></td>
814 <td>Boolean "true" if the entry is delayed (optional)</td>
817 <td><code>probe</code></td>
818 <td>Boolean "true" if the entry is in probe state (optional)</td>
821 <td><code>failed</code></td>
822 <td>Boolean "true" if the entry is in failed state (optional)</td>
825 <td><code>noarp</code></td>
826 <td>Boolean "true" if the entry is not caused by NDP or
830 <td><code>permanent</code></td>
831 <td>Boolean "true" if the entry was statically configured from
832 userspace (optional)</td>
843 <dt><a name="link"></a><strong>link</strong> (device)</dt>
847 Fetch basic device information
854 device: String containing the network device to query
864 <li>Test whether device br-lan exists:
865 <pre>print(luci.ip.link("br-lan").name ~= nil)
867 <li>Query MAC address of eth0:
868 <pre>print(luci.ip.link("eth0").mac)
874 <h3>Return value:</h3>
875 If the given interface is found, a table containing the fields
876 described below is returned, else an empty table.
879 <tr><th>Field</th><th>Description</th></tr>
881 <td><code>up</code></td>
882 <td>Boolean indicating whether the device is in IFF_RUNNING state</td>
885 <td><code>type</code></td>
886 <td>Numeric value indicating the type of the device, e.g. <code>1</code>
890 <td><code>name</code></td>
891 <td>String containing the name of the device</td>
894 <td><code>master</code></td>
895 <td>If queried device is a bridge port, string containing the name of
896 parent bridge device (optional)</td>
899 <td><code>mtu</code></td>
900 <td>Number containing the current MTU of the device</td>
903 <td><code>qlen</code></td>
904 <td>Number containing the TX queue length of the device</td>
907 <td><code>mac</code></td>
908 <td>String containing the link local address of the device in
909 dotted hex notation</td>
924 </div> <!-- id="content" -->
926 </div> <!-- id="main" -->
929 <p><a href="http://validator.w3.org/check?uri=referer"><img src="http://www.w3.org/Icons/valid-xhtml10" alt="Valid XHTML 1.0!" height="31" width="88" /></a></p>
930 </div> <!-- id="about" -->
932 </div> <!-- id="container" -->