GPOWMI.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
function Get-GPOWmiFilter
{
<#
.Synopsis
   Gets all Group Policy Filters or by name
.DESCRIPTION
   This cmdlet depends on the GroupPolicy module
.EXAMPLE
   Get-GPOWmiFilter
 
   Lists all (if any) WMIFilter configured in Group Policy Management
.EXAMPLE
   Get-GPOWmiFilter -Name HR
 
   Get a WMIFilter named HR
.EXAMPLE
   "HR" | Get-GPOWmiFilter
 
   Get a WMIFilter named HR using the pipeline
.EXAMPLE
   "HR","AllClients" | Get-GPOWmiFilter
 
   Gets WMIFilters named HR and Allclients using the pipeline
.INPUTS
   String (Name of WMIFilter)
.OUTPUTS
   Microsoft.GroupPolicy.WmiFilter
.NOTES
   Created by Tore.Groneng@firstpoint.no @ToreGroneng 2016
.ROLE
   Active Directory scripting
.FUNCTIONALITY
   Linking GPOs with WMIFilters
#>

[cmdletbinding()]
Param(
    [Parameter(ValueFromPipeline)]
    [string[]]$Name = "*"
)
BEGIN
{
    $f = $MyInvocation.InvocationName

    if(-not (Get-Module -Name GroupPolicy))
    {
        Import-Module -Name GroupPolicy -ErrorAction Stop -Verbose:$false
    }

    Write-Verbose -Message "$f - START"
    $GPdomain = New-Object Microsoft.GroupPolicy.GPDomain
    $SearchFilter = New-Object Microsoft.GroupPolicy.GPSearchCriteria
    Write-Verbose -Message "$f - Searching for WmiFilters"
    $allWmiFilters = $GPdomain.SearchWmiFilters($SearchFilter)
    Write-Verbose -Message "$f - Found $($allWmiFilters.Count) filters"
}

PROCESS
{
    foreach($FilterName in $Name)
    {
        Write-Verbose -Message "$f - Looking for $FilterName"
        $allWmiFilters | Where-Object Name -like $FilterName
    }
}

END
{
    Write-Verbose -Message "$f - END"
}
}

function Set-GPOWmiFilter
{
<#
.Synopsis
   Links a Group Policy to a WMIFilter
.DESCRIPTION
   This cmdlet depends on the GroupPolicy module. Apply a WMI filter to any Group Policy configured in Active Directory
.EXAMPLE
   Set-GPOWmiFilter -WMIFilterName HR -GroupPolicyName MyGPO
 
   Links the WMIfilter named HR to the Group Policy MyGPO
.EXAMPLE
   Set-GPOWmiFilter -WMIFilterName HR -GroupPolicyGUID ed3119f9-4038-464e-abdc-9202bfd24917
 
   Links the WMIfilter named HR to the Group Policy with the specified GUID
.EXAMPLE
   Get-GPOWmiFilter -Name HR | Set-GPOWmiFilter -GroupPolicyName MyGPO
 
   Get a WMIFilter named HR and applies it using the pipeline to the Group Policy MyGPO
.OUTPUTS
   $null
.NOTES
   Created by Tore.Groneng@firstpoint.no @ToreGroneng 2016
.ROLE
   Active Directory scripting
.FUNCTIONALITY
   Linking GPOs with WMIFilters
#>

[cmdletbinding()]
Param(
    [Parameter(
        ValueFromPipeline,
        ParameterSetName='ByWMIFilterObject')]
    [Microsoft.GroupPolicy.WmiFilter]$WMIfilter
    ,
    [Parameter(ParameterSetName='ByWMIFilterName')]
    [Parameter(ParameterSetName='FilterByPolicyName')]
    [Parameter(ParameterSetName='FilterByPolicyGUID')]
    [string]$WMIFilterName
    ,
    
    [Parameter(ParameterSetName='FilterByPolicyName')]
    [Parameter(ParameterSetName='ByWMIFilterObject')]
    [string]$GroupPolicyName
    ,
    
    [Parameter(ParameterSetName='FilterByPolicyGUID')]
    [Parameter(ParameterSetName='ByWMIFilterObject')]
    [guid]$GroupPolicyGUID
)
BEGIN
{
    $f = $MyInvocation.InvocationName
    Write-Verbose -Message "$f - START"

    Write-Verbose -Message "$f - Loading required module GroupPolicy"

    if(-not (Get-Module -Name GroupPolicy))
    {
        Import-Module -Name GroupPolicy -ErrorAction Stop -Verbose:$false
    }
    $GPdomain = New-Object Microsoft.GroupPolicy.GPDomain
    $SearchFilter = New-Object Microsoft.GroupPolicy.GPSearchCriteria

    Write-Verbose -Message "$f - Searching for WmiFilters"
    $allWmiFilters = $GPdomain.SearchWmiFilters($SearchFilter)
}

PROCESS
{    
    if($WMIFilterName)
    {
        Write-Verbose -Message "$f - Finding WMI-filter with name $WMIFilterName"
        $WMIfilter = $allWmiFilters | Where-Object Name -eq $WMIFilterName
        if(-not $WMIfilter)
        {
            $msg = "Did not find a WMIfilter with name '$WMIFilterName'"
            Write-Verbose -Message "$f - ERROR - $msg"
            Write-Error -Message $msg -ErrorAction Stop
        }
    }

    $GroupPolicyObject = $null

    if($GroupPolicyName)
    {
        Write-Verbose -Message "$f - Finding Group Policy with name '$GroupPolicyName'"
        $GroupPolicyObject = Get-GPO -Name $GroupPolicyName
        if(-not $GroupPolicyObject)
        {
            $msg = "Unable to find GPO with Name '$GroupPolicyName'"
            Write-Verbose -Message "$f - ERROR - $msg"
            Write-Error -Message $msg -ErrorAction Stop
        }
    }

    if($GroupPolicyGUID)
    {
        Write-Verbose -Message "$f - Finding Group Policy with GUID '$GroupPolicyGUID'"
        $GroupPolicyObject = Get-GPO -Guid $GroupPolicyGUID
        if(-not $GroupPolicyObject)
        {
            $msg = "Unable to find GPO with GUID '$GroupPolicyGUID'"
            Write-Verbose -Message "$f - ERROR - $msg"
            Write-Error -Message $msg -ErrorAction Stop
        }
    }

    Write-Verbose -Message "$f - Applying filter with name '$($WMIfilter.Name)' to GPO '$($GroupPolicyObject.DisplayName)'"

    try
    {
        $GroupPolicyObject.WmiFilter = $WMIfilter
    }
    catch
    {
        $ex = $_.Exception
        Write-Verbose -Message "$f - EXCEPTION - $($ex.Message)"
        throw $ex
    }
}

END
{
    Write-Verbose -Message "$f - END"
}
}