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