Public/Get-GPSetting.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
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
function Get-GPSetting {
<#
.SYNOPSIS
Get the group policy settings for specific extensions or list configured extensions.
 
.DESCRIPTION
This function will display the group policy settings of the supplied group policy
objects, or will display the extensions for which the group policy contains
configuration settings.
 
It uses the GenerateReport() method of the group policy .Net object to create an
XML version of the report which it then parses.
 
Since generating XML can be time consuming, the Verbose common parameter can be
specified which will provide notices to the user while it is processing.
 
.PARAMETER GroupPolicy
The group policy or array of group policies for which to return the settings.
 
.PARAMETER Type
The type of data returned. Accepted values are:
 
ExtensionType
This type of returned data will identify which group policy extensions contain
configuration. This can return extension types beyond what the function can
currently process.
 
Script
DriveMapSetting
SecuritySetting
RegistrySetting
FolderRedirectionSetting
 
.INPUTS
Microsoft.GroupPolicy.Gpo[]
 
.OUTPUTS
System.Management.Automation.PSCustomObject
 
.EXAMPLE
C:\PS> Get-GPO -All | Get-GPSetting -Verbose -OutVariable MyGPOs
 
.EXAMPLE
C:\PS> Get-GPO 'DriveMapping' | Get-GPSetting -Type DriveMapping
 
Name : DriveMapping
ConfigurationGroup : User
SettingChanged : 2017-10-03 18:20:54
Order : 1
DriveAction : Replace
ShowThisDrive : True
ShowAllDrives : True
Label : MyUser
Path : \\MyServerA\ShareB
Reconnect : True
FirstAvailableLetter : False
DriveLetter : P
ConnectUserName :
Filters : CONTOSO\MyUsers
 
Name : DriveMapping
ConfigurationGroup : User
SettingChanged : 2017-10-03 18:20:57
Order : 2
DriveAction : Replace
ShowThisDrive : True
ShowAllDrives : True
Label : Department
Path : \\DeptServer\ShareB
Reconnect : True
FirstAvailableLetter : False
DriveLetter : S
ConnectUserName :
Filters : CONTOSO\DeptUsers
 
.EXAMPLE
C:\PS> Get-GPO 'Workstation Scripts' | Get-GPSetting -Type Script | Sort-Object -Property Type,Order | Format-Table -AutoSize
 
Name ConfigurationGroup Script Type Parameters Order PSRunOrder
---- ------------------ ------ ---- ---------- ----- ----------
Workstation Scripts Computer CleanTempFiles.cmd Shutdown 0 PSNotConfigured
Workstation Scripts Computer ComputerInventory.ps1 Startup 0 RunPSFirst
Workstation Scripts Computer InstallApps.cmd Startup 1 RunPSFirst
Workstation Scripts Computer ClearAppCache.vbs Startup 2 RunPSFirst
 
.LINK
https://github.com/thedavecarroll/PoShGroupPolicy
 
#>

    [CmdLetBinding()]
    param(
        [ValidateNotNullOrEmpty()]
        [Parameter(ValueFromPipeline)]
        [Microsoft.GroupPolicy.Gpo[]]$GroupPolicy,
        
        [ValidateSet('ExtensionType','Script','DriveMapSetting','SecuritySetting','RegistrySetting','FolderRedirectionSetting')]
        [String]$Type='ExtensionType'
    )

    begin {
        $Timer = [System.Diagnostics.Stopwatch]::StartNew()
        $Counter = 0
    }

    process {

        foreach ($GPO in $GroupPolicy) {

            Write-Verbose -Message "Generating XML report to parse $Type data for GPO $($GPO.DisplayName)"
            [xml]$GpoXml = $GPO.GenerateReport('Xml')

            $GpoName      = $GpoXml.GPO.Name
            $CreatedTime  = $GpoXml.GPO.CreatedTime
            $ModifiedTime = $GpoXml.GPO.ModifiedTime
            $ReadTime     = $GpoXml.GPO.ReadTime

            $Counter++
            if ($VerbosePreference -eq 'Continue') {
                Write-Progress -Activity "Processing..." -CurrentOperation $GpoName -Status "$Counter / $($GroupPolicy.Count)"
            }

            switch ($Type) {
                'ExtensionType' {
                    foreach ($Extension in $GpoXml.GPO.Computer.ExtensionData.Extension) {
                        [PsCustomObject]@{
                            Name = $GpoName
                            ConfigurationGroup = 'Computer'
                            CreatedTime = $CreatedTime
                            ModifiedTime = $ModifiedTime
                            ExtensionType = $Extension.Type.Split(":")[1]
                        }
                    }
                    foreach ($Extension in $GpoXml.GPO.User.ExtensionData.Extension) {
                        [PsCustomObject]@{
                            Name = $GpoName
                            ConfigurationGroup = 'User'
                            CreatedTime = $CreatedTime
                            ModifiedTime = $ModifiedTime
                            ExtensionType = $Extension.Type.Split(":")[1]
                        }
                    }

                }
                'Script' {
                    foreach ($Script in $Gpoxml.GPO.Computer.ExtensionData.Extension.Script ) {
                        if ($Script) {
                            [PsCustomObject]@{
                                Name = $GpoName
                                ConfigurationGroup = 'Computer'
                                Script = $Script.Command
                                Type = $Script.Type
                                Parameters = $Script.Parameters
                                Order = $Script.Order
                                PSRunOrder = $Script.RunOrder
                            }
                        }
                    }
                    foreach ($Script in $Gpoxml.GPO.User.ExtensionData.Extension.Script ) {
                        if ($Script) {
                            [PsCustomObject]@{
                                Name = $GpoName
                                ConfigurationGroup = 'User'
                                Script = $Script.Command
                                Type = $Script.Type
                                Parameters = $Script.Parameters
                                Order = $Script.Order
                                PSRunOrder = $Script.RunOrder
                            }
                        }
                    }
                }
                'DriveMapSetting' {
                    foreach ($DriveMapping in $Gpoxml.GPO.Computer.ExtensionData.Extension.DriveMapSettings.Drive ) {
                        if ($DriveMapping) {
                            switch ($DriveMapping.Properties.action) {
                                'R' { $DriveAction = 'Replace'}
                                'U' { $DriveAction = 'Update'}
                                'C' { $DriveAction = 'Create'}
                                'D' { $DriveAction = 'Delete'}
                            }
                            if ($DriveMapping.Properties.persistent -eq 1) {
                                $Reconnect = $true
                            } else {
                                $Reconnect = $false
                            }
                            if ($DriveMapping.Filters) {
                                $Filters = $DriveMapping.Filters.FilterGroup.Name
                            } else {
                                $Filters = $null
                            }
                            if ($DriveMapping.Properties.thisDrive -eq 'SHOW') {
                                $ShowThisDrive = $true
                            } elseif ($DriveMapping.Properties.thisDrive -eq 'HIDE') {
                                $ShowThisDrive = $false
                            } else {
                                $ShowThisDrive = $null
                            }
                            if ($DriveMapping.Properties.allDrives -eq 'SHOW') {
                                $ShowAllDrives = $true
                            } elseif ($DriveMapping.Properties.allDrives -eq 'HIDE') {
                                $ShowAllDrives = $false
                            } else {
                                $ShowAllDrives = $null
                            }
                            if ($DriveMapping.Properties.useLetter -eq 0) {
                                $FirstAvailableLetter = $true
                            } else {
                                $FirstAvailableLetter = $false
                            }
                            [PsCustomObject]@{
                                Name = $GpoName
                                ConfigurationGroup = 'Computer'
                                SettingChanged = $DriveMapping.Changed
                                Order = $DriveMapping.GPOSettingOrder                                
                                DriveAction = $DriveAction
                                ShowThisDrive = $ShowThisDrive
                                ShowAllDrives = $ShowAllDrives                                
                                Label = $DriveMapping.Properties.label
                                Path = $DriveMapping.Properties.path
                                Reconnect = $Reconnect
                                FirstAvailableLetter = $FirstAvailableLetter
                                DriveLetter = $DriveMapping.Properties.letter
                                ConnectUserName = $DriveMapping.Properties.userName
                                Filters = $Filters
                            }
                        }
                    }
                    foreach ($DriveMapping in $Gpoxml.GPO.User.ExtensionData.Extension.DriveMapSettings.Drive ) {
                        if ($DriveMapping) {
                            switch ($DriveMapping.Properties.action) {
                                'R' { $DriveAction = 'Replace'}
                                'U' { $DriveAction = 'Update'}
                                'C' { $DriveAction = 'Create'}
                                'D' { $DriveAction = 'Delete'}
                            }
                            if ($DriveMapping.Properties.persistent -eq 1) {
                                $Reconnect = $true
                            } else {
                                $Reconnect = $false
                            }
                            if ($DriveMapping.Filters) {
                                $Filters = $DriveMapping.Filters.FilterGroup.Name
                            } else {
                                $Filters = $null
                            }
                            if ($DriveMapping.Properties.thisDrive -eq 'SHOW') {
                                $ShowThisDrive = $true
                            } elseif ($DriveMapping.Properties.thisDrive -eq 'HIDE') {
                                $ShowThisDrive = $false
                            } else {
                                $ShowThisDrive = $null
                            }
                            if ($DriveMapping.Properties.allDrives -eq 'SHOW') {
                                $ShowAllDrives = $true
                            } elseif ($DriveMapping.Properties.allDrives -eq 'HIDE') {
                                $ShowAllDrives = $false
                            } else {
                                $ShowAllDrives = $null
                            }
                            if ($DriveMapping.Properties.useLetter -eq 0) {
                                $FirstAvailableLetter = $true
                            } else {
                                $FirstAvailableLetter = $false
                            }
                            [PsCustomObject]@{
                                Name = $GpoName
                                ConfigurationGroup = 'User'
                                SettingChanged = $DriveMapping.Changed
                                Order = $DriveMapping.GPOSettingOrder                                
                                DriveAction = $DriveAction
                                ShowThisDrive = $ShowThisDrive
                                ShowAllDrives = $ShowAllDrives                                
                                Label = $DriveMapping.Properties.label
                                Path = $DriveMapping.Properties.path
                                Reconnect = $Reconnect
                                FirstAvailableLetter = $FirstAvailableLetter
                                DriveLetter = $DriveMapping.Properties.letter
                                ConnectUserName = $DriveMapping.Properties.userName
                                Filters = $Filters
                            }
                        }
                    }
                }
                'SecuritySetting' {
                    foreach ($SecuritySetting in $Gpoxml.GPO.Computer.ExtensionData.Extension.SecurityOptions ) {
                        if ($SecuritySetting) {
                            [PsCustomObject]@{
                                Name = $GpoName
                                ConfigurationGroup = 'Computer'
                                KeyName = $SecuritySetting.KeyName
                                SettingNumber = $SecuritySetting.SettingNumber
                                Display = $SecuritySetting.Display.Name
                                Units = $SecuritySetting.Display.Units
                            }
                        }
                    }
                    foreach ($SecuritySetting in $Gpoxml.GPO.User.ExtensionData.Extension.SecurityOptions ) {
                        if ($SecuritySetting) {
                            [PsCustomObject]@{
                                Name = $GpoName
                                ConfigurationGroup = 'User'
                                KeyName = $SecuritySetting.KeyName
                                SettingNumber = $SecuritySetting.SettingNumber
                                Display = $SecuritySetting.Display.Name
                                Units = $SecuritySetting.Display.Units
                            }
                        }
                    }
                }
                'RegistrySetting' {
                    foreach ($RegistrySetting in $Gpoxml.Computer.ExtensionData.Extension.Policy ) {
                        if ($RegistrySetting) {
                            $GPORegistrySettingsInfo += [PsCustomObject]@{
                                Name = $GpoName
                                ConfigurationGroup = 'Computer'
                                PolicyName = $RegistrySetting.Name
                                State = $RegistrySetting.State
                                Supported = $RegistrySetting.Supported
                            }
                        }
                    }
                    foreach ($RegistrySetting in $Gpoxml.User.ExtensionData.Extension.Policy ) {
                        if ($RegistrySetting) {
                            $GPORegistrySettingsInfo += [PsCustomObject]@{
                                Name = $GpoName
                                ConfigurationGroup = 'User'
                                PolicyName = $RegistrySetting.Name
                                State = $RegistrySetting.State
                                Supported = $RegistrySetting.Supported
                            }
                        }
                    }
                }
                'FolderRedirectionSetting' {
                    try {
                        $KnownFolders = Get-GPKnownFolderId -ErrorAction Stop                 
                        foreach ($FolderRedirectionSetting in $Gpoxml.Computer.ExtensionData.Extension.Folder ) {
                            if ($FolderRedirectionSetting) {
                                $GPOFolderRedirectionSettingsInfo += [PsCustomObject]@{
                                    Name = $GpoName
                                    ConfigurationGroup = 'Computer'
                                    Id = $FolderRedirectionSetting.Id
                                    DisplayName = $KnownFolders | Where-Object {$_.GUID -eq $FolderRedirectionSetting.Id} | Select-Object -ExpandProperty DisplayName
                                    FolderType = $KnownFolders | Where-Object {$_.GUID -eq $FolderRedirectionSetting.Id} | Select-Object -ExpandProperty FolderType
                                    DefaultPath = $KnownFolders | Where-Object {$_.GUID -eq $FolderRedirectionSetting.Id} | Select-Object -ExpandProperty DefaultPath
                                    DestinationPath = $FolderRedirectionSetting.Location.DestinationPath
                                }
                            }
                        }
                        foreach ($FolderRedirectionSetting in $Gpoxml.User.ExtensionData.Extension.Folder ) {
                            if ($FolderRedirectionSetting) {
                                $GPOFolderRedirectionSettingsInfo += [PsCustomObject]@{
                                    Name = $GpoName
                                    ConfigurationGroup = 'User'
                                    Id = $FolderRedirectionSetting.Id
                                    DisplayName = $KnownFolders | Where-Object {$_.GUID -eq $FolderRedirectionSetting.Id} | Select-Object -ExpandProperty DisplayName
                                    FolderType = $KnownFolders | Where-Object {$_.GUID -eq $FolderRedirectionSetting.Id} | Select-Object -ExpandProperty FolderType
                                    DefaultPath = $KnownFolders | Where-Object {$_.GUID -eq $FolderRedirectionSetting.Id} | Select-Object -ExpandProperty DefaultPath
                                    DestinationPath = $FolderRedirectionSetting.Location.DestinationPath
                                }
                            }
                        }
                    }
                    catch {
                        Write-Warning -Message 'Unable to obtain list of KnownFolders.'
                    }
                }
            } # end switch

        } # end foreach loop

    }

    end {
        Write-Verbose -Message "Completed in $([system.String]::Format("{0}d {1:00}h:{2:00}m:{3:00}s.{4:00}", $Timer.Elapsed.Days, $Timer.Elapsed.Hours, $Timer.Elapsed.Minutes, $Timer.Elapsed.Seconds, $Timer.Elapsed.Milliseconds / 10))"
    }
}