Internet Box API map¶
Generated by
scripts/discover_endpoints.pyon 2026-11-22 from an IB4-00 (firmware 15.21.36, web UI build 2638). Don't edit by hand; re-run the script after firmware updates or on other models.
{id} stands for an instance key, e.g. a device MAC address, an interface name (lan, wl0) or a pool name (default).
Summary¶
| Endpoints | Change settings | |
|---|---|---|
| Called by the web interface | 239 | 101 |
| Functions exposed by the router (self-description) | 727 | 369 |
| Implemented in pyinternetbox | 208 | 69 |
| Web interface endpoints missing from pyinternetbox | 70 | 42 |
Writable parameters (generic set) on 315 objects |
1873 | 1873 |
Endpoints used by the web interface¶
Parameters are the names the web UI sends (values omitted).
- ✏️ changes settings
- ✅ implemented in pyinternetbox
| Endpoint | ✏️ | ✅ | Parameters |
|---|---|---|---|
DHCPv4.Server.Pool.{id}:addStaticLease |
✏️ | ✅ | IPAddress, MACAddress |
DHCPv4.Server.Pool.{id}:deleteStaticLease |
✏️ | ✅ | MACAddress |
DNS.Server.Cache:flush |
✏️ | ✅ | |
DNS.Server:configureCache |
✏️ | ✅ | commit, enable |
DNS.Server:deleteRoute |
✏️ | ✅ | commit, dns, id |
DNS.Server:setRoute |
✏️ | ✅ | commit, dns, id |
DNS:setMode |
✏️ | ✅ | mode |
Devices.Config.{id}:set |
✏️ | ✅ | Reset |
Devices.Device.{id}:set |
✏️ | ✅ | parameters |
Devices.Device.{id}:setName |
✏️ | ✅ | name |
Devices:destroyDevice |
✏️ | ✅ | key |
DynDNS:addHost |
✏️ | ✅ | |
DynDNS:delHost |
✏️ | ✅ | |
Firewall:commit |
✏️ | ✅ | |
Firewall:deleteCustomRule |
✏️ | ✅ | chain, id |
Firewall:deleteDMZ |
✏️ | ✅ | id |
Firewall:deletePortForwarding |
✏️ | ✅ | |
Firewall:set |
✏️ | ✅ | UpnpPortForwardingEnable |
Firewall:setChainPolicy |
✏️ | ✅ | |
Firewall:setCustomRule |
✏️ | ✅ | action, chain, description, destinationMAC, destinationPort, enable, id, ipversion, persistent, protocol, sourceMAC |
Firewall:setDMZ |
✏️ | ✅ | destinationIPAddress, enable, id, sourceInterface |
Firewall:setFirewallIPv6Level |
✏️ | ✅ | |
Firewall:setFirewallLevel |
✏️ | ✅ | |
Firewall:setPortForwarding |
✏️ | ✅ | description, destinationIPAddress, enable, externalPort, id, internalPort, origin, persistent, protocol, sourceInterface, sourcePrefix |
GenLog:clearLogs |
✏️ | ✅ | source, topic |
LEDs.LED.{id}:set |
✏️ | ✅ | Brightness |
NMC.DHCPv4.DNSServers.{id}:set |
✏️ | ✅ | DNSServers |
NMC.DHCPv6.DNSServers.{id}:set |
✏️ | ✅ | DNSServers |
NMC.Debug.DebugFile:set |
✏️ | ✅ | GenerateFile |
NMC.Guest:set |
✏️ | ✅ | Enable |
NMC.LAN:addStaticRoute |
✏️ | ✅ | Dst, DstLen, Enable, Gateway, Name |
NMC.LAN:deleteStaticRoute |
✏️ | ✅ | |
NMC.NetworkConfig:launchNetworkBackup |
✏️ | ✅ | |
NMC.Wifi:set |
✏️ | ✅ | ConfigurationMode, Enable |
NMC.Wifi:setWPSEnable |
✏️ | ✅ | enable |
NMC.Wifi:startPairing |
✏️ | ✅ | |
NMC.Wifi:stopPairing |
✏️ | ✅ | |
NMC.WlanTimer:setActivationTimer |
✏️ | ✅ | InterfaceName, Timeout |
NMC:reboot |
✏️ | ✅ | reason |
NeMo.Intf.{id}:setWLANConfig |
✏️ | ✅ | mibs |
NeMo.Intf.{id}:startAutoChannelSelection |
✏️ | ✅ | |
Phonebook:addContactAndGenUUID |
✏️ | ✅ | contact, uniqueID |
Phonebook:modifyContactByUniqueID |
✏️ | ✅ | contact, uniqueID |
Phonebook:removeContactByUniqueID |
✏️ | ✅ | |
PowerManagement:setTriggeredProfiles |
✏️ | ✅ | profiles |
SSW.DataElements.Network.SSID.{id}:set |
✏️ | ✅ | mibs |
SSW.Steering.ExceptionList:createException |
✏️ | ✅ | MAC, forceMode, mask, target, type |
SSW.Steering.ExceptionList:deleteException |
✏️ | ✅ | |
SSW.Steering.MasterConfig.OperatingStandards:disable |
✏️ | ✅ | band, opStd |
SSW.Steering.MasterConfig.OperatingStandards:enable |
✏️ | ✅ | |
SSW.Steering.MasterConfig:set |
✏️ | ✅ | SyncEnableField |
SSW.Steering:set |
✏️ | ✅ | Enable |
Scheduler:addSchedule |
✏️ | ✅ | info, type |
Scheduler:enableSchedule |
✏️ | ✅ | ID, enable, type |
Scheduler:removeSchedules |
✏️ | ✅ | ID, type |
ToD:deleteMST |
✏️ | ✅ | id |
ToD:setMST |
✏️ | ✅ | allowedTime, enable, id, subject |
VoiceService.VoiceApplication:clearCallList |
✏️ | ✅ | |
WOL:sendWakeOnLan |
✏️ | ✅ | broadcast, hostID, interval, retries |
CardDav:get |
✅ | ||
DECT:getBaseState |
✅ | ||
DECT:getNEMoState |
✅ | ||
DECT:getPIN |
✅ | ||
DECT:getRFPI |
✅ | ||
DECT:getVersion |
✅ | ||
DHCPv4.Server.Pool.{id}:getStaticLeases |
✅ | ||
DHCPv4.Server:getDHCPServerPool |
✅ | ||
DHCPv6.Server:getPrefixInformation |
✅ | pool |
|
DNS.Server.Cache:get |
✅ | ||
DNS.Server.Route:get |
✅ | ||
DNS.Server:getMetrics |
✅ | ||
DNS:get |
✅ | ||
DSPGDECT:get |
✅ | ||
DeviceInfo.MemoryStatus:get |
✅ | ||
DeviceInfo:get |
✅ | flag, mibs, traverse |
|
Devices.Device.{id}.UDevice:get |
✅ | ||
Devices.Device.{id}:get |
✅ | flags |
|
Devices.Device.{id}:getEventLog |
✅ | type |
|
Devices.Device.{id}:topology |
✅ | expression, flags, traverse |
|
Devices:get |
✅ | expression, flags |
|
DynDNS:getHosts |
✅ | ||
DynDNS:getServices |
✅ | ||
Firewall:get |
✅ | ||
Firewall:getChainPolicy |
✅ | ||
Firewall:getCustomRule |
✅ | ||
Firewall:getDMZ |
✅ | ||
Firewall:getFirewallIPv6Level |
✅ | ||
Firewall:getPortForwarding |
✅ | ||
GPIOs.GPIO:get |
✅ | ||
GenLog:nextLogs |
✅ | iterator, nrecords |
|
GenLog:readLogs |
✅ | nrecords, source |
|
HTTPService:getCurrentUser |
✅ | ||
History.Backup.Entry:get |
✅ | ||
History.Upgrade.Entry:get |
✅ | ||
LEDs.LED.{id}:get |
✅ | ||
MultipathTCP:get |
✅ | ||
NMC.BDD:get |
✅ | ||
NMC.DHCPv4.DNSServers.{id}:get |
✅ | ||
NMC.DHCPv6.DNSServers.{id}:get |
✅ | ||
NMC.DNS:get |
✅ | ||
NMC.Debug.DebugFile:get |
✅ | ||
NMC.Debug:generateWiFiLogs |
✅ | ||
NMC.Debug:getWifiDriverStats |
✅ | ||
NMC.Guest:get |
✅ | ||
NMC.LAN:getStaticRoutes |
✅ | ||
NMC.NetworkConfig:get |
✅ | ||
NMC.Orientation:get |
✅ | ||
NMC.PhonebookBackup:get |
✅ | ||
NMC.VoiceActivation:get |
✅ | ||
NMC.WWAN:get |
✅ | ||
NMC.Wifi:get |
✅ | ||
NMC.WlanTimer:getActivationTimer |
✅ | ||
NMC:get |
✅ | ||
NMC:getIPConflicts |
✅ | ||
NMC:getWANStatus |
✅ | ||
NeMo.Intf.{id}:get |
✅ | ||
NeMo.Intf.{id}:getFirstParameter |
✅ | flag, name, traverse |
|
NeMo.Intf.{id}:getLatestPower |
✅ | ||
NeMo.Intf.{id}:getMIBs |
✅ | ||
NeMo.Intf.{id}:getParameters |
✅ | ||
NeMo.Intf.{id}:getPerAntennaRssi |
✅ | ||
NeMo.Intf.{id}:getSpectrumInfo |
✅ | update |
|
NeMo.Intf.{id}:getStationStats |
✅ | ||
NeMo.Intf.{id}:hasFlag |
✅ | flag |
|
NeMo.Intf.{id}:scan |
✅ | forceFast |
|
NetMaster.LAN.default.Bridge.{id}:getIPv4 |
✅ | ||
NetMaster.LAN.default.Bridge.{id}:getIPv6Configuration |
✅ | Name |
|
NetMaster:get |
✅ | ||
NetWWAN.Device.{id}:getResults |
✅ | ||
NetWWAN.Device:get |
✅ | ||
OopsTracker:get |
✅ | ||
OopsTracker:getOopses |
✅ | ||
PasswordRecovery:getStatus |
✅ | ||
Phonebook:getAllContacts |
✅ | ||
PowerManagement:getProfiles |
✅ | ||
RouterSecurityAgent:get |
✅ | ||
SSW.DataElements.Network.SSID:get |
✅ | ||
SSW.Steering.ExceptionList.Station:get |
✅ | ||
SSW.Steering.MasterConfig.OperatingStandards:get |
✅ | ||
SSW.Steering.MasterConfig:get |
✅ | ||
SSW.Steering.Radio:get |
✅ | ||
SSW.Steering.SteerLog.Attempt:get |
✅ | ||
SSW.Steering:get |
✅ | ||
Scheduler:getCompleteSchedules |
✅ | type |
|
Temperature.Sensor:get |
✅ | ||
Temperature.X_SWISSCOM-COM_Mitigation:get |
✅ | ||
Time:getTime |
✅ | ||
ToD.MaxSurfTime:get |
✅ | ||
ToD:getMST |
✅ | ||
ToD:listMST |
✅ | ||
ToD:statsMST |
✅ | id |
|
USBHosts:getDevices |
✅ | ||
UserManagement:getUserLog |
✅ | ||
VPN:get |
✅ | ||
VPN:getServersConfig |
✅ | ||
VoiceService.VoiceApplication:getCallList |
✅ | ||
VoiceService.VoiceApplication:getSipExtensionsStatus |
✅ | ||
VoiceService.VoiceApplication:listGroups |
✅ | ||
VoiceService.VoiceApplication:listHandsets |
✅ | ||
VoiceService.VoiceApplication:listTrunks |
✅ | ||
WebuiupgradeService:get |
✅ | ||
WireGuard.Server:_add |
✅ | Enable |
|
WireGuard.Server:_get |
✅ | ||
WireGuard:_get |
✅ | Enable |
|
WireGuard:_set |
✅ | ||
eventmanager:get_events |
✅ | channelid, events |
|
eventmanager:open_channel |
✅ | events |
|
eventmanager:subscribe |
✅ | channelid, events |
|
eventmanager:unsubscribe |
✅ | channelid, events |
|
DECT:removeAllHandsets |
✏️ | ||
DECT:reset |
✏️ | ||
DECT:setBaseState |
✏️ | state |
|
DECT:setNEMoState |
✏️ | state |
|
DECT:setPIN |
✏️ | pin |
|
DECT:startPairing |
✏️ | ||
DECT:stopPairing |
✏️ | ||
Devices.Device.{id}.SSW.LED.Status:set |
✏️ | Brightness |
|
Devices.Device.{id}.SSW:unpair |
✏️ | ||
Devices.Device.{id}:unPair |
✏️ | ||
NMC.PhonebookBackup:set |
✏️ | OptIn, TriggerACS |
|
NMC.WWAN:set |
✏️ | EnableTethering |
|
NMC:changePassword |
✏️ | name, password |
|
NMC:reset |
✏️ | reason |
|
NMC:set |
✏️ | GlobalEnableDect, GlobalEnableWiFi |
|
NeMo.Intf.{id}:set |
✏️ | Mode |
|
NeMo.Intf.{id}:setParameters |
✏️ | flag, name, traverse, value |
|
NetMaster.LAN.default.Bridge.{id}:setIPv4 |
✏️ | Address, DHCPEnable, DHCPMaxAddress, DHCPMinAddress, PrefixLength |
|
NetMaster.LAN.default.Bridge.{id}:setIPv6Configuration |
✏️ | DHCPIAPDEnable, Name |
|
NetMaster:set |
✏️ | EnableIPv6 |
|
PasswordRecovery:setEnable |
✏️ | Enable |
|
PasswordRecovery:setPassword |
✏️ | password |
|
PasswordRecovery:start |
✏️ | ||
PasswordRecovery:stop |
✏️ | ||
PowerManagement:setScheduledProfiles |
✏️ | profiles |
|
SSW.Steering.Device.{id}.APRoaming.Config:set |
✏️ | ForceBackhaul |
|
SSW.Steering.MasterConfig.OperatingStandards:set |
✏️ | ||
Screen:setBrightTime |
✏️ | time |
|
Screen:setLanguage |
✏️ | language |
|
Screen:setShowGuestPassword |
✏️ | enable |
|
Screen:setShowWifiPassword |
✏️ | enable |
|
VPN:disconnectServerClient |
✏️ | ||
VPN:setServer |
✏️ | ||
VPN:setServerClient |
✏️ | client, server, settings |
|
VoiceService.VoiceApplication:deleteHandset |
✏️ | line |
|
VoiceService.VoiceApplication:setGroups |
✏️ | groups |
|
VoiceService.VoiceApplication:setHandset |
✏️ | line |
|
VoiceService.VoiceApplication:setViewedCallList |
✏️ | ||
VoiceService.VoiceApplication:startFXSDetection |
✏️ | endpoint |
|
WebuiupgradeService:upgrade |
✏️ | ||
sah.Device.Information:createContext |
✏️ | applicationName, password, username |
|
sah.Device.Information:releaseContext |
✏️ | applicationName |
|
CardDav:syncContacts |
|||
Conntrack.Query:get |
|||
Conntrack:closeQuery |
id |
||
Conntrack:openQuery |
event, expression, subscriber |
||
DECT:getRSSI |
name, synchronous |
||
DeviceManager.Connectivity:getStatus |
|||
Devices.Device.{id}.LDevice:get |
|||
Devices.Device.{id}.SSW:execAPI |
method, parameters, service |
||
Devices.Device.{id}:deRegister |
|||
Devices.Device.{id}:ring |
|||
FMR5G.Devices.{id}:getResults |
|||
NMC.MCU:get |
|||
NMC.WWAN.Gateway:get |
|||
NeMo.Intf.{id}:getDSLChannelStats |
|||
RouterSecurityAgent.Mapping.Settings:_get |
|||
RouterSecurityAgent.Mapping:_get |
|||
SSW.Steering.Device.{id}.APRoaming.Config:get |
|||
SSW.Steering.Device.{id}.APRoaming:get |
|||
Screen:getBrightTime |
|||
Screen:getLanguage |
|||
Screen:getShowGuestPassword |
|||
Screen:getShowWifiPassword |
|||
UserInterface:getLanguage |
|||
UserManagement:authenticate |
groups, name, password |
||
VPN:getServer |
server |
||
VPN:getServerClient |
|||
VoiceService.VoiceApplication.VoiceProfile.SIP-Extensions.SIP:get |
|||
VoiceService.VoiceApplication:ring |
duration, line |
Everything the router exposes¶
From the router's self-description.
?after an argument: optional- ✏️ changes settings
- 🌐 used by the web interface
- ✅ implemented in pyinternetbox
Besides the listed functions, every object accepts the generic get (read all parameters) and set ({"parameters": {"parameters": {"Name": value}}}), which can change any of its writable parameters.
CardDav¶
export(fileName?)import(fileName?)✏️syncContacts()🌐- Writable parameters:
CAFile(string),CAPath(string),ChunkSize(uint32),Enable(bool),SyncInterval(uint32),UseSyncToken(bool),VerifyHost(string),VerifyPeer(string)
DECT¶
getBaseState()🌐 ✅getClockMode()getNEMoState()🌐 ✅getName()✅getPIN()🌐 ✅getPairingStatus()✅getRFPI()🌐 ✅getRSSI(name?, synchronous?)🌐getRadioState()✅getStandardVersion()✅getVersion()🌐 ✅removeAllHandsets()✏️ 🌐reset(reboot?)✏️ 🌐setBaseState(state?)✏️ 🌐setClockMode(mode?)✏️setHandsetDebugMode(enable?)✏️setNEMoState(state?)✏️ 🌐setName(name?)✏️setPIN(pin?)✏️ 🌐setRadioState(state?)✏️startPairing()✏️ 🌐stopPairing()✏️ 🌐
DECT.HAN¶
getCustomParam(deviceId, unitId, interfaceId, attributeId, drop?)getDevices()getPack(deviceId, unitId, interfaceId, drop?)getParam(deviceId, unitId, paramName, drop?)getStandardVersion()getSupportedParams(deviceId, unitId, interfaceId)invokeAction(deviceId, unitId, action, value?)invokeCustomAction(deviceId, unitId, interfaceId, commandId, value?)removeAllDevices()✏️setCustomParam(deviceId, unitId, interfaceId, attributeId, value, sync?, drop?)✏️setParam(deviceId, unitId, paramName, value, sync?, drop?)✏️
DECT.HAN.Device¶
deregister()getKeepAliveRemainingTime()query()- Writable parameters:
DeviceEnable(bool),FriendlyName(string),LinkTimeout(uint32),Location(string),PagingCapabilities(uint8)
DECT.Repeater¶
getRepeaters()removeAllRepeaters()✏️
DECT.Repeater.Device¶
deregister()
DHCPv4.Server¶
clearStatistics()✏️createPool(name, interface)✏️deleteDHCPServerPool(id)✏️getDHCPServerPool(id?)🌐 ✅setDHCPServerPool(id, interface, dhcpserver, enable, minaddress, maxaddress, netmask, leasetime?, dnsservers?, iprouters?, onHold?, ntpservers?, domainname?, options?, authoritative?)✏️setDHCPServerPoolRange(id, ipaddress, minaddress, maxaddress, netmask, dnsservers?, iprouters?, ntpservers?)✏️- Writable parameters:
AckInform(bool),Enable(bool),RtBehaviour(string),TrustClient(bool),VerifyFirst(bool)
DHCPv4.Server.Pool¶
addLeaseFromPool(MACAddress)✏️addStaticLease(MACAddress, IPAddress)✏️deleteStaticLease(MACAddress)✏️getLeases(rule?)getStaticLeases()setLeaseTime(leasetime)✏️setStaticLease(MACAddress, IPAddress?, Enable?)✏️- Writable parameters:
ARPProtect(bool),Allocation(string),Authoritative(bool),DNSServers(string),DSCPMark(int8),DomainName(string),Enable(bool),FileName(string),IPRouters(string),IncludeOption125(bool),Interface(string),LeaseTime(uint32),LeasesOnHold(bool),MaxAddress(string),MaxLeaseTime(uint32),MinAddress(string),MinLeaseTime(uint32),NTPServers(string),Name(string),PersistentLeases(bool),Server(string),ServerHostName(string),SubnetMask(string),Unnumbered(bool)
DHCPv4.Server.Pool.{id}¶
addLeaseFromPool(MACAddress)✏️addStaticLease(MACAddress, IPAddress)✏️ 🌐 ✅deleteStaticLease(MACAddress)✏️ 🌐 ✅getLeases(rule?)getStaticLeases()🌐 ✅setLeaseTime(leasetime)✏️setStaticLease(MACAddress, IPAddress?, Enable?)✏️- Writable parameters:
ARPProtect(bool),Allocation(string),Authoritative(bool),DNSServers(string),DSCPMark(int8),DomainName(string),Enable(bool),FileName(string),IPRouters(string),IncludeOption125(bool),Interface(string),LeaseTime(uint32),LeasesOnHold(bool),MaxAddress(string),MaxLeaseTime(uint32),MinAddress(string),MinLeaseTime(uint32),NTPServers(string),Name(string),PersistentLeases(bool),Server(string),ServerHostName(string),SubnetMask(string),Unnumbered(bool)
DHCPv4.Server.Pool.{id}.Authentication¶
- Writable parameters:
Algorithm(uint8),ConfigurationToken(string),Protocol(int32)
DHCPv4.Server.Pool.{id}.Option¶
- Writable parameters:
Enable(bool),Name(string),Policy(string),Tag(uint8),Value(string)
DHCPv4.Server.Pool.{id}.Option.{id}¶
- Writable parameters:
Enable(bool),Name(string),Policy(string),Tag(uint8),Value(string)
DHCPv4.Server.Pool.{id}.Rule¶
- Writable parameters:
Chaddr(string),ChaddrExclude(string),ChaddrMask(string),ClientID(string),ClientIDExclude(bool),Criteria(uint32),Name(string),UserClassID(string),UserClassIDExclude(bool),UserClassIDMode(string),VendorClassID(string),VendorClassIDExclude(bool),VendorClassIDMode(string)
DHCPv4.Server.Pool.{id}.Rule.{id}¶
- Writable parameters:
Chaddr(string),ChaddrExclude(string),ChaddrMask(string),ClientID(string),ClientIDExclude(bool),Criteria(uint32),Name(string),UserClassID(string),UserClassIDExclude(bool),UserClassIDMode(string),VendorClassID(string),VendorClassIDExclude(bool),VendorClassIDMode(string)
DHCPv4.Server.Pool.{id}.Rule.{id}.Lease¶
forceRenew()- Writable parameters:
ClientID(string),DiscoverOptionList(string),FriendlyName(string),Gateway(string),IPAddress(string),Internal(bool),LeaseTime(uint32),MACAddress(string),MsftClasslessRt(bool),OnHold(bool),RequestOptionList(string),Reserved(bool)
DHCPv4.Server.Pool.{id}.Rule.{id}.Lease.{id}¶
forceRenew()- Writable parameters:
ClientID(string),DiscoverOptionList(string),FriendlyName(string),Gateway(string),IPAddress(string),Internal(bool),LeaseTime(uint32),MACAddress(string),MsftClasslessRt(bool),OnHold(bool),RequestOptionList(string),Reserved(bool)
DHCPv4.Server.Pool.{id}.StaticAddress¶
- Writable parameters:
Alias(string),Chaddr(string),Enable(bool),Yiaddr(string)
DHCPv4.Server.Pool.{id}.StaticAddress.{id}¶
- Writable parameters:
Alias(string),Chaddr(string),Enable(bool),Yiaddr(string)
DHCPv4.Server.Stats¶
getDoraCyclesDetails()- Writable parameters:
State(string)
DHCPv6.Server¶
createPool(name, interface)✏️enableDHCPv6Server(enable)✏️getDHCPv6ServerStatus()✅getPrefixInformation(pool, key?)🌐 ✅- Writable parameters:
Enable(bool)
DNS¶
setMode(mode)✏️ 🌐 ✅- Writable parameters:
Mode(string)
DNS.Server¶
checkServer()configureCache(enable, maxCachedEntries?, commit?)✏️ 🌐 ✅deleteRoute(id?, dns?, commit?)✏️ 🌐 ✅getMetrics()🌐 ✅getServers()resetMetrics()✏️setRoute(id?, dns?, src?, srcmask?, domain?, metric?, intf?, commit?, flags?)✏️ 🌐 ✅
DNS.Server.Cache¶
dump()flush()✏️ 🌐 ✅- Writable parameters:
Enable(bool),MaxEntries(uint32),NegativeCache(bool)
DNS.Server.Host¶
- Writable parameters:
IPv4(string),IPv6(string),Name(string),Type(string)
DNS.Server.Host.{id}¶
- Writable parameters:
IPv4(string),IPv6(string),Name(string),Type(string)
DNS.Server.Route¶
- Writable parameters:
DNS(string)
DNS.Server.Route.{id}¶
- Writable parameters:
DNS(string)
DSPGDECT¶
getHandsets()- Writable parameters:
PPLineSelection(bool)
DeviceInfo¶
export(fileName?)get()🌐 ✅getPairingInfo()update()✏️- Writable parameters:
Country(string),DeviceStatus(string),ProvisioningCode(string)
DeviceInfo.VendorConfigFile¶
Restore(URL, Username, Password, FileSize?, TargetFileName?, CheckSumAlgorithm?, CheckSum?)✏️RestoreExtended(URL, Username, Password, CACert?, ClientCert?, PrivateKey?, FileSize?, TargetFileName?, CheckSumAlgorithm?, CheckSum?)✏️- Writable parameters:
Affected(string)
DeviceManager.Connectivity¶
getStatus(sources?)🌐
Devices¶
destroyDevice(key)✏️ 🌐 ✅fetchDevice(key, flags?, flag?)find(expression?, flags?)findByIPAddress(ipaddress, ipstatus?, flags?)get(expression?, flags?)🌐 ✅
Devices.Device¶
addName(name, source?)✏️clearTag(tag, expression?, traverse?)✏️delName(name, source?)✏️get(flags?)getFirstParameter(parameter, expression?, traverse?)getParameters(parameter, expression?, traverse?)hasTag(tag, expression?, traverse?)isAlternative(alternative)isImplemented(function, subObject?)isLinkedTo(device, traverse?)remove(path)✏️removeAlternative(alternative)✏️removeAlternativeRules()✏️removeName(source)✏️removeType(source)✏️set(parameters)✏️setAlternative(alternative)✏️setAlternativeRules(rules)✏️setName(name, source?)✏️setTag(tag, expression?, traverse?)✏️setType(type, source?)✏️topology(expression?, traverse?, flags?)- Writable parameters:
LastChanged(date_time),LastConnection(date_time),Tags(string)
Devices.Device.{id}¶
addName(name, source?)✏️addService(service)✏️clearTag(tag, expression?, traverse?)✏️delName(name, source?)✏️fetchFingerprints()get(flags?)🌐 ✅getAddress(family?)getEventLog(type, since?, until?)🌐 ✅getFirstParameter(parameter, expression?, traverse?)getParameters(parameter, expression?, traverse?)hasTag(tag, expression?, traverse?)isAlternative(alternative)isImplemented(function, subObject?)isLinkedTo(device, traverse?)listLiveEventTypes()listLogEventTypes()performBDDLookup()remove(path)✏️removeAlternative(alternative)✏️removeAlternativeRules()✏️removeInformation(type, source)✏️removeName(source)✏️ ✅removeType(source)✏️ring()🌐set(parameters)✏️ 🌐 ✅setAlternative(alternative)✏️setAlternativeRules(rules)✏️setInformation(type, source, value?, priority?)✏️setLocation(location)✏️setMDNSRecord(key, type, entry, value)✏️setName(name, source?)✏️ 🌐 ✅setOwner(username)✏️setTag(tag, expression?, traverse?)✏️setType(type, source?)✏️startEventing(name, types?)✏️startPairing()✏️stopEventing(name)✏️stopPairing()✏️topology(expression?, traverse?, flags?)🌐 ✅- Writable parameters:
BandwidthClassification(uint32),BusName(string),DirectoryNumber(string),EndpointType(string),IPAddress(string),IPAddressSource(string),IpAddress(string),LastChanged(date_time),LastConnection(date_time),MACVendor(string),Manufacturer(string),ManufacturerURL(string),ModelDescription(string),ModelName(string),ModelNumber(string),ModelURL(string),OutgoingTrunkLine(string),Owner(string),PhysAddress(string),PresentationURL(string),SerialNumber(string),Server(string),Tags(string),Type(string),UDN(string),UPC(string)
Devices.Device.{id}.Groups¶
- Writable parameters:
Group(string)
Devices.Device.{id}.Locations¶
- Writable parameters:
Location(string)
DynDNS¶
addHost(service?, hostname?, username?, password?, enable?)✏️ 🌐 ✅delHost(hostname?)✏️ 🌐 ✅getEnableOnCgnat()getGlobalEnable()✅getHosts()🌐 ✅getServices()🌐 ✅setEnableOnCgnat(value?)✏️setGlobalEnable(enable?)✏️ ✅- Writable parameters:
Enable(bool),EnableOnCgnat(bool)
FMR5G¶
- Writable parameters:
ServiceStatusSource(string)
FMR5G.Devices¶
getResults()- Writable parameters:
AccessTechnology(string),Active(bool),FirmwareVersion(string),ICCID(string),IMEI(string),IMSI(string),Name(string),NumberOfMobileBars4G(string),NumberOfMobileBars5G(string),OAMAPNDomain(string),OAMAPNUsername(string),OAMIPv4Address(string),OAMIPv6Address(string),OAMStatus(string),ServiceAPNDomain(string),ServiceAPNUsername(string),ServiceID(string),ServiceIPv4Address(string),ServiceIPv6Address(string),ServiceStatus(string),Status(string)
Firewall¶
commit()✏️ 🌐 ✅deleteCustomRule(id, chain?)✏️ 🌐 ✅deleteDMZ(id)✏️ 🌐 ✅deleteInterface(id)✏️deletePinhole(id?, origin)✏️ ✅deletePortForwarding(id?, origin, destinationIPAddress?)✏️ 🌐 ✅deleteProtocolForwarding(id)✏️ ✅deleteRedirect(id)✏️enablePortForwarding(id, origin, enable)✏️getChainPolicy(chain)🌐 ✅getCustomRule(id?, chain?)🌐 ✅getDMZ(id?)🌐 ✅getFirewallIPv6Level()🌐 ✅getFirewallLevel()✅getInterface(id)getPinhole(id?, origin?)✅getPortForwarding(id?, origin?)🌐 ✅getProtocolForwarding(id?)✅getRedirect(id)getRespondToPing(sourceInterface)✅getService(id)getSpecificPinhole(index?, destinationIPAddress?, sourcePort?, protocol?)getSpecificPortForwarding(index?, destinationIPAddress?, sourcePort?, protocol?, sourceInterface?)refreshPortForwarding(id, origin, description?, persistent?, leaseDuration?)✏️save()✏️setChainPolicy(chain, policy)✏️ 🌐 ✅setCustomRule(id?, chain?, action, destinationPort?, sourcePort?, destinationPrefix?, sourcePrefix?, protocol?, ipversion?, enable?, description?, destinationMAC?, sourceMAC?, persistent?)✏️ 🌐 ✅setDMZ(id?, sourceInterface, destinationIPAddress, sourcePrefix?, enable)✏️ 🌐 ✅setFirewallIPv6Level(level)✏️ 🌐 ✅setFirewallLevel(level)✏️ 🌐 ✅setInterface(id, NATEnable?, StrictNATInterface?, SourceAddress6Spoofing?, SourceAddress4Spoofing?, IsolateInterface?, IsNATInterface?, persistent?)✏️setNATConfiguration(intf, natOnLan?, natEnable?, strictNat?)✏️setPinhole(id?, origin, sourceInterface, sourcePort?, destinationPort, destinationIPAddress, sourcePrefix?, protocol, ipversion?, enable?, persistent?, description?, destinationMACAddress?)✏️ ✅setPortForwarding(id?, origin, sourceInterface, externalPort?, internalPort, destinationIPAddress, sourcePrefix?, protocol, enable?, persistent?, description?, destinationMACAddress?, leaseDuration?, upnpv1Compat?)✏️ 🌐 ✅setProtocolForwarding(id, destinationIPAddress, protocol, sourceInterface?, sourcePrefix?, enable?, persistent?, description?)✏️ ✅setRedirect(id, sourceInterface?, destinationPort?, protocol, ipversion?, enable?)✏️setRespondToPing(sourceInterface, service_enable)✏️ ✅suspendPinhole(id?, origin, suspend)✏️suspendPortForwarding(id?, origin, suspend)✏️- Writable parameters:
AdvancedIPv6Level(string),AdvancedLevel(string),ExcludedOriginsPCP(string),UpnpPortForwardingEnable(bool)
Firewall.ConnectionTracking.SIP¶
- Writable parameters:
DirectMedia(bool),DirectSignaling(bool),Enable(bool),Ports(string),TimeOut(uint32)
Firewall.DMZ¶
- Writable parameters:
DestinationIPAddress(string),Enable(bool),SourceInterface(string),SourcePrefix(string)
Firewall.Level¶
- Writable parameters:
Enable(bool)
Firewall.Level.{id}¶
- Writable parameters:
Enable(bool)
Firewall.LevelIPv6¶
- Writable parameters:
Enable(bool)
Firewall.LevelIPv6.{id}¶
- Writable parameters:
Enable(bool)
Firewall.Pinhole¶
- Writable parameters:
Description(string),DestinationIPAddress(string),DestinationMACAddress(string),DestinationPort(string),Enable(bool),IPVersion(int32),Id(string),Origin(string),Protocol(string),SourceInterface(string),SourcePort(string),SourcePrefix(string)
Firewall.PortForwarding¶
- Writable parameters:
Description(string),DestinationIPAddress(string),DestinationMACAddress(string),Enable(bool),ExternalPort(string),ExternalPortEndRange(uint32),HairpinNAT(bool),Id(string),InternalPort(string),LeaseDuration(uint32),Origin(string),Protocol(string),SourceInterface(string),SourcePrefix(string),SymmetricSNAT(bool),UPnPV1Compat(bool)
Firewall.PortForwarding.{id}¶
- Writable parameters:
Description(string),DestinationIPAddress(string),DestinationMACAddress(string),Enable(bool),ExternalPort(string),ExternalPortEndRange(uint32),HairpinNAT(bool),Id(string),InternalPort(string),LeaseDuration(uint32),Origin(string),Protocol(string),SourceInterface(string),SourcePrefix(string),SymmetricSNAT(bool),UPnPV1Compat(bool)
Firewall.ProtocolForwarding¶
- Writable parameters:
Description(string),DestinationIPAddress(string),Enable(bool),Id(string),Protocol(string),SourceInterface(string),SourcePrefix(string)
Firewall.Redirect¶
- Writable parameters:
DestinationPorts(string),Enable(bool),IPVersion(uint32),Id(string),Protocol(string),SourceInterface(string)
GPIOs.GPIO¶
- Writable parameters:
Value(bool)
GPIOs.GPIO.{id}¶
- Writable parameters:
Value(bool)
GenLog¶
clearLogs(topic, source?)✏️ 🌐 ✅nextLogs(iterator, nrecords)🌐 ✅readLogs(nrecords, source?, topic?, since?, until?)🌐 ✅
HTTPService¶
getAuthenticationModes()getCurrentUser()🌐 ✅setSessionTimeout(timeout)✏️- Writable parameters:
EnableWebServiceStatistics(bool),SessionTimeout(uint32)
LEDs.LED¶
- Writable parameters:
Brightness(uint8)
LEDs.LED.{id}¶
- Writable parameters:
Brightness(uint8)
MultipathTCP¶
- Writable parameters:
Enable(bool)
MultipathTCP.ProxyHostIPConfig¶
- Writable parameters:
FailedTimeoutMin(uint32),RetrievedTimeoutMin(uint32)
NMC¶
backup()changePassword(name, password)✏️ 🌐export()factoryReset()get()🌐 ✅getButtonsState(WLan?, Pairing?)getIPConflicts()🌐 ✅getLANIP(Address?, Netmask?, DHCPEnable?, DHCPMinAddress?, DHCPMaxAddress?, LeaseTime?)✅getRemoteAccess(username?)getVoIPConfig()getWANStatus(LinkType?, LinkState?, MACAddress?, Protocol?, ConnectionState?, LastConnectionError?, IPAddress?, RemoteGateway?, DNSServers?, IPv6Address?, IPv6DelegatedPrefix?, Info?)🌐 ✅getWanModeList()import()✏️reboot(reason?)✏️ 🌐 ✅reset(reason?)✏️ 🌐restore(source?)✏️saveflush()✏️set(parameters?)✏️ 🌐setLANIP(Address, Netmask, DHCPEnable, DHCPMinAddress, DHCPMaxAddress, LeaseTime?)✏️setWanMode(WanMode, Username?, Password?)✏️shutdown(reason?)- Writable parameters:
CallLogsObfuscationEnable(bool),EnableSilentStart(bool),EnableWANInterface(bool),GlobalEnableDect(bool),GlobalEnableWiFi(bool),IPv4AddressConflictDetection(bool),PagingRingButtonEnabled(bool),PairingButtonEnabled(bool),PairingsCountSinceReboot(uint32),Password(string),ProvisioningState(string),RestoreWithoutReboot(bool),TriggerDevicePairing(bool),Username(string),VoiceLineToMonitor(string),WanMode(string)
NMC.BCMRunner.HealthMonitor¶
- Writable parameters:
Enable(bool),FailureCount(uint32),FailureDate(date_time),RebootCount(uint32)
NMC.BCMRunner.HealthMonitor.BufferAllocated¶
- Writable parameters:
FailureCount(uint32),FailureDate(date_time),FailureValue(uint32),Reboot(bool),RebootCount(uint32),Value(string)
NMC.BCMRunner.HealthMonitor.CpuRxDiscard¶
- Writable parameters:
FailureCount(uint32),FailureDate(date_time),FailureValue(uint64),Reboot(bool),RebootCount(uint32),Value(uint64)
NMC.BCMRunner.HealthMonitor.ErrorLog¶
- Writable parameters:
FailureCount(uint32),FailureDate(date_time),FailureValue(string),Reboot(bool),RebootCount(uint32),Value(string)
NMC.BDD¶
- Writable parameters:
ExposeToUser(bool)
NMC.CaptivePortal¶
- Writable parameters:
EventsDeviceExpression(string),EventsEnable(bool)
NMC.DHCPv4.DNSServers.{id}¶
- Writable parameters:
DNSServers(string)
NMC.DHCPv6.DNSServers.{id}¶
- Writable parameters:
DNSServers(string)
NMC.Debug¶
generateWiFiLogs()🌐 ✅getWifiDriverStats(refresh?)🌐 ✅- Writable parameters:
TriggerExtResize(bool)
NMC.Debug.Backup¶
addError(name, message?, err_code?, contextinfo?)✏️clearErrors()✏️- Writable parameters:
ErrorMaxNumberOfEntries(uint32)
NMC.Debug.Backup.Error¶
- Writable parameters:
Alias(string),ContextInfo(string),ErrorCode(int32),FirmwareVersion(string),Message(string),Name(string),Timestamp(string)
NMC.Debug.DebugFile¶
- Writable parameters:
DeleteFile(bool),FileStatus(string),GenerateFile(bool),IncludeTopics(string),WebUIButton(bool)
NMC.Debug.Dect¶
- Writable parameters:
DectPairingFailuresCount(uint32),StartLog(bool)
NMC.Debug.Dect.HsLog¶
addLog(FilePath, FileSize)✏️flushLogs()✏️getLog()setTriggerACS()✏️setTxStatus(TxQId, Status, FaultCode)✏️- Writable parameters:
TriggerACS(bool)
NMC.Debug.Dect.HsLog.Entry¶
- Writable parameters:
FileName(string),FileSize(uint32),Time(date_time)
NMC.Debug.Dect.Tracing¶
- Writable parameters:
HAN(uint32),MEDIA(uint32),all(uint32),las(uint32)
NMC.Debug.L1Disconnection¶
- Writable parameters:
Count(uint32),LastOccurrence(date_time)
NMC.Debug.Loops¶
- Writable parameters:
Interfaces(string),Timestamp(date_time)
NMC.Debug.MQTT¶
- Writable parameters:
CleanSAHDBG(bool)
NMC.Debug.Restore¶
addError(name, message?, err_code?, contextinfo?)✏️clearErrors()✏️- Writable parameters:
ErrorMaxNumberOfEntries(uint32)
NMC.Debug.Restore.Error¶
- Writable parameters:
Alias(string),ContextInfo(string),ErrorCode(int32),FirmwareVersion(string),Message(string),Name(string),Timestamp(string)
NMC.Debug.SRIP¶
- Writable parameters:
Signature(string)
NMC.Debug.Wifi¶
- Writable parameters:
CountersReset(uint32),EmailEnable(bool),Enable(bool),LoopTime(uint32),Part(uint32),Threshold(uint32),TriggerWifiStats(bool),Triggercountwl0(uint32),Triggercountwl1(uint32),WPSPairingFailuresCount(uint32)
NMC.Debug.Wifi.Association¶
- Writable parameters:
CountFromReset(uint32),Counter(uint32),Enable(bool),RestartWifi(bool)
NMC.Debug.Wifi.Band24G¶
- Writable parameters:
ChipState(string),InterferenceStatus(string),Temperature(string)
NMC.Debug.Wifi.Band24G.ChanimStats¶
- Writable parameters:
badplcp(uint32),badtx(uint32),chanspec(string),doze(uint32),glitch(uint32),goodtx(uint32),idle(uint32),inbss(uint32),knoise(int32),nocat(uint32),nopkt(uint32),obss(uint32),timestamp(uint32),tx(uint32),txop(uint32)
NMC.Debug.Wifi.Band24G.Counters¶
- Writable parameters:
reset(uint32),rxbyte(uint32),rxerror(uint32),rxframe(uint32),tbtt(uint32),txbyte(uint32),txchanrej(uint32),txchit(uint32),txcmiss(uint32),txdmawar(uint32),txerror(uint32),txfail(uint32),txframe(uint32),txlost(uint32),txnoassoc(uint32),txnobuf(uint32),txphycrs(uint32),txphyerr(uint32),txprshort(uint32),txretrans(uint32),txserr(uint32)
NMC.Debug.Wifi.Band24G.LatestPower¶
- Writable parameters:
Value(string)
NMC.Debug.Wifi.Band24G.LatestPower.{id}¶
- Writable parameters:
Value(string)
NMC.Debug.Wifi.Band24G.PacketQueue¶
- Writable parameters:
Values(string)
NMC.Debug.Wifi.Band24G.PacketQueue.{id}¶
- Writable parameters:
Values(string)
NMC.Debug.Wifi.Band24G.RssiPerAnt¶
- Writable parameters:
Average(string)
NMC.Debug.Wifi.Band24G.RssiPerAnt.{id}¶
- Writable parameters:
Average(string)
NMC.Debug.Wifi.Band24G.Stations¶
- Writable parameters:
AirUse(string),ConnectedSince(string),DataMbps(string),DataUse(string),MAC(string),PHYMbps(string),Retries(string),flags(string)
NMC.Debug.Wifi.Band24G.Stations.{id}¶
- Writable parameters:
AirUse(string),ConnectedSince(string),DataMbps(string),DataUse(string),MAC(string),PHYMbps(string),Retries(string),flags(string)
NMC.Debug.Wifi.Band5G¶
- Writable parameters:
ChipState(string),InterferenceStatus(string),Temperature(string)
NMC.Debug.Wifi.Band5G.ChanimStats¶
- Writable parameters:
badplcp(uint32),badtx(uint32),chanspec(string),doze(uint32),glitch(uint32),goodtx(uint32),idle(uint32),inbss(uint32),knoise(int32),nocat(uint32),nopkt(uint32),obss(uint32),timestamp(uint32),tx(uint32),txop(uint32)
NMC.Debug.Wifi.Band5G.Counters¶
- Writable parameters:
reset(uint32),rxbyte(uint32),rxerror(uint32),rxframe(uint32),tbtt(uint32),txbyte(uint32),txchanrej(uint32),txchit(uint32),txcmiss(uint32),txdmawar(uint32),txerror(uint32),txfail(uint32),txframe(uint32),txlost(uint32),txnoassoc(uint32),txnobuf(uint32),txphycrs(uint32),txphyerr(uint32),txprshort(uint32),txretrans(uint32),txserr(uint32)
NMC.Debug.Wifi.Band5G.LatestPower¶
- Writable parameters:
Value(string)
NMC.Debug.Wifi.Band5G.LatestPower.{id}¶
- Writable parameters:
Value(string)
NMC.Debug.Wifi.Band5G.PacketQueue¶
- Writable parameters:
Values(string)
NMC.Debug.Wifi.Band5G.PacketQueue.{id}¶
- Writable parameters:
Values(string)
NMC.Debug.Wifi.Band5G.RssiPerAnt¶
- Writable parameters:
Average(string)
NMC.Debug.Wifi.Band5G.RssiPerAnt.{id}¶
- Writable parameters:
Average(string)
NMC.Debug.Wifi.Band5G.Stations¶
- Writable parameters:
AirUse(string),ConnectedSince(string),DataMbps(string),DataUse(string),MAC(string),PHYMbps(string),Retries(string),flags(string)
NMC.Debug.Wifi.Band5G.Stations.{id}¶
- Writable parameters:
AirUse(string),ConnectedSince(string),DataMbps(string),DataUse(string),MAC(string),PHYMbps(string),Retries(string),flags(string)
NMC.Debug.Wifi.ChipState¶
- Writable parameters:
TriggerReset(bool)
NMC.Debug.Wifi.Tracing¶
- Writable parameters:
MsgLevel(string),PhymsgLevel(string),wld_acs(uint32),wld_bcm(uint32),wld_hw(uint32)
NMC.Debug.Wifi.Trap.Band24G¶
- Writable parameters:
Count(uint32),LastTimeStamp(string),Total(uint32)
NMC.Debug.Wifi.Trap.Band5G¶
- Writable parameters:
Count(uint32),LastTimeStamp(string),Total(uint32)
NMC.Debug.Wifi.Trap.Band6G¶
- Writable parameters:
Count(uint32),LastTimeStamp(string),Total(uint32)
NMC.Error¶
getPrimaryErrorCode()- Writable parameters:
ErrorID(string)
NMC.Guest¶
get(Enable?, Status?, Address?, Netmask?, DHCPEnable?, DHCPMinAddress?, DHCPMaxAddress?, BandwidthLimitation?)🌐 ✅set(Enable?, Address?, Netmask?, DHCPEnable?, DHCPMinAddress?, DHCPMaxAddress?, BandwidthLimitation?)✏️ 🌐 ✅- Writable parameters:
Address(string),BandwidthLimitation(uint32),DHCPEnable(bool),DHCPMaxAddress(string),DHCPMinAddress(string),Enable(bool),Netmask(string)
NMC.HomeApp¶
- Writable parameters:
PhaseOutEnable(bool)
NMC.HomeAutomation¶
- Writable parameters:
Enable(bool),HA-ID(string)
NMC.LAN¶
addStaticRoute(Name, Dst, DstLen, Gateway, Enable?, Priority?, MTU?)✏️ 🌐 ✅deleteStaticRoute(Name)✏️ 🌐 ✅getStaticRoutes()🌐 ✅
NMC.LAN.IPv4Route¶
- Writable parameters:
Dst(string),DstLen(uint32),Enable(bool),Gateway(string),MTU(uint32),Priority(int32),Status(string)
NMC.LEDs.LED¶
- Writable parameters:
Brightness(uint8)
NMC.LEDs.LED.{id}¶
- Writable parameters:
Brightness(uint8)
NMC.MST¶
- Writable parameters:
Redirect(bool)
NMC.NetworkConfig¶
get()🌐 ✅launchNetworkBackup()✏️ 🌐 ✅- Writable parameters:
Status(string)
NMC.Orientation¶
- Writable parameters:
AxLowerThreshold(int16),AxUpperThreshold(int16),AyLowerThreshold(int16),AyUpperThreshold(int16),SamplingPeriod(uint32)
NMC.PhonebookBackup¶
- Writable parameters:
FileEnable(bool),GlobalEnable(bool),IsDownloading(bool),LastUploadStatus(string),OptIn(bool),TriggerACS(bool)
NMC.QoS¶
- Writable parameters:
Mode(string)
NMC.Reboot¶
flush()✏️- Writable parameters:
Flush(bool),ForceRebootDuration(uint16),RebootMaxDuration(uint32)
NMC.ToD¶
- Writable parameters:
Redirect(bool)
NMC.VoiceActivation¶
appendConfigRepair(config_repair?)filterConfigRepair(filter_str?)- Writable parameters:
ConfigError(bool),ConfigErrorList(string),LineErrors(uint32)
NMC.WWAN¶
getWWanMode()- Writable parameters:
Backup(bool),BackupPrimary(bool),BackupStatus(string),BackupTimer(uint32),BackupTimerAfterBoot(uint32),BackupType(string),BondingImmediateStart(bool),CurrentMode(string),EnableTethering(bool),EthernetBackupInterface(string),Mode(string),NumberOfFailovers(uint32)
NMC.WWAN.AccessPoint¶
- Writable parameters:
APN(string),Duration(uint32),Password(string),Username(string)
NMC.WWAN.FallbackAccessPoint¶
- Writable parameters:
APN(string),Enable(bool),Password(string),TriggersList(string),Username(string)
NMC.WWAN.Gateway¶
- Writable parameters:
ConnectionType(string),DetectedIPAddress(string),DeviceType(string),Interface(string),LastModified(date_time),Layer2Interface(string),OUI(string),PhysAddress(string),ProductClass(string),SerialNumber(string),SignalStrength(int32),ToolkitType(string)
NMC.WWAN.Gobi¶
- Writable parameters:
Enable(bool),VLANID(uint32)
NMC.WWAN.MPTCP.Exception¶
- Writable parameters:
Tag(string)
NMC.WWAN.MPTCP.Exception.{id}¶
- Writable parameters:
Tag(string)
NMC.Wifi¶
get(Enable?, Status?, ConfigurationMode?, TriggerAutoChannelSelection?)🌐 ✅set(Enable?, Status?, ConfigurationMode?, TriggerAutoChannelSelection?)✏️ 🌐 ✅setScheduler(Scheduler?)✏️setWPSEnable(enable?)✏️ 🌐 ✅startAutoChannelSelection()✏️startPairing()✏️ 🌐 ✅stopPairing()✏️ 🌐 ✅- Writable parameters:
ConfigurationMode(bool),Enable(bool),ImplicitBeamformingEnable(bool),Status(bool),TriggerAutoChannelSelection(bool),WPSEnable(bool),WifiONforWPSPairing(bool),ZeroWaitDFSEnable(bool)
NMC.WlanTimer¶
getActivationTimer(InterfaceName?)🌐 ✅setActivationTimer(InterfaceName?, Timeout?)✏️ 🌐 ✅setActivationTimerSec(InterfaceName?, Timeout?)✏️
NeMo.Intf.{id}¶
cleanStation(macaddress?)clearNetDevFlag(flags)✏️configureConnection(apn?, username?, password?)✏️copy(name)delNeighbourAP(BSSID?)✏️getAddrs(flag?, traverse?)getDHCPOption(type?, tag?, traverse?)getFarAssociatedDevicesCount(threshold?)getFirstParameter(name?, flag?, traverse?)🌐 ✅getIntfs(flag?, traverse?)getMIBs(mibs?, flag?, traverse?)🌐 ✅getNetDevStats()✅getParameters(name?, flag?, traverse?)🌐 ✅getPinType()getRAOptions(tag, traverse?)getRARouters(traverse?)getSSIDStats()getStationStats()🌐 ✅getStatusHistogram()hasFlag(flag?, condition?, traverse?)🌐 ✅isLinkedTo(target?, traverse?)isUp(flag?, traverse?)kickStation(macaddress?)kickStationReason(macaddress?, reason?)luckyAddr(flag?, traverse?)luckyAddrAddress(flag?, traverse?)luckyIntf(flag?, traverse?)refreshNetDev()✏️resetPin(puk?, newpin?)✏️sendBssTransferRequest(mac?, target?, class?, channel?, wait?, retries?, bssidInfo?, transitionReason?)✏️sendPublicAction(mac?, oui?, type?, subtype?, channel?, data?, numberOfRetries?, retryDelayInterval?)✏️sendRemoteMeasumentRequest(mac?, bssid?, class?, channel?, timeout?, ssid?)✏️setFirstParameter(name?, value?, flag?, traverse?)✏️setMIBs(mibs?)✏️setNetDevFlag(flags)✏️setParameters(name?, value?, flag?, traverse?)✏️ 🌐setPin(pin?)✏️setTechnologyPreference(tech?)✏️setWLANConfig(mibs?)✏️ 🌐 ✅- Writable parameters:
APBridgeDisable(bool),APN(string),Alias(string),ApRole(string),AuthenticationMethod(string),AutoConnection(bool),BSSID(string),BridgeInterface(string),ConnectionError(string),ConnectionErrorSource(string),ConnectionStatus(string),CustomEquipmentID(string),CustomVendorID(string),DNSServers(string),DefaultDeviceType(string),DiscoveryMethodEnabled(string),Enable(bool),EssIdentifier(string),Flags(string),ICCID(string),IEEE80211kEnabled(bool),IMEI(string),IMSI(string),IPRouter(string),IPv4AcceptLocal(bool),IPv4AcceptRedirects(bool),IPv4AcceptSourceRoute(bool),IPv4ArpFilter(bool),IPv4ForceIGMPVersion(uint32),IPv4Forwarding(bool),IPv6AcceptDAD(uint32),IPv6AcceptRA(bool),IPv6AcceptRedirects(bool),IPv6AcceptSourceRoute(bool),IPv6ActAsRouter(bool),IPv6AddrDelegate(string),IPv6AutoConf(bool),IPv6Disable(bool),IPv6HostPart(string),IPv6MaxRtrSolicitations(uint32),IPv6OptimisticDAD(bool),IPv6RtrSolicitationInterval(uint32),LLAddress(string),LastChange(uint32),LastChangeTime(uint32),LocalIPAddress(string),MACAddress(string),MACFilterAddressList(string),MBOEnable(bool),MLDUnit(int32),MSISDN(string),MTU(uint32),Manufacturer(string),MaxAssociatedDevices(uint32),MaxBitRateSupported(int32),Mode(string),Model(string),MultiAPType(string),NATEnabled(bool),NetDevFlags(string),NetDevIndex(int32),NetDevName(string),Password(string),PersistentEnable(bool),PhysicalInterface(string),PinRetryCount(int32),PinType(string),PonMode(string),PukRetryCount(int32),RegistrationID(string),RegistrationIDIsInHexFormat(bool),RetryLimit(uint32),RtPriority(uint32),RtTable(int32),SSID(string),SSIDAdvertisementEnabled(bool),SignalStrength(uint8),Status(bool),Technology(string),TechnologyPreference(string),TxQueueLen(uint32),UAPSDEnable(bool),Username(string),VeipPptpUni(bool),WDSEnable(bool),WMMEnable(bool),WanMode(string)
NeMo.Intf.{id}.ApMonitorConfig¶
- Writable parameters:
InfoEventBootDelay(uint32),InfoEventEnable(bool),InfoEventInterval(uint32)
NeMo.Intf.{id}.AssociatedDevice¶
- Writable parameters:
ChargeableUserId(string),DevicePriority(int32),DeviceType(string)
NeMo.Intf.{id}.AssociatedDevice.{id}¶
- Writable parameters:
ChargeableUserId(string),DevicePriority(int32),DeviceType(string)
NeMo.Intf.{id}.AssociationCount¶
- Writable parameters:
ResetCounters(bool)
NeMo.Intf.{id}.DriverConfig¶
- Writable parameters:
BssMaxIdlePeriod(int32)
NeMo.Intf.{id}.ErrorToggleConfig¶
- Writable parameters:
Enable(bool),MaxNrToggles(uint32),ToggleDelay(uint32)
NeMo.Intf.{id}.ErrorToggleStats¶
resetStats()✏️
NeMo.Intf.{id}.HotSpot2¶
- Writable parameters:
AccessNetworkType(uint8),DgafDisable(bool),Enable(bool),GasDelay(int32),Hs2Ie(bool),IcmpV4Echo(bool),Internet(bool),Interworking(bool),L2TrafficInspect(bool),P2PEnable(bool),VenueGroup(uint8),VenueType(uint8)
NeMo.Intf.{id}.IEEE80211r¶
- Writable parameters:
Enabled(bool),FTOverDSEnable(bool),MobilityDomain(uint16),NASIdentifier(string),R0KHKey(string)
NeMo.Intf.{id}.IEEE80211u¶
- Writable parameters:
InterworkingEnable(bool),QoSMapSet(string)
NeMo.Intf.{id}.IPv4Addr¶
- Writable parameters:
Address(string),Enable(bool),Flags(string),NeMoFlags(string),Peer(string),PrefixLen(uint8),Scope(string)
NeMo.Intf.{id}.IPv4Route¶
- Writable parameters:
Dst(string),DstLen(uint8),Enable(bool),Gateway(string),Origin(string),Priority(int32),Protocol(string),Scope(string),Table(string),Type(string)
NeMo.Intf.{id}.IPv6Addr¶
- Writable parameters:
Address(string),Enable(bool),Flags(string),NeMoFlags(string),Peer(string),PreferredLifetime(uint32),PrefixLen(uint8),Scope(string),ValidLifetime(uint32)
NeMo.Intf.{id}.IPv6Route¶
- Writable parameters:
Dst(string),DstLen(uint8),Enable(bool),Gateway(string),Origin(string),Priority(int32),Protocol(string),Scope(string),Table(string),Type(string)
NeMo.Intf.{id}.MACFiltering¶
addEntry(mac?)✏️addTempEntry(mac?)✏️delEntry(mac?)✏️delTempEntry(mac?)✏️- Writable parameters:
Mode(string),TempBlacklistEnable(bool)
NeMo.Intf.{id}.MACFiltering.Entry¶
- Writable parameters:
MACAddress(string)
NeMo.Intf.{id}.MACFiltering.TempEntry¶
- Writable parameters:
MACAddress(string)
NeMo.Intf.{id}.Neighbour¶
- Writable parameters:
BSSID(string),Channel(int32),ColocatedAP(bool),Information(int32),NASIdentifier(string),OperatingClass(int32),PhyType(int32),R0KHKey(string),SSID(string)
NeMo.Intf.{id}.Neighbour.{id}¶
- Writable parameters:
BSSID(string),Channel(int32),ColocatedAP(bool),Information(int32),NASIdentifier(string),OperatingClass(int32),PhyType(int32),R0KHKey(string),SSID(string)
NeMo.Intf.{id}.ProbeFiltering¶
addTempEntry(mac?)✏️delTempEntry(mac?)✏️
NeMo.Intf.{id}.ProbeFiltering.TempEntry¶
- Writable parameters:
MACAddress(string)
NeMo.Intf.{id}.Query¶
getResult()
NeMo.Intf.{id}.Query.{id}¶
getResult()
NeMo.Intf.{id}.RssiEventing¶
getShortHistoryStats()- Writable parameters:
AveragingFactor(uint32),Enable(bool),HistoryEnable(bool),HistoryIntervalCoeff(uint32),HistoryLen(uint32),Interval(uint32),RssiInterval(uint32),SendEventOnAssoc(bool),SendEventOnDisassoc(bool),SendPeriodicEvent(bool)
NeMo.Intf.{id}.Security¶
- Writable parameters:
BeaconProtection(bool),EncryptionMode(string),KeyPassPhrase(string),MFPConfig(string),ModeEnabled(string),ModesAvailable(string),OWETransitionInterface(string),PreSharedKey(string),RadiusCalledStationId(string),RadiusChargeableUserId(bool),RadiusDefaultSessionTimeout(uint32),RadiusNASIdentifier(string),RadiusOwnIPAddress(string),RadiusSecret(string),RadiusServerIPAddr(string),RadiusServerPort(uint32),RekeyingInterval(uint32),SAEPassphrase(string),SPPAmsdu(int32),TransitionDisable(string),WEPKey(string),WPA3Compatibility(bool)
NeMo.Intf.{id}.StaHistogram¶
clearStaHistograms()✏️getAllStaHistograms()getCurrentStaHistograms()- Writable parameters:
DetailedSpeedThresholds(string),Enable(bool),MovingAverageWindowSize(uint32),NrReadingsPerWindow(uint32),NrWindows(uint32),SendNotificationOnDisassoc(bool),SendPeriodicNotification(bool)
NeMo.Intf.{id}.StaKickOnError¶
debug()- Writable parameters:
Enable(bool),EnableAllTests(bool),MaxNrToggles(uint32),ToggleDelay(uint32)
NeMo.Intf.{id}.StaKickOnError.GenericTests¶
- Writable parameters:
TestsEnabled(string)
NeMo.Intf.{id}.StaKickOnError.VendorTests¶
- Writable parameters:
TestsEnabled(string)
NeMo.Intf.{id}.StatMon¶
- Writable parameters:
Enable(bool),Interval(uint32),Type(string)
NeMo.Intf.{id}.StatMon.{id}¶
- Writable parameters:
Enable(bool),Interval(uint32),Type(string)
NeMo.Intf.{id}.VendorIEs¶
createVendorIE(oui?, data?, frame_type?)✏️deleteVendorIE(oui?, data?)✏️- Writable parameters:
Enable(bool)
NeMo.Intf.{id}.VendorIEs.VendorIE¶
- Writable parameters:
Data(string),FrameType(string),OUI(string)
NeMo.Intf.{id}.WPS¶
- Writable parameters:
CertModeEnable(bool),ConfigMethodsEnabled(string),Configured(bool),Enable(bool),RelayCredentialsEnable(bool),RestartOnRequest(bool),SelfPIN(string),UUID(string)
NetMaster¶
getInterfaceConfig(name)getWANMode()getWANModeList()setInterfaceConfig(name, interfacetype, configs)✏️setWANMode(wanmode, username?, password?)✏️shutdownWANMode()- Writable parameters:
EnableIPv6(bool),IPv6PrefixMode(string)
NetMaster.DR¶
- Writable parameters:
DNSSLLifetime(uint32),DefaultLifetime(uint32),RDNSSLifetime(uint32)
NetMaster.DialOnPlug¶
get()set(parameters?)✏️- Writable parameters:
Enable(bool),EnableGlobalIdleTimeout(bool),GlobalIdleTimeout(uint32)
NetMaster.LAN¶
addBridge(Name)✏️removeBridge(Name)✏️
NetMaster.LAN.default.Bridge¶
addIntf(Intf)✏️getIPv4(Address?, PrefixLength?, DHCPEnable?, DHCPMinAddress?, DHCPMaxAddress?, LeaseTime?, DNSServers?, NTPServers?, DomainSearchList?, Enable?, AllowPublic?, NATEnable?, DHCPAuthoritative?)getIPv6Configuration(Name, Address?, PrefixLength?, Intf?, SubnetOffset?, DHCPEnable?, DHCPIAPDEnable?, DHCPIANAEnable?, DNSServers?, NTPServers?, Enable?)removeHostName(Key)✏️removeIntf(Intf)✏️setClientIsolations(Name, Enable)✏️setHostName(Key, HostName, IpVersion?)✏️setIPv4(Address, PrefixLength, DHCPEnable, DHCPMinAddress, DHCPMaxAddress, LeaseTime?, DNSServers?, NTPServers?, DomainSearchList?, Enable?, AllowPublic?, NATEnable?, DHCPAuthoritative?)✏️setIPv4Configuration(Name, Address, PrefixLength, Enable?, AllowPublic?, NATEnable?)✏️setIPv6Configuration(Name, Address?, PrefixLength?, Intf?, SubnetOffset?, DHCPEnable?, DHCPIAPDEnable?, DHCPIANAEnable?, DNSServers?, NTPServers?, Enable?)✏️- Writable parameters:
ClientIsolations(bool),DomainName(string)
NetMaster.LAN.default.Bridge.{id}¶
addIntf(Intf)✏️getIPv4(Address?, PrefixLength?, DHCPEnable?, DHCPMinAddress?, DHCPMaxAddress?, LeaseTime?, DNSServers?, NTPServers?, DomainSearchList?, Enable?, AllowPublic?, NATEnable?, DHCPAuthoritative?)🌐 ✅getIPv6Configuration(Name, Address?, PrefixLength?, Intf?, SubnetOffset?, DHCPEnable?, DHCPIAPDEnable?, DHCPIANAEnable?, DNSServers?, NTPServers?, Enable?)🌐 ✅removeHostName(Key)✏️removeIntf(Intf)✏️setClientIsolations(Name, Enable)✏️setHostName(Key, HostName, IpVersion?)✏️setIPv4(Address, PrefixLength, DHCPEnable, DHCPMinAddress, DHCPMaxAddress, LeaseTime?, DNSServers?, NTPServers?, DomainSearchList?, Enable?, AllowPublic?, NATEnable?, DHCPAuthoritative?)✏️ 🌐setIPv4Configuration(Name, Address, PrefixLength, Enable?, AllowPublic?, NATEnable?)✏️setIPv6Configuration(Name, Address?, PrefixLength?, Intf?, SubnetOffset?, DHCPEnable?, DHCPIAPDEnable?, DHCPIANAEnable?, DNSServers?, NTPServers?, Enable?)✏️ 🌐- Writable parameters:
ClientIsolations(bool),DomainName(string)
NetMaster.LAN.default.Bridge.{id}.DHCPv4¶
- Writable parameters:
Authoritative(bool),DNSServers(string),DomainSearchList(string),Enable(bool),LeaseTime(uint32),MaxAddress(string),MinAddress(string),NTPServers(string)
NetMaster.LAN.default.Bridge.{id}.HostName¶
- Writable parameters:
IPVersion(uint8),Name(string)
NetMaster.LAN.default.Bridge.{id}.IPv4¶
- Writable parameters:
Address(string),Enable(bool),NATEnable(bool),PrefixLength(uint8)
NetMaster.LAN.default.Bridge.{id}.IPv4.{id}¶
- Writable parameters:
Address(string),Enable(bool),NATEnable(bool),PrefixLength(uint8)
NetMaster.LAN.default.Bridge.{id}.IPv6¶
- Writable parameters:
Address(string),DNSMode(string),DNSServers(string),Enable(bool),Intf(string),NTPServers(string),PrefixLength(string),SubnetOffset(uint8)
NetMaster.LAN.default.Bridge.{id}.IPv6.{id}¶
- Writable parameters:
Address(string),DNSMode(string),DNSServers(string),Enable(bool),Intf(string),NTPServers(string),PrefixLength(string),SubnetOffset(uint8)
NetMaster.LAN.default.Bridge.{id}.IPv6.{id}.DHCPv6¶
- Writable parameters:
DefaultPreferredLifetime(int32),DefaultValidLifetime(int32),DeprecatedTimeout(int32),Enable(bool),IANAEnable(bool),IAPDEnable(bool),IAPDLeasePrefixLength(uint32),IAPDPrefixLength(uint32),IAPDPrefixMask(string)
NetMaster.LAN.default.Bridge.{id}.LLIntf¶
- Writable parameters:
Name(string)
NetMaster.LAN.default.Bridge.{id}.LLIntf.{id}¶
- Writable parameters:
Name(string)
NetMaster.LAN.{id}¶
addBridge(Name)✏️removeBridge(Name)✏️
NetMaster.LANConfig¶
enableIPv6(IPv6Enable?)✏️export()import()✏️setIPv6PrefixMode(IPv6PrefixMode?)✏️setLANMode(lanmode)✏️- Writable parameters:
InvalidSubnets(string),LANMode(string),ValidSubnets(string)
NetMaster.SFP¶
- Writable parameters:
Type(string)
NetMaster.WAN¶
getConfig(flag?)- Writable parameters:
Name(string),PhysicalInterface(string)
NetMaster.WAN.{id}¶
getConfig(flag?)- Writable parameters:
Name(string),PhysicalInterface(string)
NetMaster.WAN.{id}.Intf¶
deleteService(type)✏️deleteStaticRoute(name)✏️getConfig(flag?)setBridgeConfig(ipversion, alias?, apply?)✏️setBridgeVCConfig(alias, destinationAddress, encapsulation, qosclass, peakCellRate?, maximumBurstSize?, sustainableCellRate?, apply?)✏️setBridgeVLANConfig(alias, vlanid, vlanpriority, apply?)✏️setDHCP4ClientConfig(enable, name?, no_export?, dialonplug?, dialonplugidletimeout?, option_req?, option_sent?, check_authentication?, authentication_info?)✏️setDHCP6ClientConfig(enable, name?, no_export?, dialonplug?, dialonplugidletimeout?, option_req?, option_sent?, check_authentication?, authentication_info?)✏️setFirewallConfig(destinationInterface, ipversion, level)✏️setPPPConfig(username, password, ipversion?, ppptype?, enable?, no_export?, maxmrusize?, lcpEcho?, lcpEchoRetry?)✏️setReferenceConfig(lowerInterface)✏️setStaticRoute(name, enable?, dst?, dstlen?, gateway?, table?)✏️setUNTAGGEDConfig(ipversion?, apply?)✏️setVCConfig(destinationAddress, encapsulation, qosclass, peakCellRate?, maximumBurstSize?, sustainableCellRate?, ipversion?, apply?)✏️setVLANConfig(vlanid, vlanpriority, ipversion?, apply?)✏️setVLANoVCConfig(vlanid, vlanpriority, destinationAddress, encapsulation, qosclass, peakCellRate?, maximumBurstSize?, sustainableCellRate?, ipversion?, apply?)✏️- Writable parameters:
DialOnPlug(bool),DialOnPlugIdleTimeout(uint32),Flags(string),IPVersion(uint32),Name(string)
NetMaster.WAN.{id}.Intf.{id}¶
deleteService(type)✏️deleteStaticRoute(name)✏️getConfig(flag?)setBridgeConfig(ipversion, alias?, apply?)✏️setBridgeVCConfig(alias, destinationAddress, encapsulation, qosclass, peakCellRate?, maximumBurstSize?, sustainableCellRate?, apply?)✏️setBridgeVLANConfig(alias, vlanid, vlanpriority, apply?)✏️setDHCP4ClientConfig(enable, name?, no_export?, dialonplug?, dialonplugidletimeout?, option_req?, option_sent?, check_authentication?, authentication_info?)✏️setDHCP6ClientConfig(enable, name?, no_export?, dialonplug?, dialonplugidletimeout?, option_req?, option_sent?, check_authentication?, authentication_info?)✏️setFirewallConfig(destinationInterface, ipversion, level)✏️setPPPConfig(username, password, ipversion?, ppptype?, enable?, no_export?, maxmrusize?, lcpEcho?, lcpEchoRetry?)✏️setReferenceConfig(lowerInterface)✏️setStaticRoute(name, enable?, dst?, dstlen?, gateway?, table?)✏️setUNTAGGEDConfig(ipversion?, apply?)✏️setVCConfig(destinationAddress, encapsulation, qosclass, peakCellRate?, maximumBurstSize?, sustainableCellRate?, ipversion?, apply?)✏️setVLANConfig(vlanid, vlanpriority, ipversion?, apply?)✏️setVLANoVCConfig(vlanid, vlanpriority, destinationAddress, encapsulation, qosclass, peakCellRate?, maximumBurstSize?, sustainableCellRate?, ipversion?, apply?)✏️- Writable parameters:
DialOnPlug(bool),DialOnPlugIdleTimeout(uint32),Flags(string),IPVersion(uint32),Name(string)
NetMaster.WAN.{id}.Intf.{id}.PPP¶
deleteService(type)✏️getConfig(flag?)setDHCP4ClientConfig(enable, name?)✏️setDHCP6ClientConfig(enable, name?)✏️setFirewallConfig(destinationInterface, ipversion, level)✏️- Writable parameters:
DialOnPlug(bool),DialOnPlugIdleTimeout(uint32),Enable(bool),IPVersion(uint32),LCPEcho(uint32),LCPEchoRetry(uint32),MaxMRUSize(uint32),Name(string),Password(string),Username(string)
NetMaster.WAN.{id}.Intf.{id}.Service¶
getConfig(flag?)- Writable parameters:
DialOnPlug(bool),DialOnPlugIdleTimeout(uint32),Enable(bool),Flags(string),IPVersion(uint32),Name(string)
NetMaster.WAN.{id}.Intf.{id}.Service.{id}¶
getConfig(flag?)- Writable parameters:
DialOnPlug(bool),DialOnPlugIdleTimeout(uint32),Enable(bool),Flags(string),IPVersion(uint32),Name(string)
NetMaster.WAN.{id}.Intf.{id}.StaticRoute¶
- Writable parameters:
Dst(string),DstLen(uint32),Enable(bool),Gateway(string),Table(string)
NetWWAN¶
configureNetWWAN(enable, keepAlive)✏️deleteDevice(name)✏️resetDevice(name)✏️setDevice(name, enable, ipaddress?, port?)✏️
NetWWAN.Config¶
- Writable parameters:
Enable(bool),KeepAlive(bool)
NetWWAN.Device¶
getResults()setRequest(name, path, confirm, enable, observable)✏️writeStringValue(path, value, confirm?)- Writable parameters:
Enable(bool),IPAddress(string),Name(string),Port(uint16)
NetWWAN.Device.{id}¶
getResults()🌐 ✅setRequest(name, path, confirm, enable, observable)✏️writeStringValue(path, value, confirm?)- Writable parameters:
Enable(bool),IPAddress(string),Name(string),Port(uint16)
NetWWAN.Device.{id}.Request¶
- Writable parameters:
Confirm(bool),Enable(bool),Observable(bool),Path(string)
NetWWAN.Device.{id}.Request.{id}¶
- Writable parameters:
Confirm(bool),Enable(bool),Observable(bool),Path(string)
OopsTracker¶
getOopses()🌐 ✅
PackageManager¶
BaRtExport(usersetting?, changed?, data?)BaRtImport(data?)enablePackage(name, enable?, start_args?)✏️installPackage(name, url, index?, start_args?)✏️reinstallPackage(name, start_args?)removePackage(name)✏️webuiUpgrade(file)- Writable parameters:
Enable(bool)
PackageManager.Package¶
- Writable parameters:
Alias(string),Enable(bool),GlobalEnable(bool),MaxFailNum(int32),StartArgs(string),URL(string),Uninstall(bool)
PackageManager.Package.{id}¶
- Writable parameters:
GlobalEnable(bool),MaxFailNum(int32),StartArgs(string)
PasswordRecovery¶
export(fileName?)getStatus()🌐 ✅import(fileName?)✏️setEnable(Enable?)✏️ 🌐setPassword(password?)✏️ 🌐start()✏️ 🌐stop()✏️ 🌐- Writable parameters:
Enable(bool)
Phonebook¶
addContact(contact)✏️addContactAndGenUUID(contact)✏️ 🌐 ✅addContacts(contacts, result?)✏️checkContactExistsWithUniqueID(uniqueID)disableCardDavAndCleanupEntries()✏️getAllContacts()🌐 ✅getAvailableNumberOfContacts()getContact(formattedName)getContactByFormattedName(formattedName)getContactByNumber(number)getContactByUniqueID(uniqueID)✅getContactByUsername(username)getContactByVref(vref)getMaxNumberOfContacts()getNumberOfContacts()modifyContact(formattedName?, contact?)✏️modifyContactByFormattedName(formattedName, contact)✏️modifyContactByUniqueID(uniqueID, contact)✏️ 🌐 ✅removeAllContacts()✏️removeContact(formattedName)✏️removeContactByFormattedName(formattedName)✏️removeContactByUniqueID(uniqueID)✏️ 🌐 ✅removeContactByVref(vref)✏️
PowerManagement¶
export()getElements(elements?)getExpressions(expressions?)getProfiles(profiles?)🌐 ✅getSupportedModes()import()✏️removeElements(elements?)✏️removeExpressions(expressions?)✏️removeProfiles(profiles?)✏️setElements(elements)✏️setExpressions(expressions)✏️setPermanentProfiles(profiles)✏️setProfiles(profiles)✏️setScheduledProfiles(profiles)✏️ 🌐setScheduledProfilesOverride(overrides)✏️setSchedulers(profiles)✏️setState(ID, state)✏️setTriggeredProfiles(profiles)✏️ 🌐 ✅- Writable parameters:
Enable(bool),InformRandomDelay(uint32)
SSW¶
debugConfig(filePath?)export()import()✏️setWLANConfig(global?, group?, bssTemplate?, radioTemplate?, source?, reason?)✏️- Writable parameters:
Enable(bool)
SSW.APRoaming¶
debug(op?)devRoam(Dev?, Dest?, Bands?)getDevScoreInfo(Dev?)getDeviceRoamStats()getTopology()globalScan()listPossiblePaths()manualRoam(macaddress?, bssid2G?, bssid5G?, bssid6G?)runCheck(essUpdate?)- Writable parameters:
LogSize(uint32)
SSW.APRoaming.Config¶
- Writable parameters:
ActivationFailPeriod(uint32),AllowRoamWhilePrioTrafficBusy(bool),AllowRoamWhileTrafficBusy(bool),BandsAllowed(string),BusyRoamScoreThreshold(uint32),BusyScoreGainBase(uint32),BusyScoreGainFactor(uint32),BusyThreshold(uint32),ConnectFailPeriod(uint32),DecayPeriod(uint32),DownSteerThreshold(uint32),Enable(bool),EnableMLORoaming(bool),FailureDelay(int32),FailureDelayMultiplier(string),GroupName(string),HighFreqBonus(uint32),IdleRoamScoreThreshold(uint32),IdleScoreGainBase(uint32),IdleScoreGainFactor(uint32),MaxDepth(int32),MaxPenalty(uint32),MaxScanFailureCount(uint32),MaxWirelessDepth(int32),MinimalConnectionPeriod(uint32),MinimalRoamTimeout(uint32),PenaltyDecay(uint32),PenaltyDivider(uint32),PenaltyFactor(int32),RoamMode(string),RoamingPeriod(uint32),RssiAvoidanceThreshold(int16),SNRThreshold(uint16),ScanTriggerCount(uint32),ScanTriggerPeriod(uint32),StartRoamOnNewEssAp(bool),TopologyThresholdReduction(uint32),UpSteerThreshold(uint32)
SSW.APRoaming.Config.MultiBackhaul¶
- Writable parameters:
Enable(bool),MinimumScore(uint32),SameDevice(bool)
SSW.APRoaming.Stats¶
getAllStats()
SSW.DataElements.AssociationEvent¶
- Writable parameters:
MaxNrElements(uint32)
SSW.DataElements.AssociationEvent.AssociationEventData¶
- Writable parameters:
SignalNoiseRatio(int32),SignalStrength(int32)
SSW.DataElements.AssociationEvent.AssociationEventData.{id}¶
- Writable parameters:
SignalNoiseRatio(int32),SignalStrength(int32)
SSW.DataElements.Config.OperatingStandardProfile¶
- Writable parameters:
Alias(string),Enabled2(string),Enabled5(string),Enabled6(string)
SSW.DataElements.DisassociationEvent¶
- Writable parameters:
MaxNrElements(uint32)
SSW.DataElements.DisassociationEvent.DisassociationEventData¶
- Writable parameters:
BytesReceived(uint64),BytesSent(uint64),ErrorsReceived(uint32),ErrorsSents(uint32),FailedRetransCount(uint32),FailedRxRetransCount(uint32),PacketsReceived(uint64),PacketsSent(uint64),ReasonCode(uint32),RetransCount(uint32),RxRetransCount(uint32),SignalNoiseRatio(int32),SignalStrength(int32)
SSW.DataElements.DisassociationEvent.DisassociationEventData.{id}¶
- Writable parameters:
BytesReceived(uint64),BytesSent(uint64),ErrorsReceived(uint32),ErrorsSents(uint32),FailedRetransCount(uint32),FailedRxRetransCount(uint32),PacketsReceived(uint64),PacketsSent(uint64),ReasonCode(uint32),RetransCount(uint32),RxRetransCount(uint32),SignalNoiseRatio(int32),SignalStrength(int32)
SSW.DataElements.Network¶
debug()getShutdownBandInfo(band)setEnable(enable?, reason?)✏️setPersistentEnable(enable?, reason?)✏️setRadioBandEnable(band, enable, reason)✏️setRadioBandPersistentEnable(band, enable, reason)✏️setSSIDEnableMirror(mirrorEnable?, targetEnable?, targetPersistentEnable?)✏️shutdownBand(band, force?, timeout?)- Writable parameters:
Enable(bool),EnableRadiosOnTargetEnable(bool),MLOAvailable(bool),MLOEnable(bool),Mode(string),PersistentEnable(bool),ShutdownForce(string),ShutdownTimeout(uint32)
SSW.DataElements.Network.APMLDTemplate¶
- Writable parameters:
Alias(string),EMLMREnable(bool),EMLSREnable(bool),GroupName(string),MLOEnable(bool),STREnable(bool),SingleMLDUnit(int32),SplitMLDMode(string)
SSW.DataElements.Network.APMLDTemplate.{id}¶
- Writable parameters:
Alias(string),EMLMREnable(bool),EMLSREnable(bool),GroupName(string),MLOEnable(bool),STREnable(bool),SingleMLDUnit(int32),SplitMLDMode(string)
SSW.DataElements.Network.Band¶
getEnableStats()setEnable(enable?, reason?)✏️setPersistentEnable(enable?, reason?)✏️toggleEnable()- Writable parameters:
Enable(bool),Mode(string),PersistentEnable(bool)
SSW.DataElements.Network.Band.{id}¶
getEnableStats()setEnable(enable?, reason?)✏️setPersistentEnable(enable?, reason?)✏️toggleEnable()- Writable parameters:
Enable(bool),Mode(string),PersistentEnable(bool)
SSW.DataElements.Network.Group¶
setConfig(ssid?, passPhrase?, securityModeEnabled?, split?)✏️setEnable(enable?, reason?)✏️setPersistentEnable(enable?, reason?)✏️- Writable parameters:
CombinedMode(bool),DeviceList(string),Enable(bool),HaulType(string),Name(string),PersistentEnable(bool),WPSPriority(uint32)
SSW.DataElements.Network.Group.{id}¶
setConfig(ssid?, passPhrase?, securityModeEnabled?, split?)✏️setEnable(enable?, reason?)✏️setPersistentEnable(enable?, reason?)✏️- Writable parameters:
CombinedMode(bool),DeviceList(string),Enable(bool),HaulType(string),Name(string),PersistentEnable(bool),WPSPriority(uint32)
SSW.DataElements.Network.RadioReadConfig¶
- Writable parameters:
ReadEnable(string)
SSW.DataElements.Network.RadioTemplate¶
debug()getLinkedRadios()- Writable parameters:
Band(string),Enable(bool),Name(string),OperatingStandardProfile(string),PersistEnable(bool)
SSW.DataElements.Network.RadioTemplate.{id}¶
debug()getLinkedRadios()- Writable parameters:
Band(string),Enable(bool),Name(string),OperatingStandardProfile(string),PersistEnable(bool)
SSW.DataElements.Network.SSID¶
debug()debugQoeScore()getLinkedBss()moveStaFromBand(sendBssTermination?, preferredTargetBand?)setWLANConfig(ssid?, passPhrase?, securityModeEnabled?, ssidAdvertisementEnabled?, wmmEnable?, uapsdEnable?, enable?, persistentEnable?, source?, reason?, mirrorSSIDMACFiltering?, mfMode?, haulType?, splitMldUnit?)✏️- Writable parameters:
APMLDTemplate(string),Band(string),DeviceList(string),Enable(bool),GroupName(string),HasLocalBSS(bool),HaulType(string),MACFilteringMode(string),MLOEnable(bool),MirrorSSID(string),MirrorSSIDMACFiltering(string),Mode(string),Name(string),PassPhrase(string),PersistentEnable(bool),SSID(string),SSIDAdvertisementEnabled(bool),SecurityModeEnabled(string),SecurityModesSupported(string),SplitMLDUnit(int32),UAPSDEnable(bool),WMMEnable(bool)
SSW.DataElements.Network.SSID.{id}¶
debug()debugQoeScore()getLinkedBss()moveStaFromBand(sendBssTermination?, preferredTargetBand?)setWLANConfig(ssid?, passPhrase?, securityModeEnabled?, ssidAdvertisementEnabled?, wmmEnable?, uapsdEnable?, enable?, persistentEnable?, source?, reason?, mirrorSSIDMACFiltering?, mfMode?, haulType?, splitMldUnit?)✏️- Writable parameters:
APMLDTemplate(string),Band(string),DeviceList(string),Enable(bool),GroupName(string),HasLocalBSS(bool),HaulType(string),MACFilteringMode(string),MLOEnable(bool),MirrorSSID(string),MirrorSSIDMACFiltering(string),Mode(string),Name(string),PassPhrase(string),PersistentEnable(bool),SSID(string),SSIDAdvertisementEnabled(bool),SecurityModeEnabled(string),SecurityModesSupported(string),SplitMLDUnit(int32),UAPSDEnable(bool),WMMEnable(bool)
SSW.DataElements.Network.SSID.{id}.MACFilteringEntries¶
- Writable parameters:
Alias(string),MACAddress(string)
SSW.DataElements.Network.SSIDReadConfig¶
- Writable parameters:
ReadEnable(string),ReadMACFiltering(string),ReadMultiAPType(string),ReadPersistentEnable(string),ReadSSID(string),ReadSSIDAdvert(string),ReadSecurity(string),ReadUAPSDEnable(string),ReadWMMEnable(string)
SSW.DataElements.Network.WPS¶
InitiateWPSPBC()cancelWPSPairing()
SSW.FeatureConfig¶
startEventing(MAC?)✏️stopEventing(MAC?)✏️- Writable parameters:
NaStaMonPriorizationEnable(bool),NaStaMonPriorizationRssi(int32),NaStaMonPriorizationScore(int32)
SSW.FeatureConfig.AddOnMode¶
- Writable parameters:
ActiveTimeout(int32),Enable(bool)
SSW.FeatureConfig.AssocMonitor¶
getLatestStaAssociationAttempts()- Writable parameters:
Enable(bool),Interval(uint32),MaxNbStations(uint32)
SSW.FeatureConfig.AutoPairing¶
startAutoPairing(MAC, channel)✏️- Writable parameters:
Enable(bool),IEEE80211kRequestTimeout(uint32),MonitoringTimeout(uint32),PairingTimeout(uint32),RSSIThreshold(int32),VendorIEData(string)
SSW.FeatureConfig.BackhaulRecovery¶
debug()delProvisionedMAC(MAC?)✏️getProvisionedMACList()provisionMAC(MAC?, sharedSecret?)- Writable parameters:
AttemptTimeout(uint32),Enable(bool),ExpirationTime(uint32),MaxNumberOfProvisioningAttempts(uint32),NumberOfRetriesSentPerAttempt(uint32),OneTimePairing(bool),ProvisioningEnable(bool),RecoverOnProbingEnable(bool),RequireSharedSecret(bool),RetryDelayInterval(uint32),VerifyCertMAC(bool)
SSW.FeatureConfig.BackhaulRecovery.Entry¶
- Writable parameters:
MACAddress(string),SharedSecret(string)
SSW.FeatureConfig.BackhaulRecoveryAgent¶
debug()- Writable parameters:
Enable(bool),ReprovisionEnable(bool),ReprovisionFromPreviousMasterOnly(bool),SharedSecret(string)
SSW.FeatureConfig.DataExportManager¶
- Writable parameters:
Enable(bool)
SSW.FeatureConfig.DataExportManager.StaHistogramExportConfig¶
cleanFiles()triggerExport()✏️- Writable parameters:
Enable(bool),FileName(string),LineSize(uint32),MaxLines(uint32)
SSW.FeatureConfig.EnergySaving¶
getStats()- Writable parameters:
AirtimeThreshold(uint32),AllowVideoStation(bool),AntennaConfiguration(string),DeltaThreshold(uint8),Enable(bool),EnableThreshold(uint32),MaxStatsLength(uint32),ModesEnabled(string),RssiThreshold(int32)
SSW.FeatureConfig.EpScoreSync¶
debug()performUpdate()- Writable parameters:
Enable(bool),UpdateInterval(uint32)
SSW.FeatureConfig.IEEE80211k¶
- Writable parameters:
NeighbourConfigEnable(bool),NeighbourDisabledTargetBands(string),RequestEnable(bool),SkipNonOverlappingNeighbours(bool)
SSW.FeatureConfig.IEEE80211k.BeaconRequestProfiles¶
- Writable parameters:
AddNeighbour(bool),BSSID(string),ChannelMode(string),ChannelValue(uint8),Duration(uint16),IgnoreCapability(bool),Mode(string),Name(string),OperClassMode(string),OperClassValue(uint8),RandomizationInterval(uint16),ReportingDetail(uint8),SSID(string),ScanPrimaryChannelOnly(bool)
SSW.FeatureConfig.IEEE80211k.BeaconRequestProfiles.{id}¶
- Writable parameters:
AddNeighbour(bool),BSSID(string),ChannelMode(string),ChannelValue(uint8),Duration(uint16),IgnoreCapability(bool),Mode(string),Name(string),OperClassMode(string),OperClassValue(uint8),RandomizationInterval(uint16),ReportingDetail(uint8),SSID(string),ScanPrimaryChannelOnly(bool)
SSW.FeatureConfig.IEEE80211k.Config¶
- Writable parameters:
NoSuccessMaxCount(uint32),NoSuccessTimeout(uint32),PolicyBeaconRequestPerBand(bool),PolicyForceBandCheck(bool),PolicyKickBadStationCheck(bool),PolicyOptimalRssiCheck(bool),PolicyOptimalScoreCheck(bool),RequestTimeout(uint32),TrafficLimit(uint32)
SSW.FeatureConfig.IEEE80211r¶
- Writable parameters:
MobilityDomainSyncEnable(bool)
SSW.FeatureConfig.LongStats¶
getLongHistoryStats()- Writable parameters:
HistoryEnable(bool),SendEventOnAssoc(bool),SendEventOnDisassoc(bool),SendPeriodicEvent(bool)
SSW.FeatureConfig.MultiBackhaul¶
debugMultiBackhaul()- Writable parameters:
SteeringEnable(bool)
SSW.FeatureConfig.MultiBackhaul.Config¶
- Writable parameters:
Enable(bool),PrioBand(string),PrioTargets(string)
SSW.FeatureConfig.MultiBackhaul.Config.Station¶
- Writable parameters:
CurrentBackhaulFrequency(string),MACAddress(string),RuleName(string)
SSW.FeatureConfig.MultiBackhaul.Rules¶
- Writable parameters:
PrioBand(string),Query(string),Type(string)
SSW.FeatureConfig.NaStaStatMon.Config¶
- Writable parameters:
Enable(bool),Interval(uint32)
SSW.FeatureConfig.NodeModel¶
- Writable parameters:
HistogramCycleInterval(uint32),SendTopologyEvent(bool)
SSW.FeatureConfig.QoeScoreManager¶
getAggregationConfig()getAssocScoreConfig()getAvailScoreConfig()getAvailTotalScore()getAvailWindowList()getBadScoreEventingConfig()getLinkScoreConfig()reloadLinkScoreConfig(filePath?)- Writable parameters:
AggregationWindowInterval(uint32),Enable(bool),NumberOfWindows(uint32)
SSW.FeatureConfig.QoeScoreManager.AggregationConfig¶
- Writable parameters:
AvailScoreMaxPenalty(string),SecondaryScoreMaxPenalty(string),StationAggregationMaxTraffic(uint64),StationAggregationMinTraffic(uint64)
SSW.FeatureConfig.QoeScoreManager.AssocScoreConfig¶
- Writable parameters:
AWIDThreshold(uint32),AwidScoreSource(string),AwidScoreTarget(string),ConfigName(string),ScoreToWeightSource(string),ScoreToWeightTarget(string),TAWIThreshold(uint32),ThroughputThreshold(uint32),WeightFunctionMultiplier(string),WeightFunctionPenalty(string),WeightFunctionSource(string)
SSW.FeatureConfig.QoeScoreManager.AvailScoreConfig¶
- Writable parameters:
ActiveWeight(uint32),AvailToScoreSource(string),AvailToScoreTarget(string),ConnectedWeight(uint32),EnableWeight(uint32)
SSW.FeatureConfig.QoeScoreManager.BadScoreEventingConfig¶
debug()- Writable parameters:
AllowedEventingOverlap(uint32),Enable(bool),MaxNumberOfEventsPerHour(uint32),MaxWindowDuration(uint32),MinimumEventInterval(uint32),NumberOfBadScoresRequired(uint32),QoEThreshold(uint64),WindowSize(uint32)
SSW.FeatureConfig.QoeScoreManager.LinkScoreConfig¶
- Writable parameters:
ConfigName(string),Exponent(string),HighThreshold(string),HighWeight(string),IgnoreMaculan(bool),IgnoreMaculanForDevices(bool),LowThreshold(string),LowWeight(string),MinimumTrafficSpeed(uint32)
SSW.FeatureConfig.SettingsRestore¶
restore(settingsName, parameters?, radios?, ssids?, groups?)✏️save(settingsName, parameters?, ssids?, groups?)✏️
SSW.FeatureConfig.SettingsRestore.Config¶
- Writable parameters:
GroupsToSave(string),ParamsToSave(string),RadiosToSave(string),SSIDsToSave(string)
SSW.FeatureConfig.SettingsRestore.SettingsSet¶
- Writable parameters:
Alias(string),SavedParams(string)
SSW.FeatureConfig.SlaveScan¶
- Writable parameters:
Enable(bool),ScanInterval(uint32)
SSW.FeatureConfig.StaMonConfig¶
- Writable parameters:
FastReconnectInterval(uint32),UserFastReconnectInterval(uint32)
SSW.FeatureConfig.WDSMgmt¶
debugWDS()- Writable parameters:
Enable(bool)
SSW.Monitor.IssueMonitor.DoubleAssociation¶
debug()- Writable parameters:
Enable(bool),InactiveThreshold(uint32),KickEthSlave(bool),KickOnAssoc(bool)
SSW.Monitor.TopologyMonitor¶
debug()- Writable parameters:
CleanOnDisassociate(bool),DeviceCheckInterval(uint32),Enable(bool),Interval(uint32),MinimalInterval(uint32)
SSW.Monitor.TrafficMonitor¶
getTraffic()- Writable parameters:
Enable(bool)
SSW.Steering¶
deleteStationInfo(MAC?)✏️dumpNodeModel()getAllNetdevStats(device?, interface?)getAllStationsCompactInfo()getAllStationsStandards(ap?)getCompactStationInfo(MAC?)getNodeBackhaul(MAC?)getNodeUplinks(MAC?, dev?)getQoEStats(MAC?)getRoamInfo(MAC?)getStaObs(MAC?)getStationAssocLog(MAC?)getStationStats(MAC?)getStationSteerStats(MAC?)getTopologyScoreInfo()getUplinkInfo(MAC?, dev?)purgeMAC(MAC?)sendRrm(MAC?, bssid?, channel?, class?, timeout?, ssid?, profile?)✏️setModeConfig(mode?, targetBroker?)✏️- Writable parameters:
DevMonitorInterval(uint32),Enable(bool),GlobalEnable(bool)
SSW.Steering.DbConfig¶
- Writable parameters:
AllowRrmObsUsage(bool),AssocLogSize(uint32),AssocStationMaxCleanupDays(uint32),AssocStationMinCleanupTime(uint32),DeviceHistoryLength(uint32),FilterZeroEndingAddresses(bool),LogAllProbeRequest(bool),LogAssocEvents(bool),LogDeviceHistory(bool),LogFileLength(uint32),LogNaStaHistory(bool),LogStaAvgHistory(bool),LogStaHistory(bool),MaxProbeReqPerRadio(uint32),MinStationListUpdateTime(uint32),ObservedStationMaxCleanupDays(uint32),ObservedStationMinCleanupTime(uint32),ProbeReqFileLength(uint32),RadioHistoryLength(uint32),StaHistoryLength(uint32),StationListCleanupInterval(uint32),StationListCleanupTarget(uint32),StationListMaxSize(uint32),SteerCleanupTime(uint32),UpdateLocalBridgeAddresses(bool)
SSW.Steering.DbConfig.DeviceCleanup¶
- Writable parameters:
ConfiguredThreshold(uint32),Enable(bool),PassiveThreshold(uint32)
SSW.Steering.Device¶
debug()getDeviceStatistics()remove()✏️setLocalWiFiEnable(value)✏️setLocalWiFiTempEnable(value)✏️
SSW.Steering.Device.{id}¶
debug()getDeviceStatistics()remove()✏️setLocalWiFiEnable(value)✏️setLocalWiFiTempEnable(value)✏️
SSW.Steering.Device.{id}.APRoaming¶
debug()
SSW.Steering.Device.{id}.APRoaming.Config¶
- Writable parameters:
ForceBackhaul(string),MainBackhaul(string)
SSW.Steering.Device.{id}.Endpoint¶
debug()getStats()
SSW.Steering.Device.{id}.Interface.{id}.Config¶
- Writable parameters:
Enable(int8)
SSW.Steering.Device.{id}.Interface.{id}.StatMon¶
- Writable parameters:
Enable(bool),Interval(uint32)
SSW.Steering.Device.{id}.Interface.{id}.StatMon.{id}¶
- Writable parameters:
Enable(bool),Interval(uint32)
SSW.Steering.Device.{id}.Radio¶
debugDE()getHistogram()scan(SSID?, channels?)
SSW.Steering.Device.{id}.Radio.{id}¶
debugDE()getHistogram()scan(SSID?, channels?)
SSW.Steering.Device.{id}.Radio.{id}.BSS¶
debugDE()debugQoeScore()getHistogram()
SSW.Steering.Device.{id}.Radio.{id}.BSS.{id}¶
debugDE()debugQoeScore()getHistogram()
SSW.Steering.EndpointSync¶
- Writable parameters:
ConfigDelay(uint32),Enable(bool),EndpointInterfaceURL(string),StartDelay(uint32),SyncInterface(string)
SSW.Steering.ExceptionList¶
cleanAllExceptionsByMac(MAC?)createException(MAC?, mask?, target?, type?, forceMode?, source?)✏️ 🌐 ✅createGmapAutoException(query, target?, type?, persistent?, key?)✏️deleteException(MAC?, mask?)✏️ 🌐 ✅deleteGmapAutoExceptionByKey(key)✏️deleteGmapAutoExceptionByQuery(query)✏️- Writable parameters:
AutoCleanEmptyTargetOnMacDelete(bool),DeployExceptions(bool),MACTargetSourceString(string),MaxNumberOfExceptions(uint32),SlaveAutoExceptAction(string),SlaveAutoExceptEnable(bool),SlaveAutoExceptType(string),VideoAutoExceptAction(string),VideoAutoExceptEnable(bool),VideoAutoExceptType(string)
SSW.Steering.ExceptionList.DHCPAutoExcept¶
- Writable parameters:
Path(string),Target(string),Type(string)
SSW.Steering.ExceptionList.GmapAutoExcept¶
- Writable parameters:
Action(string),Persistent(bool),Query(string),Type(string)
SSW.Steering.ExceptionList.Station¶
- Writable parameters:
ForceMode(string),MAC(string),Mask(uint8),Source(string),Target(string),Type(string)
SSW.Steering.FeatureConfig¶
- Writable parameters:
NaStaMonEnable(bool),NaStaMonMatchChannel(bool)
SSW.Steering.FeatureConfig.ApRoleSync¶
- Writable parameters:
Depth(int32),Enable(bool),WirelessDepth(int32)
SSW.Steering.FeatureConfig.ProbeFiltering¶
debug()- Writable parameters:
AllowHandover(bool),BlockAfterSteer(bool),BlockTime(uint32),Enable(bool),FilterOnBothBands(bool)
SSW.Steering.FeatureConfig.StatMonConfig¶
- Writable parameters:
Enable(bool),Interval(uint32)
SSW.Steering.FeatureConfig.StatMonConfig.{id}¶
- Writable parameters:
Enable(bool),Interval(uint32)
SSW.Steering.FeatureConfig.UplinkQualityAssessment¶
- Writable parameters:
GoodBandwidthThreshold(uint32),GoodRssiThreshold(int32),MediumBandwidthThreshold(uint32),MediumRssiThreshold(int32)
SSW.Steering.Group¶
debug()setMacfilter()✏️setSsidAndPw(ssid?, pw?)✏️- Writable parameters:
DisableOnMasterBye(bool),DisableOnSlaveDisconnect(bool),EssIdentifier(string),GroupName(string),MobilityDomain(uint16),NeMoInterfacePath(string),NeMoInterfaceQuery(string),SteeringEnabled(bool)
SSW.Steering.Group.{id}¶
debug()setMacfilter()✏️setSsidAndPw(ssid?, pw?)✏️- Writable parameters:
DisableOnMasterBye(bool),DisableOnSlaveDisconnect(bool),EssIdentifier(string),GroupName(string),MobilityDomain(uint16),NeMoInterfacePath(string),NeMoInterfaceQuery(string),SteeringEnabled(bool)
SSW.Steering.Group.{id}.AccessPoint¶
debug()getApInfo()- Writable parameters:
Path(string)
SSW.Steering.Group.{id}.AccessPoint.{id}¶
debug()getApInfo()- Writable parameters:
Path(string)
SSW.Steering.Group.{id}.AccessPoint.{id}.WPS¶
startPairing(pin?)✏️stopPairing()✏️
SSW.Steering.Group.{id}.WPS¶
setSelfPIN(pin)✏️startPairing(pin?)✏️stopPairing()✏️- Writable parameters:
Enable(bool),EnableMasterSync(bool),EnableOnWPS(bool),EnableSlaveSync(bool),MoveAlgorithm(string),MoveMaxNrSecondaryAp(uint32),MoveMinPrimaryTime(uint32),PairingMode(string),UUIDSyncEnabled(bool)
SSW.Steering.MasterConfig¶
- Writable parameters:
ChannelMgtSyncEnable(bool),EndpointSyncEnable(bool),EnsureWiFi7Security(bool),HeartbeatTime(uint32),PrplMeshDiscoveryEnable(bool),RemoteRootEnabled(bool),SyncEnableField(bool),SyncMode(string),TargetBroker(string),UpdateVAPPersistentEnableOnEnableSync(bool),WPA3CMToTmIfNotSupported(bool)
SSW.Steering.MasterConfig.OperatingStandards¶
debug()disable(opStd?, band?)✏️ 🌐 ✅enable(opStd?, band?)✏️ 🌐 ✅- Writable parameters:
AvailableStandards(string),Enabled24GHz(string),Enabled5GHz(string),Enabled6GHz(string),SyncMode(string),UpgradeStandardsOnOldPossibleStandards(bool)
SSW.Steering.MasterState¶
dbgUpdatePrb()dbgUpdateRad()dbgUpdateSta()- Writable parameters:
EnableStaleEndpointCleanup(bool)
SSW.Steering.MasterState.Slave¶
- Writable parameters:
Id(string),Mac(string)
SSW.Steering.QoSUpgrade¶
createRule(mac, tid?)✏️deleteRule(mac)✏️- Writable parameters:
Target(string)
SSW.Steering.QoSUpgrade.Rules¶
- Writable parameters:
Query(string),TID(uint8)
SSW.Steering.Radio¶
debug()
SSW.Steering.Radio.{id}¶
debug()
SSW.Steering.Scoring¶
debug()- Writable parameters:
AirtimeMultiplier(uint32),AntennaMultiplier(uint32),AntennaMultiplierArray(string),AssocCostDivider(uint32),AssocCostExpPenalty(uint32),AssocCostMaxMultiplier(uint32),AssocCostPenalty(uint32),AssocCostThreshold(uint32),BandwidthMultiplier(uint32),BonusCutoffSNR(uint32),DualHopAdjustment(uint32),ExtenderHopMultiplier(uint32),HELinkBonus(uint32),LinkCostDivider(uint32),LinkCostMaxMultiplier(uint32),LinkCostThreshold(uint32),LinkWiredCostPenalty(uint32),LinkWiredExpCostPenalty(uint32),LinkWirelessCostPenalty(uint32),LinkWirelessExpCostPenalty(uint32),MLOSecondaryAdjustment(uint32),MLOTertiaryAdjustment(uint32),MinThroughputCategory(uint32),MultiHopAdjustment(uint32),ObservedRateWeight(uint32),RateDivider(uint32),RepeaterDivider(uint32),RepeaterHopMultiplier(uint32),ScoreInterpolate2to5(string),ScoreInterpolate2to6(string),ScoreInterpolate5to2(string),ScoreInterpolate5to6(string),ScoreInterpolate6to2(string),ScoreInterpolate6to5(string),ScoreList24GHz(string),ScoreList5GHz(string),ScoreList6GHz(string),WiredTxOpAddition(uint32),WirelessTxOpAddition(uint32)
SSW.Steering.SlaveConfig¶
- Writable parameters:
HeartBeatTime(uint32),PassServerManagementEnable(bool),TargetBroker(string),TargetPort(uint32),TargetServer(string)
SSW.Steering.StationList.Station¶
- Writable parameters:
AbortSteerCount(uint32),AffiliatedStaMAC(string),Aliases(string),AvgReconnectTime(uint64),AvgSteeringTime(uint64),EhtCapabilities(string),EnsureSecurityMatch(string),FailedSteerCount(uint32),HeCapabilities(string),HtCapabilities(string),IgnoreDetectedSeamlessTransition(string),IsBoomerang(bool),IsProvisioned(bool),IsVideoStation(bool),LastSeenTime(date_time),LastSteerResult(string),LastSteerTime(date_time),MACAddress(string),MLOModesSupported(string),MaxNumberOfAffiliatedSta(uint32),MaxRxSpatialStreamsSupported(uint16),MaxTxSpatialStreamsSupported(uint16),RecentFailureCount(uint32),RecentFailureCountChangeTime(date_time),ReconnectMeasurementCount(uint32),RrmCapabilities(string),SSWDeviceMACAddress(string),SecurityModesSupported(string),SteerCount(uint32),SuccessSteerCount(uint32),SupportedRadioStandards(string),SupportedStandards(string),SupportedUNIIBands(string),Supports24GHz(bool),Supports5GHz(bool),Supports6GHz(bool),SupportsSeamlessTransition(bool),VendorSpecificElementOUIList(string),VhtCapabilities(string),WiFiCapabilities(string)
SSW.Steering.StationList.Station.{id}¶
- Writable parameters:
AbortSteerCount(uint32),AffiliatedStaMAC(string),Aliases(string),AvgReconnectTime(uint64),AvgSteeringTime(uint64),EhtCapabilities(string),EnsureSecurityMatch(string),FailedSteerCount(uint32),HeCapabilities(string),HtCapabilities(string),IgnoreDetectedSeamlessTransition(string),IsBoomerang(bool),IsProvisioned(bool),IsVideoStation(bool),LastSeenTime(date_time),LastSteerResult(string),LastSteerTime(date_time),MACAddress(string),MLOModesSupported(string),MaxNumberOfAffiliatedSta(uint32),MaxRxSpatialStreamsSupported(uint16),MaxTxSpatialStreamsSupported(uint16),RecentFailureCount(uint32),RecentFailureCountChangeTime(date_time),ReconnectMeasurementCount(uint32),RrmCapabilities(string),SSWDeviceMACAddress(string),SecurityModesSupported(string),SteerCount(uint32),SuccessSteerCount(uint32),SupportedRadioStandards(string),SupportedStandards(string),SupportedUNIIBands(string),Supports24GHz(bool),Supports5GHz(bool),Supports6GHz(bool),SupportsSeamlessTransition(bool),VendorSpecificElementOUIList(string),VhtCapabilities(string),WiFiCapabilities(string)
SSW.Steering.SteerConfig¶
- Writable parameters:
AllowInactiveSteer(bool),AllowMLOSteering(bool),BTMMinSuccessesPerFailure(string),BanAfterAssoc(bool),BanAllLocalAPs(bool),BanDelay(int32),BlackListPropagationEnable(bool),BtmExtendedReply(bool),BusyThreshold(uint32),CrossBandFreshnessRequired(bool),EnsureSecurityMatch(bool),FailureCountMode(string),FalseHandoverTime(uint32),FastFailThreshold(uint32),FreshnessRequirement(int32),GoodSteerableThreshold(uint32),HandbackThreshold(uint32),IdleThreshold(uint32),IgnoreSeamlessTransitionDetected(bool),KickDelay(int32),LastProbeSec(uint32),LastValueWeight(uint32),LatestInactiveThreshold(uint32),MaxHandbackTime(uint32),MaxHandoverTime(uint32),MaxInactiveThreshold(uint32),MaxProbeHashCandidateCount(uint32),MaxRecentSteerThreshold(uint32),MaxValidProbeHashCount(uint32),MinProbeCount(uint32),MinSteerResultsForClassDelay(uint32),MotionThreshold(uint32),NoBTMMinSuccessesPerFailure(string),NoBTMSteerMaxFailure(uint32),ObservationAveraging(string),ObservationAveragingFactor(uint32),ObservationDecayInterval(uint32),ObservationForgetInterval(uint32),ProbeFlushTime(uint32),ProbeRssiDelta(uint32),ProbeRssiLimit(int32),RecentSteerDecayInterval(uint32),RequireBssMgtReply(string),RequireBssMgtReplyOk(bool),ResteerTimeout(uint32),RssiDeltaLastValueWeight(uint32),RssiDeltaMethod(string),SnrRequirement(int32),StationAveraging(string),StationAveragingFactor(uint32),SteerDelay(int32),SteerDelayAbort(uint32),SteerDelayFailByClass(string),SteerDelayFailure(uint32),SteerDelayHandback(int32),SteerDelaySuccess(uint32),SteerDisassoc(int32),SteerDisassocImminent(bool),SteerFailClasses(string),SteerFailureDecay(uint32),SteerFailureMaxDecay(uint32),SteerFailureTimeout(uint32),SteerLoopMaxCount(uint32),SteerLoopRssiDiffAllow(uint32),SteerLoopTimeout(uint32),SteerMaxFailure(uint32),SteerMaxHandback(uint32),SteerRetries(int32),SteerUnbanTimer(uint32),SteerValidity(int32),UNIIBandsSupportRequired(bool)
SSW.Steering.SteerLog¶
- Writable parameters:
SteerLogSize(uint32)
Scheduler¶
addSchedule(type, info)✏️ 🌐 ✅enableAllSchedule(type, enable)✏️enableSchedule(type, ID, enable?, device?)✏️ 🌐 ✅getCompleteSchedules(type, scheduleInfo?, target?)🌐 ✅getSchedule(type, ID, info?, device?)✅getScheduleTypes(types?)getSchedules(type, scheduleInfo?, target?)overrideSchedule(type, ID, override, device?)✏️ ✅overrideState(type, ID, state, device?)✏️ ✅removeSchedules(type, ID?, device?)✏️ 🌐 ✅updateScheduleEntries(type, ID, entries, device?)✏️
Time¶
configureBaRt(configuration)✏️export(usersetting?, changed?, data?)getLocalTimeZoneName(timezone?)getNTPServers(servers?)getStatus(status?)getTime(time?)🌐 ✅getUTCTime(time?)import(data)✏️listLocalTimeZoneNames(timezones?)- Writable parameters:
DaylightSavingsEnd(date_time),DaylightSavingsStart(date_time),DaylightSavingsUsed(bool),Enable(bool),Interface(string),LastTimeAdjustment(int32),ListenOn1(string),ListenOn2(string),ListenOn3(string),ListenOn4(string),ListenOn5(string),LocalTimeZone(string),LocalTimeZoneName(string),NTPReqInterval(uint32),NTPServer1(string),NTPServer1IP(string),NTPServer2(string),NTPServer2IP(string),NTPServer3(string),NTPServer3IP(string),NTPServer4(string),NTPServer4IP(string),NTPServer5(string),NTPServer5IP(string),PreferredServer(string),Retry1(string),Retry2(string),Retry3(string),Retry4(string),Retry5(string),SyncMode(string)
ToD¶
addBlacklistEntry(MACAddress)✏️configureMST(enable?, granularity?)✏️deleteBlacklistEntry(MACAddress)✏️deleteMST(id)✏️ 🌐 ✅export(fileName?)findMST(subject, ids?)getMST(id, subject?, enable?, status?, allowedTime?)🌐 ✅import(fileName?)✏️listMST(ids?)🌐 ✅resetMST(id)✏️setMST(id, subject?, enable?, allowedTime?)✏️ 🌐 ✅setState(ID?, state?)✏️statsMST(id, enable?, status?, consumed?, left?)🌐 ✅- Writable parameters:
BlockDevices(bool),BlockExpression(string),GlobalBlockEnable(bool),WhitelistCoverage(string),WhitelistDevices(string)
ToD.MaxSurfTime¶
- Writable parameters:
Enable(bool),Granularity(uint32)
ToD.MaxSurfTime.Subject¶
- Writable parameters:
AllowedFri(uint32),AllowedMon(uint32),AllowedSat(uint32),AllowedSun(uint32),AllowedThu(uint32),AllowedTue(uint32),AllowedWed(uint32),Enable(bool),Subject(string)
ToD.MaxSurfTime.Subject.{id}¶
- Writable parameters:
AllowedFri(uint32),AllowedMon(uint32),AllowedSat(uint32),AllowedSun(uint32),AllowedThu(uint32),AllowedTue(uint32),AllowedWed(uint32),Enable(bool),Subject(string)
UPnP-IGD¶
get()✅set(parameters?)✏️- Writable parameters:
AllowedHostHeader(string),AlwaysStartIgdDaemon(bool),Enable(bool),FriendlyName(string),ModelName(string),ModelNumber(string),TR064ServiceURL(string),WANAccessProvider(string)
UPnP-IGD.PnP-X¶
- Writable parameters:
HardwareId-DID(string),HardwareId-RID(string),HardwareId-SID(string),HardwareId-VID(string)
USBHosts¶
devicePlugged(syspath?)deviceUnplugged(syspath?)getDevice(id?)getDevices(deviceClass?)🌐 ✅getTopology()
USBHosts.Host.{id}.Device¶
- Writable parameters:
Eject(bool)
USBHosts.Host.{id}.Device.{id}¶
- Writable parameters:
Eject(bool)
UserManagement¶
addAuthenticationLog(username?, success?, loginsource?, customdata?)✏️addUser(name?, password?, groups?, enable?, usertype?, salt?, uid?, linux_user?, friendlyname?)✏️addUserToGroups(name?, groups?)✏️authenticate(name, password, groupName?)🌐changePassword(name?, password?)✏️changePasswordPrehashed(name?, password?, salt?, password_type?)✏️changePasswordType(name, password_type)✏️changeUser(name?, password?, groups?, enable?, usertype?, friendlyname?)✏️getGroup(name?)getGroups()getLastLoginInfo(username?)getLoginCounters()getUser(name)getUserCustomData(name, keys?, custom_data?)getUserFromKeyValue(key, value, users?)getUserLog(username?)🌐 ✅getUsers()getUsersAndGroups(users?, groups?)removeUser(name?)✏️removeUserCustomData(name, keys)✏️removeUserFromGroups(name?, groups?)✏️removeUsers(name?, type?)✏️resetLoginCounters()✏️setUserCustomData(name, custom_data)✏️
UserManagement.Group¶
- Writable parameters:
Enable(bool)
UserManagement.Group.{id}¶
- Writable parameters:
Enable(bool)
UserManagement.User¶
- Writable parameters:
AllowFTPAccess(bool),AllowHTTPAccess(bool),Enable(bool),FriendlyName(string),Password(string),RemoteAccessCapable(bool)
UserManagement.User.{id}¶
- Writable parameters:
AllowFTPAccess(bool),AllowHTTPAccess(bool),Enable(bool),FriendlyName(string),RemoteAccessCapable(bool)
VPN¶
deleteIPsecConfiguration(profile)✏️deletePPPConfiguration(profile)✏️deleteServer(server)✏️deleteServerClient(server, client)✏️deleteSite2Site(name)✏️disconnectServerClient(server, client)✏️ 🌐disconnectSite2Site(name)✏️enableServer(enable?, enabled?)✏️enableSite2Site(enable?, enabled?)✏️export(fileName?)getIPsecConfiguration(profile, settings?)getPPPConfiguration(profile, settings?)getServer(server, settings?)🌐getServerClient(server, client, settings?)🌐getServersConfig(config?)🌐 ✅getSite2Site(name, settings?)getSite2SitesConfig(config?)import(fileName?)✏️listIPsecConfigurations(profiles?)listPPPConfigurations(profiles?)listServerClients(server, clients?)listServers(servers?)listSite2Site(names?)setIPsecConfiguration(profile, settings?)✏️setPPPConfiguration(profile, settings?)✏️setServer(server, enable?, settings?)✏️ 🌐setServerClient(server, client, enable?, settings?)✏️ 🌐setSite2Site(name, enable?, settings?)✏️- Writable parameters:
ServerEnable(bool),Site2SiteEnable(bool)
VPN.IPsecConfiguration¶
- Writable parameters:
AHAllowedDiffieHellmanGroupTransforms(string),AHAllowedIntegrityAlgorithms(string),ESPAllowedDiffieHellmanGroupTransforms(string),ESPAllowedEncryptionAlgorithms(string),ESPAllowedIntegrityAlgorithms(string),IKEDeadPeerDetectionTimeout(uint32),IKEIDType(string),IKEPhase1Duration(uint32),IKEPhase2Duration(uint32),IKEVersion(string),IKEv2AllowedDiffieHellmanGroupTransforms(string),IKEv2AllowedEncryptionAlgorithm(string),IKEv2AllowedIntegrityAlgorithms(string),IKEv2AllowedPseudoRandomFunctions(string),Mode(string),Protocol(string)
VPN.IPsecConfiguration.{id}¶
- Writable parameters:
AHAllowedDiffieHellmanGroupTransforms(string),AHAllowedIntegrityAlgorithms(string),ESPAllowedDiffieHellmanGroupTransforms(string),ESPAllowedEncryptionAlgorithms(string),ESPAllowedIntegrityAlgorithms(string),IKEDeadPeerDetectionTimeout(uint32),IKEIDType(string),IKEPhase1Duration(uint32),IKEPhase2Duration(uint32),IKEVersion(string),IKEv2AllowedDiffieHellmanGroupTransforms(string),IKEv2AllowedEncryptionAlgorithm(string),IKEv2AllowedIntegrityAlgorithms(string),IKEv2AllowedPseudoRandomFunctions(string),Mode(string),Protocol(string)
VPN.Server¶
- Writable parameters:
AllowedTypes(string),BlockSIP(bool),DHCPPool(string),Enable(bool),IPVersion(uint32),IPsecAuthenticationMethod(string),IPsecConfiguration(string),IPsecConfigurationIKEv2PSK(string),IPsecPreSharedKey(string),Interface(string),InternetAccessMode(string),ListenPort(uint32),MaxConnections(uint32),PPPConfiguration(string),RemoteHost(string)
VPN.Server.{id}¶
- Writable parameters:
AllowedTypes(string),BlockSIP(bool),DHCPPool(string),Enable(bool),IPVersion(uint32),IPsecAuthenticationMethod(string),IPsecConfiguration(string),IPsecConfigurationIKEv2PSK(string),IPsecPreSharedKey(string),Interface(string),InternetAccessMode(string),ListenPort(uint32),MaxConnections(uint32),PPPConfiguration(string),RemoteHost(string)
VPN.Server.{id}.Client¶
- Writable parameters:
Enable(bool),IPSecIdentifier(string),Password(string),Type(string),Username(string)
VPN.Server.{id}.Client.{id}¶
- Writable parameters:
Enable(bool),IPSecIdentifier(string),Password(string),Type(string),Username(string)
VPN.Site2Site¶
- Writable parameters:
Enable(bool),IPVersion(uint32),IPsecAuthenticationMethod(string),IPsecConfiguration(string),IPsecConnectionMode(string),IPsecLocalID(string),IPsecPreSharedKey(string),IPsecRemoteID(string),LANInterface(string),RemoteHost(string),RemoteHostInterval(uint32),RemoteHostSubnet(string),WANInterface(string)
WOL¶
sendWakeOnLan(hostID, intf?, password?, broadcast?, retries?, interval?)✏️ 🌐 ✅
WireGuard¶
BaRtExport(usersetting?, changed?, data?)BaRtImport(data?)- Writable parameters:
Enable(bool)
WireGuard.Server¶
GeneratePrivateKey()- Writable parameters:
Alias(string),Enable(bool),ListenPort(uint16),ServerHostName(string),SubnetIPv4(string),SubnetOffsetIPv6(int64)
WireGuard.Server.default.Client¶
GeneratePrivateKeyAndGetQRConfig()- Writable parameters:
Alias(string),Enable(bool),ExtraData(string),IntranetAccess(bool),PreSharedKey(string),PublicKey(string)
WireGuard.Server.default.Client.{id}¶
GeneratePrivateKeyAndGetQRConfig()✅- Writable parameters:
Alias(string),Enable(bool),ExtraData(string),IntranetAccess(bool),PreSharedKey(string),PublicKey(string)
WireGuard.Server.default.Client.{id}.Error¶
ClearError()✏️
WireGuard.Server.{id}¶
GeneratePrivateKey()- Writable parameters:
Alias(string),Enable(bool),ListenPort(uint16),ServerHostName(string),SubnetIPv4(string),SubnetOffsetIPv6(int64)
WireGuard.Server.{id}.Error¶
ClearError()✏️
eventmanager¶
get_events(channelid?, events?)🌐 ✅open_channel(events?)🌐 ✅subscribe(channelid?, events?)🌐 ✅unsubscribe(channelid?, events?)🌐 ✅- Writable parameters:
message_servers(string)
sah.Device.Information¶
getSummary(deviceID?, deviceType?, friendlyName?, manufacturer?, manufacturerURL?, modelDescription?, modelName?, modelNumber?, modelURL?, serialNumber?, UDN?, UPC?)getVersion(deviceID?, softwareDate?, softwareVersion?, hardwareVersion?)