PoshFunctions

2.2.9

Functions/Test-IsValidIPv4.ps1

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
 function Test-IsValidIPv4 {
<#
.SYNOPSIS
    Verifies if passed parameter is a valid IP v4 address
.DESCRIPTION
    Verifies if passed parameter is a valid IP v4 address. Can take single string or array of strings.
    Can also accept input from the pipeline. Function aliased to 'Test-IsValidIP'
.EXAMPLE
    Test-IsValidIPv4 '10.0.0.1'
.EXAMPLE
    Test-IsValidIPv4 '10.0.0.1' -Verbose
 
    VERBOSE: The string being tested if a valid IPv4 address is [10.0.0.1]
    True
.EXAMPLE
    '192.168.1.1','invalid' | Test-IsValidIPv4 -IncludeInput
 
    Input Result
    ----- ------
    192.168.1.1 True
    invalid False
#>

    #region Param
    [CmdletBinding(ConfirmImpact='None')]
    [Outputtype('bool')]
    [alias('Test-IsValidIP')]
    Param (
        [parameter(ValueFromPipeLine, ValueFromPipeLineByPropertyName)]
        [Alias('IP')]
        [string[]] $IPAddress,
        [switch] $IncludeInput
    )
    #endregion Param

    begin {
        Write-Verbose -Message "Starting [$($MyInvocation.Mycommand)]"
    }

    process {
        foreach ($i in $IPAddress) {
            Try {
                Write-Verbose -Message "The string being tested if a valid IPv4 address is [$i]"
                $check = [ipaddress] $i
                # added check below to cover issue if enter only 3 octets
                # [ipaddress] "10.1.4" resolves to "10.1.0.4"
                if ($i -eq $check) {
                    if ($IncludeInput) {
                        New-Object -TypeName psobject -Property ([ordered] @{Input = "$i"; Result = $true })
                    } else {
                        Write-Output -InputObject $true
                    }
                } else {
                    if ($IncludeInput) {
                        New-Object -TypeName psobject -Property ([ordered] @{Input = "$i"; Result = $false })
                    } else {
                        Write-Output -InputObject $false
                    }
                }
            } Catch {
                if ($IncludeInput) {
                    New-Object -TypeName psobject -Property ([ordered] @{Input = "$i"; Result = $false })
                } else {
                    Write-Output -InputObject $false
                }
            }
        }
    }

    end {
        Write-Verbose -Message "Ending [$($MyInvocation.Mycommand)]"
    }
}