DSCResources/DSC_NetBios/DSC_NetBios.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
$modulePath = Join-Path -Path (Split-Path -Path (Split-Path -Path $PSScriptRoot -Parent) -Parent) -ChildPath 'Modules'

# Import the Networking Common Modules
Import-Module -Name (Join-Path -Path $modulePath `
        -ChildPath (Join-Path -Path 'NetworkingDsc.Common' `
            -ChildPath 'NetworkingDsc.Common.psm1'))

Import-Module -Name (Join-Path -Path $modulePath -ChildPath 'DscResource.Common')

# Import Localization Strings
$script:localizedData = Get-LocalizedData -DefaultUICulture 'en-US'

# Base registry key path for NetBios settings
$script:hklmInterfacesPath = 'HKLM:\SYSTEM\CurrentControlSet\Services\NetBT\Parameters\Interfaces'

#region check NetBiosSetting enum loaded, if not load
try
{
    [void][System.Reflection.Assembly]::GetAssembly([NetBiosSetting])
}
catch
{
    Add-Type -TypeDefinition @'
    public enum NetBiosSetting
    {
       Default,
       Enable,
       Disable
    }
'@

}
#endregion

<#
    .SYNOPSIS
        Returns the current state of the Net Bios on an interface.
 
    .PARAMETER InterfaceAlias
        Specifies the alias of a network interface. Supports the use of '*' and '%'.
 
    .PARAMETER Setting
        Specifies if NetBIOS should be enabled or disabled or obtained from
        the DHCP server (Default). If static IP, Enable NetBIOS.
 
        Parameter value is ignored.
#>

