Allow configuration of hidden network adapters

CHANGELOG.md

@@ -26,6 +26,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Updated build to use `Sampler.GitHubTasks` - Fixes [Issue #489](https://github.com/dsccommunity/NetworkingDsc/issues/489).
 - Added support for publishing code coverage to `CodeCov.io` and
   Azure Pipelines - Fixes [Issue #491](https://github.com/dsccommunity/NetworkingDsc/issues/491).
+- Allow configuration of hidden network adapters.
 
 ## [8.2.0] - 2020-10-16
 

source/DSCResources/DSC_DefaultGatewayAddress/DSC_DefaultGatewayAddress.psm1

@@ -292,7 +292,7 @@ function Assert-ResourceProperty
         $Address
     )
 
-    if (-not (Get-NetAdapter | Where-Object -Property Name -EQ $InterfaceAlias ))
+    if (-not (Find-NetworkAdapter -Name $InterfaceAlias ))
     {
         New-InvalidOperationException `
             -Message ($script:localizedData.InterfaceNotAvailableError -f $InterfaceAlias)

source/DSCResources/DSC_DnsConnectionSuffix/DSC_DnsConnectionSuffix.psm1

@@ -60,7 +60,9 @@ function Get-TargetResource
         $Ensure = 'Present'
     )
 
-    $dnsClient = Get-DnsClient -InterfaceAlias $InterfaceAlias -ErrorAction SilentlyContinue
+    $dnsClient = Get-DnsClient `
+        -InterfaceAlias $InterfaceAlias `
+        -ErrorAction SilentlyContinue
 
     $targetResource = @{
         InterfaceAlias                 = $dnsClient.InterfaceAlias

source/DSCResources/DSC_FirewallProfile/DSC_FirewallProfile.psm1

@@ -46,7 +46,8 @@ function Get-TargetResource
         ) -join '' )
 
     # Get the current Dns Client Global Settings
-    $netFirewallProfile = Get-NetFirewallProfile -Name $Name `
+    $netFirewallProfile = Get-NetFirewallProfile `
+        -Name $Name `
         -ErrorAction Stop
 
     # Generate the return object.
@@ -231,7 +232,8 @@ function Set-TargetResource
         ) -join '' )
 
     # Get the current Firewall Profile Settings
-    $netFirewallProfile = Get-NetFirewallProfile -Name $Name `
+    $netFirewallProfile = Get-NetFirewallProfile `
+        -Name $Name `
         -ErrorAction Stop
 
     # Generate a list of parameters that will need to be changed.
@@ -243,7 +245,10 @@ function Set-TargetResource
         $parameterNewValue = (Get-Variable -Name ($parameter.name)).Value
 
         if ($PSBoundParameters.ContainsKey($parameter.Name) `
