Global

Type Definitions

allowedDevice

Properties:
Name Type Description
MAC string

e.g. '61:56:FA:1B:E1:21'
Name string

'--' for unknown
ConnectionType string

e.g. 'wired', '2.4GHz', 'Guest Wireless 2.4G'

allowedDevice is an object with these properties.

Example
// allowedDevice
{ MAC: '6F:A1:F8:04:9F:E2',
  Name: 'OPENELEC',
  ConnectionType: 'wireless' }

AttachedDevice

Properties:
Name Type Description
ip string

e.g. '10.0.0.10'
Name string

'--' for unknown.
NameUserSet boolean

e.g. false
MAC string

e.g. '61:56:FA:1B:E1:21'
ConnectionType string

e.g. 'wired', '2.4GHz', 'Guest Wireless 2.4G'
SSID string

e.g. 'MyWiFi'
LinkSpeed number

e.g. 38
SignalStrength number

number <= 100
AllowOrBlock string

e.g. 'Allow'
Schedule boolean

e.g. false
DeviceType number

e.g. 20
DeviceTypeUserSet boolean

e.g. true
DeviceTypeName string

e.g. ''
DeviceModel string

e.g. ''
DeviceModelUserSet boolean

e.g. false
Upload number

e.g. 0
Download number

e.g. 0
QosPriority number

e.g. 2
Grouping number

e.g. 0
SchedulePeriod number

e.g. 0
ConnAPMAC string

e.g. ''

Object representing the state of a device attached to the Netgear router, with properties similar to this.

Example
// AttachedDevice
{ IP: 192.168.1.24,
  Name: 'MyIPHONE',
  NameUserSet: true,
  MAC: 'E1:4F:25:68:34:BA',
  ConnectionType: '2.4GHz',
  SSID: 'MyNetworkID',
  Linkspeed: 70
  SignalStrength: 64,
  AllowOrBlock: 'Allow',
  Schedule: 'false',
  DeviceType: 17,
  DeviceTypeUserSet: true,
  DeviceTypeName: '',
  DeviceModelUserSet: false,
  Upload: 0,
  Download: 0,
  QosPriority: 3,
  Grouping: 0,
  SchedulePeriod: 0,
  ConnAPMAC: '' }

channels

channels is an array with the available wifi channels.

Example
// channels
[ 'Auto', '1', '2', '3', '4', '5', '6', '7', '8', '9', '10', '11', '12', '13' ]

currentSetting

Properties:
Name Type Description
Firmware: string

e.g. 'V1.0.2.60WW'
RegionTag string

e.g. 'R7800_WW'
Region string

e.g. 'ww'
Model string

e.g. 'R7800'
InternetConnectionStatus string

e.g. 'Up'
ParentalControlSupported string

e.g. '1'
SOAPVersion string

e.g. '3.43'
ReadyShareSupportedLevel string

e.g. '29'
XCloudSupported string

e.g. '1'
LoginMethod string

e.g. '2.0'
host string

e.g. '192.168.1.1'
port number

e.g. 80
TLS boolean

e.g. true

currentSetting is an object with properties similar to this.

Example
// currentSetting (depending on router type)
{ Firmware: 'V1.0.2.60WW',
  RegionTag: 'R7800_WW',
  Region: 'ww',
  Model: 'R7800',
  InternetConnectionStatus: 'Up',
  ParentalControlSupported: '1',
  SOAPVersion: '3.43',
  ReadyShareSupportedLevel: '29',
  XCloudSupported: '1',
  LoginMethod: '2.0',
  host: '192.168.1.1',
  port: 80
  TLS: false }

deviceConfig

Properties:
Name Type Description
BlankState string

e.g. '0'
NewBlockSiteEnable string

e.g. '0'
NewBlockSiteName string

e.g. '0'
NewTimeZone string

e.g. '+2'
NewDaylightSaving string

e.g. '1'

deviceConfig is an object with properties similar to this.

Example
// deviceConfig
{ BlankState: '0',
  NewBlockSiteEnable: '0',
  NewBlockSiteName: '0',
  NewTimeZone: '+2',
  NewDaylightSaving: '1' }

info

Properties:
Name Type Description
ModelName string

e.g. 'R7800'
Description string

e.g. 'Netgear Smart Wizard 3.0, specification 1.6 version'
SerialNumber string

e.g. '1LG23B71067B2'
Firmwareversion string

e.g. 'V1.0.2.60'
SmartAgentversion string

e.g. '3.0'
FirewallVersion string

e.g. 'net-wall 2.0'
VPNVersion string

e.g. undefined
OthersoftwareVersion string

e.g. 'N/A'
Hardwareversion string

e.g. 'R7800'
Otherhardwareversion string

e.g. 'N/A'
FirstUseDate string

