Context API
The following context variables are readonly.
DSC
Type | Method | Description |
---|---|---|
boolean |
context.dsc.existsScalarByOid(oid) |
Checks whether the given scalar exists by oid. |
boolean |
context.dsc.existsScalarByAlias(alias) |
Checks whether the given scalar exists by alias. |
boolean |
context.dsc.existsTableByOid(oid) |
Checks whether the given Table exists via oid. |
boolean |
context.dsc.existsTableByAlias(alias) |
Checks whether the given Table exists via alias. |
Network
Type | Method | Description |
---|---|---|
<SsidObj>[] |
context.network.ssids |
Map of SSID objects indexed by its name (usage see next lines). |
string[] |
context.network.ssids[<SSID>].ifcNumber |
List with interface numbers for SSID. |
string[] |
context.network.ssids[<SSID>].ifcName |
List with interface names for SSID. |
string |
context.network.ssids[<SSID>].radiusName |
Radius name for SSID. |
string |
context.network.ssids[<SSID>].name |
The SSID (always same as |
string |
context.network.name |
Network name |
string |
context.network.configName |
Network configuration name |
string |
context.network.configNameLong |
Long network configuration name |
string |
context.network.ifcNumber |
Network interface number |
string |
context.network.tag |
Network Vlan Id |
string |
context.network.vpnGateway |
Central Site Gateway address |
string[] |
context.network.vpnConnections |
List of peer ident names for vpn connetions |
<Variables> |
context.network.vpnSiteVars[<SubnetGroupConfigName> or <PeerIdent>] |
User variablen for vpn location |
string |
context.network.vpnCredentials[<SubnetGroupConfigName> or <PeerIdent>].remote.identity |
VPN remote identity for site |
string |
context.network.vpnCredentials[<SubnetGroupConfigName> or <PeerIdent>].remote.psk |
VPN remote psk for site |
string |
context.network.vpnCredentials[<SubnetGroupConfigName> or <PeerIdent>].local.identity |
VPN local identity for site |
string |
context.network.vpnCredentials[<SubnetGroupConfigName> or <PeerIdent>].local.psk |
VPN local psk for site |
string |
context.network.vpnRemoteData[peerName].subnetMask |
|
string |
context.network.vpnRemoteData[peerName].subnetId |
|
boolean |
context.network.isCentralGateway |
true if vpn & gateway & central-site |
boolean |
context.network.isBranchGateway |
true if vpn & gateway & not central-site |
number |
context.network.gatewayNumber |
gateway number |
<DevRolObj> |
context.network.deviceRoles |
return device roles object (usage see next 2 lines) |
boolean |
context.network.deviceRoles.contains(role string) |
Check if device has role gateway with GW , access point with AP or switch with SW |
string[] |
context.network.deviceRoles.list() |
Get list of device roles, e.g. {"GW", "AP", "SW"} |
Device
Type | Method | Description |
---|---|---|
boolean |
context.device.isGateway |
true if device is gateway |
boolean |
context.device.isAccesspoint |
true if device is accesspoint |
boolean |
context.device.isSwitch |
true if device is switch |
number |
context.device.firmwareVersion |
Firmware version without build number as double value |
number |
context.device.firmwareVersionWithBuild |
Firmware version with build number as double value |
string |
context.device.firmwareVersionString |
Firmware version as string |
Object |
context.device.firmwareVersionObject |
Firmware version as object:{ major: number, minor: number, patch: number } |
string |
context.device.type |
Device type string |
<Features> |
context.device.features |
Feature object (usage see next line) |
boolean |
context.device.features.supports(int) |
Checks whether a feature with given ID is supported, e.g. 43 for feature LAN bridge |
string |
context.device.macAddress |
MAC Address for LAN interface. (Added April 2022. Requires device reboot before use.) |
string |
context.device.serialNumber |
Serial number of the device (Added April 2022. Requires device reboot before use.) |
Location
Type | Method | Description |
---|---|---|
string |
context.location.configName |
Location configuration name |
string |
context.location.subnetId |
Network ID at location, for example 192.168.1.0 |
string |
context.location.subnetMask |
Subnet mask |
string |
context.location.gatewayIp |
Routing IP address to Central Site, if device Role is Gateway, else null |
string[] |
context.location.gatewayIps |
Returns IP addresses of all location gateways. |