-            -and (Compare-Object -ReferenceObject $parameterSourceValue -DifferenceObject $parameterNewValue -SyncWindow 0))
+            -and (Compare-Object `
+                -ReferenceObject $parameterSourceValue `
+                -DifferenceObject $parameterNewValue `
+                -SyncWindow 0))
         {
             $changeParameters += @{
                 $($parameter.name) = $parameterNewValue
@@ -442,7 +447,8 @@ function Test-TargetResource
     $desiredConfigurationMatch = $true
 
     # Get the current Dns Client Global Settings
-    $netFirewallProfile = Get-NetFirewallProfile -Name $Name `
+    $netFirewallProfile = Get-NetFirewallProfile `
+        -Name $Name `
         -ErrorAction Stop
 
     # Check each parameter

source/DSCResources/DSC_IPAddress/DSC_IPAddress.psm1

@@ -228,7 +228,8 @@ function Set-TargetResource
         try
         {
             # Apply the specified IP configuration
-            New-NetIPAddress @newNetIPAddressParameters -ErrorAction Stop
+            New-NetIPAddress @newNetIPAddressParameters `
+                -ErrorAction Stop
         }
         catch [Microsoft.Management.Infrastructure.CimException]
         {
@@ -240,7 +241,8 @@ function Set-TargetResource
                 Setting New-NetIPaddress will throw [Microsoft.Management.Infrastructure.CimException] if
                 the IP address is already set. Need to check to make sure the IP is set on correct interface
             #>
-            $verifyNetIPAddressAdapter = Get-NetIPAddress @verifyNetIPAddressAdapterParam -ErrorAction SilentlyContinue
+            $verifyNetIPAddressAdapter = Get-NetIPAddress @verifyNetIPAddressAdapterParam `
+                -ErrorAction SilentlyContinue
 
             if ($verifyNetIPAddressAdapter.InterfaceAlias -eq $InterfaceAlias)
             {
@@ -343,7 +345,9 @@ function Test-TargetResource
         }
     } # while
 
-    $ipAddressObject = Get-IPAddressPrefix -IPAddress $IPAddress -AddressFamily $AddressFamily
+    $ipAddressObject = Get-IPAddressPrefix `
+        -IPAddress $IPAddress `
+        -AddressFamily $AddressFamily
 
     # Test if the IP Address passed is present
     foreach ($singleIP in $ipAddressObject)
@@ -480,7 +484,9 @@ function Assert-ResourceProperty
     {
         $singleIP = ($singleIPAddress -split '/')[0]
 
-        Assert-IPAddress -Address $singleIP -AddressFamily $AddressFamily
+        Assert-IPAddress `
+            -Address $singleIP `
+            -AddressFamily $AddressFamily
     }
 
     foreach ($prefixLength in $prefixLengthArray)

source/DSCResources/DSC_IPAddressOption/DSC_IPAddressOption.psm1

@@ -83,7 +83,9 @@ function Set-TargetResource
 
     if ($currentConfig.SkipAsSource -ne $SkipAsSource)
     {
-        Set-NetIPAddress -IPAddress $IPAddress -SkipAsSource $SkipAsSource
+        Set-NetIPAddress `
+            -IPAddress $IPAddress `
+            -SkipAsSource $SkipAsSource
     }
 }
 

source/DSCResources/DSC_NetAdapterAdvancedProperty/DSC_NetAdapterAdvancedProperty.psm1

@@ -51,6 +51,7 @@ function Get-TargetResource
     {
         $netAdapterAdvancedProperty = Get-NetAdapterAdvancedProperty `
             -Name $networkAdapterName `
+            -IncludeHidden:$true `
             -RegistryKeyword $RegistryKeyword `
             -ErrorAction Stop
     }
@@ -118,6 +119,7 @@ function Set-TargetResource
     {
         $netAdapterAdvancedProperty = Get-NetAdapterAdvancedProperty `
             -Name $networkAdapterName `
+            -IncludeHidden:$true `
             -RegistryKeyword $RegistryKeyword `
             -ErrorAction Stop
     }
@@ -146,6 +148,7 @@ function Set-TargetResource
             Set-NetAdapterAdvancedProperty `
                 -RegistryValue $RegistryValue `
                 -Name $networkAdapterName `
+                -IncludeHidden:$true `
                 -RegistryKeyword $RegistryKeyword
         }
     }
@@ -192,6 +195,7 @@ function Test-TargetResource
     {
         $netAdapterAdvancedProperty = Get-NetAdapterAdvancedProperty `
             -Name $networkAdapterName `
+            -IncludeHidden:$true `
             -RegistryKeyword $RegistryKeyword `
             -ErrorAction Stop
     }

source/DSCResources/DSC_NetAdapterBinding/DSC_NetAdapterBinding.psm1

@@ -126,7 +126,8 @@ function Set-TargetResource
 
     if ($State -eq 'Enabled')
     {
-        Enable-NetAdapterBinding @PSBoundParameters
+        Enable-NetAdapterBinding @PSBoundParameters `
+            -IncludeHidden:$true
 
         Write-Verbose -Message ( @("$($MyInvocation.MyCommand): "
                 $($script:localizedData.NetAdapterBindingEnabledMessage -f `
@@ -135,7 +136,8 @@ function Set-TargetResource
     }
     else
     {
-        Disable-NetAdapterBinding @PSBoundParameters
+        Disable-NetAdapterBinding @PSBoundParameters `
+            -IncludeHidden:$true
 
         Write-Verbose -Message ( @("$($MyInvocation.MyCommand): "
                 $($script:localizedData.NetAdapterBindingDisabledMessage -f `
@@ -260,7 +262,7 @@ function Get-Binding
         $State = 'Enabled'
     )
 
