everydayPS_Systems.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
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
FUNCTION Confirm-TargetSystem{
    <#
        .SYNOPSIS
        Attempt to verify that a system is the intended target system and,
        optionally, is the intended logged on user.
 
        .DESCRIPTION
        Attempt to verify that a system is the intended target system and,
        optionally, is the intended logged on user. Will use Get-CIMInstance
        to reach out to target system and attempt to match the computer name
        or IP address and, if desired, the username as well.
 
        .EXAMPLE
        Confirm-TargetSystem -sysID PSCenter
 
        Expected results of a confirmed system:
 
        WARNING: You have not entered identifying information for a user on
        the target system. Confirm-TargetSystem will only attempt to verify
        the system, not the user at this time.
 
 
        sysID : PSCenter
        sysName : PSCENTER
        sysIP : 169.254.255.162
        usrID : NA
        usrLoggedOn : NA
        isIntendedSystem : True
        isIntendedUser : False
        usingTechnician : PSCENTER\PSAdmin
        targetSystemNotes : NA
 
        .EXAMPLE
        Confirm-TargetSystem -sysID PSCenter -Silent
 
        Optional warnings suppressed.
        Expected results of a confirmed system:
 
        sysID : PSCenter
        sysName : PSCENTER
        sysIP : 169.254.255.162
        usrID : NA
        usrLoggedOn : NA
        isIntendedSystem : True
        isIntendedUser : False
        usingTechnician : PSCENTER\PSAdmin
        targetSystemNotes : NA
 
        .EXAMPLE
        Confirm-TargetSystem -sysID PSCenters
 
        Expected results of a failed confirmation where the system could not
        be reached.
 
        sysID : PSCenters
        sysName : NA
        sysIP : NA
        usrID : NA
        usrLoggedOn : NA
        isIntendedSystem : False
        isIntendedUser : False
        usingTechnician : PSCENTER\PSAdmin
        targetSystemNotes : Name resolution of PSCenters failed
 
        .EXAMPLE
        Confirm-TargetSystem -sysID PSCenter -usrID PSAdmin
 
        If all results confirmed, feedback would appear as:
 
        sysID : PSCenter
        sysName : PSCENTER
        sysIP : 169.254.255.162
        usrID : PSAdmin
        usrLoggedOn : PSAdmin
        isIntendedSystem : True
        isIntendedUser : True
        usingTechnician : PSCENTER\PSAdmin
        targetSystemNotes : NA
 
        .EXAMPLE
        Confirm-TargetSystem -sysID 192.168.1.21
 
        Expected results if you attempt to check an IP address instead of
        a computer name.
 
        sysID : NA
        sysName : NA
        sysIP : 192.168.1.21
        usrID : NA
        usrLoggedOn : NA
        isIntendedSystem : False
        isIntendedUser : False
        usingTechnician : PSCENTER\PSAdmin
        targetSystemNotes : This function is intended to be used to verify you are
                            not facing DNS issues and are correctly reaching an
                            intended system by name. IP address checks aren't necessary
                            as they would bypass any DNS issues.
 
                            Thank you. Confirm-TargetSystem will now stop.
 
        .EXAMPLE
        Confirm-TargetSystem -sysID PSCenter -tCred BettyBoop
 
        Expected results if your credentials are invalid on the remote system.
 
        WARNING: You have not entered identifying information for a user on the target
        system. Confirm-TargetSystem will only attempt to verify the system, not the
        user at this time.
 
 
        sysID : PSCenter
        sysName : NA
        sysIP : 169.254.255.162
        usrID : NA
        usrLoggedOn : NA
        isIntendedSystem : False
        isIntendedUser : False
        usingTechnician : BettyBoop
        targetSystemNotes : You do not have access to this system with your current
                            credentials. Perhaps try other credentials using the
                            -tCred option if you haven't already?
                            Error:
                            Access is denied.
 
        .EXAMPLE
        IF(Confirm-TargetSystem -sysID PSCenter -usrID PSAdmin -Silent |
            SELECT -ExpandProperty isIntendedSystem){Write-Host "Hello"}
 
        To use in another script to confirm whether or not to proceed with
        an intended action/configuration, above will return true and act if
        confirmation of the system is clear.
 
        .PARAMETER sysID
        sysID is looking for a computer name. Name or FQDN can be accepted.
 
        .PARAMETER usrID
        usrID is looking to match the user's login ID. When it reaches out
        to the remote system, if a logged on user is found, it will grab the
        user's name. This will be username only, not domain. For example,
        if I'm logged in as PSCenter\PSAdmin, attempting to match
        -usrID PSAdmin will come back successful. Matching
        -usrID PSCenter\PSAdmin will not match.
 
        .PARAMETER tCred
        tCred is aiming to collect alternate creds if you need to connect with the
        remote system using another account. If a technician is running PowerShell
        as MSmith but needs to reach out with the tech cred PSAdmin, they would
        include -tCred PSAdmin. When they do, they'll be prompted for their current
        password and then PSAdmin will be the account used to reach the remote
        system.
 
        Domain accounts are supported here as well. If the domain is needed, it
        can be added in the format Domain\Username.
        E.g. -tCred PSCenter\PSAdmin
 
        .LINK
        http://blog.everydaypowershell.com/2019/03/confirm-targetsystem.html
 
        .NOTES
        Mark Smith
        MarkTSmith@everydayPowerShell.com
        blog.everydayPowerShell.com
        Twitter: @edPowerShell
    #>

    [cmdletbinding()]
    param (
        [String]$sysID,
        [String]$usrID,
        [Switch]$Silent,
        [Switch]$SystemMatchOnly,
        [PSCredential]$tCred
    )
    IF($SystemMatchOnly){
        $Silent = $true
    }
    IF(!($silent)){
        Clear-Host
        Start-Sleep -Seconds 1
    }
    #region Functions
        FUNCTION Initialize-CIMSplat {
            param(
                [PSCredential]$tCred,
                [String]$sysID
            )
            $dcom = New-CimSessionOption -Protocol Dcom
            IF($tCred){
                $cimSesSplat = @{
                    Credential = $tCred
                    ComputerName = $sysID
                    SkipTestConnection = $true
                }
                $cimSesAlt = @{
                    Credential = $tCred
                    ComputerName = $sysID
                    SkipTestConnection = $true
                    SessionOption = $dcom
                }
                $cimInstSplat = @{
                    ClassName = "CIM_ComputerSystem"
                    CimSession = (New-CimSession @cimSesSplat)
                }
                $cimInstAlt = @{
                    ClassName = "CIM_ComputerSystem"
                    CimSession = (New-CimSession @cimSesAlt)
                }
                return $cimInstSplat,$cimInstAlt
            }
            ELSE{
                $cimSesSplat = @{
                    ComputerName = $sysID
                    SkipTestConnection = $true
                }
                $cimSesAlt = @{
                    ComputerName = $sysID
                    SkipTestConnection = $true
                    SessionOption = $dcom
                }
                $cimInstSplat = @{
                    ClassName = "CIM_ComputerSystem"
                    CimSession = (New-CimSession @cimSesSplat)
                }
                $cimInstAlt = @{
                    ClassName = "CIM_ComputerSystem"
                    CimSession = (New-CimSession @cimSesAlt)
                }
                return $cimInstSplat,$cimInstAlt
            }
        }
        FUNCTION Redo-TargetSystemResult {
            param(
                [Parameter(Position=0)]
                $sysID,
                [Parameter(Position=1)]
                $sysName,
                [Parameter(Position=2)]
                $sysIP,
                [Parameter(Position=3)]
                $usrID,
                [Parameter(Position=4)]
                $usrLoggedOn,
                [Parameter(Position=5)]
                $isIntendedSystem,
                [Parameter(Position=6)]
                $isIntendedUser,
                [Parameter(Position=7)]
                $usingTechnician,
                [Parameter(Position=8)]
                $targetSystemNotes,
                [Parameter(Position=9)]
                $result
            )
            IF($sysID){
                $result.sysID = $sysID
            }
            IF($sysName){
                $result.sysName = $sysName
            }
            IF($sysIP){
                $result.sysIP = $sysIP
            }
            IF($usrID){
                $result.usrID = $usrID
            }
            IF($usrLoggedOn){
                $result.usrLoggedOn = $usrLoggedOn
            }
            IF($isIntendedSystem -eq "False"){
                $result.isIntendedSystem = $false
            }
            ELSEIF($isIntendedSystem -eq "True"){
                $result.isIntendedSystem = $true
            }
            IF($isIntendedUser -eq "False"){
                $result.isIntendedUser = $false
            }
            ELSEIF($isIntendedUser -eq "True"){
                $result.isIntendedUser = $true
            }
            IF($usingTechnician){
                $result.usingTechnician = $usingTechnician
            }
            IF($targetSystemNotes){
                $result.targetSystemNotes = $targetSystemNotes
            }
            return $result
        }
    #endregion
    #region Param Check & Variable Prep
        #region Establish End Game Object
            $result = "" | Select-Object sysID, sysName, sysIP, usrID,
            usrLoggedOn, isIntendedSystem, isIntendedUser, usingTechnician,
            targetSystemNotes
        #endregion
        #region Splats
            $stopSplat = @{
                WarningAction = "Stop"
                ErrorAction = "Stop"
            }
        #endregion
        #region Check tCred
            IF(!($tCred)){
                $rSplat = @{
                    usingTechnician = "$($env:USERDOMAIN)\$($env:USERNAME)"
                    result = $result
                }
                $result = Redo-TargetSystemResult @rSplat
            }
            ELSE{
                $rSplat = @{
                    usingTechnician = ($tCred.UserName)
                    result = $result
                }
                $result = Redo-TargetSystemResult @rSplat
            }
        #endregion
        #region Check SysID
            IF(!($sysID)){
                #No SysID Provided
                $Msg = -JOIN(
                    "You have not entered identifying information for a ",
                    "system that needs to be confirmed. Confirm-TargetSystem ",
                    "cannot run without this information. ",
                    "Please use `"Get-Help Confirm-TargetSystem -Examples`" ",
                    "for examples of how to use this function.`n`n",
                    "Thank you. Confirm-TargetSystem will now stop."
                )
                $TSRSplat = @{
                    sysID = "NA"
                    sysName = "NA"
                    sysIP = "NA"
                    usrID = "NA"
                    usrLoggedOn = "NA"
                    isIntendedSystem = "False"
                    isIntendedUser = "False"
                    targetSystemNotes = $Msg
                    result = $result
                }
                $result = Redo-TargetSystemResult @TSRSplat
                IF($systemMatchOnly){
                    $result = $result.isIntendedSystem
                    return $result
                }
                ELSE{
                    return $result
                }
            }
            ELSEIF($sysID -like "*.*.*.*"){
                #SysID Is An IP
                $Msg = -JOIN(
                    "This function is intended to be used to verify ",
                    "you are not facing DNS issues and are correctly ",
                    "reaching an intended system by name. IP address ",
                    "checks aren't necessary as they would bypass ",
                    "any DNS issues.`n`n",
                    "Thank you. Confirm-TargetSystem will now stop."
                )
                $TSRSplat = @{
                    sysID = "NA"
                    sysName = "NA"
                    sysIP = $sysID
                    usrID = "NA"
                    usrLoggedOn = "NA"
                    isIntendedSystem = "False"
                    isIntendedUser = "False"
                    targetSystemNotes = $Msg
                    result = $result
                }
                $result = Redo-TargetSystemResult @TSRSplat
                IF($systemMatchOnly){
                    $result = $result.isIntendedSystem
                    return $result
                }
                ELSE{
                    return $result
                }
            }
            ELSE{
                TRY{
                    #System Online
                    $result = Redo-TargetSystemResult -sysID $sysID -result $result
                    $tcSplat = @{
                        ComputerName = $sysID
                        Count = 1
                        TimeToLive = 24
                    }
                    $thisTC = Test-Connection @tcSplat @stopSplat
                    $thisTC = ($thisTC |
                        Select-Object -ExpandProperty IPV4Address).IPAddressToString
                    $result = Redo-TargetSystemResult -sysIP $thisTC -result $result
                }
                CATCH{
                    #System Offline
                    $Msg = Test-NetConnection -ComputerName $sysID *>&1 |
                        Select-Object -First 1
                    $TSRSplat = @{
                        sysName = "NA"
                        sysIP = "NA"
                        usrID = "NA"
                        usrLoggedOn = "NA"
                        isIntendedSystem = "False"
                        isIntendedUser = "False"
                        targetSystemNotes = $Msg
                        result = $result
                    }
                    $result = Redo-TargetSystemResult @TSRSplat
                    IF($systemMatchOnly){
                        $result = $result.isIntendedSystem
                        return $result
                    }
                    ELSE{
                        return $result
                    }
                }
            }
        #endregion
        #region Check UsrID
            IF(!($usrID)){
                $Msg = -JOIN(
                    "You have not entered identifying information for a user ",
                    "on the target system. Confirm-TargetSystem will only ",
                    "attempt to verify the system, not the user at this time."
                )
                $TSRSplat = @{
                    usrID = "NA"
                    usrLoggedOn = "NA"
                    isIntendedUser = "False"
                    result = $result
                }
                $result = Redo-TargetSystemResult @TSRSplat
                IF(!($silent)){
                    Write-Warning -Message $Msg
                }
            }
            ELSE{
                $result = Redo-TargetSystemResult -usrID $usrID -result $result
            }
        #endregion
    #endregion
    #region Verify System
        Write-Verbose -Message "Attempting To Verify System $sysID now."
        TRY{
            #region Splats
                IF($tCred){
                    $cimInstSplat = (Initialize-CIMSplat -tCred $tCred -sysID $sysID)[0]
                    $cimInstAlt = (Initialize-CIMSplat -tCred $tCred -sysID $sysID)[1]
                }
                ELSE{
                    $cimInstSplat = (Initialize-CIMSplat -sysID $sysID)[0]
                    $cimInstAlt = (Initialize-CIMSplat -sysID $sysID)[1]
                }
            #endregion
            #region Attempting System Verification
                TRY{
                    $sysName = Get-CimInstance @cimInstSplat @stopSplat |
                        Select-Object -ExpandProperty Name
                }
                CATCH{
                    TRY{
                        $sysName = Get-CimInstance @cimInstAlt @stopSplat |
                            Select-Object -ExpandProperty Name
                    }
                    CATCH{
                        throw $_.Exception.Message
                    }
                }
                $result = Redo-TargetSystemResult -sysName $sysName -result $result
                IF($sysID -eq ($result.sysName)){
                    $result = Redo-TargetSystemResult -isIntendedSystem True -result $result
                }
                ELSE{
                    $result = Redo-TargetSystemResult -isIntendedSystem False -result $result
                }
            #endregion
        }
        CATCH [Microsoft.Management.Infrastructure.CimException] {
            IF(($_.Exception.Message) -like "*WinRM cannot complete the operation*"){
                $Msg = -JOIN (
                    "The system is unavailable to communicate with the system ",
                    "$sysID.`nError:`n$($_.Exception.Message)"
                )
                $TSRSplat = @{
                    targetSystemNotes = $Msg
                    sysName = "NA"
                    isIntendedSystem = "False"
                    result = $result
                }
                $result = Redo-TargetSystemResult @TSRSplat
                IF($systemMatchOnly){
                    $result = $result.isIntendedSystem
                    return $result
                }
                ELSE{
                    return $result
                }
            }
            ELSEIF(($_.Exception.Message) -like "*Access is denied*"){
                $Msg = -JOIN (
                    "You do not have access to this system with your current ",
                    "credentials. Perhaps try other credentials using the ",
                    "-tCred option if you haven't already?`nError:`n",
                    "$($_.Exception.Message)"
                )
                $TSRSplat = @{
                    targetSystemNotes = $Msg
                    sysName = "NA"
                    isIntendedSystem = "False"
                    result = $result
                }
                $result = Redo-TargetSystemResult @TSRSplat
                IF($systemMatchOnly){
                    $result = $result.isIntendedSystem
                    return $result
                }
                ELSE{
                    return $result
                }
            }
            ELSE{
                $Msg = -JOIN (
                    "$($_.Exception.GetType().FullName)`n",
                    "$($_.Exception.Message)"
                )
                $TSRSplat = @{
                    targetSystemNotes = $Msg
                    sysName = "NA"
                    isIntendedSystem = "False"
                    result = $result
                }
                $result = Redo-TargetSystemResult @TSRSplat
                IF($systemMatchOnly){
                    $result = $result.isIntendedSystem
                    return $result
                }
                ELSE{
                    return $result
                }
            }
        }
        CATCH{
            $Msg = -JOIN (
                "$($_.Exception.GetType().FullName)`n",
                "$($_.Exception.Message)"
            )
            $TSRSplat = @{
                targetSystemNotes = $Msg
                sysName = "NA"
                isIntendedSystem = "False"
                result = $result
            }
            $result = Redo-TargetSystemResult @TSRSplat
            IF($systemMatchOnly){
                $result = $result.isIntendedSystem
                return $result
            }
            ELSE{
                return $result
            }
        }
    #endregion
    #region Verify User
        IF($usrID){
            #region Attempting User Verification
                Write-Verbose -Message "Attempting To Verify User $usrID Is On $sysID now."
                TRY{
                    TRY{
                        $loggedOnUser = (Get-CimInstance @cimInstSplat @stopSplat |
                            Select-Object -ExpandProperty Username).Split("\") |
                            Select-Object -Last 1
                    }
                    CATCH{
                        TRY{
                            $loggedOnUser = (Get-CimInstance @cimInstAlt @stopSplat |
                                Select-Object -ExpandProperty Username).Split("\") |
                                Select-Object -Last 1
                        }
                        CATCH{
                            throw $_.Exception.Message
                        }
                    }
                    $loggedOnUser = (Get-CimInstance @cimInstSplat @stopSplat |
                        Select-Object -ExpandProperty Username).Split("\") |
                        Select-Object -Last 1
                    $result = Redo-TargetSystemResult -usrLoggedOn $loggedOnUser -result $result
                    IF($usrID -eq ($result.usrLoggedOn)){
                        $result = Redo-TargetSystemResult -isIntendedUser True -result $result
                    }
                    ELSE{
                        $result = Redo-TargetSystemResult -isIntendedUser False -result $result
                    }
                }
                CATCH{
                    $Msg = -JOIN (
                        "$($_.Exception.GetType().FullName)`n",
                        "$($_.Exception.Message)"
                    )
                    $TSRSplat = @{
                        targetSystemNotes = $Msg
                        sysName = "NA"
                        isIntendedSystem = "False"
                        result = $result
                    }
                    $result = Redo-TargetSystemResult @TSRSplat
                    IF($systemMatchOnly){
                        $result = $result.isIntendedSystem
                        return $result
                    }
                    ELSE{
                        return $result
                    }
                }
            #endregion
        }
    #endregion
    #region Closure
        Get-PSSession | Remove-PSSession *>$null
        $result = Redo-TargetSystemResult -targetSystemNotes NA -result $result
        IF($systemMatchOnly){
            $result = $result.isIntendedSystem
            return $result
        }
        ELSE{
            return $result
        }
    #endregion
}
Export-ModuleMember -Function Confirm-TargetSystem