function Get-TargetResource
{
    [CmdletBinding()]
    [OutputType([System.Collections.Hashtable])]
    param
    (
        [Parameter(Mandatory = $true)]
        [System.String]
        $InterfaceAlias,

        [Parameter(Mandatory = $true)]
        [ValidateSet('Default', 'Enable', 'Disable')]
        [System.String]
        $Setting
    )

    Write-Verbose -Message ($script:localizedData.GettingNetBiosSettingMessage -f $InterfaceAlias)

    $win32NetworkAdapterFilter = Format-Win32NetworkAdapterFilterByNetConnectionId -InterfaceAlias $InterfaceAlias

    $netAdapter = Get-CimInstance `
        -ClassName Win32_NetworkAdapter `
        -Filter $win32NetworkAdapterFilter

    if ($netAdapter)
    {
        Write-Verbose -Message ($script:localizedData.InterfaceDetectedMessage -f $InterfaceAlias, ($netAdapter.InterfaceIndex -Join ','))
    }
    else
    {
        New-InvalidOperationException `
            -Message ($script:localizedData.InterfaceNotFoundError -f $InterfaceAlias)
    }

    <#
        If a wildcard was specified for the InterfaceAlias then
        more than one adapter may be returned. If more than one
        adapter is returned then the NetBios setting value will
        be evaluated for all matching adapters. If there is a
        mismatch, a wrong value is returned to signify the
        resource is not in the desired state.
    #>

    if ($netAdapter -is [System.Array])
    {
        [System.String[]] $settingResults = @()

        foreach ($netAdapterItem in $netAdapter)
        {
            $settingResults += Get-NetAdapterNetbiosOptionsFromRegistry `
                -NetworkAdapterGUID $netAdapterItem.GUID `
                -Setting $Setting

            Write-Verbose -Message ($script:localizedData.CurrentNetBiosSettingMessage -f $netAdapterItem.NetConnectionID, $settingResults[-1])
        }

        [System.String[]] $wrongSettings = $settingResults | Where-Object -FilterScript {
            $_ -ne $Setting
        }

        if (-not [System.String]::IsNullOrEmpty($wrongSettings))
        {
            $Setting = $wrongSettings[0]
        }
    }
    else
    {
        $Setting = Get-NetAdapterNetbiosOptionsFromRegistry `
            -NetworkAdapterGUID $netAdapter.GUID `
            -Setting $Setting
    }

    Write-Verbose -Message ($script:localizedData.CurrentNetBiosSettingMessage -f $InterfaceAlias, $Setting)

    return @{
        InterfaceAlias = $InterfaceAlias
        Setting        = $Setting
    }
}

<#
    .SYNOPSIS
        Sets the state of the Net Bios on an interface.
 
    .PARAMETER InterfaceAlias
        Specifies the alias of a network interface. Supports the use of '*' and '%'.
 
    .PARAMETER Setting
        Specifies if NetBIOS should be enabled or disabled or obtained from
        the DHCP server (Default). If static IP, Enable NetBIOS.
#>

function Set-TargetResource
{
    [CmdletBinding()]
    param
    (
        [Parameter(Mandatory = $true)]
        [System.String]
        $InterfaceAlias,

        [Parameter(Mandatory = $true)]
        [ValidateSet('Default', 'Enable', 'Disable')]
        [System.String]
        $Setting
    )

    Write-Verbose -Message ($script:localizedData.SettingNetBiosSettingMessage -f $InterfaceAlias)

    $win32NetworkAdapterFilter = Format-Win32NetworkAdapterFilterByNetConnectionId -InterfaceAlias $InterfaceAlias

    $netAdapter = Get-CimInstance `
        -ClassName Win32_NetworkAdapter `
        -Filter $win32NetworkAdapterFilter

    if ($netAdapter)
    {
        Write-Verbose -Message ($script:localizedData.InterfaceDetectedMessage -f $InterfaceAlias, ($netAdapter.InterfaceIndex -Join ','))
    }
    else
    {
        New-InvalidOperationException `
            -Message ($script:localizedData.InterfaceNotFoundError -f $InterfaceAlias)
    }

    if ($netAdapter -is [System.Array])
    {
        foreach ($netAdapterItem in $netAdapter)
        {
            $currentValue = Get-NetAdapterNetbiosOptionsFromRegistry `
                -NetworkAdapterGUID $netAdapterItem.GUID `
                -Setting $Setting

            # Only make changes if necessary
            if ($currentValue -ne $Setting)
            {
                Write-Verbose -Message ($script:localizedData.SetNetBiosMessage -f $netAdapterItem.NetConnectionID, $Setting)

                $netAdapterConfig = $netAdapterItem | Get-CimAssociatedInstance `
                    -ResultClassName Win32_NetworkAdapterConfiguration `
                    -ErrorAction Stop

                Set-NetAdapterNetbiosOptions `
                    -NetworkAdapterObject $netAdapterConfig `
                    -InterfaceAlias $netAdapterItem.NetConnectionID `
                    -Setting $Setting
            }
        }
    }
    else
    {
        Write-Verbose -Message ($script:localizedData.SetNetBiosMessage -f $netAdapter.NetConnectionID, $Setting)

        $netAdapterConfig = $netAdapter | Get-CimAssociatedInstance `
                    -ResultClassName Win32_NetworkAdapterConfiguration `
                    -ErrorAction Stop

        Set-NetAdapterNetbiosOptions `
            -NetworkAdapterObject $netAdapterConfig `
            -InterfaceAlias $netAdapter.NetConnectionID `
            -Setting $Setting
    }
}

<#
    .SYNOPSIS
        Tests the current state the Net Bios on an interface.
 
    .PARAMETER InterfaceAlias
        Specifies the alias of a network interface. Supports the use of '*' and '%'.
 
    .PARAMETER Setting
        Specifies if NetBIOS should be enabled or disabled or obtained from
        the DHCP server (Default). If static IP, Enable NetBIOS.
#>

function Test-TargetResource
{
    [CmdletBinding()]
    [OutputType([System.Boolean])]
    param
    (
        [Parameter(Mandatory = $true)]
        [System.String]
        $InterfaceAlias,

        [Parameter(Mandatory = $true)]
        [ValidateSet('Default', 'Enable', 'Disable')]
        [System.String]
        $Setting
    )

    Write-Verbose -Message ($script:localizedData.TestingNetBiosSettingMessage -f $InterfaceAlias)

    $currentState = Get-TargetResource @PSBoundParameters

    return Test-DscParameterState -CurrentValues $currentState -DesiredValues $PSBoundParameters
}

<#
    .SYNOPSIS
        Returns the NetbiosOptions value for a network adapter.
 
    .DESCRIPTION
        Most reliable method of getting this value since network adapters
        can be in any number of states (e.g. disabled, disconnected)
        which can cause Win32 classes to not report the value.
 
    .PARAMETER NetworkAdapterGUID
        Network Adapter GUID
 
    .PARAMETER Setting
        Setting value for this resource which should be one of
        the following: Default, Enable, Disable
#>

function Get-NetAdapterNetbiosOptionsFromRegistry
{
    [OutputType([System.String])]
    [CmdletBinding()]
    param
    (
        [Parameter(Mandatory = $true)]
        [ValidatePattern("^\{[a-zA-Z0-9]{8}\-[a-zA-Z0-9]{4}\-[a-zA-Z0-9]{4}\-[a-zA-Z0-9]{4}\-[a-zA-Z0-9]{12}\}$")]
        [System.String]
        $NetworkAdapterGUID,

        [Parameter(Mandatory = $true)]
        [ValidateSet('Default','Enable','Disable')]
        [System.String]
        $Setting
    )

    # Changing ErrorActionPreference variable since the switch -ErrorAction isn't supported.
    $currentErrorActionPreference = $ErrorActionPreference
    $ErrorActionPreference = 'SilentlyContinue'

    $registryNetbiosOptions = Get-ItemPropertyValue `
        -Name 'NetbiosOptions' `
        -Path "$($script:hklmInterfacesPath)\Tcpip_$($NetworkAdapterGUID)"

    $ErrorActionPreference = $currentErrorActionPreference

    if ($null -eq $registryNetbiosOptions)
    {
        $registryNetbiosOptions = 0
    }

    switch ($registryNetbiosOptions)
    {
        0
        {
            return 'Default'
        }

        1
        {
            return 'Enable'
        }

        2
        {
            return 'Disable'
        }

        default
        {
            # Unknown value. Returning invalid setting to trigger Set-TargetResource
            [System.String[]] $invalidSetting = 'Default','Enable','Disable' | Where-Object -FilterScript {
                $_ -ne $Setting
            }

            return $invalidSetting[0]
        }
    }
} # end function Get-NetAdapterNetbiosOptionsFromRegistry

<#
    .SYNOPSIS
        Configures Netbios on a Network Adapter.
 
    .DESCRIPTION
        Uses two methods for configuring Netbios on a Network Adapter.
        If an interface is IPEnabled, the CIMMethod will be invoked.
        Otherwise the registry key is configured as this will satisfy
        network adapters being in alternative states such as disabled
        or disconnected.
 
    .PARAMETER NetworkAdapterObject
        Network Adapter Win32_NetworkAdapterConfiguration Object
 
    .PARAMETER InterfaceAlias
        Name of the network adapter being configured. Example: Ethernet
 
    .PARAMETER Setting
        Setting value for this resource which should be one of
        the following: Default, Enable, Disable
#>

function Set-NetAdapterNetbiosOptions
{
    [CmdletBinding()]
    param
    (
        [Parameter(Mandatory = $true)]
        [System.Object]
        $NetworkAdapterObject,

        [Parameter(Mandatory = $true)]
        [System.String]
        $InterfaceAlias,

        [Parameter(Mandatory = $true)]
        [ValidateSet('Default','Enable','Disable')]
        [System.String]
        $Setting
    )

    Write-Verbose -Message ($script:localizedData.SetNetBiosMessage -f $InterfaceAlias, $Setting)

    # Only IPEnabled interfaces can be configured via SetTcpipNetbios method.
    if ($NetworkAdapterObject.IPEnabled)
    {
        $result = $NetworkAdapterObject |
            Invoke-CimMethod `
                -MethodName SetTcpipNetbios `
                -ErrorAction Stop `
                -Arguments @{
                    TcpipNetbiosOptions = [uint32][NetBiosSetting]::$Setting.value__
                }

        if ($result.ReturnValue -ne 0)
        {
            New-InvalidOperationException `
                -Message ($script:localizedData.FailedUpdatingNetBiosError -f $InterfaceAlias, $result.ReturnValue, $Setting)
        }
    }
    else
    {
        <#
            IPEnabled=$false can only be configured via registry
            this satisfies disabled and disconnected states
        #>

        $setItemPropertyParameters = @{
            Path  = "$($script:hklmInterfacesPath)\Tcpip_$($NetworkAdapterObject.SettingID)"
            Name  = 'NetbiosOptions'
            Value = [NetBiosSetting]::$Setting.value__
        }
        $null = Set-ItemProperty @setItemPropertyParameters
    }
} # end function Set-NetAdapterNetbiosOptions

Export-ModuleMember -Function *-TargetResource