-    if (-not (Get-NetAdapter -Name $InterfaceAlias -ErrorAction SilentlyContinue))
+    if (-not (Find-NetworkAdapter -Name $InterfaceAlias -ErrorAction SilentlyContinue))
     {
         New-InvalidArgumentException `
             -Message ($script:localizedData.InterfaceNotAvailableError -f $InterfaceAlias) `
@@ -269,6 +271,7 @@ function Get-Binding
 
     $binding = Get-NetAdapterBinding `
         -InterfaceAlias $InterfaceAlias `
+        -IncludeHidden:$true `
         -ComponentId $ComponentId `
         -ErrorAction Stop
 

source/DSCResources/DSC_NetAdapterLso/DSC_NetAdapterLso.psm1

@@ -50,7 +50,10 @@ function Get-TargetResource
 
     try
     {
-        $netAdapter = Get-NetAdapterLso -Name $Name -ErrorAction Stop
+        $netAdapter = Get-NetAdapterLso `
+            -Name $Name `
+            -IncludeHidden:$true `
+            -ErrorAction Stop
     }
     catch
     {
@@ -131,7 +134,10 @@ function Set-TargetResource
 
     try
     {
-        $netAdapter = Get-NetAdapterLso -Name $Name -ErrorAction Stop
+        $netAdapter = Get-NetAdapterLso `
+            -Name $Name `
+            -IncludeHidden:$true `
+            -ErrorAction Stop
     }
     catch
     {
@@ -154,7 +160,10 @@ function Set-TargetResource
                             $Name, $Protocol, $($netAdapter.V1IPv4Enabled.ToString()), $($State.ToString()) )
                 ) -join '')
 
-            Set-NetAdapterLso -Name $Name -V1IPv4Enabled $State
+            Set-NetAdapterLso `
+                -Name $Name `
+                -IncludeHidden:$true `
+                -V1IPv4Enabled $State
         }
         elseif ($Protocol -eq 'IPv4' -and $State -ne $netAdapter.IPv4Enabled)
         {
@@ -164,7 +173,10 @@ function Set-TargetResource
                             $Name, $Protocol, $($netAdapter.IPv4Enabled.ToString()), $($State.ToString()) )
                 ) -join '')
 
-            Set-NetAdapterLso -Name $Name -IPv4Enabled $State
+            Set-NetAdapterLso `
+                -Name $Name `
+                -IncludeHidden:$true `
+                -IPv4Enabled $State
         }
         elseif ($Protocol -eq 'IPv6' -and $State -ne $netAdapter.IPv6Enabled)
         {
@@ -174,7 +186,10 @@ function Set-TargetResource
                             $Name, $Protocol, $($netAdapter.IPv6Enabled.ToString()), $($State.ToString()) )
                 ) -join '')
 
