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.host_hints">host_hints</a>&nbsp;()</td>
 246         <td class="summary">
 247
 248 Returns a two-dimensional table of host hints.</td>
 249         </tr>
 250
 251         <tr>
 252         <td class="name" nowrap><a href="#net.ipv4_hints">ipv4_hints</a>&nbsp;()</td>
 253         <td class="summary">
 254
 255 Returns a two-dimensional table of IPv4 address hints.</td>
 256         </tr>
 257
 258         <tr>
 259         <td class="name" nowrap><a href="#net.ipv6_hints">ipv6_hints</a>&nbsp;()</td>
 260         <td class="summary">
 261
 262 Returns a two-dimensional table of IPv6 address hints.</td>
 263         </tr>
 264
 265         <tr>
 266         <td class="name" nowrap><a href="#net.mac_hints">mac_hints</a>&nbsp;()</td>
 267         <td class="summary">
 268
 269 Returns a two-dimensional table of mac address hints.</td>
 270         </tr>
 271
 272         <tr>
 273         <td class="name" nowrap><a href="#net.pingtest">pingtest</a>&nbsp;(host)</td>
 274         <td class="summary">
 275
 276 Tests whether the given host responds to ping probes.</td>
 277         </tr>
 278
 279         <tr>
 280         <td class="name" nowrap><a href="#net.routes">routes</a>&nbsp;()</td>
 281         <td class="summary">
 282
 283 Returns the current kernel routing table entries.</td>
 284         </tr>
 285
 286         <tr>
 287         <td class="name" nowrap><a href="#net.routes6">routes6</a>&nbsp;()</td>
 288         <td class="summary">
 289
 290 Returns the current ipv6 kernel routing table entries.</td>
 291         </tr>
 292
 293 </table>
 294
 295
 296
 297
 298
 299
 300 <br/>
 301 <br/>
 302
 303
 304 <h2><a name="functions"></a>Functions</h2>
 305 <dl class="function">
 306
 307
 308
 309 <dt><a name="net.arptable"></a><strong>arptable</strong>&nbsp;()</dt>
 310 <dd>
 311
 312
 313 Returns the current arp-table entries as two-dimensional table.
 314
 315
 316
 317
 318
 319
 320
 321
 322 <h3>Return value:</h3>
 323 Table of table containing the current arp entries.
 324                         The following fields are defined for arp entry objects:
 325                         { "IP address", "HW address", "HW type", "Flags", "Mask", "Device" }
 326
 327
 328
 329 </dd>
 330
 331
 332
 333
 334 <dt><a name="net.conntrack"></a><strong>conntrack</strong>&nbsp;()</dt>
 335 <dd>
 336
 337
 338 Returns conntrack information
 339
 340
 341
 342
 343
 344
 345
 346
 347 <h3>Return value:</h3>
 348 Table with the currently tracked IP connections
 349
 350
 351
 352 </dd>
 353
 354
 355
 356
 357 <dt><a name="net.deviceinfo"></a><strong>deviceinfo</strong>&nbsp;()</dt>
 358 <dd>
 359
 360
 361 Return information about available network interfaces.
 362
 363
 364
 365
 366
 367
 368
 369
 370 <h3>Return value:</h3>
 371 Table containing all current interface names and their information
 372
 373
 374
 375 </dd>
 376
 377
 378
 379
 380 <dt><a name="net.devices"></a><strong>devices</strong>&nbsp;()</dt>
 381 <dd>
 382
 383
 384 Determine the names of available network interfaces.
 385
 386
 387
 388
 389
 390
 391
 392
 393 <h3>Return value:</h3>
 394 Table containing all current interface names
 395
 396
 397
 398 </dd>
 399
 400
 401
 402
 403 <dt><a name="net.host_hints"></a><strong>host_hints</strong>&nbsp;()</dt>
 404 <dd>
 405
 406
 407 Returns a two-dimensional table of host hints.
 408
 409
 410
 411
 412
 413
 414
 415
 416 <h3>Return value:</h3>
 417 Table of table containing known hosts from various sources,
 418          indexed by mac address. Each subtable contains at least one
 419          of the fields "name", "ipv4" or "ipv6".
 420
 421
 422
 423 </dd>
 424
 425
 426
 427
 428 <dt><a name="net.ipv4_hints"></a><strong>ipv4_hints</strong>&nbsp;()</dt>
 429 <dd>
 430
 431
 432 Returns a two-dimensional table of IPv4 address hints.
 433
 434
 435
 436
 437
 438
 439
 440
 441 <h3>Return value:</h3>
 442 Table of table containing known hosts from various sources.
 443          Each entry contains the values in the following order:
 444          [ "ip", "name" ]
 445
 446
 447
 448 </dd>
 449
 450
 451
 452
 453 <dt><a name="net.ipv6_hints"></a><strong>ipv6_hints</strong>&nbsp;()</dt>
 454 <dd>
 455
 456
 457 Returns a two-dimensional table of IPv6 address hints.
 458
 459
 460
 461
 462
 463
 464
 465
 466 <h3>Return value:</h3>
 467 Table of table containing known hosts from various sources.
 468          Each entry contains the values in the following order:
 469          [ "ip", "name" ]
 470
 471
 472
 473 </dd>
 474
 475
 476
 477
 478 <dt><a name="net.mac_hints"></a><strong>mac_hints</strong>&nbsp;()</dt>
 479 <dd>
 480
 481
 482 Returns a two-dimensional table of mac address hints.
 483
 484
 485
 486
 487
 488
 489
 490
 491 <h3>Return value:</h3>
 492 Table of table containing known hosts from various sources.
 493          Each entry contains the values in the following order:
 494          [ "mac", "name" ]
 495
 496
 497
 498 </dd>
 499
 500
 501
 502
 503 <dt><a name="net.pingtest"></a><strong>pingtest</strong>&nbsp;(host)</dt>
 504 <dd>
 505
 506
 507 Tests whether the given host responds to ping probes.
 508
 509
 510
 511 <h3>Parameters</h3>
 512 <ul>
 513
 514         <li>
 515           host: String containing a hostname or IPv4 address
 516         </li>
 517
 518 </ul>
 519
 520
 521
 522
 523
 524
 525 <h3>Return value:</h3>
 526 Number containing 0 on success and >= 1 on error
 527
 528
 529
 530 </dd>
 531
 532
 533
 534
 535 <dt><a name="net.routes"></a><strong>routes</strong>&nbsp;()</dt>
 536 <dd>
 537
 538
 539 Returns the current kernel routing table entries.
 540
 541
 542
 543
 544
 545
 546
 547
 548 <h3>Return value:</h3>
 549 Table of tables with properties of the corresponding routes.
 550                         The following fields are defined for route entry tables:
 551                         { "dest", "gateway", "metric", "refcount", "usecount", "irtt",
 552                           "flags", "device" }
 553
 554
 555
 556 </dd>
 557
 558
 559
 560
 561 <dt><a name="net.routes6"></a><strong>routes6</strong>&nbsp;()</dt>
 562 <dd>
 563
 564
 565 Returns the current ipv6 kernel routing table entries.
 566
 567
 568
 569
 570
 571
 572
 573
 574 <h3>Return value:</h3>
 575 Table of tables with properties of the corresponding routes.
 576                         The following fields are defined for route entry tables:
 577                         { "source", "dest", "nexthop", "metric", "refcount", "usecount",
 578                           "flags", "device" }
 579
 580
 581
 582 </dd>
 583
 584
 585 </dl>
 586
 587
 588
 589
 590
 591 </div> <!-- id="content" -->
 592
 593 </div> <!-- id="main" -->
 594
 595 <div id="about">
 596         <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>
 597 </div> <!-- id="about" -->
 598
 599 </div> <!-- id="container" -->
 600 </body>
 601 </html>