diff options
Diffstat (limited to 'documentation/jsapi/LuCI.Network.html')
| -rw-r--r-- | documentation/jsapi/LuCI.Network.html | 7032 |
1 files changed, 0 insertions, 7032 deletions
diff --git a/documentation/jsapi/LuCI.Network.html b/documentation/jsapi/LuCI.Network.html deleted file mode 100644 index 5b4d1e81b1..0000000000 --- a/documentation/jsapi/LuCI.Network.html +++ /dev/null @@ -1,7032 +0,0 @@ -<!DOCTYPE html> -<html> -<head> - <meta charset="utf-8"> - <title>Class: Network</title> - - - <script src="scripts/prettify/prettify.js"></script> - <script src="scripts/prettify/lang-css.js"></script> - <script src="scripts/jquery.min.js"></script> - <!--[if lt IE 9]> - <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script> - <![endif]--> - <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css"> - <link type="text/css" rel="stylesheet" href="styles/bootstrap.min.css"> - <link type="text/css" rel="stylesheet" href="styles/jaguar.css"> - - - <script> - var config = {"monospaceLinks":true,"cleverLinks":true,"default":{}}; - </script> - - - -</head> -<body> -<div id="wrap" class="clearfix"> - -<div class="navigation"> - <h3 class="applicationName"><a href="index.html"></a></h3> - - <div class="search"> - <input id="search" type="text" class="form-control input-sm" placeholder="Search Documentations"> - </div> - <ul class="list"> - - <li class="item" data-name="LuCI"> - <span class="title"> - <a href="LuCI.html">LuCI</a> - - </span> - <ul class="members itemMembers"> - - <span class="subtitle">Members</span> - - <li data-name="LuCI#env"><a href="LuCI.html#env">env</a></li> - - </ul> - <ul class="typedefs itemMembers"> - - <span class="subtitle">Typedefs</span> - - <li data-name="LuCI.requestCallbackFn"><a href="LuCI.html#.requestCallbackFn">requestCallbackFn</a></li> - - </ul> - <ul class="typedefs itemMembers"> - - </ul> - <ul class="methods itemMembers"> - - <span class="subtitle">Methods</span> - - <li data-name="LuCI#bind"><a href="LuCI.html#bind">bind</a></li> - - <li data-name="LuCI#error"><a href="LuCI.html#error">error</a></li> - - <li data-name="LuCI#get"><a href="LuCI.html#get">get</a></li> - - <li data-name="LuCI#halt"><a href="LuCI.html#halt">halt</a></li> - - <li data-name="LuCI#hasSystemFeature"><a href="LuCI.html#hasSystemFeature">hasSystemFeature</a></li> - - <li data-name="LuCI#isObject"><a href="LuCI.html#isObject">isObject</a></li> - - <li data-name="LuCI#location"><a href="LuCI.html#location">location</a></li> - - <li data-name="LuCI#path"><a href="LuCI.html#path">path</a></li> - - <li data-name="LuCI#poll"><a href="LuCI.html#poll">poll</a></li> - - <li data-name="LuCI#post"><a href="LuCI.html#post">post</a></li> - - <li data-name="LuCI#raise"><a href="LuCI.html#raise">raise</a></li> - - <li data-name="LuCI#require"><a href="LuCI.html#require">require</a></li> - - <li data-name="LuCI#resolveDefault"><a href="LuCI.html#resolveDefault">resolveDefault</a></li> - - <li data-name="LuCI#resource"><a href="LuCI.html#resource">resource</a></li> - - <li data-name="LuCI#run"><a href="LuCI.html#run">run</a></li> - - <li data-name="LuCI#sortedKeys"><a href="LuCI.html#sortedKeys">sortedKeys</a></li> - - <li data-name="LuCI#stop"><a href="LuCI.html#stop">stop</a></li> - - <li data-name="LuCI#toArray"><a href="LuCI.html#toArray">toArray</a></li> - - <li data-name="LuCI#url"><a href="LuCI.html#url">url</a></li> - - </ul> - <ul class="events itemMembers"> - - </ul> - </li> - - <li class="item" data-name="LuCI.Class"> - <span class="title"> - <a href="LuCI.Class.html">LuCI.Class</a> - - </span> - <ul class="members itemMembers"> - - </ul> - <ul class="typedefs itemMembers"> - - </ul> - <ul class="typedefs itemMembers"> - - </ul> - <ul class="methods itemMembers"> - - <span class="subtitle">Methods</span> - - <li data-name="LuCI.Class.extend"><a href="LuCI.Class.html#.extend">extend</a></li> - - <li data-name="LuCI.Class.instantiate"><a href="LuCI.Class.html#.instantiate">instantiate</a></li> - - <li data-name="LuCI.Class.isSubclass"><a href="LuCI.Class.html#.isSubclass">isSubclass</a></li> - - <li data-name="LuCI.Class.singleton"><a href="LuCI.Class.html#.singleton">singleton</a></li> - - <li data-name="LuCI.Class#super"><a href="LuCI.Class.html#super">super</a></li> - - <li data-name="LuCI.Class#varargs"><a href="LuCI.Class.html#varargs">varargs</a></li> - - </ul> - <ul class="events itemMembers"> - - </ul> - </li> - - <li class="item" data-name="LuCI.dom"> - <span class="title"> - <a href="LuCI.dom.html">LuCI.dom</a> - - </span> - <ul class="members itemMembers"> - - </ul> - <ul class="typedefs itemMembers"> - - <span class="subtitle">Typedefs</span> - - <li data-name="LuCI.dom~ignoreCallbackFn"><a href="LuCI.dom.html#~ignoreCallbackFn">ignoreCallbackFn</a></li> - - </ul> - <ul class="typedefs itemMembers"> - - </ul> - <ul class="methods itemMembers"> - - <span class="subtitle">Methods</span> - - <li data-name="LuCI.dom#append"><a href="LuCI.dom.html#append">append</a></li> - - <li data-name="LuCI.dom#attr"><a href="LuCI.dom.html#attr">attr</a></li> - - <li data-name="LuCI.dom#bindClassInstance"><a href="LuCI.dom.html#bindClassInstance">bindClassInstance</a></li> - - <li data-name="LuCI.dom#callClassMethod"><a href="LuCI.dom.html#callClassMethod">callClassMethod</a></li> - - <li data-name="LuCI.dom#content"><a href="LuCI.dom.html#content">content</a></li> - - <li data-name="LuCI.dom#create"><a href="LuCI.dom.html#create">create</a></li> - - <li data-name="LuCI.dom#data"><a href="LuCI.dom.html#data">data</a></li> - - <li data-name="LuCI.dom#elem"><a href="LuCI.dom.html#elem">elem</a></li> - - <li data-name="LuCI.dom#findClassInstance"><a href="LuCI.dom.html#findClassInstance">findClassInstance</a></li> - - <li data-name="LuCI.dom#isEmpty"><a href="LuCI.dom.html#isEmpty">isEmpty</a></li> - - <li data-name="LuCI.dom#matches"><a href="LuCI.dom.html#matches">matches</a></li> - - <li data-name="LuCI.dom#parent"><a href="LuCI.dom.html#parent">parent</a></li> - - <li data-name="LuCI.dom#parse"><a href="LuCI.dom.html#parse">parse</a></li> - - </ul> - <ul class="events itemMembers"> - - </ul> - </li> - - <li class="item" data-name="LuCI.fs"> - <span class="title"> - <a href="LuCI.fs.html">LuCI.fs</a> - - </span> - <ul class="members itemMembers"> - - </ul> - <ul class="typedefs itemMembers"> - - <span class="subtitle">Typedefs</span> - - <li data-name="LuCI.fs.FileExecResult"><a href="LuCI.fs.html#.FileExecResult">FileExecResult</a></li> - - <li data-name="LuCI.fs.FileStatEntry"><a href="LuCI.fs.html#.FileStatEntry">FileStatEntry</a></li> - - </ul> - <ul class="typedefs itemMembers"> - - </ul> - <ul class="methods itemMembers"> - - <span class="subtitle">Methods</span> - - <li data-name="LuCI.fs#exec"><a href="LuCI.fs.html#exec">exec</a></li> - - <li data-name="LuCI.fs#lines"><a href="LuCI.fs.html#lines">lines</a></li> - - <li data-name="LuCI.fs#list"><a href="LuCI.fs.html#list">list</a></li> - - <li data-name="LuCI.fs#read"><a href="LuCI.fs.html#read">read</a></li> - - <li data-name="LuCI.fs#remove"><a href="LuCI.fs.html#remove">remove</a></li> - - <li data-name="LuCI.fs#stat"><a href="LuCI.fs.html#stat">stat</a></li> - - <li data-name="LuCI.fs#trimmed"><a href="LuCI.fs.html#trimmed">trimmed</a></li> - - <li data-name="LuCI.fs#write"><a href="LuCI.fs.html#write">write</a></li> - - </ul> - <ul class="events itemMembers"> - - </ul> - </li> - - <li class="item" data-name="LuCI.Headers"> - <span class="title"> - <a href="LuCI.Headers.html">LuCI.Headers</a> - - </span> - <ul class="members itemMembers"> - - </ul> - <ul class="typedefs itemMembers"> - - </ul> - <ul class="typedefs itemMembers"> - - </ul> - <ul class="methods itemMembers"> - - <span class="subtitle">Methods</span> - - <li data-name="LuCI.Headers#get"><a href="LuCI.Headers.html#get">get</a></li> - - <li data-name="LuCI.Headers#has"><a href="LuCI.Headers.html#has">has</a></li> - - </ul> - <ul class="events itemMembers"> - - </ul> - </li> - - <li class="item" data-name="LuCI.Network"> - <span class="title"> - <a href="LuCI.Network.html">LuCI.Network</a> - - </span> - <ul class="members itemMembers"> - - </ul> - <ul class="typedefs itemMembers"> - - <span class="subtitle">Typedefs</span> - - <li data-name="LuCI.Network.SwitchTopology"><a href="LuCI.Network.html#.SwitchTopology">SwitchTopology</a></li> - - <li data-name="LuCI.Network.WifiEncryption"><a href="LuCI.Network.html#.WifiEncryption">WifiEncryption</a></li> - - <li data-name="LuCI.Network.WifiPeerEntry"><a href="LuCI.Network.html#.WifiPeerEntry">WifiPeerEntry</a></li> - - <li data-name="LuCI.Network.WifiRateEntry"><a href="LuCI.Network.html#.WifiRateEntry">WifiRateEntry</a></li> - - <li data-name="LuCI.Network.WifiScanResult"><a href="LuCI.Network.html#.WifiScanResult">WifiScanResult</a></li> - - </ul> - <ul class="typedefs itemMembers"> - - </ul> - <ul class="methods itemMembers"> - - <span class="subtitle">Methods</span> - - <li data-name="LuCI.Network#addNetwork"><a href="LuCI.Network.html#addNetwork">addNetwork</a></li> - - <li data-name="LuCI.Network#addWifiNetwork"><a href="LuCI.Network.html#addWifiNetwork">addWifiNetwork</a></li> - - <li data-name="LuCI.Network#deleteNetwork"><a href="LuCI.Network.html#deleteNetwork">deleteNetwork</a></li> - - <li data-name="LuCI.Network#deleteWifiNetwork"><a href="LuCI.Network.html#deleteWifiNetwork">deleteWifiNetwork</a></li> - - <li data-name="LuCI.Network#flushCache"><a href="LuCI.Network.html#flushCache">flushCache</a></li> - - <li data-name="LuCI.Network#formatWifiEncryption"><a href="LuCI.Network.html#formatWifiEncryption">formatWifiEncryption</a></li> - - <li data-name="LuCI.Network#getDevice"><a href="LuCI.Network.html#getDevice">getDevice</a></li> - - <li data-name="LuCI.Network#getDevices"><a href="LuCI.Network.html#getDevices">getDevices</a></li> - - <li data-name="LuCI.Network#getDSLModemType"><a href="LuCI.Network.html#getDSLModemType">getDSLModemType</a></li> - - <li data-name="LuCI.Network#getHostHints"><a href="LuCI.Network.html#getHostHints">getHostHints</a></li> - - <li data-name="LuCI.Network#getIfnameOf"><a href="LuCI.Network.html#getIfnameOf">getIfnameOf</a></li> - - <li data-name="LuCI.Network#getNetwork"><a href="LuCI.Network.html#getNetwork">getNetwork</a></li> - - <li data-name="LuCI.Network#getNetworks"><a href="LuCI.Network.html#getNetworks">getNetworks</a></li> - - <li data-name="LuCI.Network#getProtocol"><a href="LuCI.Network.html#getProtocol">getProtocol</a></li> - - <li data-name="LuCI.Network#getProtocols"><a href="LuCI.Network.html#getProtocols">getProtocols</a></li> - - <li data-name="LuCI.Network#getSwitchTopologies"><a href="LuCI.Network.html#getSwitchTopologies">getSwitchTopologies</a></li> - - <li data-name="LuCI.Network#getWAN6Networks"><a href="LuCI.Network.html#getWAN6Networks">getWAN6Networks</a></li> - - <li data-name="LuCI.Network#getWANNetworks"><a href="LuCI.Network.html#getWANNetworks">getWANNetworks</a></li> - - <li data-name="LuCI.Network#getWifiDevice"><a href="LuCI.Network.html#getWifiDevice">getWifiDevice</a></li> - - <li data-name="LuCI.Network#getWifiDevices"><a href="LuCI.Network.html#getWifiDevices">getWifiDevices</a></li> - - <li data-name="LuCI.Network#getWifiNetwork"><a href="LuCI.Network.html#getWifiNetwork">getWifiNetwork</a></li> - - <li data-name="LuCI.Network#isIgnoredDevice"><a href="LuCI.Network.html#isIgnoredDevice">isIgnoredDevice</a></li> - - <li data-name="LuCI.Network#maskToPrefix"><a href="LuCI.Network.html#maskToPrefix">maskToPrefix</a></li> - - <li data-name="LuCI.Network#prefixToMask"><a href="LuCI.Network.html#prefixToMask">prefixToMask</a></li> - - <li data-name="LuCI.Network#registerErrorCode"><a href="LuCI.Network.html#registerErrorCode">registerErrorCode</a></li> - - <li data-name="LuCI.Network#registerPatternVirtual"><a href="LuCI.Network.html#registerPatternVirtual">registerPatternVirtual</a></li> - - <li data-name="LuCI.Network#registerProtocol"><a href="LuCI.Network.html#registerProtocol">registerProtocol</a></li> - - <li data-name="LuCI.Network#renameNetwork"><a href="LuCI.Network.html#renameNetwork">renameNetwork</a></li> - - </ul> - <ul class="events itemMembers"> - - </ul> - </li> - - <li class="item" data-name="LuCI.Network.Device"> - <span class="title"> - <a href="LuCI.Network.Device.html">LuCI.Network.Device</a> - - </span> - <ul class="members itemMembers"> - - </ul> - <ul class="typedefs itemMembers"> - - </ul> - <ul class="typedefs itemMembers"> - - </ul> - <ul class="methods itemMembers"> - - <span class="subtitle">Methods</span> - - <li data-name="LuCI.Network.Device#getBridgeID"><a href="LuCI.Network.Device.html#getBridgeID">getBridgeID</a></li> - - <li data-name="LuCI.Network.Device#getBridgeSTP"><a href="LuCI.Network.Device.html#getBridgeSTP">getBridgeSTP</a></li> - - <li data-name="LuCI.Network.Device#getI18n"><a href="LuCI.Network.Device.html#getI18n">getI18n</a></li> - - <li data-name="LuCI.Network.Device#getIP6Addrs"><a href="LuCI.Network.Device.html#getIP6Addrs">getIP6Addrs</a></li> - - <li data-name="LuCI.Network.Device#getIPAddrs"><a href="LuCI.Network.Device.html#getIPAddrs">getIPAddrs</a></li> - - <li data-name="LuCI.Network.Device#getMAC"><a href="LuCI.Network.Device.html#getMAC">getMAC</a></li> - - <li data-name="LuCI.Network.Device#getMTU"><a href="LuCI.Network.Device.html#getMTU">getMTU</a></li> - - <li data-name="LuCI.Network.Device#getName"><a href="LuCI.Network.Device.html#getName">getName</a></li> - - <li data-name="LuCI.Network.Device#getNetwork"><a href="LuCI.Network.Device.html#getNetwork">getNetwork</a></li> - - <li data-name="LuCI.Network.Device#getNetworks"><a href="LuCI.Network.Device.html#getNetworks">getNetworks</a></li> - - <li data-name="LuCI.Network.Device#getPorts"><a href="LuCI.Network.Device.html#getPorts">getPorts</a></li> - - <li data-name="LuCI.Network.Device#getRXBytes"><a href="LuCI.Network.Device.html#getRXBytes">getRXBytes</a></li> - - <li data-name="LuCI.Network.Device#getRXPackets"><a href="LuCI.Network.Device.html#getRXPackets">getRXPackets</a></li> - - <li data-name="LuCI.Network.Device#getShortName"><a href="LuCI.Network.Device.html#getShortName">getShortName</a></li> - - <li data-name="LuCI.Network.Device#getTXBytes"><a href="LuCI.Network.Device.html#getTXBytes">getTXBytes</a></li> - - <li data-name="LuCI.Network.Device#getTXPackets"><a href="LuCI.Network.Device.html#getTXPackets">getTXPackets</a></li> - - <li data-name="LuCI.Network.Device#getType"><a href="LuCI.Network.Device.html#getType">getType</a></li> - - <li data-name="LuCI.Network.Device#getTypeI18n"><a href="LuCI.Network.Device.html#getTypeI18n">getTypeI18n</a></li> - - <li data-name="LuCI.Network.Device#getWifiNetwork"><a href="LuCI.Network.Device.html#getWifiNetwork">getWifiNetwork</a></li> - - <li data-name="LuCI.Network.Device#isBridge"><a href="LuCI.Network.Device.html#isBridge">isBridge</a></li> - - <li data-name="LuCI.Network.Device#isBridgePort"><a href="LuCI.Network.Device.html#isBridgePort">isBridgePort</a></li> - - <li data-name="LuCI.Network.Device#isUp"><a href="LuCI.Network.Device.html#isUp">isUp</a></li> - - </ul> - <ul class="events itemMembers"> - - </ul> - </li> - - <li class="item" data-name="LuCI.Network.Hosts"> - <span class="title"> - <a href="LuCI.Network.Hosts.html">LuCI.Network.Hosts</a> - - </span> - <ul class="members itemMembers"> - - </ul> - <ul class="typedefs itemMembers"> - - </ul> - <ul class="typedefs itemMembers"> - - </ul> - <ul class="methods itemMembers"> - - <span class="subtitle">Methods</span> - - <li data-name="LuCI.Network.Hosts#getHostnameByIP6Addr"><a href="LuCI.Network.Hosts.html#getHostnameByIP6Addr">getHostnameByIP6Addr</a></li> - - <li data-name="LuCI.Network.Hosts#getHostnameByIPAddr"><a href="LuCI.Network.Hosts.html#getHostnameByIPAddr">getHostnameByIPAddr</a></li> - - <li data-name="LuCI.Network.Hosts#getHostnameByMACAddr"><a href="LuCI.Network.Hosts.html#getHostnameByMACAddr">getHostnameByMACAddr</a></li> - - <li data-name="LuCI.Network.Hosts#getIP6AddrByMACAddr"><a href="LuCI.Network.Hosts.html#getIP6AddrByMACAddr">getIP6AddrByMACAddr</a></li> - - <li data-name="LuCI.Network.Hosts#getIPAddrByMACAddr"><a href="LuCI.Network.Hosts.html#getIPAddrByMACAddr">getIPAddrByMACAddr</a></li> - - <li data-name="LuCI.Network.Hosts#getMACAddrByIP6Addr"><a href="LuCI.Network.Hosts.html#getMACAddrByIP6Addr">getMACAddrByIP6Addr</a></li> - - <li data-name="LuCI.Network.Hosts#getMACAddrByIPAddr"><a href="LuCI.Network.Hosts.html#getMACAddrByIPAddr">getMACAddrByIPAddr</a></li> - - <li data-name="LuCI.Network.Hosts#getMACHints"><a href="LuCI.Network.Hosts.html#getMACHints">getMACHints</a></li> - - </ul> - <ul class="events itemMembers"> - - </ul> - </li> - - <li class="item" data-name="LuCI.Network.Protocol"> - <span class="title"> - <a href="LuCI.Network.Protocol.html">LuCI.Network.Protocol</a> - - </span> - <ul class="members itemMembers"> - - </ul> - <ul class="typedefs itemMembers"> - - </ul> - <ul class="typedefs itemMembers"> - - </ul> - <ul class="methods itemMembers"> - - <span class="subtitle">Methods</span> - - <li data-name="LuCI.Network.Protocol#addDevice"><a href="LuCI.Network.Protocol.html#addDevice">addDevice</a></li> - - <li data-name="LuCI.Network.Protocol#containsDevice"><a href="LuCI.Network.Protocol.html#containsDevice">containsDevice</a></li> - - <li data-name="LuCI.Network.Protocol#deleteDevice"><a href="LuCI.Network.Protocol.html#deleteDevice">deleteDevice</a></li> - - <li data-name="LuCI.Network.Protocol#get"><a href="LuCI.Network.Protocol.html#get">get</a></li> - - <li data-name="LuCI.Network.Protocol#getDevice"><a href="LuCI.Network.Protocol.html#getDevice">getDevice</a></li> - - <li data-name="LuCI.Network.Protocol#getDevices"><a href="LuCI.Network.Protocol.html#getDevices">getDevices</a></li> - - <li data-name="LuCI.Network.Protocol#getDNS6Addrs"><a href="LuCI.Network.Protocol.html#getDNS6Addrs">getDNS6Addrs</a></li> - - <li data-name="LuCI.Network.Protocol#getDNSAddrs"><a href="LuCI.Network.Protocol.html#getDNSAddrs">getDNSAddrs</a></li> - - <li data-name="LuCI.Network.Protocol#getErrors"><a href="LuCI.Network.Protocol.html#getErrors">getErrors</a></li> - - <li data-name="LuCI.Network.Protocol#getExpiry"><a href="LuCI.Network.Protocol.html#getExpiry">getExpiry</a></li> - - <li data-name="LuCI.Network.Protocol#getGateway6Addr"><a href="LuCI.Network.Protocol.html#getGateway6Addr">getGateway6Addr</a></li> - - <li data-name="LuCI.Network.Protocol#getGatewayAddr"><a href="LuCI.Network.Protocol.html#getGatewayAddr">getGatewayAddr</a></li> - - <li data-name="LuCI.Network.Protocol#getI18n"><a href="LuCI.Network.Protocol.html#getI18n">getI18n</a></li> - - <li data-name="LuCI.Network.Protocol#getIfname"><a href="LuCI.Network.Protocol.html#getIfname">getIfname</a></li> - - <li data-name="LuCI.Network.Protocol#getIP6Addr"><a href="LuCI.Network.Protocol.html#getIP6Addr">getIP6Addr</a></li> - - <li data-name="LuCI.Network.Protocol#getIP6Addrs"><a href="LuCI.Network.Protocol.html#getIP6Addrs">getIP6Addrs</a></li> - - <li data-name="LuCI.Network.Protocol#getIP6Prefix"><a href="LuCI.Network.Protocol.html#getIP6Prefix">getIP6Prefix</a></li> - - <li data-name="LuCI.Network.Protocol#getIPAddr"><a href="LuCI.Network.Protocol.html#getIPAddr">getIPAddr</a></li> - - <li data-name="LuCI.Network.Protocol#getIPAddrs"><a href="LuCI.Network.Protocol.html#getIPAddrs">getIPAddrs</a></li> - - <li data-name="LuCI.Network.Protocol#getL2Device"><a href="LuCI.Network.Protocol.html#getL2Device">getL2Device</a></li> - - <li data-name="LuCI.Network.Protocol#getL3Device"><a href="LuCI.Network.Protocol.html#getL3Device">getL3Device</a></li> - - <li data-name="LuCI.Network.Protocol#getMetric"><a href="LuCI.Network.Protocol.html#getMetric">getMetric</a></li> - - <li data-name="LuCI.Network.Protocol#getName"><a href="LuCI.Network.Protocol.html#getName">getName</a></li> - - <li data-name="LuCI.Network.Protocol#getNetmask"><a href="LuCI.Network.Protocol.html#getNetmask">getNetmask</a></li> - - <li data-name="LuCI.Network.Protocol#getOpkgPackage"><a href="LuCI.Network.Protocol.html#getOpkgPackage">getOpkgPackage</a></li> - - <li data-name="LuCI.Network.Protocol#getProtocol"><a href="LuCI.Network.Protocol.html#getProtocol">getProtocol</a></li> - - <li data-name="LuCI.Network.Protocol#getType"><a href="LuCI.Network.Protocol.html#getType">getType</a></li> - - <li data-name="LuCI.Network.Protocol#getUptime"><a href="LuCI.Network.Protocol.html#getUptime">getUptime</a></li> - - <li data-name="LuCI.Network.Protocol#getZoneName"><a href="LuCI.Network.Protocol.html#getZoneName">getZoneName</a></li> - - <li data-name="LuCI.Network.Protocol#isAlias"><a href="LuCI.Network.Protocol.html#isAlias">isAlias</a></li> - - <li data-name="LuCI.Network.Protocol#isBridge"><a href="LuCI.Network.Protocol.html#isBridge">isBridge</a></li> - - <li data-name="LuCI.Network.Protocol#isDynamic"><a href="LuCI.Network.Protocol.html#isDynamic">isDynamic</a></li> - - <li data-name="LuCI.Network.Protocol#isEmpty"><a href="LuCI.Network.Protocol.html#isEmpty">isEmpty</a></li> - - <li data-name="LuCI.Network.Protocol#isFloating"><a href="LuCI.Network.Protocol.html#isFloating">isFloating</a></li> - - <li data-name="LuCI.Network.Protocol#isInstalled"><a href="LuCI.Network.Protocol.html#isInstalled">isInstalled</a></li> - - <li data-name="LuCI.Network.Protocol#isUp"><a href="LuCI.Network.Protocol.html#isUp">isUp</a></li> - - <li data-name="LuCI.Network.Protocol#isVirtual"><a href="LuCI.Network.Protocol.html#isVirtual">isVirtual</a></li> - - <li data-name="LuCI.Network.Protocol#set"><a href="LuCI.Network.Protocol.html#set">set</a></li> - - </ul> - <ul class="events itemMembers"> - - </ul> - </li> - - <li class="item" data-name="LuCI.Network.WifiDevice"> - <span class="title"> - <a href="LuCI.Network.WifiDevice.html">LuCI.Network.WifiDevice</a> - - </span> - <ul class="members itemMembers"> - - </ul> - <ul class="typedefs itemMembers"> - - </ul> - <ul class="typedefs itemMembers"> - - </ul> - <ul class="methods itemMembers"> - - <span class="subtitle">Methods</span> - - <li data-name="LuCI.Network.WifiDevice#addWifiNetwork"><a href="LuCI.Network.WifiDevice.html#addWifiNetwork">addWifiNetwork</a></li> - - <li data-name="LuCI.Network.WifiDevice#deleteWifiNetwork"><a href="LuCI.Network.WifiDevice.html#deleteWifiNetwork">deleteWifiNetwork</a></li> - - <li data-name="LuCI.Network.WifiDevice#get"><a href="LuCI.Network.WifiDevice.html#get">get</a></li> - - <li data-name="LuCI.Network.WifiDevice#getHTModes"><a href="LuCI.Network.WifiDevice.html#getHTModes">getHTModes</a></li> - - <li data-name="LuCI.Network.WifiDevice#getHWModes"><a href="LuCI.Network.WifiDevice.html#getHWModes">getHWModes</a></li> - - <li data-name="LuCI.Network.WifiDevice#getI18n"><a href="LuCI.Network.WifiDevice.html#getI18n">getI18n</a></li> - - <li data-name="LuCI.Network.WifiDevice#getName"><a href="LuCI.Network.WifiDevice.html#getName">getName</a></li> - - <li data-name="LuCI.Network.WifiDevice#getScanList"><a href="LuCI.Network.WifiDevice.html#getScanList">getScanList</a></li> - - <li data-name="LuCI.Network.WifiDevice#getWifiNetwork"><a href="LuCI.Network.WifiDevice.html#getWifiNetwork">getWifiNetwork</a></li> - - <li data-name="LuCI.Network.WifiDevice#getWifiNetworks"><a href="LuCI.Network.WifiDevice.html#getWifiNetworks">getWifiNetworks</a></li> - - <li data-name="LuCI.Network.WifiDevice#isDisabled"><a href="LuCI.Network.WifiDevice.html#isDisabled">isDisabled</a></li> - - <li data-name="LuCI.Network.WifiDevice#isUp"><a href="LuCI.Network.WifiDevice.html#isUp">isUp</a></li> - - <li data-name="LuCI.Network.WifiDevice#set"><a href="LuCI.Network.WifiDevice.html#set">set</a></li> - - </ul> - <ul class="events itemMembers"> - - </ul> - </li> - - <li class="item" data-name="LuCI.Network.WifiNetwork"> - <span class="title"> - <a href="LuCI.Network.WifiNetwork.html">LuCI.Network.WifiNetwork</a> - - </span> - <ul class="members itemMembers"> - - </ul> - <ul class="typedefs itemMembers"> - - </ul> - <ul class="typedefs itemMembers"> - - </ul> - <ul class="methods itemMembers"> - - <span class="subtitle">Methods</span> - - <li data-name="LuCI.Network.WifiNetwork#get"><a href="LuCI.Network.WifiNetwork.html#get">get</a></li> - - <li data-name="LuCI.Network.WifiNetwork#getActiveBSSID"><a href="LuCI.Network.WifiNetwork.html#getActiveBSSID">getActiveBSSID</a></li> - - <li data-name="LuCI.Network.WifiNetwork#getActiveEncryption"><a href="LuCI.Network.WifiNetwork.html#getActiveEncryption">getActiveEncryption</a></li> - - <li data-name="LuCI.Network.WifiNetwork#getActiveMode"><a href="LuCI.Network.WifiNetwork.html#getActiveMode">getActiveMode</a></li> - - <li data-name="LuCI.Network.WifiNetwork#getActiveModeI18n"><a href="LuCI.Network.WifiNetwork.html#getActiveModeI18n">getActiveModeI18n</a></li> - - <li data-name="LuCI.Network.WifiNetwork#getActiveSSID"><a href="LuCI.Network.WifiNetwork.html#getActiveSSID">getActiveSSID</a></li> - - <li data-name="LuCI.Network.WifiNetwork#getAssocList"><a href="LuCI.Network.WifiNetwork.html#getAssocList">getAssocList</a></li> - - <li data-name="LuCI.Network.WifiNetwork#getBitRate"><a href="LuCI.Network.WifiNetwork.html#getBitRate">getBitRate</a></li> - - <li data-name="LuCI.Network.WifiNetwork#getBSSID"><a href="LuCI.Network.WifiNetwork.html#getBSSID">getBSSID</a></li> - - <li data-name="LuCI.Network.WifiNetwork#getChannel"><a href="LuCI.Network.WifiNetwork.html#getChannel">getChannel</a></li> - - <li data-name="LuCI.Network.WifiNetwork#getCountryCode"><a href="LuCI.Network.WifiNetwork.html#getCountryCode">getCountryCode</a></li> - - <li data-name="LuCI.Network.WifiNetwork#getDevice"><a href="LuCI.Network.WifiNetwork.html#getDevice">getDevice</a></li> - - <li data-name="LuCI.Network.WifiNetwork#getFrequency"><a href="LuCI.Network.WifiNetwork.html#getFrequency">getFrequency</a></li> - - <li data-name="LuCI.Network.WifiNetwork#getI18n"><a href="LuCI.Network.WifiNetwork.html#getI18n">getI18n</a></li> - - <li data-name="LuCI.Network.WifiNetwork#getID"><a href="LuCI.Network.WifiNetwork.html#getID">getID</a></li> - - <li data-name="LuCI.Network.WifiNetwork#getIfname"><a href="LuCI.Network.WifiNetwork.html#getIfname">getIfname</a></li> - - <li data-name="LuCI.Network.WifiNetwork#getMeshID"><a href="LuCI.Network.WifiNetwork.html#getMeshID">getMeshID</a></li> - - <li data-name="LuCI.Network.WifiNetwork#getMode"><a href="LuCI.Network.WifiNetwork.html#getMode">getMode</a></li> - - <li data-name="LuCI.Network.WifiNetwork#getName"><a href="LuCI.Network.WifiNetwork.html#getName">getName</a></li> - - <li data-name="LuCI.Network.WifiNetwork#getNetwork"><a href="LuCI.Network.WifiNetwork.html#getNetwork">getNetwork</a></li> - - <li data-name="LuCI.Network.WifiNetwork#getNetworkNames"><a href="LuCI.Network.WifiNetwork.html#getNetworkNames">getNetworkNames</a></li> - - <li data-name="LuCI.Network.WifiNetwork#getNetworks"><a href="LuCI.Network.WifiNetwork.html#getNetworks">getNetworks</a></li> - - <li data-name="LuCI.Network.WifiNetwork#getNoise"><a href="LuCI.Network.WifiNetwork.html#getNoise">getNoise</a></li> - - <li data-name="LuCI.Network.WifiNetwork#getShortName"><a href="LuCI.Network.WifiNetwork.html#getShortName">getShortName</a></li> - - <li data-name="LuCI.Network.WifiNetwork#getSignal"><a href="LuCI.Network.WifiNetwork.html#getSignal">getSignal</a></li> - - <li data-name="LuCI.Network.WifiNetwork#getSignalLevel"><a href="LuCI.Network.WifiNetwork.html#getSignalLevel">getSignalLevel</a></li> - - <li data-name="LuCI.Network.WifiNetwork#getSignalPercent"><a href="LuCI.Network.WifiNetwork.html#getSignalPercent">getSignalPercent</a></li> - - <li data-name="LuCI.Network.WifiNetwork#getSSID"><a href="LuCI.Network.WifiNetwork.html#getSSID">getSSID</a></li> - - <li data-name="LuCI.Network.WifiNetwork#getTXPower"><a href="LuCI.Network.WifiNetwork.html#getTXPower">getTXPower</a></li> - - <li data-name="LuCI.Network.WifiNetwork#getTXPowerOffset"><a href="LuCI.Network.WifiNetwork.html#getTXPowerOffset">getTXPowerOffset</a></li> - - <li data-name="LuCI.Network.WifiNetwork#getWifiDevice"><a href="LuCI.Network.WifiNetwork.html#getWifiDevice">getWifiDevice</a></li> - - <li data-name="LuCI.Network.WifiNetwork#getWifiDeviceName"><a href="LuCI.Network.WifiNetwork.html#getWifiDeviceName">getWifiDeviceName</a></li> - - <li data-name="LuCI.Network.WifiNetwork#isDisabled"><a href="LuCI.Network.WifiNetwork.html#isDisabled">isDisabled</a></li> - - <li data-name="LuCI.Network.WifiNetwork#isUp"><a href="LuCI.Network.WifiNetwork.html#isUp">isUp</a></li> - - <li data-name="LuCI.Network.WifiNetwork#set"><a href="LuCI.Network.WifiNetwork.html#set">set</a></li> - - </ul> - <ul class="events itemMembers"> - - </ul> - </li> - - <li class="item" data-name="LuCI.Poll"> - <span class="title"> - <a href="LuCI.Poll.html">LuCI.Poll</a> - - </span> - <ul class="members itemMembers"> - - </ul> - <ul class="typedefs itemMembers"> - - </ul> - <ul class="typedefs itemMembers"> - - </ul> - <ul class="methods itemMembers"> - - <span class="subtitle">Methods</span> - - <li data-name="LuCI.Poll#active"><a href="LuCI.Poll.html#active">active</a></li> - - <li data-name="LuCI.Poll#add"><a href="LuCI.Poll.html#add">add</a></li> - - <li data-name="LuCI.Poll#remove"><a href="LuCI.Poll.html#remove">remove</a></li> - - <li data-name="LuCI.Poll#start"><a href="LuCI.Poll.html#start">start</a></li> - - <li data-name="LuCI.Poll#stop"><a href="LuCI.Poll.html#stop">stop</a></li> - - </ul> - <ul class="events itemMembers"> - - </ul> - </li> - - <li class="item" data-name="LuCI.Request"> - <span class="title"> - <a href="LuCI.Request.html">LuCI.Request</a> - - </span> - <ul class="members itemMembers"> - - </ul> - <ul class="typedefs itemMembers"> - - <span class="subtitle">Typedefs</span> - - <li data-name="LuCI.Request.interceptorFn"><a href="LuCI.Request.html#.interceptorFn">interceptorFn</a></li> - - <li data-name="LuCI.Request.RequestOptions"><a href="LuCI.Request.html#.RequestOptions">RequestOptions</a></li> - - </ul> - <ul class="typedefs itemMembers"> - - </ul> - <ul class="methods itemMembers"> - - <span class="subtitle">Methods</span> - - <li data-name="LuCI.Request#addInterceptor"><a href="LuCI.Request.html#addInterceptor">addInterceptor</a></li> - - <li data-name="LuCI.Request#expandURL"><a href="LuCI.Request.html#expandURL">expandURL</a></li> - - <li data-name="LuCI.Request#get"><a href="LuCI.Request.html#get">get</a></li> - - <li data-name="LuCI.Request#post"><a href="LuCI.Request.html#post">post</a></li> - - <li data-name="LuCI.Request#removeInterceptor"><a href="LuCI.Request.html#removeInterceptor">removeInterceptor</a></li> - - <li data-name="LuCI.Request#request"><a href="LuCI.Request.html#request">request</a></li> - - </ul> - <ul class="events itemMembers"> - - </ul> - </li> - - <li class="item" data-name="LuCI.Request.poll"> - <span class="title"> - <a href="LuCI.Request.poll.html">LuCI.Request.poll</a> - - </span> - <ul class="members itemMembers"> - - </ul> - <ul class="typedefs itemMembers"> - - <span class="subtitle">Typedefs</span> - - <li data-name="LuCI.Request.poll~callbackFn"><a href="LuCI.Request.poll.html#~callbackFn">callbackFn</a></li> - - </ul> - <ul class="typedefs itemMembers"> - - </ul> - <ul class="methods itemMembers"> - - <span class="subtitle">Methods</span> - - <li data-name="LuCI.Request.poll#active"><a href="LuCI.Request.poll.html#active">active</a></li> - - <li data-name="LuCI.Request.poll#add"><a href="LuCI.Request.poll.html#add">add</a></li> - - <li data-name="LuCI.Request.poll#remove"><a href="LuCI.Request.poll.html#remove">remove</a></li> - - <li data-name="LuCI.Request.poll#start"><a href="LuCI.Request.poll.html#start">start</a></li> - - <li data-name="LuCI.Request.poll#stop"><a href="LuCI.Request.poll.html#stop">stop</a></li> - - </ul> - <ul class="events itemMembers"> - - </ul> - </li> - - <li class="item" data-name="LuCI.Response"> - <span class="title"> - <a href="LuCI.Response.html">LuCI.Response</a> - - </span> - <ul class="members itemMembers"> - - <span class="subtitle">Members</span> - - <li data-name="LuCI.Response#duration"><a href="LuCI.Response.html#duration">duration</a></li> - - <li data-name="LuCI.Response#headers"><a href="LuCI.Response.html#headers">headers</a></li> - - <li data-name="LuCI.Response#ok"><a href="LuCI.Response.html#ok">ok</a></li> - - <li data-name="LuCI.Response#status"><a href="LuCI.Response.html#status">status</a></li> - - <li data-name="LuCI.Response#statusText"><a href="LuCI.Response.html#statusText">statusText</a></li> - - <li data-name="LuCI.Response#url"><a href="LuCI.Response.html#url">url</a></li> - - </ul> - <ul class="typedefs itemMembers"> - - </ul> - <ul class="typedefs itemMembers"> - - </ul> - <ul class="methods itemMembers"> - - <span class="subtitle">Methods</span> - - <li data-name="LuCI.Response#clone"><a href="LuCI.Response.html#clone">clone</a></li> - - <li data-name="LuCI.Response#json"><a href="LuCI.Response.html#json">json</a></li> - - <li data-name="LuCI.Response#text"><a href="LuCI.Response.html#text">text</a></li> - - </ul> - <ul class="events itemMembers"> - - </ul> - </li> - - <li class="item" data-name="LuCI.rpc"> - <span class="title"> - <a href="LuCI.rpc.html">LuCI.rpc</a> - - </span> - <ul class="members itemMembers"> - - </ul> - <ul class="typedefs itemMembers"> - - <span class="subtitle">Typedefs</span> - - <li data-name="LuCI.rpc.DeclareOptions"><a href="LuCI.rpc.html#.DeclareOptions">DeclareOptions</a></li> - - <li data-name="LuCI.rpc~filterFn"><a href="LuCI.rpc.html#~filterFn">filterFn</a></li> - - <li data-name="LuCI.rpc~interceptorFn"><a href="LuCI.rpc.html#~interceptorFn">interceptorFn</a></li> - - <li data-name="LuCI.rpc~invokeFn"><a href="LuCI.rpc.html#~invokeFn">invokeFn</a></li> - - </ul> - <ul class="typedefs itemMembers"> - - </ul> - <ul class="methods itemMembers"> - - <span class="subtitle">Methods</span> - - <li data-name="LuCI.rpc#addInterceptor"><a href="LuCI.rpc.html#addInterceptor">addInterceptor</a></li> - - <li data-name="LuCI.rpc#declare"><a href="LuCI.rpc.html#declare">declare</a></li> - - <li data-name="LuCI.rpc#getBaseURL"><a href="LuCI.rpc.html#getBaseURL">getBaseURL</a></li> - - <li data-name="LuCI.rpc#getSessionID"><a href="LuCI.rpc.html#getSessionID">getSessionID</a></li> - - <li data-name="LuCI.rpc#getStatusText"><a href="LuCI.rpc.html#getStatusText">getStatusText</a></li> - - <li data-name="LuCI.rpc#list"><a href="LuCI.rpc.html#list">list</a></li> - - <li data-name="LuCI.rpc#removeInterceptor"><a href="LuCI.rpc.html#removeInterceptor">removeInterceptor</a></li> - - <li data-name="LuCI.rpc#setBaseURL"><a href="LuCI.rpc.html#setBaseURL">setBaseURL</a></li> - - <li data-name="LuCI.rpc#setSessionID"><a href="LuCI.rpc.html#setSessionID">setSessionID</a></li> - - </ul> - <ul class="events itemMembers"> - - </ul> - </li> - - <li class="item" data-name="LuCI.uci"> - <span class="title"> - <a href="LuCI.uci.html">LuCI.uci</a> - - </span> - <ul class="members itemMembers"> - - </ul> - <ul class="typedefs itemMembers"> - - <span class="subtitle">Typedefs</span> - - <li data-name="LuCI.uci.ChangeRecord"><a href="LuCI.uci.html#.ChangeRecord">ChangeRecord</a></li> - - <li data-name="LuCI.uci.SectionObject"><a href="LuCI.uci.html#.SectionObject">SectionObject</a></li> - - <li data-name="LuCI.uci~sectionsFn"><a href="LuCI.uci.html#~sectionsFn">sectionsFn</a></li> - - </ul> - <ul class="typedefs itemMembers"> - - </ul> - <ul class="methods itemMembers"> - - <span class="subtitle">Methods</span> - - <li data-name="LuCI.uci#add"><a href="LuCI.uci.html#add">add</a></li> - - <li data-name="LuCI.uci#apply"><a href="LuCI.uci.html#apply">apply</a></li> - - <li data-name="LuCI.uci#changes"><a href="LuCI.uci.html#changes">changes</a></li> - - <li data-name="LuCI.uci#createSID"><a href="LuCI.uci.html#createSID">createSID</a></li> - - <li data-name="LuCI.uci#get"><a href="LuCI.uci.html#get">get</a></li> - - <li data-name="LuCI.uci#get_first"><a href="LuCI.uci.html#get_first">get_first</a></li> - - <li data-name="LuCI.uci#load"><a href="LuCI.uci.html#load">load</a></li> - - <li data-name="LuCI.uci#move"><a href="LuCI.uci.html#move">move</a></li> - - <li data-name="LuCI.uci#remove"><a href="LuCI.uci.html#remove">remove</a></li> - - <li data-name="LuCI.uci#resolveSID"><a href="LuCI.uci.html#resolveSID">resolveSID</a></li> - - <li data-name="LuCI.uci#save"><a href="LuCI.uci.html#save">save</a></li> - - <li data-name="LuCI.uci#sections"><a href="LuCI.uci.html#sections">sections</a></li> - - <li data-name="LuCI.uci#set"><a href="LuCI.uci.html#set">set</a></li> - - <li data-name="LuCI.uci#set_first"><a href="LuCI.uci.html#set_first">set_first</a></li> - - <li data-name="LuCI.uci#unload"><a href="LuCI.uci.html#unload">unload</a></li> - - <li data-name="LuCI.uci#unset"><a href="LuCI.uci.html#unset">unset</a></li> - - <li data-name="LuCI.uci#unset_first"><a href="LuCI.uci.html#unset_first">unset_first</a></li> - - </ul> - <ul class="events itemMembers"> - - </ul> - </li> - - <li class="item" data-name="LuCI.view"> - <span class="title"> - <a href="LuCI.view.html">LuCI.view</a> - - </span> - <ul class="members itemMembers"> - - </ul> - <ul class="typedefs itemMembers"> - - </ul> - <ul class="typedefs itemMembers"> - - </ul> - <ul class="methods itemMembers"> - - <span class="subtitle">Methods</span> - - <li data-name="LuCI.view#addFooter"><a href="LuCI.view.html#addFooter">addFooter</a></li> - - <li data-name="LuCI.view#handleReset"><a href="LuCI.view.html#handleReset">handleReset</a></li> - - <li data-name="LuCI.view#handleSave"><a href="LuCI.view.html#handleSave">handleSave</a></li> - - <li data-name="LuCI.view#handleSaveApply"><a href="LuCI.view.html#handleSaveApply">handleSaveApply</a></li> - - <li data-name="LuCI.view#load"><a href="LuCI.view.html#load">load</a></li> - - <li data-name="LuCI.view#render"><a href="LuCI.view.html#render">render</a></li> - - </ul> - <ul class="events itemMembers"> - - </ul> - </li> - - <li class="item" data-name="LuCI.XHR"> - <span class="title"> - <a href="LuCI.XHR.html">LuCI.XHR</a> - - </span> - <ul class="members itemMembers"> - - </ul> - <ul class="typedefs itemMembers"> - - </ul> - <ul class="typedefs itemMembers"> - - </ul> - <ul class="methods itemMembers"> - - <span class="subtitle">Methods</span> - - <li data-name="LuCI.XHR#abort"><a href="LuCI.XHR.html#abort">abort</a></li> - - <li data-name="LuCI.XHR#busy"><a href="LuCI.XHR.html#busy">busy</a></li> - - <li data-name="LuCI.XHR#cancel"><a href="LuCI.XHR.html#cancel">cancel</a></li> - - <li data-name="LuCI.XHR#get"><a href="LuCI.XHR.html#get">get</a></li> - - <li data-name="LuCI.XHR#post"><a href="LuCI.XHR.html#post">post</a></li> - - <li data-name="LuCI.XHR#send_form"><a href="LuCI.XHR.html#send_form">send_form</a></li> - - </ul> - <ul class="events itemMembers"> - - </ul> - </li> - - </ul> -</div> - <div class="main"> - <h1 class="page-title" data-filename="LuCI.Network.html">Class: Network</h1> - - - - -<section> - -<header> - <h2> - <span class="ancestors"><a href="LuCI.html">LuCI</a>.</span> - - Network - </h2> - - <div class="class-description"><p>The <code>LuCI.Network</code> class combines data from multiple <code>ubus</code> apis to -provide an abstraction of the current network configuration state.</p> -<p>It provides methods to enumerate interfaces and devices, to query -current configuration details and to manipulate settings.</p></div> - -</header> - -<article> - <div class="container-overview"> - - - - -<dt> - <div class="nameContainer"> - <h4 class="name" id="Network"> - - new LuCI.Network<span class="signature">()</span> - </h4> - - - <div class="tag-source"> - network.js, line 628 - </div> - - </div> - - -</dt> -<dd> - - - - - - - - - - -<dl class="details"> - - - - - - - - - - - - - - - - - - - - - -</dl> - - - - - - - - - - - - - -</dd> - - - </div> - - - - - - - - - <h3 class="subsection-title">Classes</h3> - - <dl> - <dt><a href="LuCI.Network.Device.html">Device</a></dt> - <dd></dd> - - <dt><a href="LuCI.Network.Hosts.html">Hosts</a></dt> - <dd></dd> - - <dt><a href="LuCI.Network.Protocol.html">Protocol</a></dt> - <dd></dd> - - <dt><a href="LuCI.Network.WifiDevice.html">WifiDevice</a></dt> - <dd></dd> - - <dt><a href="LuCI.Network.WifiNetwork.html">WifiNetwork</a></dt> - <dd></dd> - </dl> - - - - - - - - <h3 class="subsection-title">Methods</h3> - - <dl> - -<dt> - <div class="nameContainer"> - <h4 class="name" id="addNetwork"> - - addNetwork<span class="signature">(name, <span class="optional">options</span>)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Promise.<(null|<a href="LuCI.Network.Protocol.html">LuCI.Network.Protocol</a>)>}</span> - </h4> - - - <div class="tag-source"> - network.js, line 884 - </div> - - </div> - - -</dt> -<dd> - - - <div class="description"> - <p>Adds a new network of the given name and update it with the given -uci option values.</p> -<p>If a network with the given name already exist but is empty, then -this function will update its option, otherwise it will do nothing.</p> - </div> - - - - - - - - - -<table class="params"> - <thead> - <tr> - - <th>Name</th> - - - <th>Type</th> - - - - <th class="last">Description</th> - </tr> - </thead> - - <tbody> - - - <tr> - - <td class="name"><code>name</code></td> - - - <td class="type"> - - -<span class="param-type">string</span> - - - - </td> - - - - <td class="description last"> - - - - - - - <p>The name of the network to add. Must be in the format <code>[a-zA-Z0-9_]+</code>.</p></td> - </tr> - - - - <tr> - - <td class="name"><code>options</code></td> - - - <td class="type"> - - -<span class="param-type">Object.<string, (string|Array.<string>)></span> - - - - </td> - - - - <td class="description last"> - - - <span class="optional">optional</span> - - - - - - <p>An object of uci option values to set on the new network or to -update in an existing, empty network.</p></td> - </tr> - - - </tbody> -</table> - - - -<dl class="details"> - - - - - - - - - - - - - - - - - - - - - -</dl> - - - - - - - - - - - - <h5>Returns:</h5> - - - -<table class="params"> - <thead> - <tr> - - <th>Type</th> - <th class="last">Description</th> - </tr> - </thead> - <tbody> - - <tr> - - <td class="type"> - - Promise.<(null|<a href="LuCI.Network.Protocol.html">LuCI.Network.Protocol</a>)> - - - </td> - <td class="description last">Returns a promise resolving to the <code>Protocol</code> subclass instance -describing the added network or resolving to <code>null</code> if the name -was invalid or if a non-empty network of the given name already -existed.</td> - </tr> - - </tbody> -</table> - - - - -</dd> - - - -<dt> - <div class="nameContainer"> - <h4 class="name" id="addWifiNetwork"> - - addWifiNetwork<span class="signature">(options)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Promise.<(null|<a href="LuCI.Network.WifiNetwork.html">LuCI.Network.WifiNetwork</a>)>}</span> - </h4> - - - <div class="tag-source"> - network.js, line 1352 - </div> - - </div> - - -</dt> -<dd> - - - <div class="description"> - <p>Adds a new wireless network to the configuration and sets its options -to the provided values.</p> - </div> - - - - - - - - - -<table class="params"> - <thead> - <tr> - - <th>Name</th> - - - <th>Type</th> - - - - <th class="last">Description</th> - </tr> - </thead> - - <tbody> - - - <tr> - - <td class="name"><code>options</code></td> - - - <td class="type"> - - -<span class="param-type">Object.<string, (string|Array.<string>)></span> - - - - </td> - - - - <td class="description last"> - - <p>The options to set for the newly added wireless network. This object -must at least contain a <code>device</code> property which is set to the radio -name the new network belongs to.</p></td> - </tr> - - - </tbody> -</table> - - - -<dl class="details"> - - - - - - - - - - - - - - - - - - - - - -</dl> - - - - - - - - - - - - <h5>Returns:</h5> - - - -<table class="params"> - <thead> - <tr> - - <th>Type</th> - <th class="last">Description</th> - </tr> - </thead> - <tbody> - - <tr> - - <td class="type"> - - Promise.<(null|<a href="LuCI.Network.WifiNetwork.html">LuCI.Network.WifiNetwork</a>)> - - - </td> - <td class="description last">Returns a promise resolving to a <code>WifiNetwork</code> instance describing -the newly added wireless network or <code>null</code> if the given options -were invalid or if the associated radio device could not be found.</td> - </tr> - - </tbody> -</table> - - - - -</dd> - - - -<dt> - <div class="nameContainer"> - <h4 class="name" id="deleteNetwork"> - - deleteNetwork<span class="signature">(name)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Promise.<boolean>}</span> - </h4> - - - <div class="tag-source"> - network.js, line 962 - </div> - - </div> - - -</dt> -<dd> - - - <div class="description"> - <p>Deletes the given network and its references from the network and -firewall configuration.</p> - </div> - - - - - - - - - -<table class="params"> - <thead> - <tr> - - <th>Name</th> - - - <th>Type</th> - - - - <th class="last">Description</th> - </tr> - </thead> - - <tbody> - - - <tr> - - <td class="name"><code>name</code></td> - - - <td class="type"> - - -<span class="param-type">string</span> - - - - </td> - - - - <td class="description last"> - - <p>The name of the network to delete.</p></td> - </tr> - - - </tbody> -</table> - - - -<dl class="details"> - - - - - - - - - - - - - - - - - - - - - -</dl> - - - - - - - - - - - - <h5>Returns:</h5> - - - -<table class="params"> - <thead> - <tr> - - <th>Type</th> - <th class="last">Description</th> - </tr> - </thead> - <tbody> - - <tr> - - <td class="type"> - - Promise.<boolean> - - - </td> - <td class="description last">Returns a promise resolving to either <code>true</code> if the network and -references to it were successfully deleted from the configuration or -<code>false</code> if the given network could not be found.</td> - </tr> - - </tbody> -</table> - - - - -</dd> - - - -<dt> - <div class="nameContainer"> - <h4 class="name" id="deleteWifiNetwork"> - - deleteWifiNetwork<span class="signature">(netname)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Promise.<boolean>}</span> - </h4> - - - <div class="tag-source"> - network.js, line 1390 - </div> - - </div> - - -</dt> -<dd> - - - <div class="description"> - <p>Deletes the given wireless network from the configuration.</p> - </div> - - - - - - - - - -<table class="params"> - <thead> - <tr> - - <th>Name</th> - - - <th>Type</th> - - - - <th class="last">Description</th> - </tr> - </thead> - - <tbody> - - - <tr> - - <td class="name"><code>netname</code></td> - - - <td class="type"> - - -<span class="param-type">string</span> - - - - </td> - - - - <td class="description last"> - - <p>The name of the network to remove. This may be either a -network ID in the form <code>radio#.network#</code> or a Linux network device -name like <code>wlan0</code> which is resolved to the corresponding configuration -section through <code>ubus</code> runtime information.</p></td> - </tr> - - - </tbody> -</table> - - - -<dl class="details"> - - - - - - - - - - - - - - - - - - - - - -</dl> - - - - - - - - - - - - <h5>Returns:</h5> - - - -<table class="params"> - <thead> - <tr> - - <th>Type</th> - <th class="last">Description</th> - </tr> - </thead> - <tbody> - - <tr> - - <td class="type"> - - Promise.<boolean> - - - </td> - <td class="description last">Returns a promise resolving to <code>true</code> if the wireless network has been -successfully deleted from the configuration or <code>false</code> if it could not -be found.</td> - </tr> - - </tbody> -</table> - - - - -</dd> - - - -<dt> - <div class="nameContainer"> - <h4 class="name" id="flushCache"> - - flushCache<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Promise.<Object>}</span> - </h4> - - - <div class="tag-source"> - network.js, line 728 - </div> - - </div> - - -</dt> -<dd> - - - <div class="description"> - <p>Flushes the local network state cache and fetches updated information -from the remote <code>ubus</code> apis.</p> - </div> - - - - - - - - - -<dl class="details"> - - - - - - - - - - - - - - - - - - - - - -</dl> - - - - - - - - - - - - <h5>Returns:</h5> - - - -<table class="params"> - <thead> - <tr> - - <th>Type</th> - <th class="last">Description</th> - </tr> - </thead> - <tbody> - - <tr> - - <td class="type"> - - Promise.<Object> - - - </td> - <td class="description last">Returns a promise resolving to the internal network state object.</td> - </tr> - - </tbody> -</table> - - - - -</dd> - - - -<dt> - <div class="nameContainer"> - <h4 class="name" id="formatWifiEncryption"> - - formatWifiEncryption<span class="signature">(encryption)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{null|string}</span> - </h4> - - - <div class="tag-source"> - network.js, line 719 - </div> - - </div> - - -</dt> -<dd> - - - <div class="description"> - <p>Converts a given <a href="LuCI.Network.html#.WifiEncryption"><code>encryption entry</code></a> -into a human readable string such as <code>mixed WPA/WPA2 PSK (TKIP, CCMP)</code> -or <code>WPA3 SAE (CCMP)</code>.</p> - </div> - - - - - - - - - -<table class="params"> - <thead> - <tr> - - <th>Name</th> - - - <th>Type</th> - - - - <th class="last">Description</th> - </tr> - </thead> - - <tbody> - - - <tr> - - <td class="name"><code>encryption</code></td> - - - <td class="type"> - - -<span class="param-type"><a href="LuCI.Network.html#.WifiEncryption">LuCI.Network.WifiEncryption</a></span> - - - - </td> - - - - <td class="description last"> - - <p>The wireless encryption entry to convert.</p></td> - </tr> - - - </tbody> -</table> - - - -<dl class="details"> - - - - - - - - - - - - - - - - - - - - - -</dl> - - - - - - - - - - - - <h5>Returns:</h5> - - - -<table class="params"> - <thead> - <tr> - - <th>Type</th> - <th class="last">Description</th> - </tr> - </thead> - <tbody> - - <tr> - - <td class="type"> - - null - | - - string - - - </td> - <td class="description last">Returns the description string for the given encryption entry or -<code>null</code> if the given entry was invalid.</td> - </tr> - - </tbody> -</table> - - - - -</dd> - - - -<dt> - <div class="nameContainer"> - <h4 class="name" id="getDevice"> - - getDevice<span class="signature">(name)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Promise.<(null|<a href="LuCI.Network.Device.html">LuCI.Network.Device</a>)>}</span> - </h4> - - - <div class="tag-source"> - network.js, line 1087 - </div> - - </div> - - -</dt> -<dd> - - - <div class="description"> - <p>Get a <a href="LuCI.Network.Device.html"><code>Device</code></a> instance describing the -given network device.</p> - </div> - - - - - - - - - -<table class="params"> - <thead> - <tr> - - <th>Name</th> - - - <th>Type</th> - - - - <th class="last">Description</th> - </tr> - </thead> - - <tbody> - - - <tr> - - <td class="name"><code>name</code></td> - - - <td class="type"> - - -<span class="param-type">string</span> - - - - </td> - - - - <td class="description last"> - - <p>The name of the network device to get, e.g. <code>eth0</code> or <code>br-lan</code>.</p></td> - </tr> - - - </tbody> -</table> - - - -<dl class="details"> - - - - - - - - - - - - - - - - - - - - - -</dl> - - - - - - - - - - - - <h5>Returns:</h5> - - - -<table class="params"> - <thead> - <tr> - - <th>Type</th> - <th class="last">Description</th> - </tr> - </thead> - <tbody> - - <tr> - - <td class="type"> - - Promise.<(null|<a href="LuCI.Network.Device.html">LuCI.Network.Device</a>)> - - - </td> - <td class="description last">Returns a promise resolving to the <code>Device</code> instance describing -the network device or <code>null</code> if the given device name could not -be found.</td> - </tr> - - </tbody> -</table> - - - - -</dd> - - - -<dt> - <div class="nameContainer"> - <h4 class="name" id="getDevices"> - - getDevices<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Promise.<Array.<<a href="LuCI.Network.Device.html">LuCI.Network.Device</a>>>}</span> - </h4> - - - <div class="tag-source"> - network.js, line 1110 - </div> - - </div> - - -</dt> -<dd> - - - <div class="description"> - <p>Get a sorted list of all found network devices.</p> - </div> - - - - - - - - - -<dl class="details"> - - - - - - - - - - - - - - - - - - - - - -</dl> - - - - - - - - - - - - <h5>Returns:</h5> - - - -<table class="params"> - <thead> - <tr> - - <th>Type</th> - <th class="last">Description</th> - </tr> - </thead> - <tbody> - - <tr> - - <td class="type"> - - Promise.<Array.<<a href="LuCI.Network.Device.html">LuCI.Network.Device</a>>> - - - </td> - <td class="description last">Returns a promise resolving to a sorted array of <code>Device</code> class -instances describing the network devices found on the system.</td> - </tr> - - </tbody> -</table> - - - - -</dd> - - - -<dt> - <div class="nameContainer"> - <h4 class="name" id="getDSLModemType"> - - getDSLModemType<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Promise.<(null|string)>}</span> - </h4> - - - <div class="tag-source"> - network.js, line 1594 - </div> - - </div> - - -</dt> -<dd> - - - <div class="description"> - <p>Queries the internal DSL modem type from board information.</p> - </div> - - - - - - - - - -<dl class="details"> - - - - - - - - - - - - - - - - - - - - - -</dl> - - - - - - - - - - - - <h5>Returns:</h5> - - - -<table class="params"> - <thead> - <tr> - - <th>Type</th> - <th class="last">Description</th> - </tr> - </thead> - <tbody> - - <tr> - - <td class="type"> - - Promise.<(null|string)> - - - </td> - <td class="description last">Returns a promise resolving to the type of the internal modem -(e.g. <code>vdsl</code>) or to <code>null</code> if no internal modem is present.</td> - </tr> - - </tbody> -</table> - - - - -</dd> - - - -<dt> - <div class="nameContainer"> - <h4 class="name" id="getHostHints"> - - getHostHints<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Promise.<<a href="LuCI.Network.Hosts.html">LuCI.Network.Hosts</a>>}</span> - </h4> - - - <div class="tag-source"> - network.js, line 1611 - </div> - - </div> - - -</dt> -<dd> - - - <div class="description"> - <p>Queries aggregated information about known hosts.</p> -<p>This function aggregates information from various sources such as -DHCP lease databases, ARP and IPv6 neighbour entries, wireless -association list etc. and returns a <a href="LuCI.Network.Hosts.html"><code>Hosts</code></a> -class instance describing the found hosts.</p> - </div> - - - - - - - - - -<dl class="details"> - - - - - - - - - - - - - - - - - - - - - -</dl> - - - - - - - - - - - - <h5>Returns:</h5> - - - -<table class="params"> - <thead> - <tr> - - <th>Type</th> - <th class="last">Description</th> - </tr> - </thead> - <tbody> - - <tr> - - <td class="type"> - - Promise.<<a href="LuCI.Network.Hosts.html">LuCI.Network.Hosts</a>> - - - </td> - <td class="description last">Returns a <code>Hosts</code> instance describing host known on the system.</td> - </tr> - - </tbody> -</table> - - - - -</dd> - - - -<dt> - <div class="nameContainer"> - <h4 class="name" id="getIfnameOf"> - - getIfnameOf<span class="signature">(obj)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{null|string}</span> - </h4> - - - <div class="tag-source"> - network.js, line 1583 - </div> - - </div> - - -</dt> -<dd> - - - <div class="description"> - <p>Obtains the the network device name of the given object.</p> - </div> - - - - - - - - - -<table class="params"> - <thead> - <tr> - - <th>Name</th> - - - <th>Type</th> - - - - <th class="last">Description</th> - </tr> - </thead> - - <tbody> - - - <tr> - - <td class="name"><code>obj</code></td> - - - <td class="type"> - - -<span class="param-type"><a href="LuCI.Network.Protocol.html">LuCI.Network.Protocol</a></span> -| - -<span class="param-type"><a href="LuCI.Network.Device.html">LuCI.Network.Device</a></span> -| - -<span class="param-type"><a href="LuCI.Network.WifiDevice.html">LuCI.Network.WifiDevice</a></span> -| - -<span class="param-type"><a href="LuCI.Network.WifiNetwork.html">LuCI.Network.WifiNetwork</a></span> -| - -<span class="param-type">string</span> - - - - </td> - - - - <td class="description last"> - - <p>The object to get the device name from.</p></td> - </tr> - - - </tbody> -</table> - - - -<dl class="details"> - - - - - - - - - - - - - - - - - - - - - -</dl> - - - - - - - - - - - - <h5>Returns:</h5> - - - -<table class="params"> - <thead> - <tr> - - <th>Type</th> - <th class="last">Description</th> - </tr> - </thead> - <tbody> - - <tr> - - <td class="type"> - - null - | - - string - - - </td> - <td class="description last">Returns a string containing the device name or <code>null</code> if the given -object could not be converted to a name.</td> - </tr> - - </tbody> -</table> - - - - -</dd> - - - -<dt> - <div class="nameContainer"> - <h4 class="name" id="getNetwork"> - - getNetwork<span class="signature">(name)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Promise.<(null|<a href="LuCI.Network.Protocol.html">LuCI.Network.Protocol</a>)>}</span> - </h4> - - - <div class="tag-source"> - network.js, line 921 - </div> - - </div> - - -</dt> -<dd> - - - <div class="description"> - <p>Get a <a href="LuCI.Network.Protocol.html"><code>Protocol</code></a> instance describing -the network with the given name.</p> - </div> - - - - - - - - - -<table class="params"> - <thead> - <tr> - - <th>Name</th> - - - <th>Type</th> - - - - <th class="last">Description</th> - </tr> - </thead> - - <tbody> - - - <tr> - - <td class="name"><code>name</code></td> - - - <td class="type"> - - -<span class="param-type">string</span> - - - - </td> - - - - <td class="description last"> - - <p>The logical interface name of the network get, e.g. <code>lan</code> or <code>wan</code>.</p></td> - </tr> - - - </tbody> -</table> - - - -<dl class="details"> - - - - - - - - - - - - - - - - - - - - - -</dl> - - - - - - - - - - - - <h5>Returns:</h5> - - - -<table class="params"> - <thead> - <tr> - - <th>Type</th> - <th class="last">Description</th> - </tr> - </thead> - <tbody> - - <tr> - - <td class="type"> - - Promise.<(null|<a href="LuCI.Network.Protocol.html">LuCI.Network.Protocol</a>)> - - - </td> - <td class="description last">Returns a promise resolving to a -<a href="LuCI.Network.Protocol.html"><code>Protocol</code></a> subclass instance describing -the network or <code>null</code> if the network did not exist.</td> - </tr> - - </tbody> -</table> - - - - -</dd> - - - -<dt> - <div class="nameContainer"> - <h4 class="name" id="getNetworks"> - - getNetworks<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Promise.<Array.<<a href="LuCI.Network.Protocol.html">LuCI.Network.Protocol</a>>>}</span> - </h4> - - - <div class="tag-source"> - network.js, line 946 - </div> - - </div> - - -</dt> -<dd> - - - <div class="description"> - <p>Gets an array containing all known networks.</p> - </div> - - - - - - - - - -<dl class="details"> - - - - - - - - - - - - - - - - - - - - - -</dl> - - - - - - - - - - - - <h5>Returns:</h5> - - - -<table class="params"> - <thead> - <tr> - - <th>Type</th> - <th class="last">Description</th> - </tr> - </thead> - <tbody> - - <tr> - - <td class="type"> - - Promise.<Array.<<a href="LuCI.Network.Protocol.html">LuCI.Network.Protocol</a>>> - - - </td> - <td class="description last">Returns a promise resolving to a name-sorted array of -<a href="LuCI.Network.Protocol.html"><code>Protocol</code></a> subclass instances -describing all known networks.</td> - </tr> - - </tbody> -</table> - - - - -</dd> - - - -<dt> - <div class="nameContainer"> - <h4 class="name" id="getProtocol"> - - getProtocol<span class="signature">(protoname, <span class="optional">netname</span>)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{null|<a href="LuCI.Network.Protocol.html">LuCI.Network.Protocol</a>}</span> - </h4> - - - <div class="tag-source"> - network.js, line 750 - </div> - - </div> - - -</dt> -<dd> - - - <div class="description"> - <p>Instantiates the given <a href="LuCI.Network.Protocol.html"><code>Protocol</code></a> backend, -optionally using the given network name.</p> - </div> - - - - - - - - - -<table class="params"> - <thead> - <tr> - - <th>Name</th> - - - <th>Type</th> - - - <th>Default</th> - - - <th class="last">Description</th> - </tr> - </thead> - - <tbody> - - - <tr> - - <td class="name"><code>protoname</code></td> - - - <td class="type"> - - -<span class="param-type">string</span> - - - - </td> - - - <td class="default"> - - </td> - - - <td class="description last"> - - - - - - - <p>The protocol backend to use, e.g. <code>static</code> or <code>dhcp</code>.</p></td> - </tr> - - - - <tr> - - <td class="name"><code>netname</code></td> - - - <td class="type"> - - -<span class="param-type">string</span> - - - - </td> - - - <td class="default"> - - __dummy__ - - </td> - - - <td class="description last"> - - - <span class="optional">optional</span> - - - - - - <p>The network name to use for the instantiated protocol. This should be -usually set to one of the interfaces described in /etc/config/network -but it is allowed to omit it, e.g. to query protocol capabilities -without the need for an existing interface.</p></td> - </tr> - - - </tbody> -</table> - - - -<dl class="details"> - - - - - - - - - - - - - - - - - - - - - -</dl> - - - - - - - - - - - - <h5>Returns:</h5> - - - -<table class="params"> - <thead> - <tr> - - <th>Type</th> - <th class="last">Description</th> - </tr> - </thead> - <tbody> - - <tr> - - <td class="type"> - - null - | - - <a href="LuCI.Network.Protocol.html">LuCI.Network.Protocol</a> - - - </td> - <td class="description last">Returns the instantiated protocol backend class or <code>null</code> if the given -protocol isn't known.</td> - </tr> - - </tbody> -</table> - - - - -</dd> - - - -<dt> - <div class="nameContainer"> - <h4 class="name" id="getProtocols"> - - getProtocols<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Array.<<a href="LuCI.Network.Protocol.html">LuCI.Network.Protocol</a>>}</span> - </h4> - - - <div class="tag-source"> - network.js, line 765 - </div> - - </div> - - -</dt> -<dd> - - - <div class="description"> - <p>Obtains instances of all known <a href="LuCI.Network.Protocol.html"><code>Protocol</code></a> -backend classes.</p> - </div> - - - - - - - - - -<dl class="details"> - - - - - - - - - - - - - - - - - - - - - -</dl> - - - - - - - - - - - - <h5>Returns:</h5> - - - -<table class="params"> - <thead> - <tr> - - <th>Type</th> - <th class="last">Description</th> - </tr> - </thead> - <tbody> - - <tr> - - <td class="type"> - - Array.<<a href="LuCI.Network.Protocol.html">LuCI.Network.Protocol</a>> - - - </td> - <td class="description last">Returns an array of protocol class instances.</td> - </tr> - - </tbody> -</table> - - - - -</dd> - - - -<dt> - <div class="nameContainer"> - <h4 class="name" id="getSwitchTopologies"> - - getSwitchTopologies<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Promise.<Object.<string, <a href="LuCI.Network.html#.SwitchTopology">LuCI.Network.SwitchTopology</a>>>}</span> - </h4> - - - <div class="tag-source"> - network.js, line 1538 - </div> - - </div> - - -</dt> -<dd> - - - <div class="description"> - <p>Returns the topologies of all swconfig switches found on the system.</p> - </div> - - - - - - - - - -<dl class="details"> - - - - - - - - - - - - - - - - - - - - - -</dl> - - - - - - - - - - - - <h5>Returns:</h5> - - - -<table class="params"> - <thead> - <tr> - - <th>Type</th> - <th class="last">Description</th> - </tr> - </thead> - <tbody> - - <tr> - - <td class="type"> - - Promise.<Object.<string, <a href="LuCI.Network.html#.SwitchTopology">LuCI.Network.SwitchTopology</a>>> - - - </td> - <td class="description last">Returns a promise resolving to an object containing the topologies -of each switch. The object keys correspond to the name of the switches -such as <code>switch0</code>, the values are -<a href="LuCI.Network.html#.SwitchTopology"><code>SwitchTopology</code></a> objects describing -the layout.</td> - </tr> - - </tbody> -</table> - - - - -</dd> - - - -<dt> - <div class="nameContainer"> - <h4 class="name" id="getWAN6Networks"> - - getWAN6Networks<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Promise.<Array.<<a href="LuCI.Network.Protocol.html">LuCI.Network.Protocol</a>>>}</span> - </h4> - - - <div class="tag-source"> - network.js, line 1493 - </div> - - </div> - - -</dt> -<dd> - - - <div class="description"> - <p>Get IPv6 wan networks.</p> -<p>This function looks up all networks having a default <code>::/0</code> route -and returns them as array.</p> - </div> - - - - - - - - - -<dl class="details"> - - - - - - - - - - - - - - - - - - - - - -</dl> - - - - - - - - - - - - <h5>Returns:</h5> - - - -<table class="params"> - <thead> - <tr> - - <th>Type</th> - <th class="last">Description</th> - </tr> - </thead> - <tbody> - - <tr> - - <td class="type"> - - Promise.<Array.<<a href="LuCI.Network.Protocol.html">LuCI.Network.Protocol</a>>> - - - </td> - <td class="description last">Returns a promise resolving to an array of <code>Protocol</code> subclass -instances describing the found IPv6 default route interfaces.</td> - </tr> - - </tbody> -</table> - - - - -</dd> - - - -<dt> - <div class="nameContainer"> - <h4 class="name" id="getWANNetworks"> - - getWANNetworks<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Promise.<Array.<<a href="LuCI.Network.Protocol.html">LuCI.Network.Protocol</a>>>}</span> - </h4> - - - <div class="tag-source"> - network.js, line 1472 - </div> - - </div> - - -</dt> -<dd> - - - <div class="description"> - <p>Get IPv4 wan networks.</p> -<p>This function looks up all networks having a default <code>0.0.0.0/0</code> route -and returns them as array.</p> - </div> - - - - - - - - - -<dl class="details"> - - - - - - - - - - - - - - - - - - - - - -</dl> - - - - - - - - - - - - <h5>Returns:</h5> - - - -<table class="params"> - <thead> - <tr> - - <th>Type</th> - <th class="last">Description</th> - </tr> - </thead> - <tbody> - - <tr> - - <td class="type"> - - Promise.<Array.<<a href="LuCI.Network.Protocol.html">LuCI.Network.Protocol</a>>> - - - </td> - <td class="description last">Returns a promise resolving to an array of <code>Protocol</code> subclass -instances describing the found default route interfaces.</td> - </tr> - - </tbody> -</table> - - - - -</dd> - - - -<dt> - <div class="nameContainer"> - <h4 class="name" id="getWifiDevice"> - - getWifiDevice<span class="signature">(devname)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Promise.<(null|<a href="LuCI.Network.WifiDevice.html">LuCI.Network.WifiDevice</a>)>}</span> - </h4> - - - <div class="tag-source"> - network.js, line 1240 - </div> - - </div> - - -</dt> -<dd> - - - <div class="description"> - <p>Get a <a href="LuCI.Network.WifiDevice.html"><code>WifiDevice</code></a> instance describing -the given wireless radio.</p> - </div> - - - - - - - - - -<table class="params"> - <thead> - <tr> - - <th>Name</th> - - - <th>Type</th> - - - - <th class="last">Description</th> - </tr> - </thead> - - <tbody> - - - <tr> - - <td class="name"><code>devname</code></td> - - - <td class="type"> - - -<span class="param-type">string</span> - - - - </td> - - - - <td class="description last"> - - <p>The configuration name of the wireless radio to lookup, e.g. <code>radio0</code> -for the first mac80211 phy on the system.</p></td> - </tr> - - - </tbody> -</table> - - - -<dl class="details"> - - - - - - - - - - - - - - - - - - - - - -</dl> - - - - - - - - - - - - <h5>Returns:</h5> - - - -<table class="params"> - <thead> - <tr> - - <th>Type</th> - <th class="last">Description</th> - </tr> - </thead> - <tbody> - - <tr> - - <td class="type"> - - Promise.<(null|<a href="LuCI.Network.WifiDevice.html">LuCI.Network.WifiDevice</a>)> - - - </td> - <td class="description last">Returns a promise resolving to the <code>WifiDevice</code> instance describing -the underlying radio device or <code>null</code> if the wireless radio could not -be found.</td> - </tr> - - </tbody> -</table> - - - - -</dd> - - - -<dt> - <div class="nameContainer"> - <h4 class="name" id="getWifiDevices"> - - getWifiDevices<span class="signature">()</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Promise.<Array.<<a href="LuCI.Network.WifiDevice.html">LuCI.Network.WifiDevice</a>>>}</span> - </h4> - - - <div class="tag-source"> - network.js, line 1260 - </div> - - </div> - - -</dt> -<dd> - - - <div class="description"> - <p>Obtain a list of all configured radio devices.</p> - </div> - - - - - - - - - -<dl class="details"> - - - - - - - - - - - - - - - - - - - - - -</dl> - - - - - - - - - - - - <h5>Returns:</h5> - - - -<table class="params"> - <thead> - <tr> - - <th>Type</th> - <th class="last">Description</th> - </tr> - </thead> - <tbody> - - <tr> - - <td class="type"> - - Promise.<Array.<<a href="LuCI.Network.WifiDevice.html">LuCI.Network.WifiDevice</a>>> - - - </td> - <td class="description last">Returns a promise resolving to an array of <code>WifiDevice</code> instances -describing the wireless radios configured in the system. -The order of the array corresponds to the order of the radios in -the configuration.</td> - </tr> - - </tbody> -</table> - - - - -</dd> - - - -<dt> - <div class="nameContainer"> - <h4 class="name" id="getWifiNetwork"> - - getWifiNetwork<span class="signature">(netname)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Promise.<(null|<a href="LuCI.Network.WifiNetwork.html">LuCI.Network.WifiNetwork</a>)>}</span> - </h4> - - - <div class="tag-source"> - network.js, line 1289 - </div> - - </div> - - -</dt> -<dd> - - - <div class="description"> - <p>Get a <a href="LuCI.Network.WifiNetwork.html"><code>WifiNetwork</code></a> instance describing -the given wireless network.</p> - </div> - - - - - - - - - -<table class="params"> - <thead> - <tr> - - <th>Name</th> - - - <th>Type</th> - - - - <th class="last">Description</th> - </tr> - </thead> - - <tbody> - - - <tr> - - <td class="name"><code>netname</code></td> - - - <td class="type"> - - -<span class="param-type">string</span> - - - - </td> - - - - <td class="description last"> - - <p>The name of the wireless network to lookup. This may be either an uci -configuration section ID, a network ID in the form <code>radio#.network#</code> -or a Linux network device name like <code>wlan0</code> which is resolved to the -corresponding configuration section through <code>ubus</code> runtime information.</p></td> - </tr> - - - </tbody> -</table> - - - -<dl class="details"> - - - - - - - - - - - - - - - - - - - - - -</dl> - - - - - - - - - - - - <h5>Returns:</h5> - - - -<table class="params"> - <thead> - <tr> - - <th>Type</th> - <th class="last">Description</th> - </tr> - </thead> - <tbody> - - <tr> - - <td class="type"> - - Promise.<(null|<a href="LuCI.Network.WifiNetwork.html">LuCI.Network.WifiNetwork</a>)> - - - </td> - <td class="description last">Returns a promise resolving to the <code>WifiNetwork</code> instance describing -the wireless network or <code>null</code> if the corresponding network could not -be found.</td> - </tr> - - </tbody> -</table> - - - - -</dd> - - - -<dt> - <div class="nameContainer"> - <h4 class="name" id="isIgnoredDevice"> - - isIgnoredDevice<span class="signature">(name)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{boolean}</span> - </h4> - - - <div class="tag-source"> - network.js, line 1223 - </div> - - </div> - - -</dt> -<dd> - - - <div class="description"> - <p>Test if a given network device name is in the list of patterns for -device names to ignore.</p> -<p>Ignored device names are usually Linux network devices which are -spawned implicitly by kernel modules such as <code>tunl0</code> or <code>hwsim0</code> -and which are unsuitable for use in network configuration.</p> - </div> - - - - - - - - - -<table class="params"> - <thead> - <tr> - - <th>Name</th> - - - <th>Type</th> - - - - <th class="last">Description</th> - </tr> - </thead> - - <tbody> - - - <tr> - - <td class="name"><code>name</code></td> - - - <td class="type"> - - -<span class="param-type">string</span> - - - - </td> - - - - <td class="description last"> - - <p>The device name to test.</p></td> - </tr> - - - </tbody> -</table> - - - -<dl class="details"> - - - - - - - - - - - - - - - - - - - - - -</dl> - - - - - - - - - - - - <h5>Returns:</h5> - - - -<table class="params"> - <thead> - <tr> - - <th>Type</th> - <th class="last">Description</th> - </tr> - </thead> - <tbody> - - <tr> - - <td class="type"> - - boolean - - - </td> - <td class="description last">Returns <code>true</code> if the given name is in the ignore pattern list, -else returns <code>false</code>.</td> - </tr> - - </tbody> -</table> - - - - -</dd> - - - -<dt> - <div class="nameContainer"> - <h4 class="name" id="maskToPrefix"> - - maskToPrefix<span class="signature">(netmask, <span class="optional">v6</span>)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{null|number}</span> - </h4> - - - <div class="tag-source"> - network.js, line 664 - </div> - - </div> - - -</dt> -<dd> - - - <div class="description"> - <p>Converts the given netmask to a prefix size in bits.</p> - </div> - - - - - - - - - -<table class="params"> - <thead> - <tr> - - <th>Name</th> - - - <th>Type</th> - - - <th>Default</th> - - - <th class="last">Description</th> - </tr> - </thead> - - <tbody> - - - <tr> - - <td class="name"><code>netmask</code></td> - - - <td class="type"> - - -<span class="param-type">string</span> - - - - </td> - - - <td class="default"> - - </td> - - - <td class="description last"> - - - - - - - <p>The netmask to convert into a bit count.</p></td> - </tr> - - - - <tr> - - <td class="name"><code>v6</code></td> - - - <td class="type"> - - -<span class="param-type">boolean</span> - - - - </td> - - - <td class="default"> - - false - - </td> - - - <td class="description last"> - - - <span class="optional">optional</span> - - - - - - <p>Whether to parse the given netmask as IPv4 (<code>false</code>) or IPv6 (<code>true</code>) -address.</p></td> - </tr> - - - </tbody> -</table> - - - -<dl class="details"> - - - - - - - - - - - - - - - - - - - - - -</dl> - - - - - - - - - - - - <h5>Returns:</h5> - - - -<table class="params"> - <thead> - <tr> - - <th>Type</th> - <th class="last">Description</th> - </tr> - </thead> - <tbody> - - <tr> - - <td class="type"> - - null - | - - number - - - </td> - <td class="description last">Returns the number of prefix bits contained in the netmask or <code>null</code> -if the given netmask value was invalid.</td> - </tr> - - </tbody> -</table> - - - - -</dd> - - - -<dt> - <div class="nameContainer"> - <h4 class="name" id="prefixToMask"> - - prefixToMask<span class="signature">(bits, <span class="optional">v6</span>)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{null|string}</span> - </h4> - - - <div class="tag-source"> - network.js, line 646 - </div> - - </div> - - -</dt> -<dd> - - - <div class="description"> - <p>Converts the given prefix size in bits to a netmask.</p> - </div> - - - - - - - - - -<table class="params"> - <thead> - <tr> - - <th>Name</th> - - - <th>Type</th> - - - <th>Default</th> - - - <th class="last">Description</th> - </tr> - </thead> - - <tbody> - - - <tr> - - <td class="name"><code>bits</code></td> - - - <td class="type"> - - -<span class="param-type">number</span> - - - - </td> - - - <td class="default"> - - </td> - - - <td class="description last"> - - - - - - - <p>The prefix size in bits.</p></td> - </tr> - - - - <tr> - - <td class="name"><code>v6</code></td> - - - <td class="type"> - - -<span class="param-type">boolean</span> - - - - </td> - - - <td class="default"> - - false - - </td> - - - <td class="description last"> - - - <span class="optional">optional</span> - - - - - - <p>Whether to convert the bits value into an IPv4 netmask (<code>false</code>) or -an IPv6 netmask (<code>true</code>).</p></td> - </tr> - - - </tbody> -</table> - - - -<dl class="details"> - - - - - - - - - - - - - - - - - - - - - -</dl> - - - - - - - - - - - - <h5>Returns:</h5> - - - -<table class="params"> - <thead> - <tr> - - <th>Type</th> - <th class="last">Description</th> - </tr> - </thead> - <tbody> - - <tr> - - <td class="type"> - - null - | - - string - - - </td> - <td class="description last">Returns a string containing the netmask corresponding to the bit count -or <code>null</code> when the given amount of bits exceeds the maximum possible -value of <code>32</code> for IPv4 or <code>128</code> for IPv6.</td> - </tr> - - </tbody> -</table> - - - - -</dd> - - - -<dt> - <div class="nameContainer"> - <h4 class="name" id="registerErrorCode"> - - registerErrorCode<span class="signature">(code, message)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{boolean}</span> - </h4> - - - <div class="tag-source"> - network.js, line 853 - </div> - - </div> - - -</dt> -<dd> - - - <div class="description"> - <p>Registers a new human readable translation string for a <code>Protocol</code> -error code.</p> - </div> - - - - - - - - - -<table class="params"> - <thead> - <tr> - - <th>Name</th> - - - <th>Type</th> - - - - <th class="last">Description</th> - </tr> - </thead> - - <tbody> - - - <tr> - - <td class="name"><code>code</code></td> - - - <td class="type"> - - -<span class="param-type">string</span> - - - - </td> - - - - <td class="description last"> - - <p>The <code>ubus</code> protocol error code to register a translation for, e.g. -<code>NO_DEVICE</code>.</p></td> - </tr> - - - - <tr> - - <td class="name"><code>message</code></td> - - - <td class="type"> - - -<span class="param-type">string</span> - - - - </td> - - - - <td class="description last"> - - <p>The message to use as translation for the given protocol error code.</p></td> - </tr> - - - </tbody> -</table> - - - -<dl class="details"> - - - - - - - - - - - - - - - - - - - - - -</dl> - - - - - - - - - - - - <h5>Returns:</h5> - - - -<table class="params"> - <thead> - <tr> - - <th>Type</th> - <th class="last">Description</th> - </tr> - </thead> - <tbody> - - <tr> - - <td class="type"> - - boolean - - - </td> - <td class="description last">Returns <code>true</code> if the error code description has been added or <code>false</code> -if either the arguments were invalid or if there already was a -description for the given code.</td> - </tr> - - </tbody> -</table> - - - - -</dd> - - - -<dt> - <div class="nameContainer"> - <h4 class="name" id="registerPatternVirtual"> - - registerPatternVirtual<span class="signature">(pat)</span> - </h4> - - - <div class="tag-source"> - network.js, line 833 - </div> - - </div> - - -</dt> -<dd> - - - <div class="description"> - <p>Registers a new regular expression pattern to recognize -virtual interfaces.</p> - </div> - - - - - - - - - -<table class="params"> - <thead> - <tr> - - <th>Name</th> - - - <th>Type</th> - - - - <th class="last">Description</th> - </tr> - </thead> - - <tbody> - - - <tr> - - <td class="name"><code>pat</code></td> - - - <td class="type"> - - -<span class="param-type">RegExp</span> - - - - </td> - - - - <td class="description last"> - - <p>A <code>RegExp</code> instance to match a virtual interface name -such as <code>6in4-wan</code> or <code>tun0</code>.</p></td> - </tr> - - - </tbody> -</table> - - - -<dl class="details"> - - - - - - - - - - - - - - - - - - - - - -</dl> - - - - - - - - - - - - - -</dd> - - - -<dt> - <div class="nameContainer"> - <h4 class="name" id="registerProtocol"> - - registerProtocol<span class="signature">(protoname, methods)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{<a href="LuCI.Network.Protocol.html">LuCI.Network.Protocol</a>}</span> - </h4> - - - <div class="tag-source"> - network.js, line 792 - </div> - - </div> - - -</dt> -<dd> - - - <div class="description"> - <p>Registers a new <a href="LuCI.Network.Protocol.html"><code>Protocol</code></a> subclass -with the given methods and returns the resulting subclass value.</p> -<p>This functions internally calls -<a href="LuCI.Class.html#.extend"><code>Class.extend()</code></a> on the <code>Network.Protocol</code> -base class.</p> - </div> - - - - - - - - - -<table class="params"> - <thead> - <tr> - - <th>Name</th> - - - <th>Type</th> - - - - <th class="last">Description</th> - </tr> - </thead> - - <tbody> - - - <tr> - - <td class="name"><code>protoname</code></td> - - - <td class="type"> - - -<span class="param-type">string</span> - - - - </td> - - - - <td class="description last"> - - <p>The name of the new protocol to register.</p></td> - </tr> - - - - <tr> - - <td class="name"><code>methods</code></td> - - - <td class="type"> - - -<span class="param-type">Object.<string, *></span> - - - - </td> - - - - <td class="description last"> - - <p>The member methods and values of the new <code>Protocol</code> subclass to -be passed to <a href="LuCI.Class.html#.extend"><code>Class.extend()</code></a>.</p></td> - </tr> - - - </tbody> -</table> - - - -<dl class="details"> - - - - - - - - - - - - - - - - - - - - - -</dl> - - - - - - - - - - - - <h5>Returns:</h5> - - - -<table class="params"> - <thead> - <tr> - - <th>Type</th> - <th class="last">Description</th> - </tr> - </thead> - <tbody> - - <tr> - - <td class="type"> - - <a href="LuCI.Network.Protocol.html">LuCI.Network.Protocol</a> - - - </td> - <td class="description last">Returns the new <code>Protocol</code> subclass.</td> - </tr> - - </tbody> -</table> - - - - -</dd> - - - -<dt> - <div class="nameContainer"> - <h4 class="name" id="renameNetwork"> - - renameNetwork<span class="signature">(oldName, newName)</span><span class="glyphicon glyphicon-circle-arrow-right"></span><span class="type-signature returnType">{Promise.<boolean>}</span> - </h4> - - - <div class="tag-source"> - network.js, line 1026 - </div> - - </div> - - -</dt> -<dd> - - - <div class="description"> - <p>Rename the given network and its references to a new name.</p> - </div> - - - - - - - - - -<table class="params"> - <thead> - <tr> - - <th>Name</th> - - - <th>Type</th> - - - - <th class="last">Description</th> - </tr> - </thead> - - <tbody> - - - <tr> - - <td class="name"><code>oldName</code></td> - - - <td class="type"> - - -<span class="param-type">string</span> - - - - </td> - - - - <td class="description last"> - - <p>The current name of the network.</p></td> - </tr> - - - - <tr> - - <td class="name"><code>newName</code></td> - - - <td class="type"> - - -<span class="param-type">string</span> - - - - </td> - - - - <td class="description last"> - - <p>The name to rename the network to, must be in the format -<code>[a-z-A-Z0-9_]+</code>.</p></td> - </tr> - - - </tbody> -</table> - - - -<dl class="details"> - - - - - - - - - - - - - - - - - - - - - -</dl> - - - - - - - - - - - - <h5>Returns:</h5> - - - -<table class="params"> - <thead> - <tr> - - <th>Type</th> - <th class="last">Description</th> - </tr> - </thead> - <tbody> - - <tr> - - <td class="type"> - - Promise.<boolean> - - - </td> - <td class="description last">Returns a promise resolving to either <code>true</code> if the network was -successfully renamed or <code>false</code> if the new name was invalid, if -a network with the new name already exists or if the network to -rename could not be found.</td> - </tr> - - </tbody> -</table> - - - - -</dd> - - </dl> - - - - <h3 class="subsection-title">Type Definitions</h3> - - <dl> - -<dt> - <div class="nameContainer"> - <h4 class="name" id=".SwitchTopology">LuCI.Network.SwitchTopology<span class="type-signature type object.<string, (object|array)>">Object.<string, (Object|Array)></span> </h4> - </div> - - -</dt> -<dd> - - <div class="description"> - <p>Describes an swconfig switch topology by specifying the CPU -connections and external port labels of a switch.</p> - </div> - - - -<dl class="details"> - - - <h5 class="subsection-title">Properties:</h5> - - <dl> - -<table class="props"> - <thead> - <tr> - - <th>Name</th> - - - <th>Type</th> - - - - - - <th class="last">Description</th> - </tr> - </thead> - - <tbody> - - - <tr> - - <td class="name"><code>netdevs</code></td> - - - <td class="type"> - - -<span class="param-type">Object.<number, string></span> - - - - </td> - - - - - - <td class="description last"><p>The <code>netdevs</code> property points to an object describing the CPU port -connections of the switch. The numeric key of the enclosed object is -the port number, the value contains the Linux network device name the -port is hardwired to.</p></td> - </tr> - - - - <tr> - - <td class="name"><code>ports</code></td> - - - <td class="type"> - - -<span class="param-type">Array.<Object.<string, (boolean|number|string)>></span> - - - - </td> - - - - - - <td class="description last"><p>The <code>ports</code> property points to an array describing the populated -ports of the switch in the external label order. Each array item is -an object containg the following keys:</p> -<ul> -<li><code>num</code> - the internal switch port number</li> -<li><code>label</code> - the label of the port, e.g. <code>LAN 1</code> or <code>CPU (eth0)</code></li> -<li><code>device</code> - the connected Linux network device name (CPU ports only)</li> -<li><code>tagged</code> - a boolean indicating whether the port must be tagged to -function (CPU ports only)</li> -</ul></td> - </tr> - - - </tbody> -</table></dl> - - - - - - - - - - - - - - - - - - - - - - -</dl> - - - -</dd> - - - -<dt> - <div class="nameContainer"> - <h4 class="name" id=".WifiEncryption">LuCI.Network.WifiEncryption<span class="type-signature type object.<string, (boolean|array.<(number|string)>)>">Object.<string, (boolean|Array.<(number|string)>)></span> </h4> - </div> - - -</dt> -<dd> - - <div class="description"> - <p>An encryption entry describes active wireless encryption settings -such as the used key management protocols, active ciphers and -protocol versions.</p> - </div> - - - -<dl class="details"> - - - <h5 class="subsection-title">Properties:</h5> - - <dl> - -<table class="props"> - <thead> - <tr> - - <th>Name</th> - - - <th>Type</th> - - - <th>Argument</th> - - - - - <th class="last">Description</th> - </tr> - </thead> - - <tbody> - - - <tr> - - <td class="name"><code>enabled</code></td> - - - <td class="type"> - - -<span class="param-type">boolean</span> - - - - </td> - - - <td class="attributes"> - - - - </td> - - - - - <td class="description last"><p>Specifies whether any kind of encryption, such as <code>WEP</code> or <code>WPA</code> is -enabled. If set to <code>false</code>, then no encryption is active and the -corresponding network is open.</p></td> - </tr> - - - - <tr> - - <td class="name"><code>wep</code></td> - - - <td class="type"> - - -<span class="param-type">Array.<string></span> - - - - </td> - - - <td class="attributes"> - - <optional><br> - - - - </td> - - - - - <td class="description last"><p>When the <code>wep</code> property exists, the network uses WEP encryption. -In this case, the property is set to an array of active WEP modes -which might be either <code>open</code>, <code>shared</code> or both.</p></td> - </tr> - - - - <tr> - - <td class="name"><code>wpa</code></td> - - - <td class="type"> - - -<span class="param-type">Array.<number></span> - - - - </td> - - - <td class="attributes"> - - <optional><br> - - - - </td> - - - - - <td class="description last"><p>When the <code>wpa</code> property exists, the network uses WPA security. -In this case, the property is set to an array containing the WPA -protocol versions used, e.g. <code>[ 1, 2 ]</code> for WPA/WPA2 mixed mode or -<code>[ 3 ]</code> for WPA3-SAE.</p></td> - </tr> - - - - <tr> - - <td class="name"><code>authentication</code></td> - - - <td class="type"> - - -<span class="param-type">Array.<string></span> - - - - </td> - - - <td class="attributes"> - - <optional><br> - - - - </td> - - - - - <td class="description last"><p>The <code>authentication</code> property only applies to WPA encryption and -is defined when the <code>wpa</code> property is set as well. It points to -an array of active authentication suites used by the network, e.g. -<code>[ "psk" ]</code> for a WPA(2)-PSK network or <code>[ "psk", "sae" ]</code> for -mixed WPA2-PSK/WPA3-SAE encryption.</p></td> - </tr> - - - - <tr> - - <td class="name"><code>ciphers</code></td> - - - <td class="type"> - - -<span class="param-type">Array.<string></span> - - - - </td> - - - <td class="attributes"> - - <optional><br> - - - - </td> - - - - - <td class="description last"><p>If either WEP or WPA encryption is active, then the <code>ciphers</code> -property will be set to an array describing the active encryption -ciphers used by the network, e.g. <code>[ "tkip", "ccmp" ]</code> for a -WPA/WPA2-PSK mixed network or <code>[ "wep-40", "wep-104" ]</code> for an -WEP network.</p></td> - </tr> - - - </tbody> -</table></dl> - - - - - - - - - - - - - - - - - - - - - - -</dl> - - - -</dd> - - - -<dt> - <div class="nameContainer"> - <h4 class="name" id=".WifiPeerEntry">LuCI.Network.WifiPeerEntry<span class="type-signature type object.<string, (boolean|number|string|luci.network.wifirateentry)>">Object.<string, (boolean|number|string|<a href="LuCI.Network.html#.WifiRateEntry">LuCI.Network.WifiRateEntry</a>)></span> </h4> - </div> - - -</dt> -<dd> - - <div class="description"> - <p>A wireless peer entry describes the properties of a remote wireless -peer associated with a local network.</p> - </div> - - - -<dl class="details"> - - - <h5 class="subsection-title">Properties:</h5> - - <dl> - -<table class="props"> - <thead> - <tr> - - <th>Name</th> - - - <th>Type</th> - - - <th>Argument</th> - - - - - <th class="last">Description</th> - </tr> - </thead> - - <tbody> - - - <tr> - - <td class="name"><code>mac</code></td> - - - <td class="type"> - - -<span class="param-type">string</span> - - - - </td> - - - <td class="attributes"> - - - - </td> - - - - - <td class="description last"><p>The MAC address (BSSID).</p></td> - </tr> - - - - <tr> - - <td class="name"><code>signal</code></td> - - - <td class="type"> - - -<span class="param-type">number</span> - - - - </td> - - - <td class="attributes"> - - - - </td> - - - - - <td class="description last"><p>The received signal strength.</p></td> - </tr> - - - - <tr> - - <td class="name"><code>signal_avg</code></td> - - - <td class="type"> - - -<span class="param-type">number</span> - - - - </td> - - - <td class="attributes"> - - <optional><br> - - - - </td> - - - - - <td class="description last"><p>The average signal strength if supported by the driver.</p></td> - </tr> - - - - <tr> - - <td class="name"><code>noise</code></td> - - - <td class="type"> - - -<span class="param-type">number</span> - - - - </td> - - - <td class="attributes"> - - <optional><br> - - - - </td> - - - - - <td class="description last"><p>The current noise floor of the radio. May be <code>0</code> or absent if not -supported by the driver.</p></td> - </tr> - - - - <tr> - - <td class="name"><code>inactive</code></td> - - - <td class="type"> - - -<span class="param-type">number</span> - - - - </td> - - - <td class="attributes"> - - - - </td> - - - - - <td class="description last"><p>The amount of milliseconds the peer has been inactive, e.g. due -to powersave.</p></td> - </tr> - - - - <tr> - - <td class="name"><code>connected_time</code></td> - - - <td class="type"> - - -<span class="param-type">number</span> - - - - </td> - - - <td class="attributes"> - - - - </td> - - - - - <td class="description last"><p>The amount of milliseconds the peer is associated to this network.</p></td> - </tr> - - - - <tr> - - <td class="name"><code>thr</code></td> - - - <td class="type"> - - -<span class="param-type">number</span> - - - - </td> - - - <td class="attributes"> - - <optional><br> - - - - </td> - - - - - <td class="description last"><p>The estimated throughput of the peer, May be <code>0</code> or absent if not -supported by the driver.</p></td> - </tr> - - - - <tr> - - <td class="name"><code>authorized</code></td> - - - <td class="type"> - - -<span class="param-type">boolean</span> - - - - </td> - - - <td class="attributes"> - - - - </td> - - - - - <td class="description last"><p>Specifies whether the peer is authorized to associate to this network.</p></td> - </tr> - - - - <tr> - - <td class="name"><code>authenticated</code></td> - - - <td class="type"> - - -<span class="param-type">boolean</span> - - - - </td> - - - <td class="attributes"> - - - - </td> - - - - - <td class="description last"><p>Specifies whether the peer completed authentication to this network.</p></td> - </tr> - - - - <tr> - - <td class="name"><code>preamble</code></td> - - - <td class="type"> - - -<span class="param-type">string</span> - - - - </td> - - - <td class="attributes"> - - - - </td> - - - - - <td class="description last"><p>The preamble mode used by the peer. May be <code>long</code> or <code>short</code>.</p></td> - </tr> - - - - <tr> - - <td class="name"><code>wme</code></td> - - - <td class="type"> - - -<span class="param-type">boolean</span> - - - - </td> - - - <td class="attributes"> - - - - </td> - - - - - <td class="description last"><p>Specifies whether the peer supports WME/WMM capabilities.</p></td> - </tr> - - - - <tr> - - <td class="name"><code>mfp</code></td> - - - <td class="type"> - - -<span class="param-type">boolean</span> - - - - </td> - - - <td class="attributes"> - - - - </td> - - - - - <td class="description last"><p>Specifies whether management frame protection is active.</p></td> - </tr> - - - - <tr> - - <td class="name"><code>tdls</code></td> - - - <td class="type"> - - -<span class="param-type">boolean</span> - - - - </td> - - - <td class="attributes"> - - - - </td> - - - - - <td class="description last"><p>Specifies whether TDLS is active.</p></td> - </tr> - - - - <tr> - - <td class="name"><code>mesh llid</code></td> - - - <td class="type"> - - -<span class="param-type">number</span> - - - - </td> - - - <td class="attributes"> - - <optional><br> - - - - </td> - - - - - <td class="description last"><p>The mesh LLID, may be <code>0</code> or absent if not applicable or supported -by the driver.</p></td> - </tr> - - - - <tr> - - <td class="name"><code>mesh plid</code></td> - - - <td class="type"> - - -<span class="param-type">number</span> - - - - </td> - - - <td class="attributes"> - - <optional><br> - - - - </td> - - - - - <td class="description last"><p>The mesh PLID, may be <code>0</code> or absent if not applicable or supported -by the driver.</p></td> - </tr> - - - - <tr> - - <td class="name"><code>mesh plink</code></td> - - - <td class="type"> - - -<span class="param-type">string</span> - - - - </td> - - - <td class="attributes"> - - <optional><br> - - - - </td> - - - - - <td class="description last"><p>The mesh peer link state description, may be an empty string (<code>''</code>) -or absent if not applicable or supported by the driver.</p> -<p>The following states are known:</p> -<ul> -<li><code>LISTEN</code></li> -<li><code>OPN_SNT</code></li> -<li><code>OPN_RCVD</code></li> -<li><code>CNF_RCVD</code></li> -<li><code>ESTAB</code></li> -<li><code>HOLDING</code></li> -<li><code>BLOCKED</code></li> -<li><code>UNKNOWN</code></li> -</ul></td> - </tr> - - - - <tr> - - <td class="name"><code>mesh local PS</code></td> - - - <td class="type"> - - -<span class="param-type">number</span> - - - - </td> - - - <td class="attributes"> - - <optional><br> - - - - </td> - - - - - <td class="description last"><p>The local powersafe mode for the peer link, may be an empty -string (<code>''</code>) or absent if not applicable or supported by -the driver.</p> -<p>The following modes are known:</p> -<ul> -<li><code>ACTIVE</code> (no power save)</li> -<li><code>LIGHT SLEEP</code></li> -<li><code>DEEP SLEEP</code></li> -<li><code>UNKNOWN</code></li> -</ul></td> - </tr> - - - - <tr> - - <td class="name"><code>mesh peer PS</code></td> - - - <td class="type"> - - -<span class="param-type">number</span> - - - - </td> - - - <td class="attributes"> - - <optional><br> - - - - </td> - - - - - <td class="description last"><p>The remote powersafe mode for the peer link, may be an empty -string (<code>''</code>) or absent if not applicable or supported by -the driver.</p> -<p>The following modes are known:</p> -<ul> -<li><code>ACTIVE</code> (no power save)</li> -<li><code>LIGHT SLEEP</code></li> -<li><code>DEEP SLEEP</code></li> -<li><code>UNKNOWN</code></li> -</ul></td> - </tr> - - - - <tr> - - <td class="name"><code>mesh non-peer PS</code></td> - - - <td class="type"> - - -<span class="param-type">number</span> - - - - </td> - - - <td class="attributes"> - - <optional><br> - - - - </td> - - - - - <td class="description last"><p>The powersafe mode for all non-peer neigbours, may be an empty -string (<code>''</code>) or absent if not applicable or supported by the driver.</p> -<p>The following modes are known:</p> -<ul> -<li><code>ACTIVE</code> (no power save)</li> -<li><code>LIGHT SLEEP</code></li> -<li><code>DEEP SLEEP</code></li> -<li><code>UNKNOWN</code></li> -</ul></td> - </tr> - - - - <tr> - - <td class="name"><code>rx</code></td> - - - <td class="type"> - - -<span class="param-type"><a href="LuCI.Network.html#.WifiRateEntry">LuCI.Network.WifiRateEntry</a></span> - - - - </td> - - - <td class="attributes"> - - - - </td> - - - - - <td class="description last"><p>Describes the receiving wireless rate from the peer.</p></td> - </tr> - - - - <tr> - - <td class="name"><code>tx</code></td> - - - <td class="type"> - - -<span class="param-type"><a href="LuCI.Network.html#.WifiRateEntry">LuCI.Network.WifiRateEntry</a></span> - - - - </td> - - - <td class="attributes"> - - - - </td> - - - - - <td class="description last"><p>Describes the transmitting wireless rate to the peer.</p></td> - </tr> - - - </tbody> -</table></dl> - - - - - - - - - - - - - - - - - - - - - - -</dl> - - - -</dd> - - - -<dt> - <div class="nameContainer"> - <h4 class="name" id=".WifiRateEntry">LuCI.Network.WifiRateEntry<span class="type-signature type object.<string, (boolean|number)>">Object.<string, (boolean|number)></span> </h4> - </div> - - -</dt> -<dd> - - <div class="description"> - <p>A wireless rate entry describes the properties of a wireless -transmission rate to or from a peer.</p> - </div> - - - -<dl class="details"> - - - <h5 class="subsection-title">Properties:</h5> - - <dl> - -<table class="props"> - <thead> - <tr> - - <th>Name</th> - - - <th>Type</th> - - - <th>Argument</th> - - - - - <th class="last">Description</th> - </tr> - </thead> - - <tbody> - - - <tr> - - <td class="name"><code>drop_misc</code></td> - - - <td class="type"> - - -<span class="param-type">number</span> - - - - </td> - - - <td class="attributes"> - - <optional><br> - - - - </td> - - - - - <td class="description last"><p>The amount of received misc. packages that have been dropped, e.g. -due to corruption or missing authentication. Only applicable to -receiving rates.</p></td> - </tr> - - - - <tr> - - <td class="name"><code>packets</code></td> - - - <td class="type"> - - -<span class="param-type">number</span> - - - - </td> - - - <td class="attributes"> - - - - </td> - - - - - <td class="description last"><p>The amount of packets that have been received or sent.</p></td> - </tr> - - - - <tr> - - <td class="name"><code>bytes</code></td> - - - <td class="type"> - - -<span class="param-type">number</span> - - - - </td> - - - <td class="attributes"> - - - - </td> - - - - - <td class="description last"><p>The amount of bytes that have been received or sent.</p></td> - </tr> - - - - <tr> - - <td class="name"><code>failed</code></td> - - - <td class="type"> - - -<span class="param-type">number</span> - - - - </td> - - - <td class="attributes"> - - <optional><br> - - - - </td> - - - - - <td class="description last"><p>The amount of failed tranmission attempts. Only applicable to -transmit rates.</p></td> - </tr> - - - - <tr> - - <td class="name"><code>retries</code></td> - - - <td class="type"> - - -<span class="param-type">number</span> - - - - </td> - - - <td class="attributes"> - - <optional><br> - - - - </td> - - - - - <td class="description last"><p>The amount of retried transmissions. Only applicable to transmit -rates.</p></td> - </tr> - - - - <tr> - - <td class="name"><code>is_ht</code></td> - - - <td class="type"> - - -<span class="param-type">boolean</span> - - - - </td> - - - <td class="attributes"> - - - - </td> - - - - - <td class="description last"><p>Specifies whether this rate is an HT (IEEE 802.11n) rate.</p></td> - </tr> - - - - <tr> - - <td class="name"><code>is_vht</code></td> - - - <td class="type"> - - -<span class="param-type">boolean</span> - - - - </td> - - - <td class="attributes"> - - - - </td> - - - - - <td class="description last"><p>Specifies whether this rate is an VHT (IEEE 802.11ac) rate.</p></td> - </tr> - - - - <tr> - - <td class="name"><code>mhz</code></td> - - - <td class="type"> - - -<span class="param-type">number</span> - - - - </td> - - - <td class="attributes"> - - - - </td> - - - - - <td class="description last"><p>The channel width in MHz used for the transmission.</p></td> - </tr> - - - - <tr> - - <td class="name"><code>rate</code></td> - - - <td class="type"> - - -<span class="param-type">number</span> - - - - </td> - - - <td class="attributes"> - - - - </td> - - - - - <td class="description last"><p>The bitrate in bit/s of the transmission.</p></td> - </tr> - - - - <tr> - - <td class="name"><code>mcs</code></td> - - - <td class="type"> - - -<span class="param-type">number</span> - - - - </td> - - - <td class="attributes"> - - <optional><br> - - - - </td> - - - - - <td class="description last"><p>The MCS index of the used transmission rate. Only applicable to -HT or VHT rates.</p></td> - </tr> - - - - <tr> - - <td class="name"><code>40mhz</code></td> - - - <td class="type"> - - -<span class="param-type">number</span> - - - - </td> - - - <td class="attributes"> - - <optional><br> - - - - </td> - - - - - <td class="description last"><p>Specifies whether the tranmission rate used 40MHz wide channel. -Only applicable to HT or VHT rates.</p> -<p>Note: this option exists for backwards compatibility only and its -use is discouraged. The <code>mhz</code> field should be used instead to -determine the channel width.</p></td> - </tr> - - - - <tr> - - <td class="name"><code>short_gi</code></td> - - - <td class="type"> - - -<span class="param-type">boolean</span> - - - - </td> - - - <td class="attributes"> - - <optional><br> - - - - </td> - - - - - <td class="description last"><p>Specifies whether a short guard interval is used for the transmission. -Only applicable to HT or VHT rates.</p></td> - </tr> - - - - <tr> - - <td class="name"><code>nss</code></td> - - - <td class="type"> - - -<span class="param-type">number</span> - - - - </td> - - - <td class="attributes"> - - <optional><br> - - - - </td> - - - - - <td class="description last"><p>Specifies the number of spatial streams used by the transmission. -Only applicable to VHT rates.</p></td> - </tr> - - - </tbody> -</table></dl> - - - - - - - - - - - - - - - - - - - - - - -</dl> - - - -</dd> - - - -<dt> - <div class="nameContainer"> - <h4 class="name" id=".WifiScanResult">LuCI.Network.WifiScanResult<span class="type-signature type object.<string, (number|string|luci.network.wifiencryption)>">Object.<string, (number|string|<a href="LuCI.Network.html#.WifiEncryption">LuCI.Network.WifiEncryption</a>)></span> </h4> - </div> - - -</dt> -<dd> - - <div class="description"> - <p>A wireless scan result object describes a neighbouring wireless -network found in the vincinity.</p> - </div> - - - -<dl class="details"> - - - <h5 class="subsection-title">Properties:</h5> - - <dl> - -<table class="props"> - <thead> - <tr> - - <th>Name</th> - - - <th>Type</th> - - - - - - <th class="last">Description</th> - </tr> - </thead> - - <tbody> - - - <tr> - - <td class="name"><code>ssid</code></td> - - - <td class="type"> - - -<span class="param-type">string</span> - - - - </td> - - - - - - <td class="description last"><p>The SSID / Mesh ID of the network.</p></td> - </tr> - - - - <tr> - - <td class="name"><code>bssid</code></td> - - - <td class="type"> - - -<span class="param-type">string</span> - - - - </td> - - - - - - <td class="description last"><p>The BSSID if the network.</p></td> - </tr> - - - - <tr> - - <td class="name"><code>mode</code></td> - - - <td class="type"> - - -<span class="param-type">string</span> - - - - </td> - - - - - - <td class="description last"><p>The operation mode of the network (<code>Master</code>, <code>Ad-Hoc</code>, <code>Mesh Point</code>).</p></td> - </tr> - - - - <tr> - - <td class="name"><code>channel</code></td> - - - <td class="type"> - - -<span class="param-type">number</span> - - - - </td> - - - - - - <td class="description last"><p>The wireless channel of the network.</p></td> - </tr> - - - - <tr> - - <td class="name"><code>signal</code></td> - - - <td class="type"> - - -<span class="param-type">number</span> - - - - </td> - - - - - - <td class="description last"><p>The received signal strength of the network in dBm.</p></td> - </tr> - - - - <tr> - - <td class="name"><code>quality</code></td> - - - <td class="type"> - - -<span class="param-type">number</span> - - - - </td> - - - - - - <td class="description last"><p>The numeric quality level of the signal, can be used in conjunction -with <code>quality_max</code> to calculate a quality percentage.</p></td> - </tr> - - - - <tr> - - <td class="name"><code>quality_max</code></td> - - - <td class="type"> - - -<span class="param-type">number</span> - - - - </td> - - - - - - <td class="description last"><p>The maximum possible quality level of the signal, can be used in -conjunction with <code>quality</code> to calculate a quality percentage.</p></td> - </tr> - - - - <tr> - - <td class="name"><code>encryption</code></td> - - - <td class="type"> - - -<span class="param-type"><a href="LuCI.Network.html#.WifiEncryption">LuCI.Network.WifiEncryption</a></span> - - - - </td> - - - - - - <td class="description last"><p>The encryption used by the wireless network.</p></td> - </tr> - - - </tbody> -</table></dl> - - - - - - - - - - - - - - - - - - - - - - -</dl> - - - -</dd> - - </dl> - - - - - -</article> - -</section> - - - - - - - - <footer> - Documentation generated by <a target="_blank" href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Tue Nov 05 2019 10:17:12 GMT+0100 (Central European Standard Time) - </footer> - </div> -</div> -<script>prettyPrint();</script> -<script src="scripts/jaguar.js"></script> -</body> -</html>
\ No newline at end of file |