-            Set-NetAdapterLso -Name $Name -IPv6Enabled $State
+            Set-NetAdapterLso `
+                -Name $Name `
+                -IncludeHidden:$true `
+                -IPv6Enabled $State
         }
     }
 }
@@ -219,7 +234,10 @@ function Test-TargetResource
 
     try
     {
-        $netAdapter = Get-NetAdapterLso -Name $Name -ErrorAction Stop
+        $netAdapter = Get-NetAdapterLso `
+            -Name $Name `
+            -IncludeHidden:$true `
+            -ErrorAction Stop
     }
     catch
     {

source/DSCResources/DSC_NetAdapterName/DSC_NetAdapterName.psm1

@@ -33,6 +33,9 @@ $script:localizedData = Get-LocalizedData -DefaultUICulture 'en-US'
     .PARAMETER InterfaceDescription
         This is the interface description of the network adapter to find.
 
+    .PARAMETER IncludeHidden
+        This switch indicates the adapter to find may be hidden.
+
     .PARAMETER InterfaceIndex
         This is the interface index of the network adapter to find.
 
@@ -84,6 +87,10 @@ function Get-TargetResource
         [System.String]
         $InterfaceDescription,
 
+        [Parameter()]
+        [System.Boolean]
+        $IncludeHidden = $false,
+
         [Parameter()]
         [System.UInt32]
         $InterfaceIndex,
@@ -111,6 +118,7 @@ function Get-TargetResource
 
     $adapter = Find-NetworkAdapter `
         -Name $NewName `
+        -IncludeHidden:$IncludeHidden `
         -ErrorAction SilentlyContinue
 
     if (-not $adapter)
@@ -136,6 +144,7 @@ function Get-TargetResource
         Status                         = $adapter.Status
         MacAddress                     = $adapter.MacAddress
         InterfaceDescription           = $adapter.InterfaceDescription
+        IncludeHidden                  = $IncludeHidden
         InterfaceIndex                 = $adapter.InterfaceIndex
         InterfaceGuid                  = $adapter.InterfaceGuid
         DriverDescription              = $adapter.DriverDescription
@@ -168,6 +177,9 @@ function Get-TargetResource
     .PARAMETER InterfaceDescription
         This is the interface description of the network adapter to find.
 
+    .PARAMETER IncludeHidden
+        This switch indicates the adapter to find may be hidden.
+
     .PARAMETER InterfaceIndex
         This is the interface index of the network adapter to find.
 
@@ -218,6 +230,10 @@ function Set-TargetResource
         [System.String]
         $InterfaceDescription,
 
+        [Parameter()]
+        [System.Boolean]
+        $IncludeHidden = $false,
+
         [Parameter()]
         [System.UInt32]
         $InterfaceIndex,
@@ -253,7 +269,9 @@ function Set-TargetResource
             $($script:localizedData.RenamingNetAdapterNameMessage -f $adapter.Name, $NewName)
         ) -join '')
 
-    $adapter | Rename-NetAdapter -NewName $NewName
+    $adapter | Rename-NetAdapter `
+        -IncludeHidden:$IncludeHidden `
+        -NewName $NewName
 
     Write-Verbose -Message ( @( "$($MyInvocation.MyCommand): "
             $($script:localizedData.NetAdapterNameRenamedMessage -f $NewName)
@@ -283,6 +301,9 @@ function Set-TargetResource
     .PARAMETER InterfaceDescription
         This is the interface description of the network adapter to find.
 
+    .PARAMETER IncludeHidden
+        This switch indicates the adapter to find may be hidden.
+
     .PARAMETER InterfaceIndex
         This is the interface index of the network adapter to find.
 
@@ -334,6 +355,10 @@ function Test-TargetResource
         [System.String]
         $InterfaceDescription,
 
+        [Parameter()]
+        [System.Boolean]
+        $IncludeHidden = $false,
+
         [Parameter()]
         [System.UInt32]
         $InterfaceIndex,
@@ -364,6 +389,7 @@ function Test-TargetResource
     # Can an adapter be found with the new name?
     $adapterWithNewName = Find-NetworkAdapter `
         -Name $NewName `
+        -IncludeHidden:$IncludeHidden `
         -Verbose:$Verbose `
         -ErrorAction SilentlyContinue
 

source/DSCResources/DSC_NetAdapterName/DSC_NetAdapterName.schema.mof

@@ -7,6 +7,7 @@ class DSC_NetAdapterName : OMI_BaseResource
     [Write, Description("This is the status of the network adapter to find."), ValueMap{"Up", "Disconnected", "Disabled"}, Values{"Up", "Disconnected", "Disabled"}] String Status;
     [Write, Description("This is the MAC address of the network adapter to find.")] String MacAddress;
     [Write, Description("This is the interface description of the network adapter to find.")] String InterfaceDescription;
+    [Write, Description("This switch indicates the adapter to find may be hidden.")] Boolean IncludeHidden;
     [Write, Description("This is the interface index of the network adapter to find.")] UInt32 InterfaceIndex;
     [Write, Description("This is the interface GUID of the network adapter to find.")] String InterfaceGuid;
     [Write, Description("This is the driver description of the network adapter.")] String DriverDescription;