e.g. 'Saturday, 20 Feb 2016 23:40:20'
DeviceName string

e.g. 'R7800'
FirmwareDLmethod string

e.g. 'HTTPS'
FirmwareLastUpdate string

e.g. '2018_10.23_11:47:18'
FirmwareLastChecked string

e.g. '2018_11.14_15:5:37'
DeviceMode string

e.g. '0' 0=router, 1=AP mode
DeviceModeCapability string

e.g. '0;1;2'
DeviceNameUserSet string

e.g. 'false'

info is an object with properties similar to this.

Example
// info (depending on router type)
{ ModelName: 'R7800',
  Description: 'Netgear Smart Wizard 3.0, specification 1.6 version',
  SerialNumber: '**********',
  Firmwareversion: 'V1.0.2.60',
  SmartAgentversion: '3.0',
  FirewallVersion: 'net-wall 2.0',
  VPNVersion: undefined,
  OthersoftwareVersion: 'N/A',
  Hardwareversion: 'R7800',
  Otherhardwareversion: 'N/A',
  FirstUseDate: 'Sunday, 30 Sep 2007 01:10:03',
  DeviceName: 'R7800',
  FirmwareDLmethod: 'HTTPS',
  FirmwareLastUpdate: '2018_10.23_11:47:18',
  FirmwareLastChecked: '2018_11.25_20:29:3',
  DeviceMode: '0',
  DeviceModeCapability: '0;1;2',
  DeviceNameUserSet: 'false' }

LANConfig

Properties:
Name Type Description
NewLANSubnet string

e.g. '255.255.255.0'
NewWANLAN_Subnet_Match string

e.g. '1'
NewLANMACAddress string

e.g. 'B07AB9A81D1A'
NewLANIP string

e.g. '192.168.0.1'
NewDHCPEnabled string

e.g. 'true'

LANConfig is an object with properties similar to this.

Example
// LANConfig
{ NewLANSubnet: '255.255.255.0',
  NewWANLAN_Subnet_Match: '1',
  NewLANMACAddress: 'B07FB9F81DEA',
  NewLANIP: '10.0.0.1',
  NewDHCPEnabled: 'true' }

logs

Properties:
Name Type Description
string string

the logentry as string
event string

the event type
info string

event information
ts object

timestamp of the event

logs is an array with the log events.

Example
// parsed logs
[	{	string: '[admin login] from source 10.0.0.2, Wednesday, October 02, 2019 20:00:41',
		event: 'admin login',
		info: 'from source 10.0.0.2',
		ts: 1570039241000 },
	{	string: '[DHCP IP: 10.0.0.3] to MAC address e1:4f:25:68:34:ba, Wednesday, October 02, 2019 20:00:39',
		event: 'DHCP IP: 10.0.0.3',
		info: 'to MAC address e1:4f:25:68:34:ba',
		ts: 1570039239000 },
	{	string: '[LAN access from remote] from 77.247.108.110:55413 to 10.0.0.5:443, Wednesday, October 02, 2019 19:59:39',
		event: 'LAN access from remote',
		info: 'from 77.247.108.110:55413 to 10.0.0.5:443',
		ts: 1570039179000 } ]

newFirmwareInfo

Properties:
Name Type Description
currentVersion string

e.g. 'V1.0.2.60'
newVersion string

e.g. ''
releaseNote string

e.g. ''

newFirmwareInfo is an object with these properties.

Example
// newFirmwareInfo
{ currentVersion: 'V1.0.2.60', newVersion: '', releaseNote: '' }

NTPservers

Properties:
Name Type Description
NTPServer1 string

e.g. 'time-g.netgear.com'
NTPServer2 string

e.g. 'time-g.netgear.com'
NTPServer3 string

e.g. 'time-g.netgear.com'
NTPServer4 string

e.g. 'time-g.netgear.com'

TimeZoneInfo is an object with these properties.

Example
// NTPservers
{
	NTPServer1: 'time-g.netgear.com',
	NTPServer2: 'time-g.netgear.com',
	NTPServer3: 'time-g.netgear.com',
	NTPServer4: 'time-g.netgear.com'
}

portMapping

Properties:
Name Type Description
NewPortMappingNumberOfEntries number

e.g. 0
NewPortMappingInfo object

e.g. undefined

portMapping is an object with properties similar to this.

Example
// portMapping
{ NewPortMappingNumberOfEntries: '0',
  NewPortMappingInfo: undefined }

sessionOptions

Properties:
Name Type Attributes Default Description
password string <optional>
 'password'

The login password. Defaults to 'password'.
username string <optional>
 'admin'

The login username. Defaults to 'admin'.
host string <optional>
 'routerlogin.net'

The url or ip address of the router. Leave undefined to try autodiscovery.
port number <optional>
 80

