Cradlepoint
The Cradlepoint driver for HSYCO allows you to monitor the real-time status of the Cradlepoint IBR6xx series of routers.
Contents
HSYCO Configuration
Add a CRADLEPOINT I/O Server in the I/O Servers section of the Settings and set its parameters:
Communication
- IP Address: LAN IP address of the IBR6xx router
- IP Port: TCP/IP port to use for the SSH CLI (Command Line Interface), leave blank to use default port 22.
High Availability
- Shutdown when inactive: defaults to false.
Options
| ID | Default | Values | Description |
|---|---|---|---|
| startupevents | false | true | generate IO events also during the driver’s start-up phase |
| false | start generating events only after HSYCO is aligned with the current status of the system | ||
| query | /status/wan/connection_state /status/system/wan_signal_strength /status/wan/stats | space-separated pathnames | this parameter can be used to retrieve specific status data from the router. Use / to retrieve all data (note that using / the router will need several seconds to return all data, and the number of generated data points will be huge. You should specify the / full path only for development purposes |
Datapoints
The status information that the driver retrieves from the Cradlepoint router depends on the pathnames defined in the query option.
Refer to the CRADLEPOINT Router CLI Overview document for the description of the file system structure and the list of valid directories. Each directory contains status information that this driver translates into standard HSYCO data points.
When no query option is explicitly set, the driver retrieves all data located in the following directories:
- /status/wan/connection_state
- /status/system/wan_signal_strength
- /status/wan/stats
| ID | Value | R/W | Description |
|---|---|---|---|
| connection | online | R | connection established |
| offline | R | HSYCO can't connect to the router | |
| status.system.wan_signal_strength | 0..100 | R | wireless WAN connection signal strength |
| status.wan.connection_state | <status> | R | WAN connection status |
| status.wan.stats.bps | <number> | R | WAN total throughput in BPS |
| status.wan.stats.collisions | <number> | R | number of collisions on the WAN connection |
| status.wan.stats.ibps | <number> | R | WAN input throughput in BPS |
| status.wan.stats.idrops | <number> | R | wireless WAN input packets dropped |
| status.wan.stats.ierrors | <number> | R | wireless WAN input errors |
| status.wan.stats.imcasts | <number> | R | wireless WAN input multicast traffic |
| status.wan.stats.in | <number> | R | wireless WAN total input bytes of current connection |
| status.wan.stats.ipackets | <number> | R | wireless WAN total input packets of current connection |
| status.wan.stats.noproto | <number> | R | wireless WAN total no protocol packets |
| status.wan.stats.obps | <number> | R | WAN output throughput in BPS |
| status.wan.stats.oerrors | <number> | R | wireless WAN output errors |
| status.wan.stats.omcasts | <number> | R | wireless WAN output multicast traffic |
| status.wan.stats.opackets | <number> | R | wireless WAN total output packets of current connection |
| status.wan.stats.out | <number> | R | wireless WAN total output bytes of current connection |
| status.wan.stats.ts | <number> | R | wireless WAN current connection time in seconds (ignore the decimal part) |
| command | <command> | W | send a generic CLI command to the router. The <command> value is a text string exactly as specified in the CLI documentation |
| router | reboot | W | reboot the router |
Release Notes
3.7.0
- fixed error parsing data points returning long values
3.5.0
- performance improvements
3.4.0
- initial release
Cradlepoint is a registered trademark of CradlePoint Technology, Inc.
