DSCResources/DSC_NetAdapterName/DSC_NetAdapterName.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 |
$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' <# .SYNOPSIS This function will get the network adapter based on the provided parameters. .PARAMETER NewName Specifies the new name of the network adapter. .PARAMETER Name This is the name of the network adapter to find. .PARAMETER PhysicalMediaType This is the media type of the network adapter to find. .PARAMETER Status This is the status of the network adapter to find. .PARAMETER MacAddress This is the MAC address of the network adapter to find. .PARAMETER InterfaceDescription This is the interface description of the network adapter to find. .PARAMETER InterfaceIndex This is the interface index of the network adapter to find. .PARAMETER InterfaceGuid This is the interface GUID of the network adapter to find. .PARAMETER DriverDescription This is the driver description of the network adapter. .PARAMETER InterfaceNumber This is the interface number of the network adapter if more than one are returned by the parameters. .PARAMETER IgnoreMultipleMatchingAdapters This switch will suppress an error occurring if more than one matching adapter matches the parameters passed. #> function Get-TargetResource { [CmdletBinding()] [OutputType([System.Collections.Hashtable])] param ( [Parameter(Mandatory = $true)] [ValidateNotNullOrEmpty()] [System.String] $NewName, [Parameter()] [ValidateNotNullOrEmpty()] [System.String] $Name, [Parameter()] [System.String] $PhysicalMediaType, [Parameter()] [ValidateNotNullOrEmpty()] [ValidateSet('Up', 'Disconnected', 'Disabled')] [System.String] $Status = 'Up', [Parameter()] [System.String] $MacAddress, [Parameter()] [System.String] $InterfaceDescription, [Parameter()] [System.UInt32] $InterfaceIndex, [Parameter()] [System.String] $InterfaceGuid, [Parameter()] [System.String] $DriverDescription, [Parameter()] [System.UInt32] $InterfaceNumber = 1, [Parameter()] [System.Boolean] $IgnoreMultipleMatchingAdapters = $false ) Write-Verbose -Message ( @("$($MyInvocation.MyCommand): " $($script:localizedData.GettingNetAdapterNameMessage -f $NewName) ) -join '') $adapter = Find-NetworkAdapter ` -Name $NewName ` -ErrorAction SilentlyContinue if (-not $adapter) { Write-Verbose -Message ( @( "$($MyInvocation.MyCommand): " $($script:localizedData.FindNetAdapterMessage) ) -join '') $null = $PSBoundParameters.Remove('NewName') $adapter = Find-NetworkAdapter ` @PSBoundParameters ` -ErrorAction Stop } Write-Verbose -Message ( @( "$($MyInvocation.MyCommand): " $($script:localizedData.NetAdapterNameFoundMessage -f $adapter.Name) ) -join '') $returnValue = @{ Name = $adapter.Name PhysicalMediaType = $adapter.PhysicalMediaType Status = $adapter.Status MacAddress = $adapter.MacAddress InterfaceDescription = $adapter.InterfaceDescription InterfaceIndex = $adapter.InterfaceIndex InterfaceGuid = $adapter.InterfaceGuid DriverDescription = $adapter.DriverDescription InterfaceNumber = $InterfaceNumber IgnoreMultipleMatchingAdapters = $IgnoreMultipleMatchingAdapters } return $returnValue } # Get-TargetResource <# .SYNOPSIS This function will rename a network adapter that matches the parameters. .PARAMETER NewName Specifies the new name of the network adapter. .PARAMETER Name This is the name of the network adapter to find. .PARAMETER PhysicalMediaType This is the media type of the network adapter to find. .PARAMETER Status This is the status of the network adapter to find. .PARAMETER MacAddress This is the MAC address of the network adapter to find. .PARAMETER InterfaceDescription This is the interface description of the network adapter to find. .PARAMETER InterfaceIndex This is the interface index of the network adapter to find. .PARAMETER InterfaceGuid This is the interface GUID of the network adapter to find. .PARAMETER DriverDescription This is the driver description of the network adapter. .PARAMETER InterfaceNumber This is the interface number of the network adapter if more than one are returned by the parameters. .PARAMETER IgnoreMultipleMatchingAdapters This switch will suppress an error occurring if more than one matching adapter matches the parameters passed. #> function Set-TargetResource { [CmdletBinding()] param ( [Parameter(Mandatory = $true)] [ValidateNotNullOrEmpty()] [System.String] $NewName, [Parameter()] [ValidateNotNullOrEmpty()] [System.String] $Name, [Parameter()] [System.String] $PhysicalMediaType, [Parameter()] [ValidateNotNullOrEmpty()] [ValidateSet('Up', 'Disconnected', 'Disabled')] [System.String] $Status = 'Up', [Parameter()] [System.String] $MacAddress, [Parameter()] [System.String] $InterfaceDescription, [Parameter()] [System.UInt32] $InterfaceIndex, [Parameter()] [System.String] $InterfaceGuid, [Parameter()] [System.String] $DriverDescription, [Parameter()] [System.UInt32] $InterfaceNumber = 1, [Parameter()] [System.Boolean] $IgnoreMultipleMatchingAdapters = $false ) Write-Verbose -Message ( @( "$($MyInvocation.MyCommand): " $($script:localizedData.SettingNetAdapterNameMessage -f $NewName) ) -join '') $null = $PSBoundParameters.Remove('NewName') $adapter = Find-NetworkAdapter ` @PSBoundParameters ` -ErrorAction Stop Write-Verbose -Message ( @( "$($MyInvocation.MyCommand): " $($script:localizedData.RenamingNetAdapterNameMessage -f $adapter.Name, $NewName) ) -join '') $adapter | Rename-NetAdapter -NewName $NewName Write-Verbose -Message ( @( "$($MyInvocation.MyCommand): " $($script:localizedData.NetAdapterNameRenamedMessage -f $NewName) ) -join '') } # Set-TargetResource <# .SYNOPSIS This will check if the network adapter that matches the parameters needs to be returned. .PARAMETER NewName Specifies the new name of the network adapter. .PARAMETER Name This is the name of the network adapter to find. .PARAMETER PhysicalMediaType This is the media type of the network adapter to find. .PARAMETER Status This is the status of the network adapter to find. .PARAMETER MacAddress This is the MAC address of the network adapter to find. .PARAMETER InterfaceDescription This is the interface description of the network adapter to find. .PARAMETER InterfaceIndex This is the interface index of the network adapter to find. .PARAMETER InterfaceGuid This is the interface GUID of the network adapter to find. .PARAMETER DriverDescription This is the driver description of the network adapter. .PARAMETER InterfaceNumber This is the interface number of the network adapter if more than one are returned by the parameters. .PARAMETER IgnoreMultipleMatchingAdapters This switch will suppress an error occurring if more than one matching adapter matches the parameters passed. #> function Test-TargetResource { [CmdletBinding()] [OutputType([System.Boolean])] param ( [Parameter(Mandatory = $true)] [ValidateNotNullOrEmpty()] [System.String] $NewName, [Parameter()] [ValidateNotNullOrEmpty()] [System.String] $Name, [Parameter()] [System.String] $PhysicalMediaType, [Parameter()] [ValidateNotNullOrEmpty()] [ValidateSet('Up', 'Disconnected', 'Disabled')] [System.String] $Status = 'Up', [Parameter()] [System.String] $MacAddress, [Parameter()] [System.String] $InterfaceDescription, [Parameter()] [System.UInt32] $InterfaceIndex, [Parameter()] [System.String] $InterfaceGuid, [Parameter()] [System.String] $DriverDescription, [Parameter()] [System.UInt32] $InterfaceNumber = 1, [Parameter()] [System.Boolean] $IgnoreMultipleMatchingAdapters = $false ) Write-Verbose -Message ( @("$($MyInvocation.MyCommand): " $($script:localizedData.TestingNetAdapterNameMessage -f $NewName) ) -join '') $null = $PSBoundParameters.Remove('NewName') # Can an adapter be found with the new name? $adapterWithNewName = Find-NetworkAdapter ` -Name $NewName ` -Verbose:$Verbose ` -ErrorAction SilentlyContinue if ($adapterWithNewName) { # An adapter was found matching the new name Write-Verbose -Message ( @("$($MyInvocation.MyCommand): " $($script:localizedData.NetAdapterWithNewNameExistsMessage -f $adapterWithNewName.Name) ) -join '') return $true } else { # Find an adapter matching the parameters - throw if none can be found Write-Verbose -Message ( @( "$($MyInvocation.MyCommand): " $($script:localizedData.FindNetAdapterMessage) ) -join '') $adapter = Find-NetworkAdapter ` @PSBoundParameters ` -ErrorAction Stop # An adapter was found that needs to be changed to the new name Write-Verbose -Message ( @("$($MyInvocation.MyCommand): " $($script:localizedData.NetAdapterNameNotMatchMessage -f $adapter.Name, $NewName) ) -join '') return $false } # if } # Test-TargetResource Export-ModuleMember -function *-TargetResource |