The SOAP port of the router. Leave undefined to try autodiscovery.
method number <optional>
 0

0: auto, 1: v1 (old), 2: v2 (new)
timeout number <optional>
 18000

http(s) timeout in milliseconds. Defaults to 18000ms.
tls boolean <optional>
 false

Use TLS/SSL (HTTPS) for SOAP calls. Defaults to false.

Set of configurable options to set on the router class

Example
// router options
{ password: 'mySecretPassword',
  host:'routerlogin.net',
  port: 5000,
  timeout: 19000,
  tls: false }

supportFeatureList

Properties:
Name Type Description
DynamicQoS string

e.g. '1.0'
OpenDNSParentalControl string

e.g. '1.0'
AccessControl string

e.g. '1.0'
SpeedTest string

e.g. '2.0'
GuestNetworkSchedule string

e.g. '1.0'
TCAcceptance string

e.g. '1.0'
DeviceTypeIdentification string

e.g. '1.0'
AttachedDevice string

e.g. '2.0'
NameNTGRDevice string

e.g. '1.0'
SmartConnect string

e.g. '2.0'
MaxMonthlyTrafficLimitation string

e.g. '4095000000'

supportFeatureList is an object with properties similar to this.

Example
// supportFeatureList (depending on router type)
{ DynamicQoS: '1.0',
  OpenDNSParentalControl: '1.0',
  AccessControl: '1.0',
  SpeedTest: '2.0',
  GuestNetworkSchedule: '1.0',
  TCAcceptance: '1.0',
  DeviceTypeIdentification: '1.0',
  AttachedDevice: '2.0',
  NameNTGRDevice: '1.0',
  SmartConnect: '2.0',
  MaxMonthlyTrafficLimitation: '4095000000' }

systemInfo

Properties:
Name Type Description
NewCPUUtilization number

e.g. 21
NewPhysicalMemory number

e.g. 256
NewMemoryUtilization number

e.g. 72
NewPhysicalFlash number

e.g. 128
NewAvailableFlash number

e.g. 128

systemInfo is an object with these properties.

Example
// systemInfo
{ NewCPUUtilization: 21,
  NewPhysicalMemory: 256,
  NewMemoryUtilization: 72,
  NewPhysicalFlash: 128,
  NewAvailableFlash: 128 }

timeZoneInfo

Properties:
Name Type Description
TimeZone string

e.g. '+1'
DaylightSaving string

e.g. '0'
IndexValue string

e.g. '19'

TimeZoneInfo is an object with these properties.

Example
// timeZoneInfo
{ TimeZone: '+1', DaylightSaving: '0', IndexValue: '19' }

trafficStatistics

Properties:
Name Type Description
newTodayUpload number

e.g. 561.29
newTodayDownload number

e.g. 5436
newMonthUpload number

e.g. 26909
newMonthDownload number

e.g. 151850

trafficStatistics is an object with these properties (in Mbytes).

Example
// trafficStatitics
{ newTodayUpload: 92.15,
  newTodayDownload: 743.3,
  newMonthUpload: 92.15,
  newMonthDownload: 743.3 }

WANConfig

Properties:
Name Type Description
NewEnable string

e.g. '1'
NewConnectionType string

e.g. 'DHCP'
NewExternalIPAddress string

e.g. '66.220.144.18'
NewSubnetMask string

e.g. '255.255.255.0'
NewAddressingType string

e.g. 'DHCP'
NewDefaultGateway string

e.g. '66.220.144.254'
NewMACAddress string

e.g. 'B07AB9A81D1B',
NewMACAddressOverride string

e.g. '0',
NewMaxMTUSize string

e.g. '1500',
NewDNSEnabled string

e.g. '1',
NewDNSServers string

e.g. '66.220.144.254'

WANConfig is an object with properties similar to this.

Example
// WANConfig
{ NewEnable: '1',
  NewConnectionType: 'DHCP',
  NewExternalIPAddress: '66.220.144.18',
  NewSubnetMask: '255.255.255.0',
  NewAddressingType: 'DHCP',
  NewDefaultGateway: '66.220.144.254',
  NewMACAddress: 'B07FB9F81DEB',
  NewMACAddressOverride: '0',
  NewMaxMTUSize: '1500',
  NewDNSEnabled: '1',
  NewDNSServers: '66.220.144.254' }

WANConnectionType

Properties:
Name Type Description
ConnectionType string

e.g. 'DHCP'

WANConnectionType is an object with these properties.

Example
// WANConnectionType
{ ConnectionType: 'DHCP' }

WANInternetPort

Properties:
Name Type Description
InternetPortInfo string

e.g. '1@1;Ethernet'

WANInternetPort is an object with these properties.

Example
// WANInternetPort
{ InternetPortInfo: '1@1;Ethernet' }