]> git.ipfire.org Git - thirdparty/pdns.git/commitdiff
dnsdist: Document the return value of getMACAddress()
authorRemi Gacogne <remi.gacogne@powerdns.com>
Mon, 23 May 2022 11:30:06 +0000 (13:30 +0200)
committerRemi Gacogne <remi.gacogne@powerdns.com>
Mon, 23 May 2022 11:30:06 +0000 (13:30 +0200)
As suggested by Otto.

pdns/dnsdistdist/docs/reference/config.rst

index 32d8d4aef98fd40d32b6dfce723dfeb58769d4b5..c652674c16b42a7a1ff310b5304773eb3626dc78 100644 (file)
@@ -986,11 +986,12 @@ Status, Statistics and More
   Return the list of network interfaces configured on the system, as strings.
   This function requires support for ``getifaddrs``, which is known to be present on FreeBSD, Linux, and OpenBSD at least.
 
-.. function:: getMACAddress(ip)
+.. function:: getMACAddress(ip) -> str
 
   .. versionadded:: 1.8.0
 
   Return the link-level address (MAC) corresponding to the supplied neighbour IP address, if known by the kernel.
+  The link-level address is returned as a raw binary string. An empty string is returned if no matching entry has been found.
   This function is only implemented on Linux.
 
   :param str ip: The IP address, IPv4 or IPv6, to look up the corresponding link-level address for.