documentation/api/modules/luci.sys.net.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
   2    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
   3 <html>
   4 <head>
   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"/-->
   8 </head>
   9
  10 <body>
  11 <div id="container">
  12
  13 <div id="product">
  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" -->
  18
  19 <div id="main">
  20
  21 <div id="navigation">
  22
  23
  24 <h1>LuaDoc</h1>
  25 <ul>
  26
  27         <li><a href="../index.html">Index</a></li>
  28
  29 </ul>
  30
  31
  32 <!-- Module list -->
  33
  34 <h1>Modules</h1>
  35 <ul>
  36
  37         <li>
  38                 <a href="../modules/luci.dispatcher.html">luci.dispatcher</a>
  39         </li>
  40
  41         <li>
  42                 <a href="../modules/luci.http.html">luci.http</a>
  43         </li>
  44
  45         <li>
  46                 <a href="../modules/luci.http.protocol.html">luci.http.protocol</a>
  47         </li>
  48
  49         <li>
  50                 <a href="../modules/luci.http.protocol.conditionals.html">luci.http.protocol.conditionals</a>
  51         </li>
  52
  53         <li>
  54                 <a href="../modules/luci.http.protocol.date.html">luci.http.protocol.date</a>
  55         </li>
  56
  57         <li>
  58                 <a href="../modules/luci.http.protocol.mime.html">luci.http.protocol.mime</a>
  59         </li>
  60
  61         <li>
  62                 <a href="../modules/luci.i18n.html">luci.i18n</a>
  63         </li>
  64
  65         <li>
  66                 <a href="../modules/luci.ip.html">luci.ip</a>
  67         </li>
  68
  69         <li>
  70                 <a href="../modules/luci.ip.cidr.html">luci.ip.cidr</a>
  71         </li>
  72
  73         <li>
  74                 <a href="../modules/luci.json.html">luci.json</a>
  75         </li>
  76
  77         <li>
  78                 <a href="../modules/luci.jsonc.html">luci.jsonc</a>
  79         </li>
  80
  81         <li>
  82                 <a href="../modules/luci.jsonc.parser.html">luci.jsonc.parser</a>
  83         </li>
  84
  85         <li>
  86                 <a href="../modules/luci.model.ipkg.html">luci.model.ipkg</a>
  87         </li>
  88
  89         <li>
  90                 <a href="../modules/luci.model.uci.html">luci.model.uci</a>
  91         </li>
  92
  93         <li>
  94                 <a href="../modules/luci.rpcc.html">luci.rpcc</a>
  95         </li>
  96
  97         <li>
  98                 <a href="../modules/luci.rpcc.ruci.html">luci.rpcc.ruci</a>
  99         </li>
 100
 101         <li>
 102                 <a href="../modules/luci.sys.html">luci.sys</a>
 103         </li>
 104
 105         <li>
 106                 <a href="../modules/luci.sys.init.html">luci.sys.init</a>
 107         </li>
 108
 109         <li>
 110                 <a href="../modules/luci.sys.iptparser.html">luci.sys.iptparser</a>
 111         </li>
 112
 113         <li><strong>luci.sys.net</strong></li>
 114
 115         <li>
 116                 <a href="../modules/luci.sys.process.html">luci.sys.process</a>
 117         </li>
 118
 119         <li>
 120                 <a href="../modules/luci.sys.user.html">luci.sys.user</a>
 121         </li>
 122
 123         <li>
 124                 <a href="../modules/luci.sys.wifi.html">luci.sys.wifi</a>
 125         </li>
 126
 127         <li>
 128                 <a href="../modules/luci.util.html">luci.util</a>
 129         </li>
 130
 131         <li>
 132                 <a href="../modules/nixio.html">nixio</a>
 133         </li>
 134
 135         <li>
 136                 <a href="../modules/nixio.CHANGELOG.html">nixio.CHANGELOG</a>
 137         </li>
 138
 139         <li>
 140                 <a href="../modules/nixio.CryptoHash.html">nixio.CryptoHash</a>
 141         </li>
 142
 143         <li>
 144                 <a href="../modules/nixio.File.html">nixio.File</a>
 145         </li>
 146
 147         <li>
 148                 <a href="../modules/nixio.README.html">nixio.README</a>
 149         </li>
 150
 151         <li>
 152                 <a href="../modules/nixio.Socket.html">nixio.Socket</a>
 153         </li>
 154
 155         <li>
 156                 <a href="../modules/nixio.TLSContext.html">nixio.TLSContext</a>
 157         </li>
 158
 159         <li>
 160                 <a href="../modules/nixio.TLSSocket.html">nixio.TLSSocket</a>
 161         </li>
 162
 163         <li>
 164                 <a href="../modules/nixio.UnifiedIO.html">nixio.UnifiedIO</a>
 165         </li>
 166
 167         <li>
 168                 <a href="../modules/nixio.bin.html">nixio.bin</a>
 169         </li>
 170
 171         <li>
 172                 <a href="../modules/nixio.bit.html">nixio.bit</a>
 173         </li>
 174
 175         <li>
 176                 <a href="../modules/nixio.crypto.html">nixio.crypto</a>
 177         </li>
 178
 179         <li>
 180                 <a href="../modules/nixio.fs.html">nixio.fs</a>
 181         </li>
 182
 183 </ul>
 184
 185
 186
 187 <!-- File list -->
 188
 189
 190
 191
 192
 193
 194
 195 </div><!-- id="navigation" -->
 196
 197 <div id="content">
 198
 199 <h1>Class <code>luci.sys.net</code></h1>
 200
 201 <p>
 202
 203 LuCI system utilities / network related functions.
 204 </p>
 205
 206
 207
 208
 209
 210
 211
 212 <h2>Functions</h2>
 213 <table class="function_list">
 214
 215         <tr>
 216         <td class="name" nowrap><a href="#net.arptable">arptable</a>&nbsp;()</td>
 217         <td class="summary">
 218
 219 Returns the current arp-table entries as two-dimensional table.</td>
 220         </tr>
 221
 222         <tr>
 223         <td class="name" nowrap><a href="#net.conntrack">conntrack</a>&nbsp;()</td>
 224         <td class="summary">
 225
 226 Returns conntrack information
 227  </td>
 228         </tr>
 229
 230         <tr>
 231         <td class="name" nowrap><a href="#net.deviceinfo">deviceinfo</a>&nbsp;()</td>
 232         <td class="summary">
 233
 234 Return information about available network interfaces.</td>
 235         </tr>
 236
 237         <tr>
 238         <td class="name" nowrap><a href="#net.devices">devices</a>&nbsp;()</td>
 239         <td class="summary">
 240
 241 Determine the names of available network interfaces.</td>
 242         </tr>
 243
 244         <tr>
 245         <td class="name" nowrap><a href="#net.ipv4_hints">ipv4_hints</a>&nbsp;()</td>
 246         <td class="summary">
 247
 248 Returns a two-dimensional table of IPv4 address hints.</td>
 249         </tr>
 250
 251         <tr>
 252         <td class="name" nowrap><a href="#net.ipv6_hints">ipv6_hints</a>&nbsp;()</td>
 253         <td class="summary">
 254
 255 Returns a two-dimensional table of IPv6 address hints.</td>
 256         </tr>
 257
 258         <tr>
 259         <td class="name" nowrap><a href="#net.mac_hints">mac_hints</a>&nbsp;()</td>
 260         <td class="summary">
 261
 262 Returns a two-dimensional table of mac address hints.</td>
 263         </tr>
 264
 265         <tr>
 266         <td class="name" nowrap><a href="#net.pingtest">pingtest</a>&nbsp;(host)</td>
 267         <td class="summary">
 268
 269 Tests whether the given host responds to ping probes.</td>
 270         </tr>
 271
 272         <tr>
 273         <td class="name" nowrap><a href="#net.routes">routes</a>&nbsp;()</td>
 274         <td class="summary">
 275
 276 Returns the current kernel routing table entries.</td>
 277         </tr>
 278
 279         <tr>
 280         <td class="name" nowrap><a href="#net.routes6">routes6</a>&nbsp;()</td>
 281         <td class="summary">
 282
 283 Returns the current ipv6 kernel routing table entries.</td>
 284         </tr>
 285
 286 </table>
 287
 288
 289
 290
 291
 292
 293 <br/>
 294 <br/>
 295
 296
 297 <h2><a name="functions"></a>Functions</h2>
 298 <dl class="function">
 299
 300
 301
 302 <dt><a name="net.arptable"></a><strong>arptable</strong>&nbsp;()</dt>
 303 <dd>
 304
 305
 306 Returns the current arp-table entries as two-dimensional table.
 307
 308
 309
 310
 311
 312
 313
 314
 315 <h3>Return value:</h3>
 316 Table of table containing the current arp entries.
 317                         The following fields are defined for arp entry objects:
 318                         { "IP address", "HW address", "HW type", "Flags", "Mask", "Device" }
 319
 320
 321
 322 </dd>
 323
 324
 325
 326
 327 <dt><a name="net.conntrack"></a><strong>conntrack</strong>&nbsp;()</dt>
 328 <dd>
 329
 330
 331 Returns conntrack information
 332
 333
 334
 335
 336
 337
 338
 339
 340 <h3>Return value:</h3>
 341 Table with the currently tracked IP connections
 342
 343
 344
 345 </dd>
 346
 347
 348
 349
 350 <dt><a name="net.deviceinfo"></a><strong>deviceinfo</strong>&nbsp;()</dt>
 351 <dd>
 352
 353
 354 Return information about available network interfaces.
 355
 356
 357
 358
 359
 360
 361
 362
 363 <h3>Return value:</h3>
 364 Table containing all current interface names and their information
 365
 366
 367
 368 </dd>
 369
 370
 371
 372
 373 <dt><a name="net.devices"></a><strong>devices</strong>&nbsp;()</dt>
 374 <dd>
 375
 376
 377 Determine the names of available network interfaces.
 378
 379
 380
 381
 382
 383
 384
 385
 386 <h3>Return value:</h3>
 387 Table containing all current interface names
 388
 389
 390
 391 </dd>
 392
 393
 394
 395
 396 <dt><a name="net.ipv4_hints"></a><strong>ipv4_hints</strong>&nbsp;()</dt>
 397 <dd>
 398
 399
 400 Returns a two-dimensional table of IPv4 address hints.
 401
 402
 403
 404
 405
 406
 407
 408
 409 <h3>Return value:</h3>
 410 Table of table containing known hosts from various sources.
 411          Each entry contains the values in the following order:
 412          [ "ip", "name" ]
 413
 414
 415
 416 </dd>
 417
 418
 419
 420
 421 <dt><a name="net.ipv6_hints"></a><strong>ipv6_hints</strong>&nbsp;()</dt>
 422 <dd>
 423
 424
 425 Returns a two-dimensional table of IPv6 address hints.
 426
 427
 428
 429
 430
 431
 432
 433
 434 <h3>Return value:</h3>
 435 Table of table containing known hosts from various sources.
 436          Each entry contains the values in the following order:
 437          [ "ip", "name" ]
 438
 439
 440
 441 </dd>
 442
 443
 444
 445
 446 <dt><a name="net.mac_hints"></a><strong>mac_hints</strong>&nbsp;()</dt>
 447 <dd>
 448
 449
 450 Returns a two-dimensional table of mac address hints.
 451
 452
 453
 454
 455
 456
 457
 458
 459 <h3>Return value:</h3>
 460 Table of table containing known hosts from various sources.
 461          Each entry contains the values in the following order:
 462          [ "mac", "name" ]
 463
 464
 465
 466 </dd>
 467
 468
 469
 470
 471 <dt><a name="net.pingtest"></a><strong>pingtest</strong>&nbsp;(host)</dt>
 472 <dd>
 473
 474
 475 Tests whether the given host responds to ping probes.
 476
 477
 478
 479 <h3>Parameters</h3>
 480 <ul>
 481
 482         <li>
 483           host: String containing a hostname or IPv4 address
 484         </li>
 485
 486 </ul>
 487
 488
 489
 490
 491
 492
 493 <h3>Return value:</h3>
 494 Number containing 0 on success and >= 1 on error
 495
 496
 497
 498 </dd>
 499
 500
 501
 502
 503 <dt><a name="net.routes"></a><strong>routes</strong>&nbsp;()</dt>
 504 <dd>
 505
 506
 507 Returns the current kernel routing table entries.
 508
 509
 510
 511
 512
 513
 514
 515
 516 <h3>Return value:</h3>
 517 Table of tables with properties of the corresponding routes.
 518                         The following fields are defined for route entry tables:
 519                         { "dest", "gateway", "metric", "refcount", "usecount", "irtt",
 520                           "flags", "device" }
 521
 522
 523
 524 </dd>
 525
 526
 527
 528
 529 <dt><a name="net.routes6"></a><strong>routes6</strong>&nbsp;()</dt>
 530 <dd>
 531
 532
 533 Returns the current ipv6 kernel routing table entries.
 534
 535
 536
 537
 538
 539
 540
 541
 542 <h3>Return value:</h3>
 543 Table of tables with properties of the corresponding routes.
 544                         The following fields are defined for route entry tables:
 545                         { "source", "dest", "nexthop", "metric", "refcount", "usecount",
 546                           "flags", "device" }
 547
 548
 549
 550 </dd>
 551
 552
 553 </dl>
 554
 555
 556
 557
 558
 559 </div> <!-- id="content" -->
 560
 561 </div> <!-- id="main" -->
 562
 563 <div id="about">
 564         <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>
 565 </div> <!-- id="about" -->
 566
 567 </div> <!-- id="container" -->
 568 </body>
 569 </html>