Net::Ifconfig::Wrapper - provides a unified way to configure network interfaces on FreeBSD, OpenBSD, Solaris, Linux, OS X, and WinNT (from Win2K).
use Net::Ifconfig::Wrapper; my $rhInfo = Net::Ifconfig::Wrapper::Ifconfig('list');
This module provides a unified way to configure the network interfaces on FreeBSD, OpenBSD, Solaris, Linux, OS X, and WinNT (from Win2K) systems.
Only inet (IPv4) and ether (MAC) addresses are supported at this time
inet
ether
On Unix, this module calls the system ifconfig command to gather the information. On Windows, the functions from IpHlpAPI.DLL are called.
ifconfig
For all supported Unixes, Net::Ifconfig::Wrapper expects the ifconfig command to be /sbin/ifconfig.
Net::Ifconfig::Wrapper
/sbin/ifconfig
See the top-level README file for a list of tested OSes.
On the MSWin32 family, only Windows NT is supported. In the Windows NT family, only Windows 2000 or later is supported.
Ifconfig(Command, Interface, Address, Netmask);
The one and only method of the Net::Ifconfig::Wrapper module. Does all the jobs. The particular action is described by the $Command parameter.
$Command
$Command could be:
Ifconfig('list', '', '', '') will return a reference to a hash containing information about interfaces.
Ifconfig('list', '', '', '')
The structure of this hash is the following:
{IfaceName => {'status' => 0|1 # The status of the interface. 0 means down, 1 means up 'ether' => MACaddr, # The ethernet address of the interface if available 'descr' => Description, # The description of the interface if available 'inet' => {IPaddr1 => NetMask, # The IP address and his netmask, both are in AAA.BBB.CCC.DDD notation IPaddr2 => NetMask, ... }, ... };
Interface, Address, Netmask parameters are ignored.
The following shows what program is called for each OS:
/sbin/ifconfig -a
/sbin/ifconfig -A
GetAdaptersInfo function from IpHlpAPI.DLL
GetAdaptersInfo
IpHlpAPI.DLL
Known Limitations:
OpenBSD: /sbin/ifconfig -A command is not returning information about MAC addresses so we are trying to get it from '/usr/sbin/arp -a' command (first 'static' entry). If no one present the 'ff:ff:ff:ff:ff' address is returned.
'/usr/sbin/arp -a'
'static'
'ff:ff:ff:ff:ff'
MSWin32: GetAdaptersInfo function is not returning information about the interface which has address 127.0.0.1 bound to it, so we have no way to return it.
127.0.0.1
Not a limitation, but a small problem: in MSWin32, interface names are not human-readable, they look like {843C2077-30EC-4C56-A401-658BB1E42BC7} (on Win2K at least).
{843C2077-30EC-4C56-A401-658BB1E42BC7}
This function is used to set IPv4 address on interface. It is called as
Ifconfig('inet', $IfaceName, $Addr, $Mask);
$IfaceName is an interface name as displayed by 'list' command
$IfaceName
'list'
$Addr is an IPv4 address in the AAA.AAA.AAA.AAA notation
$Addr
AAA.AAA.AAA.AAA
$Mask is an IPv4 subnet mask in the MMM.MMM.MMM.MMM notation
$Mask
MMM.MMM.MMM.MMM
In order to accomplish this, the following actual ifconfig programs are called:
/sbin/ifconfig %Iface% inet %Addr% netmask %Mask% up
nothing :(
MSWin32: I did not find a reliable way to recognize the "main" address on the Win32 network interface, so I have disabled this functionality. If you know how, please let me know.
Just a synonym for 'inet'
'inet'
This function is used to bring specified interface down. It is called as
Ifconfig('inet', $IfaceName, '', '');
Last two arguments are ignored.
In order to accomplish this, the following programs are called:
/sbin/ifconfig %Iface% down
Sorry, this function is not possible.
MSWin32: I did not find the way to implement the 'up' command so I did not implement 'down'.
'up'
'down'
This function is used to set IPv4 alias address on interface. It have to be called as
Ifconfig('+alias', $IfaceName, $Addr, $Mask);
In order to accomplish this, the following ifconfig programs are called:
/sbin/ifconfig %Iface% inet %Addr% netmask %Mask% alias
/sbin/ifconfig %Iface%:%Logic% inet %Addr% netmask %Mask% up
AddIPAddress function from IpHlpAPI.DLL
AddIPAddress
First available logic interface is taken automatically for Solaris and Linux
Just a synonim for '+alias'
'+alias'
This function is used to remove IPv4 alias address from interface. It have to be called as
Ifconfig('-alias', $IfaceName, $Addr, '');
$IfaceName is an interface name as displayed by 'list' command.
$Addr is an IPv4 address in the AAA.AAA.AAA.AAA notation.
Last argument is ignored if present.
/sbin/ifconfig %Iface% inet %Addr% -alias
/sbin/ifconfig %Iface%:%Logic% down
DeleteIPAddress function from IpHlpAPI.DLL
DeleteIPAddress
Appropriate logic interface is obtained automatically for Solaris and Linux
On success, the Ifconfig(...) function returns the defined value. Actually, it is a reference to the array containing the output of the actual ifconfig program called.
Ifconfig(...)
In case of error, Ifconfig(...) returns 'undef' value, and the $@ variable contains the error message.
'undef'
$@
None by default.
Daniel Podolsky, <tpaba@cpan.org> As of 2015-11, maintained by Martin Thurn <mthurn@cpan.org>
ifconfig(8), Internet Protocol Helper in Platform SDK.
To install Net::Ifconfig::Wrapper, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Net::Ifconfig::Wrapper
CPAN shell
perl -MCPAN -e shell install Net::Ifconfig::Wrapper
For more information on module installation, please visit the detailed CPAN module installation guide.