watchyourlan/docs/VLAN_ARP_SCAN.md

Passing arguments to arp-scan

1. IFACES

IFACES is a required variable for WYL to work. It can be set through GUI, config file or environment variables.
IFACES is a list of network interfaces to scan, space separated. For example

IFACES: "enp4s0 wlxf4ec3892dd51"

You can get a list of network interfaces by running ip link show or netstat -i. By default, the scan command will look like this:

arp-scan -glNx -I $ONE_IFACE

2. ARP_ARGS

Setting ARP_ARGS is optional. It can be set through GUI, config file or environment variables.
ARP_ARGS is additional arguments for arp-scan, that will be applied for every one of IFACES. For example:

ARP_ARGS: "-r 1"

arp-scan -glNx -r 1 -I $ONE_IFACE

See man arp-scan for all arguments available.

3. ARP_STRS for VLANs, docker0 and other complicated scans

If ARP_STRS is set, it will initiate a completely separate from IFACES scan.

Warning

ARP_STRS can be set only through GUI or config file. For environment (docker-compose) see ARP_STRS_JOINED.

ARP_STRS is a list of strings. arp-scan will run for each of them:

arp-scan $ONE_STRING

Every string must contain all information you need to pass to arp-scan. For example:

arp-scan -gNx 10.0.107.0/24 -Q 107 -I eth0

Where -Q is a vlan id. Warning: the last element of string (eth0 in this example) will be set as Interface for found hosts, so it is recommended to put interface at the end.

Setting ARP_STRS from config file:

arp_strs:
    - -gNx 172.17.0.1/24 -I docker0
    - -glNx -I virbr0

From GUI put one string in Arp Strings input field, click Save, then another empty string will appear.

4. ARP_STRS_JOINED

ARP_STRS_JOINED is a way to set ARP_STRS from ENV. It's a list of strings, comma separated, without spaces before or after comma.

ARP_STRS_JOINED: "-gNx 172.17.0.1/24 -I docker0,-gNx 10.0.107.0/24 -Q 107 -I eth0"

5. Examples

vlan id 107

ARP_STRS_JOINED: "-gNx 10.0.107.0/24 -Q 107 -I eth0"

docker0

ARP_STRS_JOINED: "-gNx 172.17.0.1/24 -I docker0"