Docs Reference
Command-line options
Every option of the collector program.
The launchers and installers set these for you. Run netmap -h for the built-in list.
| Option | Default | Meaning |
|---|---|---|
-collector |
sim |
Data source: snmp for real devices, sim for the simulated network, replay for recorded SNMP walks. |
-addr |
127.0.0.1:8000 |
Where the web UI listens. |
-tls-cert, -tls-key |
PEM certificate and key: serve the web UI over HTTPS. | |
-hosts |
Comma-separated DNS names the web UI may be reached by (IP addresses and localhost always work). |
|
-ssh |
127.0.0.1:2222 |
SSH session broker address; off turns it off. |
-snmp-config |
<data>/snmp.json |
Collector configuration file. |
-syslog |
from snmp.json |
UDP syslog address, such as 0.0.0.0:514; off turns it off. |
-poll |
10 |
Poll interval in seconds for the simulator. With real devices, use interval_s in snmp.json. |
-replay |
testdata/walks |
Folder of recorded walks for -collector replay. |
-ui |
Serve the web UI from a folder instead of the built-in copy (development). |
| Environment variable | Meaning |
|---|---|
NETMAP_DATA |
The data folder (default data in the working directory). |
Examples:
# real devices, this machine only
netmap -collector snmp
# real devices over HTTPS for the network, with syslog and the SSH broker reachable
netmap -collector snmp -addr 0.0.0.0:8443 -tls-cert lantern.crt -tls-key lantern.key -hosts lantern.northwind.local -ssh 0.0.0.0:2222
# the simulated network, its data kept apart
NETMAP_DATA=./data-demo netmap -collector sim