.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.16) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is turned on, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .ie \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . nr % 0 . rr F .\} .el \{\ . de IX .. .\} .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "IPAddress 3pm" .TH IPAddress 3pm "2013-04-07" "perl v5.14.2" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" Net::IPAddress \- Functions used to manipulate IP addresses, masks and FQDN's. .SH "SYNOPSIS" .IX Header "SYNOPSIS" use Net::IPAddress; .PP \&\f(CW@ISA\fR = qw(Net::IPAddress); .SH "DESCRIPTION" .IX Header "DESCRIPTION" \&\f(CW\*(C`Net::IPAddr\*(C'\fR is a collection of helpful functions used to convert \s-1IP\s0 addresses to/from 32\-bit integers, applying subnet masks to \s-1IP\s0 addresses, validating \s-1IP\s0 address strings, and splitting a \s-1FQDN\s0 into its host and domain parts. .PP No rocket science here, but I have found these functions to very, very handy. For example, have you ever tried to sort a list of \s-1IP\s0 addresses only to find out that they don't sort the way you expected? Here is the solution! If you convert the \s-1IP\s0 addresses to 32\-bit integer addresses, they will sort in correct order. .IP "ip2num( \s-1STRING\s0 )" 4 .IX Item "ip2num( STRING )" Returns the 32\-bit integer of the passed \s-1IP\s0 address string. .Sp \&\f(CW\*(C`$ipnum\ =\ ip2num("10.1.1.1");\*(C'\fR \&\f(CW$ipnum\fR is 167837953. .IP "num2ip( \s-1INTEGER\s0 )" 4 .IX Item "num2ip( INTEGER )" Returns the \s-1IP\s0 address string of the passed 32\-bit \s-1IP\s0 address. .Sp \&\f(CW\*(C`$IP\ =\ num2ip(167837953);\*(C'\fR \&\f(CW$IP\fR is \*(L"10.1.1.1\*(R". .IP "validaddr( \s-1STRING\s0 )" 4 .IX Item "validaddr( STRING )" Returns true (1) if the \s-1IP\s0 address string is a valid and properly formatted \&\s-1IP\s0 address, and false (0) otherwise. .Sp \&\f(CW\*(C`$valid\ =\ validaddr("10.1.2.1");\*(C'\fR\ \ #\ returns\ true .Sp \&\f(CW\*(C`$valid\ =\ validaddr("10.1.2.");\*(C'\fR\ \ \ #\ returns\ false! .Sp If you have your own \s-1IP\s0 address validator, try the last one. Most will incorrectly compute that as a valid address. .IP "mask( \s-1IPADDRESS\s0, \s-1MASK\s0 )" 4 .IX Item "mask( IPADDRESS, MASK )" Returns the result of binary (\s-1IPADDRESS\s0 & \s-1MASK\s0). \s-1IPADDRESS\s0 can be either an \s-1IP\s0 address string or a 32\-bit integer address. \s-1MASK\s0 can be either an \s-1IP\s0 address string, or the number of bits in the mask. The returned value will be in the same format as the passed \s-1IP\s0 address. If you pass an \s-1IP\s0 address string, then an \s-1IP\s0 address string is returned, if you pass a 32\-bit integer address then a 32\-bit integer address is returned. .Sp Examples .RS 4 .Sp .RS 2 \&\f(CW\*(C`$subnet\ =\ mask("10.96.3.2",16);\*(C'\fR #\ \f(CW$subnet\fR\ =\ \*(L"10.96.0.0\*(R" .Sp \&\f(CW\*(C`$subnet\ =\ mask("10.21.4.22","255.240.0.0");\*(C'\fR #\ \f(CW$subnet\fR\ =\ \*(L"10.16.0.0\*(R" .Sp \&\f(CW\*(C`$subnet\ =\ mask(167837953,"255.255.255.0");\*(C'\fR #\ \f(CW$subnet\fR\ =\ 167837952> .RE .RE .RS 4 .Sp This function, when used with the others, is very useful for computing \s-1IP\s0 addresses. For example, you need to add another server to a subnet that an existing server is on. You want the new server to be the \*(L".17\*(R" address of a /24 subnet. This is done easily in the following example: .Sp .RS 2 \&\f(CW\*(C`use\ Net::IPAddress\*(C'\fR .Sp \&\f(CW\*(C`$server\ =\ "10.8.9.12";\*(C'\fR \&\f(CW\*(C`$newserver\ =\ num2ip(ip2num(mask($server,24))\ +\ 17);\*(C'\fR \&\f(CW\*(C`print\ "New\ server\ IP\ is\ $newserver\en";\*(C'\fR .Sp \&\f(CW\*(C`New\ server\ IP\ is\ 10.8.9.17\*(C'\fR .Sp The following code does exactly the same thing: .Sp \&\f(CW\*(C`use\ Net::IPAddress;\*(C'\fR .Sp \&\f(CW\*(C`$server\ =\ "10.8.9.12";\*(C'\fR \&\f(CW\*(C`$newserver\ =\ num2ip(mask(ip2num($server),24)\ +\ 17);\*(C'\fR \&\f(CW\*(C`print\ "New\ server\ IP\ is\ $newserver\en";\*(C'\fR .RE .RE .RS 4 .RE .IP "fqdn( \s-1FQDN\s0 )" 4 .IX Item "fqdn( FQDN )" This function returns the host and domain of the passed \s-1FQDN\s0 (fully qualified domain name). .Sp \&\f(CW\*(C`($host,$domain)\ =\ fqdn("www.cpan.perl.org");\*(C'\fR #\ \f(CW$host\fR\ =\ \*(L"www\*(R",\ \f(CW$domain\fR\ =\ \*(L"cpan.perl.org\*(R" .SH "EXPORTS" .IX Header "EXPORTS" \&\f(CW\*(C`Net::IPAddress\*(C'\fR exports five functions \f(CW\*(C`ip2num\*(C'\fR, \f(CW\*(C`num2ip\*(C'\fR, \f(CW\*(C`validaddr\*(C'\fR, \&\f(CW\*(C`mask\*(C'\fR, and \f(CW\*(C`fqdn\*(C'\fR. .SH "AUTHOR" .IX Header "AUTHOR" Scott Renner , .SH "COPYRIGHT" .IX Header "COPYRIGHT" Copyright(c) 2003\-2005 Scott Renner. All rights reserved. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.