Tools
- Get Bandwidth Test Server Settings
- Update Bandwidth Test Server Settings
- List Active Bandwidth Test Server Sessions
get_bandwidth_server
Get Bandwidth Test Server Settings · Risk: read
Reads bandwidth-test server configuration (/tool bandwidth-server print) — use to inspect whether the server is enabled, requires client authentication, and what session/port limits are active. For live in-progress tests use list_bandwidth_server_sessions. Returns the full settings block including enabled, authenticate, max-sessions, and allocate-udp-ports-from.
No tool-specific parameters.
update_bandwidth_server
Update Bandwidth Test Server Settings · Risk: write-idempotent
Configures the bandwidth-test server (/tool bandwidth-server set) — enables or disables the server, toggles client authentication, caps concurrent sessions, sets the UDP port allocation base and restricts client IP prefixes. An empty allowlist allows all clients; retain authentication and firewall restrictions. To inspect current values before changing them use get_bandwidth_server. Returns the updated settings block after applying changes.
Arguments:
enabled: accept incoming bandwidth-test sessions.
authenticate: require valid device credentials from test clients.
max_sessions: cap concurrent test sessions.
allocate_udp_ports_from: first UDP port used for test streams.
| Parameter | Required | Definition |
|---|---|---|
enabled | No | {"type":"boolean"} |
authenticate | No | {"type":"boolean"} |
max_sessions | No | {"type":"integer","minimum":1,"maximum":9007199254740991} |
allocate_udp_ports_from | No | {"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991} |
allowed_addresses4 | No | {"type":"array","items":{"anyOf":[{"type":"string","format":"ipv4","pattern":"^(?:(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9][0-9]|[0-9])\\.){3}(?:25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9][0-9]|[0-9])$"},{"type":"string","format":"cidrv4","pattern":"^((25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9][0-9]|[0-9])\\.){3}(25[0-5]|2[0-4][0-9]|1[0-9][0-9]|[1-9][0-9]|[0-9])\\/([0-9]|[1-2][0-9]|3[0-2])$"}]}} |
allowed_addresses6 | No | {"type":"array","items":{"anyOf":[{"type":"string","format":"ipv6","pattern":"^(([0-9a-fA-F]{1,4}:){7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:))$"},{"type":"string","format":"cidrv6","pattern":"^(([0-9a-fA-F]{1,4}:){7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:))\\/(12[0-8]|1[01][0-9]|[1-9]?[0-9])$"}]}} |
list_bandwidth_server_sessions
List Active Bandwidth Test Server Sessions · Risk: read
Lists currently active bandwidth-test server sessions (/tool bandwidth-server session print) — use to see in-progress tests accepted by this device's server side, including remote client usernames. Optionally filter by partial username with user_filter. To inspect or change the server's global settings use get_bandwidth_server or update_bandwidth_server. Returns zero or more active session records; empty when no tests are running.
| Parameter | Required | Definition |
|---|---|---|
user_filter | No | Partial user match {"type":"string"} |