Skip to main content

A library for interacting with Netgear Plus switches.

Project description

Python Library for NETGEAR Plus Switches

What it does

Grabs statistical network data from supported NETGEAR Switches from the Plus Managed Network Switch line. These switches can only be managed using a Web interface and not through SNMP or cli. This library uses web scraping to collect the switch configuration, statistics and some basic configuration updates.

How it works

  1. Detecting Switch Model/Product in login.cgi
  2. Connects to the Switch and asks for a cookie (http://IP_OF_SWITCH/login.cgi)
  3. HTTP-Request send to the Switch twice (http://IP_OF_SWITCH/portStatistics.cgi) and compared with previous data ("in response time")

List of port statistics

Name key from get_switch_infos() Unit
Port {port} Traffic Received port_{port}_traffic_rx_mbytes MB (in response time)
Port {port} Traffic Sent port_{port}_traffic_tx_mbytes MB (in response time)
Port {port} Receiving port_{port}_speed_rx_mbytes MB/s
Port {port} Transferring port_{port}_speed_tx_mbytes MB/s
Port {port} IO port_{port}_speed_io_mbytes MB/s
Port {port} Total Received port_{port}_sum_rx_mbytes MB (since last switch reboot/reset)
Port {port} Total Transferred port_{port}_sum_tx_mbytes MB (since last switch reboot/reset)
Port {port} Connection Speed port_{port}_connection_speed MB/s
Port {port} Status port_{port}_status "on"/"off"
Port {poe_port} POE Power port_{poe_port}_poe_power_active "on"/"off"

List of aggregated statistics

Sensor Name key from get_switch_infos() Unit
Switch IO sum_port_speed_bps_io MB/s
Switch Traffic Received sum_port_traffic_rx MB (in response time)
Switch Traffic Sent sum_port_traffic_tx MB (in response time)

Supported and tested NETGEAR Models/Products and firmware versions

Model Ports Firmware versions Bootloader versions
GS105E 5 ?
GS105Ev2 5 ? ?
GS105Ev3 5 ?
GS105PE 5 V1.6.0.17 V1.6.0.2-VB
GS108E 8 V1.00.11 V1.00.03
GS108Ev3 8 V2.00.05, V2.06.10, V2.06.17, V2.06.24 V2.06.01 - V2.06.03
GS110EMX 10 V1.0.2.8
GS305EP 5 V1.0.1.1
GS305EPP 5 V1.0.1.4
GS308EP 8 V1.0.0.10, V1.0.1.4
GS308EPP 8 V1.0.1.4
GS316EP 16 V1.0.4.4
GS316EPP 16 V1.0.4.4
JGS524Ev2 24 V2.6.0.48
XS512EM 12 V1.0.2.8

Supported firmware languages: GR (German), EN (English)

Unsupported models

Model Support status Firmware versions
GS108PEv3 In progress
GS105Ev2 Not yet started

HOWTO_Add_New_Models.md contains instructions to add unsupported models.

CLI usage

export NETGEAR_PLUS_PASSWORD=s3cr3t # replace with your password
ngp-cli login 192.168.178.68 # replace with IP address of your switch
ngp-cli status
ngp-cli logout
ngp-cli -h

Library Usage

Create a python virtual environment

python3 -m venv .venv
source .venv/bin/activate
pip install py-netgear-plus

Using this VENV go to your local source folder

Example calls

cd src
python3
ip = '192.168.178.68' # replace with IP address of your switch
p = 'fyce4gKZemkqjDY' # replace with your password
import py_netgear_plus
sw = py_netgear_plus.NetgearSwitchConnector(ip, p)
sw.autodetect_model()
sw.get_login_cookie()

data = sw.get_switch_infos()
print(sw.switch_model.MODEL_NAME)
print(data["port_1_sum_rx_mbytes"])
print(data)
sw.turn_off_poe_port(1) # Supported only on PoE capable models
sw.turn_on_poe_port(1)

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

py_netgear_plus-0.4.4.tar.gz (151.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

py_netgear_plus-0.4.4-py3-none-any.whl (29.5 kB view details)

Uploaded Python 3

File details

Details for the file py_netgear_plus-0.4.4.tar.gz.

File metadata

  • Download URL: py_netgear_plus-0.4.4.tar.gz
  • Upload date:
  • Size: 151.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.8

File hashes

Hashes for py_netgear_plus-0.4.4.tar.gz
Algorithm Hash digest
SHA256 4a127b15cdc544fa18565049de35766f780d164398f917e2e3ef2ba50700f861
MD5 c710db732f889caa5c9eeb0ecb2de5ca
BLAKE2b-256 6f9eade634e6a242684aff6c47d24d3459e2952a0cf039592532bd2f3cc131b8

See more details on using hashes here.

Provenance

The following attestation bundles were made for py_netgear_plus-0.4.4.tar.gz:

Publisher: release.yml on foxey/py-netgear-plus

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file py_netgear_plus-0.4.4-py3-none-any.whl.

File metadata

File hashes

Hashes for py_netgear_plus-0.4.4-py3-none-any.whl
Algorithm Hash digest
SHA256 ec7c01a5907d23dcc42d9afb1eb89eb84e572a0f23179a2dd13c148af99dedaf
MD5 511a8ac786d19de95c2374baf53317d9
BLAKE2b-256 350b3da0b9e31f478f943b55485ef01b038ab7adadb5c4ee54dbc8b63593bc4f

See more details on using hashes here.

Provenance

The following attestation bundles were made for py_netgear_plus-0.4.4-py3-none-any.whl:

Publisher: release.yml on foxey/py-netgear-plus

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page