How to configure wiremaps

Wiremaps configuration

The configuration of Wiremaps is done in /etc/wiremaps/wiremaps.cfg. You can use doc/wiremaps.cfg.sample to get started. The file uses YAML format which is pretty easy to understand. There are several sections.

Configuring the collector

The collector is the module that gathers information on different hosts using SNMPv2. Here are the recognized options:

• ips: The network to crawl with CIDR notation: 192.168.0.0/24 for 192.168.0.0 to 192.168.0.255. This item is mandatory. You can also use a list.
• parallel: The number of hosts to pool in parallel. Do not put this too low because when an host does not exist, Wiremaps can take up to 10 seconds to detect it. This item is mandatory.
• community: A list of community to use to query hosts with SNMP. For example: [public] or [public, anothercommunity]. If the first community does not match, Wiremaps will try the next one. This item is mandatory.
• expire: When a host is not updated after the given number of days, it is deleted from the database. The default value is 1 day.
• fdbexpire: How long to keep a non updated FDB entry, in hours. Default to 24.
• arpexpire: How long to keep a non updated ARP entry, in hours. Default to 24.
• bulk: Do we use GET_BULK (1) or GET_NEXT (0). GET_BULK is more performant. Default to 1.

Configuring the database

Here are the recognized options for database item:

• host: The server hosting the database. The default value is localhost.
• port: The port to connect to the server. The default value is 5432.
• username: The username to use to connect to the database. This item is mandatory.
• password: The password to use to connect to the database. This item is mandatory.
• database: The name of the database. This item is mandatory.

Configuring the web interface

The web section allows to customize the web interface.

• logo: The full path to the logo.