IPerfAutomate.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
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
$thisModule = Get-Module -ListAvailable -Name 'iPerfAutomate'

$iperfFileName = 'iperf3.exe'
$Defaults = @{
    IPerfSharedFolderPath       = $thismodule.ModuleBase
    EmailNotificationRecipients = 'foo@var.com', 'ghi@whaev.com'
    SmtpServer                  = 'foo.test.local'
    InvokeIPerfPSSessionSuffix  = 'iPerf'
}

$SiteServerMap = @{
    '<YourSiteHere1>' = '<AHostAtThisSite>'
    '<YourSiteHere2>' = '<AHostAtThisSite>'
    
}

Set-StrictMode -Version Latest

function ConvertToUncPath {
    [OutputType([string])]
    [CmdletBinding()]
    param (
        [Parameter(Mandatory)]
        [string]$LocalFilePath,

        [Parameter(Mandatory)]
        [string]$ComputerName
    )

    $RemoteFilePathDrive = ($LocalFilePath | Split-Path -Qualifier).TrimEnd(':')
    "\\$ComputerName\$RemoteFilePathDrive`$$($LocalFilePath | Split-Path -NoQualifier)"
}

function TestServerAvailability {
    [OutputType([pscustomobject])]
    [CmdletBinding()]
    param
    (
        [Parameter(Mandatory)]
        [ValidateNotNullOrEmpty()]
        [string[]]$ComputerName
    )
    begin {
        $ErrorActionPreference = 'Stop'
    }
    process {
        try {
            foreach ($computer in $ComputerName) {
                $output = @{
                    ComputerName = $computer
                    Online       = $false
                }
                if (Test-Connection -ComputerName $computer -Quiet -Count 1) {
                    $output.Online = $true
                }
                [pscustomobject]$output
            }
        } catch {
            $PSCmdlet.ThrowTerminatingError($_)
        }
    }
}

function InvokeIperf {
    [OutputType([void])]
    [CmdletBinding()]
    param
    (
        [Parameter(Mandatory)]
        [ValidateNotNullOrEmpty()]
        [string[]]$ComputerName,

        [Parameter()]
        [ValidateNotNullOrEmpty()]
        [string]$Arguments
    )
    begin {
        $ErrorActionPreference = 'Stop'
    }
    process {
        try {
            $iperfServerFilePath = Join-Path -Path $Defaults.IPerfSharedFolderPath -ChildPath $iperfFileName

            $mode = ConvertArgsToMode -IPerfArgs $Arguments

            $icmParams = @{
                ComputerName = $ComputerName
                ArgumentList = $iperfServerFilePath, $Arguments
            }

            if ($mode -eq 'Server') {
                ## Do not invoke server mode for servers that already have it running
                if ($runningServers = @($ComputerName).where({ Test-IPerfServer -ComputerName $_ })) {
                    Write-Verbose -Message "The server(s) [$(($runningServers -join ','))] are already running."
                    [string[]]$ComputerName = @($ComputerName).where({ $_ -notin $runningServers})
                }
                $icmParams.InDisconnectedSession = $true
            }

            Write-Verbose -Message "Invoking iPerf in [$($mode)] mode on computer(s) [$ComputerName] using args [$($Arguments)]..."
            $ComputerName | ForEach-Object {
                if ($mode -eq 'Server') {
                    $icmParams.SessionName = "$_ - $mode - $($Defaults.InvokeIPerfPSSessionSuffix)"
                }
                Invoke-Command @icmParams -ScriptBlock {
                    $VerbosePreference = 'Continue'
                    ## Convert to short name so that IEX doesn't puke when using quotes
                    $fileShortPath = (New-Object -com scripting.filesystemobject).GetFile($args[0]).ShortPath
                    $cliString = "$fileShortPath $($args[1])"
                    Invoke-Expression -Command $cliString
                }
            }
        } catch {
            $PSCmdlet.ThrowTerminatingError($_)
        }
    }
}

function StartIperfServer {
    [OutputType([void])]
    [CmdletBinding()]
    param
    (
        [Parameter(Mandatory)]
        [ValidateNotNullOrEmpty()]
        [string[]]$ComputerName
    )
    begin {
        $ErrorActionPreference = 'Stop'
    }
    process {
        try {
            if ($runningServers = @($ComputerName).where({ Test-IPerfServer -ComputerName $_ })) {
                Write-Verbose -Message "The server(s) [$(($runningServers -join ','))] are already running."
                $ComputerName = @($ComputerName).where({ $_ -notin $runningServers})
            }

            $null = InvokeIperf -ComputerName $ComputerName -Arguments '-s'
        } catch {
            $PSCmdlet.ThrowTerminatingError($_)
        }
    }
}

