diff --git a/nselib/nmap.luadoc b/nselib/nmap.luadoc index a8ef7deab..8f4bd8581 100644 --- a/nselib/nmap.luadoc +++ b/nselib/nmap.luadoc @@ -84,29 +84,21 @@ function get_interface() -- This function takes a dnet-style interface name and returns a table -- containing the network information of the interface. -- +-- Keys of the returned table: +-- * device The interface name, can be an interface alias. +-- * shortname A simple short name of the device. +-- * netmask The netmask bits (CIDR) of the interface. +-- * address The string representing the IP address assigned to the interface. +-- * link The string representing the hardware type of the interface. Possible values are: "ethernet", "loopback", "p2p" or "other". +-- * mac MAC address (six-byte-long binary string) of the interface if the type of the interface is "ethernet", otherwise it is nil. +-- * broadcast The string representing the broadcast address assigned to the interface if the interface type is "ethernet" and if the used address is IPv4, otherwise it is nil. +-- * up The state of the interface, possible values are "up" or "down". +-- * mtu The MTU size of the interface. +-- -- @param interface_name The name of the interface. -- @return Table containing the network information of the interface on -- success, or nil and an error message on failures. -- @usage local iface, err = nmap.get_interface_info("eth0") --- --- Keys of the returned table: --- device The interface name, can be an interface aliase. --- shortname A simple short name of the device. --- netmask The netmask bits (CIDR) of the interface. --- address The string representing the IP address assigned --- to the interface. --- link The string representing the hardware type of the --- interface. Possible values are: "ethernet", --- "loopback", "p2p" or "other". --- mac MAC address (six-byte-long binary string) of the --- interface if the type of the interface is "ethernet", --- otherwise it is nil. --- broadcast The string representing the broadcast address --- assigned to the interface if the interface type is "ethernet" --- and if the used address is IPv4, otherwise it is nil. --- up The state of the interface, possible values are: --- "up" or "down". --- mtu The MTU size of the interface. function get_interface_info(interface_name) --- Searches for the specified file and returns a string containing its path if