SendNetworkPing.psm1

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
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149

#
#
# Send Network Ping Module
#
#


$ErrorActionPreference = 'Stop'


#
# Module functions
#


Function Send-NetworkPing {

    <#
 
     .SYNOPSIS
     Send a ping to a computer
 
     .DESCRIPTION
     Send a ping to a computer
 
     .PARAMETER ComputerName
     The target to ping
 
     .PARAMETER TimeOut
     The time in milliseconds to wait for a response
 
     .PARAMETER Quiet
     Switch to omit output (just receive a TRUE or FALSE response)
 
     .EXAMPLE
     Send-NetworkPing -ComputerName www.powershellgallery.com
 
     .EXAMPLE
     Send-NetworkPing -ComputerName LabPC2064 -Quiet
 
     .EXAMPLE
     Send-NetworkPing -ComputerName LabPC2064 -Quiet -TimeOut 200
 
     .NOTES
     N/A
 
     .LINK
     N/A
 
    #>


    Param (

        [Parameter(Mandatory = $True,
                   ValueFromPipeline = $True,
                   ValueFromPipelineByPropertyName = $True,
                   HelpMessage = 'Enter computer name'
                  )
        ]

        [String[]]$ComputerName,

        [Parameter(Mandatory = $False,
                   ValueFromPipeline = $True,
                   ValueFromPipelineByPropertyName = $True,
                   HelpMessage = 'Enter timeout'
                  )
        ]

        [Int]$TimeOut = 100,

        [Switch]$Quiet

    )

    BEGIN {

        $PingObj = New-Object System.Net.NetworkInformation.Ping

        Function Show-Output ($Values) {

            If ($Null -eq $Values[1]) {

                $Values[1] = 'Unreachable'

            }

            [PSCustomObject]@{

                ComputerName = $Values[0]
                Status = $Values[1].ToString()
                IPAddress = $Values[2]

            }

        }

    }

    PROCESS {

        ForEach ($Computer In $ComputerName) {

            Try {

                $PingReply = $PingObj.Send($Computer, $TimeOut)

                If ($Quiet) {

                    Write-Output $True

                }

                Else {

                    Show-Output ($Computer.ToUpper(), $PingReply.Status, $PingReply.Address)

                    $PingReply = $Null

                }

            }

            Catch {

                If ($Quiet) {

                    Write-Output $False

                }

                Else {

                    Show-Output ($Computer.ToUpper(), $PingReply.Status, $PingReply.Address)

                    $PingReply = $Null

                }

            }

        }

    }

    END {}

}