Expose -IncludeHidden parameter

NetAdapter module Cmdlets have an -IncludeHidden flag which allows access to adapters which are hidden; expose that flag here. - Add flag to MOF schemas - Add function parameter and comment based help - NetAdapterName should now be working - NetAdapterRdma should now be working - NetAdapterRss should now be working - NetAdapterState should now be working
dsccommunity · May 20, 2021 · 5b20e0a · 5b20e0a
1 parent 983c54b
commit 5b20e0a
Show file tree

Hide file tree

Showing 26 changed files with 429 additions and 36 deletions.
diff --git a/source/DSCResources/DSC_DefaultGatewayAddress/DSC_DefaultGatewayAddress.psm1 b/source/DSCResources/DSC_DefaultGatewayAddress/DSC_DefaultGatewayAddress.psm1
@@ -141,6 +141,7 @@ function Set-TargetResource
         $newNetRouteParameters = @{
             DestinationPrefix = $destinationPrefix
             InterfaceAlias    = $InterfaceAlias
+            IncludeHidden     = $IncludeHidden
             AddressFamily     = $AddressFamily
             NextHop           = $Address
         }
@@ -292,7 +293,7 @@ function Assert-ResourceProperty
         $Address
     )
 
-    if (-not (Get-NetAdapter | Where-Object -Property Name -EQ $InterfaceAlias ))
+    if (-not (Get-NetAdapter -IncludeHidden:$IncludeHidden | Where-Object -Property Name -EQ $InterfaceAlias ))
     {
         New-InvalidOperationException `
             -Message ($script:localizedData.InterfaceNotAvailableError -f $InterfaceAlias)

diff --git a/source/DSCResources/DSC_NetAdapterAdvancedProperty/DSC_NetAdapterAdvancedProperty.psm1 b/source/DSCResources/DSC_NetAdapterAdvancedProperty/DSC_NetAdapterAdvancedProperty.psm1
@@ -17,6 +17,9 @@ $script:localizedData = Get-LocalizedData -DefaultUICulture 'en-US'
     .PARAMETER NetworkAdapterName
         Specifies the name of the network adapter to set the advanced property for.
 
+    .PARAMETER IncludeHidden
+        This switch will causes hidden network adapters to be included in the search.
+
     .PARAMETER RegistryKeyword
         Specifies the registry keyword that should be in desired state.
 
@@ -33,6 +36,10 @@ function Get-TargetResource
         [System.String]
         $NetworkAdapterName,
 
+        [Parameter()]
+        [System.Boolean]
+        $IncludeHidden = $false,
+
         [Parameter(Mandatory = $true)]
         [System.String]
         $RegistryKeyword,
@@ -51,6 +58,7 @@ function Get-TargetResource
     {
         $netAdapterAdvancedProperty = Get-NetAdapterAdvancedProperty `
             -Name $networkAdapterName `
+            -IncludeHidden:$IncludeHidden `
             -RegistryKeyword $RegistryKeyword `
             -ErrorAction Stop
     }
@@ -85,6 +93,9 @@ function Get-TargetResource
     .PARAMETER NetworkAdapterName
         Specifies the name of the network adapter to set the advanced property for.
 
+    .PARAMETER IncludeHidden
+        This switch will causes hidden network adapters to be included in the search.
+
     .PARAMETER RegistryKeyword
         Specifies the registry keyword that should be in desired state.
 
@@ -100,6 +111,10 @@ function Set-TargetResource
         [System.String]
         $NetworkAdapterName,
 
+        [Parameter()]
+        [System.Boolean]
+        $IncludeHidden = $false,
+
         [Parameter(Mandatory = $true)]
         [System.String]
         $RegistryKeyword,
@@ -118,6 +133,7 @@ function Set-TargetResource
     {
         $netAdapterAdvancedProperty = Get-NetAdapterAdvancedProperty `
             -Name $networkAdapterName `
+            -IncludeHidden:$IncludeHidden `
             -RegistryKeyword $RegistryKeyword `
             -ErrorAction Stop
     }
@@ -146,6 +162,7 @@ function Set-TargetResource
             Set-NetAdapterAdvancedProperty `
                 -RegistryValue $RegistryValue `
                 -Name $networkAdapterName `
+                -IncludeHidden:$IncludeHidden `
                 -RegistryKeyword $RegistryKeyword
         }
     }
@@ -158,6 +175,9 @@ function Set-TargetResource
     .PARAMETER NetworkAdapterName
         Specifies the name of the network adapter to set the advanced property for.
 
+    .PARAMETER IncludeHidden
+        This switch will causes hidden network adapters to be included in the search.
+
     .PARAMETER RegistryKeyword
         Specifies the registry keyword that should be in desired state.
 
@@ -174,6 +194,10 @@ function Test-TargetResource
         [System.String]
         $NetworkAdapterName,
 
+        [Parameter()]
+        [System.Boolean]
+        $IncludeHidden = $false,
+
         [Parameter(Mandatory = $true)]
         [System.String]
         $RegistryKeyword,
@@ -192,6 +216,7 @@ function Test-TargetResource
     {
         $netAdapterAdvancedProperty = Get-NetAdapterAdvancedProperty `
             -Name $networkAdapterName `
+            -IncludeHidden:$IncludeHidden `
             -RegistryKeyword $RegistryKeyword `
             -ErrorAction Stop
     }

diff --git a/source/DSCResources/DSC_NetAdapterAdvancedProperty/DSC_NetAdapterAdvancedProperty.schema.mof b/source/DSCResources/DSC_NetAdapterAdvancedProperty/DSC_NetAdapterAdvancedProperty.schema.mof
@@ -2,6 +2,7 @@
 class DSC_NetAdapterAdvancedProperty : OMI_BaseResource
 {
     [Key, Description("Specifies the name of the network adapter to set the advanced property for.")] String NetworkAdapterName;
+    [Write, Description("This switch will causes hidden network adapters to be included in the search.")] Boolean IncludeHidden;
     [Key, Description("Specifies the registry keyword that should be in desired state.")] String RegistryKeyword;
     [Required, Description("Specifies the value of the registry keyword.")] String RegistryValue;
     [Read, Description("Output Display value of selected RegistryKeyword.")] String DisplayValue;

diff --git a/source/DSCResources/DSC_NetAdapterBinding/DSC_NetAdapterBinding.psm1 b/source/DSCResources/DSC_NetAdapterBinding/DSC_NetAdapterBinding.psm1
@@ -17,6 +17,9 @@ $script:localizedData = Get-LocalizedData -DefaultUICulture 'en-US'
     .PARAMETER InterfaceAlias
         Specifies the alias of a network interface. Supports the use of '*'.
 
+    .PARAMETER IncludeHidden
+        This switch will causes hidden network adapters to be included in the search.
+
     .PARAMETER ComponentId
         Specifies the underlying name of the transport or filter in the following
         form - ms_xxxx, such as ms_tcpip.
@@ -35,6 +38,10 @@ function Get-TargetResource
         [System.String]
         $InterfaceAlias,
 
+        [Parameter()]
+        [System.Boolean]
+        $IncludeHidden = $false,
+
         [Parameter(Mandatory = $true)]
         [ValidateNotNullOrEmpty()]
         [System.String]
@@ -86,6 +93,9 @@ function Get-TargetResource
     .PARAMETER InterfaceAlias
         Specifies the alias of a network interface. Supports the use of '*'.
 
+    .PARAMETER IncludeHidden
+        This switch will causes hidden network adapters to be included in the search.
+
     .PARAMETER ComponentId
         Specifies the underlying name of the transport or filter in the following
         form - ms_xxxx, such as ms_tcpip.
@@ -103,6 +113,10 @@ function Set-TargetResource
         [System.String]
         $InterfaceAlias,
 
+        [Parameter()]
+        [System.Boolean]
+        $IncludeHidden = $false,
+
         [Parameter(Mandatory = $true)]
         [ValidateNotNullOrEmpty()]
         [System.String]
@@ -151,6 +165,9 @@ function Set-TargetResource
     .PARAMETER InterfaceAlias
         Specifies the alias of a network interface. Supports the use of '*'.
 
+    .PARAMETER IncludeHidden
+        This switch will causes hidden network adapters to be included in the search.
+
     .PARAMETER ComponentId
         Specifies the underlying name of the transport or filter in the following
         form - ms_xxxx, such as ms_tcpip.
@@ -169,6 +186,10 @@ function Test-TargetResource
         [System.String]
         $InterfaceAlias,
 
+        [Parameter()]
+        [System.Boolean]
+        $IncludeHidden = $false,
+
         [Parameter(Mandatory = $true)]
         [ValidateNotNullOrEmpty()]
         [System.String]
@@ -231,6 +252,9 @@ function Test-TargetResource
     .PARAMETER InterfaceAlias
         Specifies the alias of a network interface. Supports the use of '*'.
 
+    .PARAMETER IncludeHidden
+        This switch will causes hidden network adapters to be included in the search.
+
     .PARAMETER ComponentId
         Specifies the underlying name of the transport or filter in the following
         form - ms_xxxx, such as ms_tcpip.
@@ -249,6 +273,10 @@ function Get-Binding
         [System.String]
         $InterfaceAlias,
 
+        [Parameter()]
+        [System.Boolean]
+        $IncludeHidden = $false,
+
         [Parameter(Mandatory = $true)]
         [ValidateNotNullOrEmpty()]
         [System.String]
@@ -260,7 +288,7 @@ function Get-Binding
         $State = 'Enabled'
     )
 
-    if (-not (Get-NetAdapter -Name $InterfaceAlias -ErrorAction SilentlyContinue))
+    if (-not (Get-NetAdapter -Name $InterfaceAlias -IncludeHidden:$IncludeHidden -ErrorAction SilentlyContinue))
     {
         New-InvalidArgumentException `
             -Message ($script:localizedData.InterfaceNotAvailableError -f $InterfaceAlias) `

diff --git a/source/DSCResources/DSC_NetAdapterBinding/DSC_NetAdapterBinding.schema.mof b/source/DSCResources/DSC_NetAdapterBinding/DSC_NetAdapterBinding.schema.mof
@@ -2,6 +2,7 @@
 class DSC_NetAdapterBinding : OMI_BaseResource
 {
     [Key, Description("Specifies the alias of a network interface. Supports the use of '*'.")] string InterfaceAlias;
+    [Write, Description("This switch will causes hidden network adapters to be included in the search.")] Boolean IncludeHidden;
     [Key, Description("Specifies the underlying name of the transport or filter in the following form - ms_xxxx, such as ms_tcpip.")] string ComponentId;
     [Write, Description("Specifies if the component ID for the Interface should be Enabled or Disabled."), ValueMap{"Enabled", "Disabled"}, Values{"Enabled", "Disabled"}] string State;
     [Read, Description("Returns the current state of the component ID for the Interfaces."), ValueMap{"Enabled", "Disabled","Mixed"}, Values{"Enabled", "Disabled","Mixed"}] string CurrentState;

diff --git a/source/DSCResources/DSC_NetAdapterLso/DSC_NetAdapterLso.psm1 b/source/DSCResources/DSC_NetAdapterLso/DSC_NetAdapterLso.psm1
@@ -17,6 +17,9 @@ $script:localizedData = Get-LocalizedData -DefaultUICulture 'en-US'
     .PARAMETER Name
         Specifies the name of the network adapter to check.
 
+    .PARAMETER IncludeHidden
+        This switch will causes hidden network adapters to be included in the search.
+
     .PARAMETER Protocol
         Specifies which protocol to target.
 
@@ -33,6 +36,10 @@ function Get-TargetResource
         [System.String]
         $Name,
 
+        [Parameter()]
+        [System.Boolean]
+        $IncludeHidden = $false,
+
         [Parameter(Mandatory = $true)]
         [ValidateSet('V1IPv4', 'IPv4', 'IPv6')]
         [System.String]
@@ -50,7 +57,9 @@ function Get-TargetResource
 
     try
     {
-        $netAdapter = Get-NetAdapterLso -Name $Name -ErrorAction Stop
+        $netAdapter = Get-NetAdapterLso -Name $Name `
+                                        -IncludeHidden:$IncludeHidden `
+                                        -ErrorAction Stop
     }
     catch
     {
@@ -99,6 +108,9 @@ function Get-TargetResource
     .PARAMETER Name
         Specifies the name of the network adapter to check.
 
+    .PARAMETER IncludeHidden
+        This switch will causes hidden network adapters to be included in the search.
+
     .PARAMETER Protocol
         Specifies which protocol to target.
 
@@ -114,6 +126,10 @@ function Set-TargetResource
         [System.String]
         $Name,
 
+        [Parameter()]
+        [System.Boolean]
+        $IncludeHidden = $false,
+
         [Parameter(Mandatory = $true)]
         [ValidateSet('V1IPv4', 'IPv4', 'IPv6')]
         [System.String]
@@ -131,7 +147,9 @@ function Set-TargetResource
 
     try
     {
-        $netAdapter = Get-NetAdapterLso -Name $Name -ErrorAction Stop
+        $netAdapter = Get-NetAdapterLso -Name $Name `
+                                        -IncludeHidden:$IncludeHidden `
+                                        -ErrorAction Stop
     }
     catch
     {
@@ -154,7 +172,9 @@ function Set-TargetResource
                             $Name, $Protocol, $($netAdapter.V1IPv4Enabled.ToString()), $($State.ToString()) )
                 ) -join '')
 
-            Set-NetAdapterLso -Name $Name -V1IPv4Enabled $State
+            Set-NetAdapterLso -Name $Name `
+                              -IncludeHidden:$IncludeHidden `
+                              -ErrorAction Stop
         }
         elseif ($Protocol -eq 'IPv4' -and $State -ne $netAdapter.IPv4Enabled)
         {
@@ -164,7 +184,9 @@ function Set-TargetResource
                             $Name, $Protocol, $($netAdapter.IPv4Enabled.ToString()), $($State.ToString()) )
                 ) -join '')
 
-            Set-NetAdapterLso -Name $Name -IPv4Enabled $State
+            Set-NetAdapterLso -Name $Name `
+                              -IncludeHidden:$IncludeHidden `
+                              -ErrorAction Stop
         }
         elseif ($Protocol -eq 'IPv6' -and $State -ne $netAdapter.IPv6Enabled)
         {
@@ -174,7 +196,9 @@ function Set-TargetResource
                             $Name, $Protocol, $($netAdapter.IPv6Enabled.ToString()), $($State.ToString()) )
                 ) -join '')
 
-            Set-NetAdapterLso -Name $Name -IPv6Enabled $State
+            Set-NetAdapterLso -Name $Name `
+                              -IncludeHidden:$IncludeHidden `
+                              -ErrorAction Stop
         }
     }
 }
@@ -186,6 +210,9 @@ function Set-TargetResource
     .PARAMETER Name
         Specifies the name of the network adapter to check.
 
+    .PARAMETER IncludeHidden
+        This switch will causes hidden network adapters to be included in the search.
+
     .PARAMETER Protocol
         Specifies which protocol to target.
 
@@ -202,6 +229,10 @@ function Test-TargetResource
         [System.String]
         $Name,
 
+        [Parameter()]
+        [System.Boolean]
+        $IncludeHidden = $false,
+
         [Parameter(Mandatory = $true)]
         [ValidateSet('V1IPv4', 'IPv4', 'IPv6')]
         [System.String]
@@ -219,7 +250,9 @@ function Test-TargetResource
 
     try
     {
-        $netAdapter = Get-NetAdapterLso -Name $Name -ErrorAction Stop
+        $netAdapter = Get-NetAdapterLso -Name $Name `
+                                        -IncludeHidden:$IncludeHidden `
+                                        -ErrorAction Stop
     }
     catch
     {

diff --git a/source/DSCResources/DSC_NetAdapterLso/DSC_NetAdapterLso.schema.mof b/source/DSCResources/DSC_NetAdapterLso/DSC_NetAdapterLso.schema.mof
@@ -2,6 +2,7 @@
 class DSC_NetAdapterLso : OMI_BaseResource
 {
     [Key, Description("Specifies the name of network adapter.")] String Name;
+    [Write, Description("This switch will causes hidden network adapters to be included in the search.")] Boolean IncludeHidden;
     [Key, Description("Specifies which protocol to make changes to."), ValueMap{"V1IPv4","IPv4","IPv6"}, Values{"V1IPv4","IPv4","IPv6"}] String Protocol;
     [Required, Description("Specifies whether LSO should be enabled or disabled.")] Boolean State;
 };