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="#MAC">MAC</a> (address, netmask)</td>
238 Construct a new MAC luci.ip.cidr instance.</td>
242 <td class="name" nowrap><a href="#checkip4">checkip4</a> (address)</td>
245 Verify an IPv4 address.</td>
249 <td class="name" nowrap><a href="#checkip6">checkip6</a> (address)</td>
252 Verify an IPv6 address.</td>
256 <td class="name" nowrap><a href="#checkmac">checkmac</a> (address)</td>
259 Verify an ethernet MAC address.</td>
263 <td class="name" nowrap><a href="#route">route</a> (address)</td>
266 Determine the route leading to the given destination.</td>
270 <td class="name" nowrap><a href="#routes">routes</a> (filter, callback)</td>
273 Fetch all routes, optionally matching the given criteria.</td>
277 <td class="name" nowrap><a href="#neighbors">neighbors</a> (filter, callback)</td>
280 Fetches entries from the IPv4 ARP and IPv6 neighbour kernel table </td>
284 <td class="name" nowrap><a href="#link">link</a> (device)</td>
287 Fetch basic device information </td>
301 <h2><a name="functions"></a>Functions</h2>
302 <dl class="function">
306 <dt><a name="new"></a><strong>new</strong> (address, netmask)</dt>
310 Construct a new luci.ip.cidr instance and autodetect the address family.
311 Throws an error if the given strings do not represent a valid address or
312 if the given optional netmask is of a different family.
319 address: String containing a valid IPv4 or IPv6 address, optionally
320 with prefix size (CIDR notation) or netmask separated by slash.
324 netmask: String containing a valid IPv4 or IPv6 netmask or number
325 containing a prefix size in bits (<code>0..32</code> for IPv4,
326 <code>0..128</code> for IPv6). Overrides mask embedded in the first argument
327 if specified. (optional)
336 <pre>addr = luci.ip.new("10.24.0.1/24")
337 addr = luci.ip.new("10.24.0.1/255.255.255.0")
338 addr = luci.ip.new("10.24.0.1", "255.255.255.0") -- separate netmask
339 addr = luci.ip.new("10.24.0.1/24", 16) -- override netmask
341 addr6 = luci.ip.new("fe80::221:63ff:fe75:aa17/64")
342 addr6 = luci.ip.new("fe80::221:63ff:fe75:aa17/ffff:ffff:ffff:ffff::")
343 addr6 = luci.ip.new("fe80::221:63ff:fe75:aa17", "ffff:ffff:ffff:ffff::")
344 addr6 = luci.ip.new("fe80::221:63ff:fe75:aa17/64", 128) -- override netmask</pre>
348 <h3>Return value:</h3>
349 A <code>luci.ip.cidr</code> object representing the given
376 <dt><a name="IPv4"></a><strong>IPv4</strong> (address, netmask)</dt>
380 Construct a new IPv4 luci.ip.cidr instance.
381 Throws an error if the given string does not represent a valid IPv4 address or
382 if the given optional netmask is of a different family.
389 address: String containing a valid IPv4, optionally with prefix size
390 (CIDR notation) or netmask separated by slash.
394 netmask: String containing a valid IPv4 netmask or number
395 containing a prefix size between <code>0</code> and <code>32</code> bit.
396 Overrides mask embedded in the first argument if specified. (optional)
405 <pre>addr = luci.ip.IPv4("10.24.0.1/24")
406 addr = luci.ip.IPv4("10.24.0.1/255.255.255.0")
407 addr = luci.ip.IPv4("10.24.0.1", "255.255.255.0") -- separate netmask
408 addr = luci.ip.IPv4("10.24.0.1/24", 16) -- override netmask</pre>
412 <h3>Return value:</h3>
413 A <code>luci.ip.cidr</code> object representing the given IPv4 range.
435 <dt><a name="IPv6"></a><strong>IPv6</strong> (address, netmask)</dt>
439 Construct a new IPv6 luci.ip.cidr instance.
440 Throws an error if the given string does not represent a valid IPv6 address or
441 if the given optional netmask is of a different family.
448 address: String containing a valid IPv6, optionally with prefix size
449 (CIDR notation) or netmask separated by slash.
453 netmask: String containing a valid IPv4 netmask or number
454 containing a prefix size between <code>0</code> and <code>128</code> bit.
455 Overrides mask embedded in the first argument if specified. (optional)
464 <pre>addr6 = luci.ip.IPv6("fe80::221:63ff:fe75:aa17/64")
465 addr6 = luci.ip.IPv6("fe80::221:63ff:fe75:aa17/ffff:ffff:ffff:ffff::")
466 addr6 = luci.ip.IPv6("fe80::221:63ff:fe75:aa17", "ffff:ffff:ffff:ffff::")
467 addr6 = luci.ip.IPv6("fe80::221:63ff:fe75:aa17/64", 128) -- override netmask</pre>
471 <h3>Return value:</h3>
472 A <code>luci.ip.cidr</code> object representing the given IPv6 range.
494 <dt><a name="MAC"></a><strong>MAC</strong> (address, netmask)</dt>
498 Construct a new MAC luci.ip.cidr instance.
499 Throws an error if the given string does not represent a valid ethernet MAC
500 address or if the given optional mask is of a different family.
507 address: String containing a valid ethernet MAC address, optionally with
508 prefix size (CIDR notation) or mask separated by slash.
512 netmask: String containing a valid MAC address mask or number
513 containing a prefix size between <code>0</code> and <code>48</code> bit.
514 Overrides mask embedded in the first argument if specified. (optional)
523 <pre>intel_macs = luci.ip.MAC("C0:B6:F9:00:00:00/24")
524 intel_macs = luci.ip.MAC("C0:B6:F9:00:00:00/FF:FF:FF:0:0:0")
525 intel_macs = luci.ip.MAC("C0:B6:F9:00:00:00", "FF:FF:FF:0:0:0")
526 intel_macs = luci.ip.MAC("C0:B6:F9:00:00:00/24", 48) -- override mask</pre>
530 <h3>Return value:</h3>
531 A <code>luci.ip.cidr</code> object representing the given MAC address range.
553 <dt><a name="checkip4"></a><strong>checkip4</strong> (address)</dt>
557 Verify an IPv4 address.
559 Checks whether given argument is a preexisting luci.ip.cidr IPv4 address
560 instance or a string literal convertible to an IPv4 address and returns a
561 plain Lua string containing the canonical representation of the address.
563 If the argument is not a valid address, returns nothing. This function is
564 intended to aid in safely verifying address literals without having to deal
572 address: String containing a valid IPv4 address or existing
573 luci.ip.cidr IPv4 instance.
582 <pre>ipv4 = luci.ip.checkip4(luci.ip.new("127.0.0.1")) -- "127.0.0.1"
583 ipv4 = luci.ip.checkip4("127.0.0.1") -- "127.0.0.1"
584 ipv4 = luci.ip.checkip4("nonesense") -- nothing
585 ipv4 = luci.ip.checkip4(123) -- nothing
586 ipv4 = luci.ip.checkip4(nil) -- nothing
587 ipv4 = luci.ip.checkip4() -- nothing</pre>
591 <h3>Return value:</h3>
592 A string representing the given IPv4 address.
599 <li><a href="#checkip6">
603 <li><a href="#checkmac">
614 <dt><a name="checkip6"></a><strong>checkip6</strong> (address)</dt>
618 Verify an IPv6 address.
620 Checks whether given argument is a preexisting luci.ip.cidr IPv6 address
621 instance or a string literal convertible to an IPv6 address and returns a
622 plain Lua string containing the canonical representation of the address.
624 If the argument is not a valid address, returns nothing. This function is
625 intended to aid in safely verifying address literals without having to deal
633 address: String containing a valid IPv6 address or existing
634 luci.ip.cidr IPv6 instance.
643 <pre>ipv6 = luci.ip.checkip6(luci.ip.new("0:0:0:0:0:0:0:1")) -- "::1"
644 ipv6 = luci.ip.checkip6("0:0:0:0:0:0:0:1") -- "::1"
645 ipv6 = luci.ip.checkip6("nonesense") -- nothing
646 ipv6 = luci.ip.checkip6(123) -- nothing
647 ipv6 = luci.ip.checkip6(nil) -- nothing
648 ipv6 = luci.ip.checkip6() -- nothing</pre>
652 <h3>Return value:</h3>
653 A string representing the given IPv6 address.
660 <li><a href="#checkip4">
664 <li><a href="#checkmac">
675 <dt><a name="checkmac"></a><strong>checkmac</strong> (address)</dt>
679 Verify an ethernet MAC address.
681 Checks whether given argument is a preexisting luci.ip.cidr MAC address
682 instance or a string literal convertible to an ethernet MAC and returns a
683 plain Lua string containing the canonical representation of the address.
685 If the argument is not a valid address, returns nothing. This function is
686 intended to aid in safely verifying address literals without having to deal
694 address: String containing a valid MAC address or existing luci.ip.cidr
695 MAC address instance.
704 <pre>mac = luci.ip.checkmac(luci.ip.new("00-11-22-cc-dd-ee")) -- "00:11:22:CC:DD:EE"
705 mac = luci.ip.checkmac("00:11:22:cc:dd:ee") -- "00:11:22:CC:DD:EE"
706 mac = luci.ip.checkmac("nonesense") -- nothing
707 mac = luci.ip.checkmac(123) -- nothing
708 mac = luci.ip.checkmac(nil) -- nothing
709 mac = luci.ip.checkmac() -- nothing</pre>
713 <h3>Return value:</h3>
714 A string representing the given MAC address.
721 <li><a href="#checkip4">
725 <li><a href="#checkip6">
736 <dt><a name="route"></a><strong>route</strong> (address)</dt>
740 Determine the route leading to the given destination.
747 address: A <code>luci.ip.cidr</code> instance or a string containing
748 a valid IPv4 or IPv6 range as specified by <code>luci.ip.new()</code>.
758 <li>Find default gateway by getting route to Google's public NS server
759 <pre>rt = luci.ip.route("8.8.8.8")
761 print("gateway is", rt.gw)
763 <li>Determine IPv6 upstream interface <pre>rt = luci.ip.route("2001::/7")
765 print("ipv6 upstream device is", rt.dev)
771 <h3>Return value:</h3>
772 <p>Table containing the fields described below.</p>
773 <table id="routetable">
774 <tr><th>Field</th><th>Description</th></tr>
775 <tr><td><code>type</code><td>
776 <p>Route type with one of the following numeric values:</p>
779 <td><code>1</code></td>
780 <td><code>RTN_UNICAST</code> - Gateway or direct route</td>
783 <td><code>2</code></td>
784 <td><code>RTN_LOCAL</code> - Accept locally</td>
787 <td><code>3</code></td>
788 <td><code>RTN_BROADCAST</code> -
789 Accept locally as broadcast send as broadcast</td>
792 <td><code>4</code></td>
793 <td><code>RTN_ANYCAST</code> -
794 Accept locally as broadcast but send as unicast</td>
797 <td><code>5</code></td>
798 <td><code>RTN_MULTICAST</code> - Multicast route</td>
803 <td><code>family</code></td>
804 <td>Number containing the route family, <code>4</code> for IPv4 or
805 <code>6</code> for IPv6</td>
808 <td><code>dest</code></td>
809 <td>Destination <code>luci.ip.cidr</code> instance</td>
812 <td><code>gw</code></td>
813 <td>Gateway <code>luci.ip.cidr</code> instance (optional)</td>
816 <td><code>from</code></td>
817 <td>Source address <code>luci.ip.cidr</code> instance (optional)</td>
820 <td><code>src</code></td>
821 <td>Preferred source <code>luci.ip.cidr</code> instance (optional)</td>
824 <td><code>dev</code></td>
825 <td>String containing the name of the outgoing interface</td>
828 <td><code>iif</code></td>
829 <td>String containing the name of the incoming interface (optional)</td>
832 <td><code>table</code></td>
833 <td>Number of the associated routing table (<code>0..65535</code>)</td>
836 <td><code>proto</code></td>
837 <td>Number of the associated routing protocol</td>
840 <td><code>scope</code></td>
841 <td>Number describing the scope of the route, most commonly
842 <code>0</code> for global or <code>253</code> for on-link</td>
845 <td><code>metric</code></td>
846 <td>Number describing the route metric (optional)</td>
849 <td><code>expires</code></td>
850 <td>Number of seconds the prefix is valid (IPv6 only, optional)</td>
853 <td><code>error</code></td>
854 <td>Route destination error code (optional)</td>
863 <li><a href="#routes">
874 <dt><a name="routes"></a><strong>routes</strong> (filter, callback)</dt>
878 Fetch all routes, optionally matching the given criteria.
885 filter: <p>Table containing one or more of the possible filter
886 critera described below (optional)</p><table>
887 <tr><th>Field</th><th>Description</th></tr>
888 <tr><td><code>family</code></td><td>
889 Number describing the address family to return - <code>4</code> selects
890 IPv4 routes, <code>6</code> IPv6 ones. Any other value selects both.
892 <tr><td><code>iif</code></td><td>
893 String containing the incoming route interface to match.
895 <tr><td><code>oif</code></td><td>
896 String containing the outgoing route interface to match.
898 <tr><td><code>type</code></td><td>
899 Numeric type to match, e.g. <code>1</code> for unicast.
901 <tr><td><code>scope</code></td><td>
902 Numeric scope to match, e.g. <code>253</code> for onlink.
904 <tr><td><code>proto</code></td><td>
905 Numeric protocol to match, e.g. <code>2</code> for boot.
907 <tr><td><code>table</code></td><td>
908 Numeric routing table to match (<code>0..65535</code>).
910 <tr><td><code>gw</code></td><td>
911 String containing the gateway address to match. Can be in any notation
912 specified by <code>luci.ip.new()</code>. Prefix matching is performed when
913 comparing the routes, e.g. "192.168.1.0/24" would select routes with gateway
914 addresses <code>192.168.1.1 .. 192.168.1.255</code>.
916 <tr><td><code>dest</code></td><td>
917 String containing the destination to match. Prefix matching is performed.
919 <tr><td><code>from</code></td><td>
920 String containing the source address to match. Prefix matching is performed.
922 <tr><td><code>src</code></td><td>
923 String containing the preferred source address to match.
924 Prefix matching is performed.
926 <tr><td><code>dest_exact</code></td><td>
927 String containing the destination to match. Exact matching is performed,
928 e.g. <code>dest = "0.0.0.0/0"</code> would match <em>any</em> IPv4 route
929 while <code>dest_exact = "0.0.0.0/0"</code> will <em>only</em> match the
932 <tr><td><code>from_exact</code></td><td>
933 String containing the source address to match. Exact matching is performed.
939 callback: <p>Callback function to invoke for each found route
940 instead of returning one table of route objects (optional)</p>
950 <li>Find all IPv4 default routes:
951 <pre>luci.ip.routes({ dest_exact = "0.0.0.0/0" }, function(rt)
952 print(rt.type, rt.gw, rt.dev)
954 <li>Find all global IPv6 prefixes on the current system:
955 <pre>luci.ip.routes({ from = "2001::/7" }, function(rt)
958 <li>Fetch all IPv4 routes:
959 <pre>routes = luci.ip.routes({ family = 4 })
960 for _, rt in ipairs(routes) do
961 print(rt.dest, rt.gw, rt.dev)
967 <h3>Return value:</h3>
968 If no callback function is provided, a table of routes
969 <a href="#routetable">as specified by <code>luci.ip.route()</code></a>
970 is returned. If a callback function is given, it is invoked for each route
971 and nothing is returned.
978 <li><a href="#route">
989 <dt><a name="neighbors"></a><strong>neighbors</strong> (filter, callback)</dt>
993 Fetches entries from the IPv4 ARP and IPv6 neighbour kernel table
1000 filter: <p>Table containing one or more of the possible filter
1001 critera described below (optional)</p><table>
1002 <tr><th>Field</th><th>Description</th></tr>
1003 <tr><td><code>family</code></td><td>
1004 Number describing the address family to return - <code>4</code> selects
1005 IPv4 ARP, <code>6</code> select IPv6 neighbour entries. Any other value
1008 <tr><td><code>dev</code></td><td>
1009 String containing the associated interface to match.
1011 <tr><td><code>dest</code></td><td>
1012 String containing the associated address to match. Can be in any notation
1013 specified by <code>luci.ip.new()</code>. Prefix matching is performed when
1014 comparing the addresses, e.g. "192.168.1.0/24" would select ARP entries
1015 for <code>192.168.1.1 .. 192.168.1.255</code>.
1017 <tr><td><code>mac</code></td><td>
1018 String containing MAC address to match.
1024 callback: <p>Callback function to invoke for each found neighbour
1025 entry instead of returning one table of neighbour entries (optional)</p>
1035 <li>Find all ARP neighbours in the LAN:
1036 <pre>luci.ip.neighbors({ dest = "192.168.0.0/16" }, function(n)
1037 print(n.dest, n.mac)
1039 <li>Find all active IPv6 addresses of host with given MAC:
1040 <pre>luci.ip.neighbors({ family = 6, mac = "00:21:63:75:aa:17" },
1048 <h3>Return value:</h3>
1049 If no callback function is provided, a table of neighbour entries
1050 is returned. If a callback function is given, it is invoked for each entry
1051 and nothing is returned.
1053 A neighbour entry is a table containing the following fields:
1056 <tr><th>Field</th><th>Description</th></tr>
1058 <td><code>family</code></td>
1059 <td>Number containing the neighbour entry family, <code>4</code> for IPv4
1060 ARP or <code>6</code> for IPv6 NDP</td>
1063 <td><code>dev</code></td>
1064 <td>String containing the associated device of the neighbour entry</td>
1067 <td><code>dest</code></td>
1068 <td>IP address <code>luci.ip.cidr</code> instance</td>
1071 <td><code>mac</code></td>
1072 <td>MAC address <code>luci.ip.cidr</code> instance</td>
1075 <td><code>router</code></td>
1076 <td>Boolean "true" if the neighbour entry is a router (IPv6, optional)</td>
1079 <td><code>proxy</code></td>
1080 <td>Boolean "true" if this is a proxy entry (optional)</td>
1083 <td><code>incomplete</code></td>
1084 <td>Boolean "true" if the entry is in incomplete state (optional)</td>
1087 <td><code>reachable</code></td>
1088 <td>Boolean "true" if the entry is in reachable state (optional)</td>
1091 <td><code>stale</code></td>
1092 <td>Boolean "true" if the entry is stale (optional)</td>
1095 <td><code>delay</code></td>
1096 <td>Boolean "true" if the entry is delayed (optional)</td>
1099 <td><code>probe</code></td>
1100 <td>Boolean "true" if the entry is in probe state (optional)</td>
1103 <td><code>failed</code></td>
1104 <td>Boolean "true" if the entry is in failed state (optional)</td>
1107 <td><code>noarp</code></td>
1108 <td>Boolean "true" if the entry is not caused by NDP or
1112 <td><code>permanent</code></td>
1113 <td>Boolean "true" if the entry was statically configured from
1114 userspace (optional)</td>
1125 <dt><a name="link"></a><strong>link</strong> (device)</dt>
1129 Fetch basic device information
1136 device: String containing the network device to query
1146 <li>Test whether device br-lan exists:
1147 <pre>print(luci.ip.link("br-lan").name ~= nil)
1149 <li>Query MAC address of eth0:
1150 <pre>print(luci.ip.link("eth0").mac)
1156 <h3>Return value:</h3>
1157 If the given interface is found, a table containing the fields
1158 described below is returned, else an empty table.
1161 <tr><th>Field</th><th>Description</th></tr>
1163 <td><code>up</code></td>
1164 <td>Boolean indicating whether the device is in IFF_RUNNING state</td>
1167 <td><code>type</code></td>
1168 <td>Numeric value indicating the type of the device, e.g. <code>1</code>
1172 <td><code>name</code></td>
1173 <td>String containing the name of the device</td>
1176 <td><code>master</code></td>
1177 <td>If queried device is a bridge port, string containing the name of
1178 parent bridge device (optional)</td>
1181 <td><code>mtu</code></td>
1182 <td>Number containing the current MTU of the device</td>
1185 <td><code>qlen</code></td>
1186 <td>Number containing the TX queue length of the device</td>
1189 <td><code>mac</code></td>
1190 <td>MAC address <code>luci.ip.cidr</code> instance representing the device ethernet
1206 </div> <!-- id="content" -->
1208 </div> <!-- id="main" -->
1211 <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>
1212 </div> <!-- id="about" -->
1214 </div> <!-- id="container" -->