function ConvertArgsToMode {
    [OutputType([string])]
    [CmdletBinding()]
    param
    (
        [Parameter(Mandatory)]
        [ValidateNotNullOrEmpty()]
        [string]$IPerfArgs
    )
    switch ($IPerfArgs) {
        '-s' {
            'Server'
        }
        {$_ -like '*-c*'} {
            'Client'
        }
        default {
            throw "Unrecognized input: [$_]"
        }
    }
}

function StopIPerfServer {
    [OutputType([void])]
    [CmdletBinding()]
    param
    (
        [Parameter(Mandatory)]
        [ValidateNotNullOrEmpty()]
        [string[]]$ComputerName
    )
    begin {
        $ErrorActionPreference = 'Stop'
    }
    process {
        try {
            $icmParams = @{
                ComputerName = $ComputerName
                ScriptBlock  = { Get-Process -Name $args[0] -ErrorAction SilentlyContinue | Stop-Process }
                ArgumentList = [System.IO.Path]::GetFileNameWithoutExtension($iperfFileName)
            }
            Invoke-Command @icmParams
        } catch {
            $PSCmdlet.ThrowTerminatingError($_)
        } finally {
            $ComputerName | ForEach-Object {
                Get-PSSession -Name "$_ - Server*" -ErrorAction SilentlyContinue | Remove-PSSession
            }
            
        }
    }
}

function Test-IPerfServer {
    [OutputType([bool])]
    [CmdletBinding()]
    param
    (
        [Parameter(Mandatory)]
        [ValidateNotNullOrEmpty()]
        [string]$ComputerName
    )
    begin {
        $ErrorActionPreference = 'Stop'
    }
    process {
        try {
            $cimParams = @{
                ComputerName = $ComputerName
                ClassName    = 'Win32_Process'
                Filter       = "Name = 'iperf3.exe'"
                Property     = 'CommandLine'
            }
            if (($serverProc =  Get-CimInstance @cimParams) -and ($serverProc.CommandLine -match '-s$')) {
                $true
            } else {
                $false
            }
        } catch {
            $PSCmdlet.ThrowTerminatingError($_)
        }
    }
}

