Public/Get-ALHADUserLogonTime.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
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
<#PSScriptInfo
 
.VERSION 1.1.0
 
.GUID dff730a8-af84-4b38-8fc3-de34ffd1e170
 
.AUTHOR Dieter Koch
 
.COMPANYNAME
 
.COPYRIGHT (c) 2021-2023 Dieter Koch
 
.TAGS
 
.LICENSEURI https://github.com/admins-little-helper/ALH/blob/main/LICENSE
 
.PROJECTURI https://github.com/admins-little-helper/ALH
 
.ICONURI
 
.EXTERNALMODULEDEPENDENCIES
 
.REQUIREDSCRIPTS
 
.EXTERNALSCRIPTDEPENDENCIES
 
.RELEASENOTES
1.0.0
- Initial release
 
1.1.0
- Made script accept values for paramter ComputerName from pipeline.
 
#>



<#
 
.DESCRIPTION
 Contains function to query 'lastLogon' and 'lastLogonTimestamp' attributes from Domain Controllers in the current AD domain for one ore more user objects.
 
#>



function Get-ALHADUserLogonTime {
    <#
    .SYNOPSIS
    Queries 'lastLogon' and 'lastLogonTimestamp' attributes from multiple Domain Controllers in the current AD domain for one ore more user objects.
 
    .DESCRIPTION
    Queries 'lastLogon' and 'lastLogonTimestamp' attributes from multiple Domain Controllers in the current AD domain for one ore more user objects.
 
    .PARAMETER Identity
    One ore more user names (SamAccountName) to query information for. Separate list with commas.
    If no value is provied, the $env:USERNAME will be used.
 
    .PARAMETER DomainController
    One ore more Domain Controller names to query information for. Separate list with commas.
    If no value is provied, all DCs in the current domain are queried.
 
    .EXAMPLE
    Get-ALHADUserLogonTime -Identity User1
    Get lastlogontime for user named 'User1'.
 
    .EXAMPLE
    Get-ALHADUserLogonTime -Identity User1, User2
    Get lastlogontime for users named 'User1' and 'User2'.
 
    .EXAMPLE
    Get-ALHADUserLogonTime -Identity User2, User2 -DomainController adds1,adds2
    Get lastlogontime for users named 'User1' and 'User2' querying Domaincontroller 'adds1' and 'adds2'.
 
    .EXAMPLE
    (Get-ADUser -Filter {name -like "a*"}).Name | Get-ALHADUserLogonTime -DomainController $(Get-ALHADDSDomainController -All)
    Get lastlogontime for all users in AD where name starts with 'a', from all domain controllers in the current domain.
 
    .INPUTS
    String
 
    .OUTPUTS
    PSCustomObject
 
    .NOTES
    Author: Dieter Koch
    Email: diko@admins-little-helper.de
 
    .LINK
    https://github.com/admins-little-helper/ALH/blob/main/Help/Get-ALHADUserLogonTime.txt
    #>


    [CmdletBinding()]
    param (
        [Parameter(ValueFromPipeline, HelpMessage = 'Enter one or more user names')]
        [ValidateNotNullOrEmpty()]
        [string[]]
        $Identity = $env:USERNAME,

        [Parameter(HelpMessage = 'Enter one or more domain controllers to query')]
        [string[]]
        $DomainController
    )

    begin {
        $RequiredModules = "ActiveDirectory"

        foreach ($RequiredModule in $RequiredModules) {
            if (-not [bool](Get-Module -Name $RequiredModule)) {
                if (-not [bool](Get-Module -Name $RequiredModule -ListAvailable)) {
                    Write-Warning -Message "Module $RequiredModule not found. Stopping function."
                    break
                }

                Write-Verbose -Message "Importing $RequiredModule Module"
                Import-Module ActiveDirectory
            }
        }

        if ($null -eq $DomainController -or $DomainController.Length -eq 0) {
            try {
                Write-Verbose -Message "Trying to get list of all domain controllers..."
                $DCs = Get-ADDomainController -Filter * -ErrorAction Stop
            }
            catch {
                Write-Information -MessageData "Error getting domain controllers" -InformationAction Continue
                break
            }
        }
        else {
            Write-Verbose -Message "DCs specified..."
            Write-Verbose -Message "$($DomainController -join '; ')"

            $UniqueDCs = $DomainController | Select-Object -Unique

            Write-Verbose -Message "Unique DC names..."
            Write-Verbose -Message "$($UniqueDCs -join '; ')"

            $DCs = foreach ($DC in $UniqueDCs) {
                Write-Verbose -Message "Checking if DC exists: $DC..."
                $DCInfo = Get-ADDomainController -Filter { Name -eq $DC } -ErrorAction SilentlyContinue
                $DCInfo
            }
        }

        $DCs = foreach ($DCtoTest in $DCs) {
            if ($null -eq $DCtoTest) {
                Write-Verbose -Message "DC not found in domain: $DCtoTest..."

                $DCInfo = [PSCustomObject]@{
                    Name      = $DCtoTest
                    Exists    = $false
                    Available = $false
                }
            }
            else {
                Write-Verbose -Message "Checking if DC is available: $DCtoTest..."

                $DCInfo = $DCtoTest | Select-Object -Property *, `
                @{Name = 'Exists'; Expression = { $true } }, `
                @{Name = 'Available'; Expression = { Test-Connection -ComputerName $DCtoTest -Count 2 -Quiet } }
                $DCInfo
            }
        }
    }

    process {
        $i = 0
        $UserCount = ($Identity | Measure-Object).Count
        $j = 0
        $DCCount = ($DCs | Measure-Object).Count

        foreach ($user in $Identity) {
            Write-Verbose -Message "Querying information for user $user..."
            Write-Progress -Activity "Querying information for user $user" -Status "$i out of $UserCount done" -PercentComplete $([int] 100 / $UserCount * $i)
            $i++
            $j = 0

            foreach ($DC in $DCs) {
                try {
                    Write-Verbose -Message "Querying information from domain controller $($DC.Name)..."
                    Write-Progress -Id 1 -Activity "Querying information from DC $($DC.Name)" -Status "$j out of $DCCount done" -PercentComplete $([int] 100 / $DCCount * $j)
                    $j++

                    $userInfo = $null

                    if ($DC.Available) {
                        $userInfo = Get-ADUser -Server $DC.Name -Filter { samAccountName -eq $user } -Properties mail, lastLogon, lastLogonTimestamp
                        $userInfo = $userInfo | Select-Object -Property SamAccountName, `
                            Name, `
                            Mail, `
                        @{Name = 'lastLogon'; Expression = { [datetime]::FromFileTime($_.lastLogon) } }, `
                        @{Name = 'lastLogonTimestamp'; Expression = { [datetime]::FromFileTime($_.lastLogonTimestamp) } }, `
                        @{Name = 'DC'; Expression = { $DC.Name } },
                        @{Name = 'DCExists'; Expression = { $DC.Exists } },
                        @{Name = 'DCAvailable'; Expression = { $DC.Available } }
                    }
                    else {
                        $userInfo = [PSCustomObject]@{
                            Name               = $user
                            lastLogon          = ''
                            lastLogonTimestamp = ''
                            DC                 = $DC.Name
                            DCExists           = $DC.Exists
                            DCAvailable        = $DC.Available
                        }
                    }
                }
                catch {
                    Write-Error $_
                }

                $userInfo
            }
        }
    }
}

#region EndOfScript
<#
################################################################################
################################################################################
#
# ______ _ __ _____ _ _
# | ____| | | / _| / ____| (_) | |
# | |__ _ __ __| | ___ | |_ | (___ ___ _ __ _ _ __ | |_
# | __| | '_ \ / _` | / _ \| _| \___ \ / __| '__| | '_ \| __|
# | |____| | | | (_| | | (_) | | ____) | (__| | | | |_) | |_
# |______|_| |_|\__,_| \___/|_| |_____/ \___|_| |_| .__/ \__|
# | |
# |_|
################################################################################
################################################################################
# created with help of http://patorjk.com/software/taag/
#>

#endregion