ArpExe

class getmac.getmac.ArpExe

Bases: Method

Query the Windows ARP table using arp.exe to find the MAC address of a remote host. This only works for IPv4, since the ARP table is IPv4-only.

Microsoft Documentation: arp <https://learn.microsoft.com/en-us/windows-server/administration/windows-commands/arp>

Attributes Summary

method_type	The type of method, e.g. does it get the MAC of a interface.
platforms	Platforms supported by a method.

Methods Summary

get(arg)	Core logic of the method that performs the lookup.
test()	Low-impact test that the method is feasible, e.g. a command exists.

Attributes Documentation

method_type: str = 'ip4'

The type of method, e.g. does it get the MAC of a interface.

Allowed values:

• ip

• ip4

• ip6

• iface

• default_iface

platforms: Set[str] = {'windows', 'wsl'}

Platforms supported by a method.

Methods Documentation

get(arg)

Core logic of the method that performs the lookup.

Warning

If the method itself fails to function an exception will be raised! (for instance, if some command arguments are invalid, or there’s an internal error with the command, or a bug in the code).

Parameters:

arg (str) – What the method should get, such as an IP address or interface name. In the case of default_iface methods, this is not used and defaults to an empty string.

Return type:

Optional[str]

Returns:

Lowercase colon-separated MAC address, or None if one could not be found.

test()

Low-impact test that the method is feasible, e.g. a command exists.

Return type:

bool