function New-IperfSchedule {
    <#
        .SYNOPSIS
            This function find the server mapped to FromSite and creates one or more Windows scheduled task on that server to
            kick off Iperf pointed to all of the sites specified. If more than one site is specified in ToSite, it will
            create that respective number of scheduled tasks.

        .PARAMETER FromSite
             A mandatory string parameter representing a single Viega site. This can be Reno, Mchpherson, Wichita, Carlisle,
             McDonough,Nashua or Broomfield. This is the site in which Iperf will be invoked from.

        .PARAMETER ToSite
             A mandatory string parameter representing a single Viega site. This can be Reno, Mchpherson, Wichita, Carlisle,
             McDonough,Nashua or Broomfield. This is the site IPerf will reach out to.

        .PARAMETER Daily
             A optional bool parameter to use if the scheduled task is to be executed every day. By default, this is set
             to $true.

        .PARAMETER Time
             A optional datetime parameter representing the time to kick off the scheduled task(s). By default, this is set
             to 6AM.
    
        .EXAMPLE
            PS> New-IperfSchedule -FromSite Reno -ToSite 'Mchpherson','Carlisle','Nashua'
    
    #>

    [OutputType([void])]
    [CmdletBinding()]
    param
    (
        [Parameter(Mandatory, ParameterSetName = 'Site')]
        [ValidateNotNullOrEmpty()]
        [ValidateSet('Reno', 'Mcpherson', 'Wichita', 'Carlisle', 'McDonough', 'Nashua', 'Broomfield')]
        [string]$FromSite,

        [Parameter(Mandatory, ParameterSetName = 'Site')]
        [ValidateNotNullOrEmpty()]
        [ValidateSet('Reno', 'Mcpherson', 'Wichita', 'Carlisle', 'McDonough', 'Nashua', 'Broomfield')]
        [string[]]$ToSite,

        [Parameter(Mandatory, ParameterSetName = 'Server')]
        [ValidateNotNullOrEmpty()]
        [string]$FromServerName,

        [Parameter(Mandatory, ParameterSetName = 'Server')]
        [ValidateNotNullOrEmpty()]
        [string[]]$ToServerName,

        [Parameter()]
        [ValidateNotNullOrEmpty()]
        [bool]$Daily = $true,

        [Parameter()]
        [ValidateNotNullOrEmpty()]
        [datetime]$Time = '06:00'
    )
    begin {
        $ErrorActionPreference = 'Stop'
    }
    process {
        try {
            if ($PSCmdlet.ParameterSetName -eq 'Site') {
                $ToServerName = $ToSite | ForEach-Object { $SiteServerMap.$_ }
                $FromServerName = $SiteServerMap.$FromSite
            }

            $localIperfFilePath = Join-Path -Path $Defaults.IPerfSharedFolderPath -ChildPath $iperfFileName

            ## Ensure the latest copy is on the remote computer
            Install-IperfModule -ComputerName $FromServerName
            
            Invoke-Command -ComputerName $FromServerName -ScriptBlock {
                $trigParams = @{
                    At = $args[3]
                }
                if ($args[2]) {
                    $trigParams.Daily = $true
                }
                $trigger = New-ScheduledTaskTrigger @trigParams
                $settings = New-ScheduledTaskSettingsSet
                
                $toServers = $args[1]
                $psCommand = "
                    try {
                        `$results = Start-IPerfMonitorTest -FromServerName $(hostname) -ToServerName $toServers;
                        Send-MailMessage -SmtpServer $($Defaults.SmtpServer) -To $($args[4]) -From `"Network Test From $(hostname) to $($args[1] -join ',')`" -Subject 'Network Monitor Test' -Body `$results
                    } catch {
                        Add-Content -Path `$env:TEMP\IperfMonitor.log -Value `$_.Exception.Message;
                        `$Host.SetShouldExit(1)
                    } finally {
                        Add-Content -Path `$env:TEMP\IperfMonitor.log -Value `$results;
                    }
                "

                $action = New-ScheduledTaskAction -Execute 'powershell.exe' -Argument "-NoProfile -NonInteractive -WindowStyle Hidden -ExecutionPolicy Unrestricted -Command `"$psCommand`""
                $task = New-ScheduledTask -Action $action -Trigger $trigger -Settings $settings
                Register-ScheduledTask "IPerf Network Test - [$($args[1] -join ',')]" -InputObject $task
            } -ArgumentList $localIperfFilePath, $ToServerName, $Daily, $Time, $Defaults.EmailNotificationRecipients
        } catch {
            $PSCmdlet.ThrowTerminatingError($_)
        }
    }
}

function Install-IPerfModule {
    [OutputType([void])]
    [CmdletBinding()]
    param
    (
        [Parameter(Mandatory)]
        [ValidateNotNullOrEmpty()]
        [string]$ComputerName
    )
    begin {
        $ErrorActionPreference = 'Stop'
    }
    process {
        try {
            $modulePath = ConvertToUncPath -LocalFilePath $Defaults.IPerfSharedFolderPath -ComputerName $ComputerName
            Write-Verbose -Message "Copying IPerf module to [$($modulePath)]..."
            if ($PSScriptRoot -eq 'iPerfAutomate') {
                $path = $PSScriptRoot
            } else {
                $path = $PSScriptRoot | Split-Path -Parent
            }
            Copy-Item -Path $PSScriptRoot -Destination $modulePath -Recurse -Force
        } catch {
            $PSCmdlet.ThrowTerminatingError($_)
        }
    }
}

function NewTestFile {
    [OutputType([System.IO.FileInfo])]
    [CmdletBinding()]
    param
    ()
    
    $testFilePath = "$env:temp\testfile.txt"
    $file = [IO.File]::Create($testFilePath)
    $file.SetLength((Invoke-Expression -Command $FileSize))
    $file.Close()
    Get-Item -Path $testFilePath
}

function Start-IPerfMonitorTest {
    <#
        .SYNOPSIS
            This function invokes Iperf from the server at site FromSite to all of the sites specified in ToSite.

        .PARAMETER FromSite
             A mandatory string parameter representing a single Viega site. This can be Reno, Mchpherson, Wichita, Carlisle,
             McDonough,Nashua or Broomfield. This is the site that IPerf will be invoked from.
            
        .PARAMETER ToSite
             A mandatory string parameter representing a single Viega site. This can be Reno, Mchpherson, Wichita, Carlisle,
             McDonough,Nashua or Broomfield. This is the site(s) that Iperf will connect to.

        .EXAMPLE
            PS> Start-IPerfMonitorTest -FromSite Reno -ToSite 'Wichita','Broomfield'
    
    #>

    [OutputType([void])]
    [CmdletBinding()]
    param
    (
        [Parameter(Mandatory, ParameterSetName = 'Site')]
        [ValidateNotNullOrEmpty()]
        [string]$FromSite,

        [Parameter(Mandatory, ParameterSetName = 'Site')]
        [ValidateNotNullOrEmpty()]
        [string[]]$ToSite,

        [Parameter(Mandatory, ParameterSetName = 'Server')]
        [ValidateNotNullOrEmpty()]
        [string]$FromServerName,

        [Parameter(Mandatory, ParameterSetName = 'Server')]
        [ValidateNotNullOrEmpty()]
        [string[]]$ToServerName,

        [Parameter()]
        [ValidateNotNullOrEmpty()]
        [ValidateScript({
                if ($_ -notmatch 'KB$') {
                    throw "FileSize must end with 'KB' to indicate kilobytes"
                } else {
                    $true
                }
            })]
        [string]$WindowSize = '712KB',

        [Parameter()]
        [ValidateNotNullOrEmpty()]
        [ValidateScript({
                if ($_ -notmatch 'MB$') {
                    throw "FileSize must end with 'MB' to indicate megabytes"
                } else {
                    $true
                }
            })]
        [string]$FileSize
    )
    begin {
        $ErrorActionPreference = 'Stop'
    }
    process {
        try {
            if ($PSCmdlet.ParameterSetName -eq 'Site') {
                $ToServerName = $ToSite | ForEach-Object { $SiteServerMap.$_ }
                $FromServerName = $SiteServerMap.$FromSite
            }

            ## Ensure all servers are available
            if ($notavail = @(TestServerAvailability -ComputerName (@($FromServerName) + $ToServerName)).where({ -not $_.Online })) {
                throw "The server(s) [$(($notavail.ComputerName -join ','))] could not be contacted."
            }

            ## Ensure the iPerf module is installed on all servers (if being invoked remotely)
            $serverNames = @($FromServerName) + $ToServerName
            $serverNames.where({ $_ -notlike "$env:COMPUTERNAME*" -and $_ -ne 'localhost' }) | ForEach-Object {
                Install-IperfModule -ComputerName $_
            }

            ## Ensure all To Servers have a server instance running
            if ($noservers = @($ToServerName).where({ -not (Test-IPerfServer -ComputerName $_) })) {
                $noservers | ForEach-Object {
                    Write-Verbose -Message "IPerf server not running on [$($_)]. Starting server..."
                    StartIperfServer -ComputerName $_
                }
            }

            ## Create the test file and copy it to clients, if necessary
            if ($PSBoundParameters.ContainsKey('FileSize')) {
                $testFile = NewTestFile
                $localTestFilePath = 'C:\{0}' -f $testFile.Name
                $copiedTestFiles = [System.Collections.ArrayList]@()
                @($FromServerName).foreach({
                        $uncTestFilePath = ConvertToUncPath -LocalFilePath $localTestFilePath -ComputerName $_
                        Write-Verbose -Message "Copying test file [$($testFile.FullName)] to $uncTestFilePath..."
                        $null = $copiedTestFiles.Add((Copy-Item -Path $testFile.FullName -Destination $uncTestFilePath -PassThru))
                    })
                
            }
            
            $ToServerName | ForEach-Object {
                $iPerfArgs = ('-c {0} -w {1}' -f $_, $WindowSize)
                if ($PSBoundParameters.ContainsKey('FileSize')) {
                    $iPerfArgs += " -F `"$localTestFilePath`""
                }
                InvokeIperf -ComputerName $FromServerName -Arguments $iPerfArgs
            }
        } catch {
            $PSCmdlet.ThrowTerminatingError($_)
        } finally {
            StopIperfServer -ComputerName $ToServerName
            if (Get-Variable -Name testFile -ErrorAction Ignore) {
                Write-Verbose -Message "Removing local test file [$($testFile.FullName)]"
                Remove-Item -Path $testFile.FullName -ErrorAction Ignore
            }

            if (Get-Variable -Name copiedTestFiles -ErrorAction Ignore) {
                Write-Verbose -Message "Removing copied test files [$($copiedTestFiles.FullName -join ',')]"
                Remove-Item -Path $copiedTestFiles.FullName -ErrorAction Ignore
            }
        }
    }
}