DSCResources/DSC_NetConnectionProfile/DSC_NetConnectionProfile.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 |
$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 Returns the current Networking Connection Profile for the specified interface. .PARAMETER InterfaceAlias Specifies the alias for the Interface that is being changed. #> function Get-TargetResource { [CmdletBinding()] [OutputType([System.Collections.Hashtable])] param ( [Parameter(Position = 0, Mandatory = $true)] [System.String] $InterfaceAlias ) Write-Verbose -Message ( @( "$($MyInvocation.MyCommand): " $($script:localizedData.GettingNetConnectionProfile) -f $InterfaceAlias ) -join '') $result = Get-NetConnectionProfile -InterfaceAlias $InterfaceAlias return @{ InterfaceAlias = $result.InterfaceAlias NetworkCategory = $result.NetworkCategory IPv4Connectivity = $result.IPv4Connectivity IPv6Connectivity = $result.IPv6Connectivity } } <# .SYNOPSIS Sets the Network Connection Profile for a specified interface. .PARAMETER InterfaceAlias Specifies the alias for the Interface that is being changed. .PARAMETER IPv4Connectivity Specifies the IPv4 Connection Value. .PARAMETER IPv6Connectivity Specifies the IPv6 Connection Value. .PARAMETER NetworkCategory Sets the Network Category for the interface #> function Set-TargetResource { [CmdletBinding()] param ( [Parameter(Mandatory = $true)] [System.String] $InterfaceAlias, [Parameter()] [ValidateSet('Disconnected', 'NoTraffic', 'Subnet', 'LocalNetwork', 'Internet')] [System.String] $IPv4Connectivity, [Parameter()] [ValidateSet('Disconnected', 'NoTraffic', 'Subnet', 'LocalNetwork', 'Internet')] [System.String] $IPv6Connectivity, [Parameter()] [ValidateSet('Public', 'Private')] [System.String] $NetworkCategory ) Write-Verbose -Message ( @( "$($MyInvocation.MyCommand): " $($script:localizedData.SetNetConnectionProfile) -f $InterfaceAlias ) -join '') Assert-ResourceProperty @PSBoundParameters Set-NetConnectionProfile @PSBoundParameters } <# .SYNOPSIS Tests is the Network Connection Profile for the specified interface is in the correct state. .PARAMETER InterfaceAlias Specifies the alias for the Interface that is being changed. .PARAMETER IPv4Connectivity Specifies the IPv4 Connection Value. .PARAMETER IPv6Connectivity Specifies the IPv6 Connection Value. .PARAMETER NetworkCategory Sets the NetworkCategory for the interface #> function Test-TargetResource { [CmdletBinding()] [OutputType([System.Boolean])] param ( [Parameter(Mandatory = $true)] [System.String] $InterfaceAlias, [Parameter()] [ValidateSet('Disconnected', 'NoTraffic', 'Subnet', 'LocalNetwork', 'Internet')] [System.String] $IPv4Connectivity, [Parameter()] [ValidateSet('Disconnected', 'NoTraffic', 'Subnet', 'LocalNetwork', 'Internet')] [System.String] $IPv6Connectivity, [Parameter()] [ValidateSet('Public', 'Private')] [System.String] $NetworkCategory ) Assert-ResourceProperty @PSBoundParameters $current = Get-TargetResource -InterfaceAlias $InterfaceAlias if (-not [System.String]::IsNullOrEmpty($IPv4Connectivity) -and ` ($IPv4Connectivity -ne $current.IPv4Connectivity)) { Write-Verbose -Message ( @( "$($MyInvocation.MyCommand): " $($script:localizedData.TestIPv4Connectivity) -f $IPv4Connectivity, $current.IPv4Connectivity ) -join '') return $false } if (-not [System.String]::IsNullOrEmpty($IPv6Connectivity) -and ` ($IPv6Connectivity -ne $current.IPv6Connectivity)) { Write-Verbose -Message ( @( "$($MyInvocation.MyCommand): " $($script:localizedData.TestIPv6Connectivity) -f $IPv6Connectivity, $current.IPv6Connectivity ) -join '') return $false } if (-not [System.String]::IsNullOrEmpty($NetworkCategory) -and ` ($NetworkCategory -ne $current.NetworkCategory)) { Write-Verbose -Message ( @( "$($MyInvocation.MyCommand): " $($script:localizedData.TestNetworkCategory) -f $NetworkCategory, $current.NetworkCategory ) -join '') return $false } return $true } <# .SYNOPSIS Check the parameter combination that was passed was valid. Ensures interface exists. If any problems are detected an exception will be thrown. .PARAMETER InterfaceAlias Specifies the alias for the Interface that is being changed. .PARAMETER IPv4Connectivity Specifies the IPv4 Connection Value. .PARAMETER IPv6Connectivity Specifies the IPv6 Connection Value. .PARAMETER NetworkCategory Sets the NetworkCategory for the interface #> function Assert-ResourceProperty { [CmdletBinding()] param ( [Parameter(Mandatory = $true)] [System.String] $InterfaceAlias, [Parameter()] [ValidateSet('Disconnected', 'NoTraffic', 'Subnet', 'LocalNetwork', 'Internet')] [System.String] $IPv4Connectivity, [Parameter()] [ValidateSet('Disconnected', 'NoTraffic', 'Subnet', 'LocalNetwork', 'Internet')] [System.String] $IPv6Connectivity, [Parameter()] [ValidateSet('Public', 'Private')] [System.String] $NetworkCategory ) if (-not (Get-NetAdapter | Where-Object -Property Name -EQ $InterfaceAlias )) { New-InvalidOperationException ` -Message ($script:localizedData.InterfaceNotAvailableError -f $InterfaceAlias) } if ([System.String]::IsNullOrEmpty($IPv4Connectivity) -and ` [System.String]::IsNullOrEmpty($IPv6Connectivity) -and ` [System.String]::IsNullOrEmpty($NetworkCategory)) { New-InvalidOperationException ` -Message ($script:localizedData.ParameterCombinationError) } } # Assert-ResourceProperty |