DscResource.Common.psm1
|
#Region './prefix.ps1' 0 $script:modulesFolderPath = Split-Path -Path $PSScriptRoot -Parent #EndRegion './prefix.ps1' 2 #Region './Private/Test-DscObjectHasProperty.ps1' 0 <# .SYNOPSIS Tests if an object has a property. .DESCRIPTION Tests if the specified object has the specified property and return $true or $false. .PARAMETER Object Specifies the object to test for the specified property. .PARAMETER PropertyName Specifies the property name to test for. .EXAMPLE Test-DscObjectHasProperty -Object 'AnyString' -PropertyName 'Length' #> function Test-DscObjectHasProperty { [CmdletBinding()] [OutputType([System.Boolean])] param ( [Parameter(Mandatory = $true)] [System.Object] $Object, [Parameter(Mandatory = $true)] [System.String] $PropertyName ) if ($Object.PSObject.Properties.Name -contains $PropertyName) { return [System.Boolean] $Object.$PropertyName } return $false } #EndRegion './Private/Test-DscObjectHasProperty.ps1' 40 #Region './Private/Test-DscPropertyState.ps1' 0 <# .SYNOPSIS Compares the current and the desired value of a property. .DESCRIPTION This function is used to compare the current and the desired value of a property. .PARAMETER Values This is set to a hash table with the current value (the CurrentValue key) and desired value (the DesiredValue key). .EXAMPLE Test-DscPropertyState -Values @{ CurrentValue = 'John' DesiredValue = 'Alice' } .EXAMPLE Test-DscPropertyState -Values @{ CurrentValue = 1 DesiredValue = 2 } .NOTES This function is used by the cmdlet Compare-ResourcePropertyState. #> function Test-DscPropertyState { [CmdletBinding()] [OutputType([System.Boolean])] param ( [Parameter(Mandatory = $true)] [System.Collections.Hashtable] $Values ) if ($null -eq $Values.CurrentValue -and $null -eq $Values.DesiredValue) { # Both values are $null so return $true $returnValue = $true } elseif ($null -eq $Values.CurrentValue -or $null -eq $Values.DesiredValue) { # Either CurrentValue or DesiredValue are $null so return $false $returnValue = $false } elseif ( $Values.DesiredValue -is [Microsoft.Management.Infrastructure.CimInstance[]] ` -or $Values.DesiredValue -is [System.Array] -and $Values.DesiredValue[0] -is [Microsoft.Management.Infrastructure.CimInstance] ) { if (-not $Values.ContainsKey('KeyProperties')) { $errorMessage = $script:localizedData.KeyPropertiesMissing New-InvalidOperationException -Message $errorMessage } $propertyState = @() <# It is a collection of CIM instances, then recursively call Test-DscPropertyState for each CIM instance in the collection. #> foreach ($desiredCimInstance in $Values.DesiredValue) { $currentCimInstance = $Values.CurrentValue <# Use the CIM instance Key properties to filter out the current values if the exist. #> foreach ($keyProperty in $Values.KeyProperties) { $currentCimInstance = $currentCimInstance | Where-Object -Property $keyProperty -EQ -Value $desiredCimInstance.$keyProperty } if ($currentCimInstance.Count -gt 1) { $errorMessage = $script:localizedData.TooManyCimInstances New-InvalidOperationException -Message $errorMessage } if ($currentCimInstance) { $keyCimInstanceProperties = $currentCimInstance.CimInstanceProperties | Where-Object -FilterScript { $_.Name -in $Values.KeyProperties } <# For each key property build a string representation of the property name and its value. #> $keyPropertyValues = $keyCimInstanceProperties.ForEach({'{0}="{1}"' -f $_.Name, ($_.Value -join ',')}) Write-Debug -Message ( $script:localizedData.TestingCimInstance -f @( $currentCimInstance.CimClass.CimClassName, ($keyPropertyValues -join ';') ) ) } else { $keyCimInstanceProperties = $desiredCimInstance.CimInstanceProperties | Where-Object -FilterScript { $_.Name -in $Values.KeyProperties } <# For each key property build a string representation of the property name and its value. #> $keyPropertyValues = $keyCimInstanceProperties.ForEach({'{0}="{1}"' -f $_.Name, ($_.Value -join ',')}) Write-Debug -Message ( $script:localizedData.MissingCimInstance -f @( $desiredCimInstance.CimClass.CimClassName, ($keyPropertyValues -join ';') ) ) } # Recursively call Test-DscPropertyState with the CimInstance to evaluate. $propertyState += Test-DscPropertyState -Values @{ CurrentValue = $currentCimInstance DesiredValue = $desiredCimInstance } } # Return $false if one property is found to not be in desired state. $returnValue = -not ($false -in $propertyState) } elseif ($Values.DesiredValue -is [Microsoft.Management.Infrastructure.CimInstance]) { $propertyState = @() <# It is a CIM instance, recursively call Test-DscPropertyState for each CIM instance property. #> $desiredCimInstanceProperties = $Values.DesiredValue.CimInstanceProperties | Select-Object -Property @('Name', 'Value') if ($desiredCimInstanceProperties) { foreach ($desiredCimInstanceProperty in $desiredCimInstanceProperties) { <# Recursively call Test-DscPropertyState to evaluate each property in the CimInstance. #> $propertyState += Test-DscPropertyState -Values @{ CurrentValue = $Values.CurrentValue.($desiredCimInstanceProperty.Name) DesiredValue = $desiredCimInstanceProperty.Value } } } else { if ($Values.CurrentValue.CimInstanceProperties.Count -gt 0) { # Current value did not have any CIM properties, but desired state has. $propertyState += $false } } # Return $false if one property is found to not be in desired state. $returnValue = -not ($false -in $propertyState) } elseif ($Values.DesiredValue -is [System.Array] -or $Values.CurrentValue -is [System.Array]) { $compareObjectParameters = @{ ReferenceObject = $Values.CurrentValue DifferenceObject = $Values.DesiredValue } $arrayCompare = Compare-Object @compareObjectParameters if ($null -ne $arrayCompare) { Write-Debug -Message $script:localizedData.ArrayDoesNotMatch $arrayCompare | ForEach-Object -Process { if ($_.SideIndicator -eq '=>') { Write-Debug -Message ( $script:localizedData.ArrayValueIsAbsent -f $_.InputObject ) } else { Write-Debug -Message ( $script:localizedData.ArrayValueIsPresent -f $_.InputObject ) } } $returnValue = $false } else { $returnValue = $true } } elseif ($Values.CurrentValue -ne $Values.DesiredValue) { $desiredType = $Values.DesiredValue.GetType() $returnValue = $false $supportedTypes = @( 'String' 'Int32' 'UInt32' 'Int16' 'UInt16' 'Single' 'Boolean' ) if ($desiredType.Name -notin $supportedTypes) { Write-Warning -Message ($script:localizedData.UnableToCompareType -f $desiredType.Name) } else { Write-Debug -Message ( $script:localizedData.PropertyValueOfTypeDoesNotMatch ` -f $desiredType.Name, $Values.CurrentValue, $Values.DesiredValue ) } } else { $returnValue = $true } return $returnValue } #EndRegion './Private/Test-DscPropertyState.ps1' 247 #Region './Public/Assert-BoundParameter.ps1' 0 <# .SYNOPSIS Throws an error if there is a bound parameter that exists in both the mutually exclusive lists. .DESCRIPTION Throws an error if there is a bound parameter that exists in both the mutually exclusive lists. .PARAMETER BoundParameterList The parameters that should be evaluated against the mutually exclusive lists MutuallyExclusiveList1 and MutuallyExclusiveList2. This parameter is normally set to the $PSBoundParameters variable. .PARAMETER MutuallyExclusiveList1 An array of parameter names that are not allowed to be bound at the same time as those in MutuallyExclusiveList2. .PARAMETER MutuallyExclusiveList2 An array of parameter names that are not allowed to be bound at the same time as those in MutuallyExclusiveList1. .EXAMPLE $assertBoundParameterParameters = @{ BoundParameterList = $PSBoundParameters MutuallyExclusiveList1 = @( 'Parameter1' ) MutuallyExclusiveList2 = @( 'Parameter2' ) } Assert-BoundParameter @assertBoundParameterParameters This example throws an exception if `$PSBoundParameters` contains both the parameters `Parameter1` and `Parameter2`. #> function Assert-BoundParameter { [CmdletBinding()] param ( [Parameter(Mandatory = $true)] [AllowEmptyCollection()] [System.Collections.Hashtable] $BoundParameterList, [Parameter(Mandatory = $true)] [System.String[]] $MutuallyExclusiveList1, [Parameter(Mandatory = $true)] [System.String[]] $MutuallyExclusiveList2 ) $itemFoundFromList1 = $BoundParameterList.Keys.Where({ $_ -in $MutuallyExclusiveList1 }) $itemFoundFromList2 = $BoundParameterList.Keys.Where({ $_ -in $MutuallyExclusiveList2 }) if ($itemFoundFromList1.Count -gt 0 -and $itemFoundFromList2.Count -gt 0) { $errorMessage = ` $script:localizedData.ParameterUsageWrong ` -f ($MutuallyExclusiveList1 -join "','"), ($MutuallyExclusiveList2 -join "','") New-InvalidArgumentException -ArgumentName 'Parameters' -Message $errorMessage } } #EndRegion './Public/Assert-BoundParameter.ps1' 70 #Region './Public/Assert-IPAddress.ps1' 0 <# .SYNOPSIS Asserts that the specified IP address is valid. .DESCRIPTION Checks the IP address so that it is valid and do not conflict with address family. If any problems are detected an exception will be thrown. .PARAMETER AddressFamily IP address family that the supplied Address should be in. Valid values are 'IPv4' or 'IPv6'. .PARAMETER Address Specifies an IPv4 or IPv6 address. .EXAMPLE Assert-IPAddress -Address '127.0.0.1' This will assert that the supplied address is a valid IPv4 address. If it is not an exception will be thrown. .EXAMPLE Assert-IPAddress -Address 'fe80:ab04:30F5:002b::1' This will assert that the supplied address is a valid IPv6 address. If it is not an exception will be thrown. .EXAMPLE Assert-IPAddress -Address 'fe80:ab04:30F5:002b::1' -AddressFamily 'IPv6' This will assert that address is valid and that it matches the supplied address family. If the supplied address family does not match the address an exception will be thrown. #> function Assert-IPAddress { [CmdletBinding()] param ( [Parameter()] [ValidateSet('IPv4', 'IPv6')] [System.String] $AddressFamily, [Parameter(Mandatory = $true)] [ValidateNotNullOrEmpty()] [System.String] $Address ) [System.Net.IPAddress] $ipAddress = $null if (-not ([System.Net.IPAddress]::TryParse($Address, [ref] $ipAddress))) { New-InvalidArgumentException ` -Message ($script:localizedData.AddressFormatError -f $Address) ` -ArgumentName 'Address' } if ($AddressFamily) { switch ($AddressFamily) { 'IPv4' { if ($ipAddress.AddressFamily -ne [System.Net.Sockets.AddressFamily]::InterNetwork.ToString()) { New-InvalidArgumentException ` -Message ($script:localizedData.AddressIPv6MismatchError -f $Address, $AddressFamily) ` -ArgumentName 'AddressFamily' } } 'IPv6' { if ($ipAddress.AddressFamily -ne [System.Net.Sockets.AddressFamily]::InterNetworkV6.ToString()) { New-InvalidArgumentException ` -Message ($script:localizedData.AddressIPv4MismatchError -f $Address, $AddressFamily) ` -ArgumentName 'AddressFamily' } } } } } #EndRegion './Public/Assert-IPAddress.ps1' 86 #Region './Public/Assert-Module.ps1' 0 <# .SYNOPSIS Assert if the specific module is available to be imported. .DESCRIPTION Assert if the specific module is available to be imported. .PARAMETER ModuleName Specifies the name of the module to assert. .PARAMETER ImportModule Specfiies to import the module if it is asserted. .EXAMPLE Assert-Module -ModuleName 'DhcpServer' This asserts that the module DhcpServer is available on the system. #> function Assert-Module { [CmdletBinding()] param ( [Parameter(Mandatory = $true)] [System.String] $ModuleName, [Parameter()] [System.Management.Automation.SwitchParameter] $ImportModule ) if (-not (Get-Module -Name $ModuleName -ListAvailable)) { $errorMessage = $script:localizedData.ModuleNotFound -f $ModuleName New-ObjectNotFoundException -Message $errorMessage } if ($ImportModule) { Import-Module -Name $ModuleName } } #EndRegion './Public/Assert-Module.ps1' 44 #Region './Public/Compare-DscParameterState.ps1' 0 <# .SYNOPSIS This method is used to compare current and desired values for any DSC resource. .DESCRIPTION This function compare the parameter status of DSC resource parameters against the current values present on the system, and return a hashtable with the metadata from the comparison. .PARAMETER CurrentValues A hashtable with the current values on the system, obtained by e.g. Get-TargetResource. .PARAMETER DesiredValues The hashtable of desired values. For example $PSBoundParameters with the desired values. .PARAMETER Properties This is a list of properties in the desired values list should be checked. If this is empty then all values in DesiredValues are checked. .PARAMETER ExcludeProperties This is a list of which properties in the desired values list should be checked. If this is empty then all values in DesiredValues are checked. .PARAMETER TurnOffTypeChecking Indicates that the type of the parameter should not be checked. .PARAMETER ReverseCheck Indicates that a reverse check should be done. The current and desired state are swapped for another test. .PARAMETER SortArrayValues If the sorting of array values does not matter, values are sorted internally before doing the comparison. .PARAMETER IncludeInDesiredState Indicates that result adds the properties in the desired state. By default, this command returns only the properties not in desired state. .PARAMETER IncludeValue Indicates that result contains the ActualValue and ExcpectedValue properties. .EXAMPLE $currentValues = @{ String = 'This is a string' Int = 1 Bool = $true } $desiredValues = @{ String = 'This is a string' Int = 99 } Compare-DscParameterState -CurrentValues $currentValues -DesiredValues $desiredValues Name Value ---- ----- Property Int InDesiredState False ExpectedType System.Int32 ActualType System.Int32 ``` The function Compare-DscParameterState compare the value of each hashtable based on the keys present in $desiredValues hashtable. The result indicates that Int property is not in the desired state. No information about Bool property, because it is not in $desiredValues hashtable. .EXAMPLE $currentValues = @{ String = 'This is a string' Int = 1 Bool = $true } $desiredValues = @{ String = 'This is a string' Int = 99 Bool = $false } $excludeProperties = @('Bool') Compare-DscParameterState ` -CurrentValues $currentValues ` -DesiredValues $desiredValues ` -ExcludeProperties $ExcludeProperties Name Value ---- ----- Property Int InDesiredState False ExpectedType System.Int32 ActualType System.Int32 ``` The function Compare-DscParameterState compare the value of each hashtable based on the keys present in $desiredValues hashtable and without those in $excludeProperties. The result indicates that Int property is not in the desired state. No information about Bool property, because it is in $excludeProperties. .EXAMPLE $serviceParameters = @{ Name = $Name } $returnValue = Compare-DscParameterState ` -CurrentValues (Get-Service @serviceParameters) ` -DesiredValues $PSBoundParameters ` -Properties @( 'Name' 'Status' 'StartType' ) This compares the values in the current state against the desires state. The command Get-Service is called using just the required parameters to get the values in the current state. The parameter 'Properties' is used to specify the properties 'Name','Status' and 'StartType' for the comparison. #> function Compare-DscParameterState { [CmdletBinding()] [OutputType([System.Object[]])] param ( [Parameter(Mandatory = $true)] [System.Object] $CurrentValues, [Parameter(Mandatory = $true)] [System.Object] $DesiredValues, [Parameter()] [System.String[]] [Alias('ValuesToCheck')] $Properties, [Parameter()] [System.String[]] $ExcludeProperties, [Parameter()] [System.Management.Automation.SwitchParameter] $TurnOffTypeChecking, [Parameter()] [System.Management.Automation.SwitchParameter] $ReverseCheck, [Parameter()] [System.Management.Automation.SwitchParameter] $SortArrayValues, [Parameter()] [System.Management.Automation.SwitchParameter] $IncludeInDesiredState, [Parameter()] [System.Management.Automation.SwitchParameter] $IncludeValue ) $returnValue = @() #region ConvertCIm to Hashtable if ($CurrentValues -is [Microsoft.Management.Infrastructure.CimInstance] -or $CurrentValues -is [Microsoft.Management.Infrastructure.CimInstance[]]) { $CurrentValues = ConvertTo-HashTable -CimInstance $CurrentValues } if ($DesiredValues -is [Microsoft.Management.Infrastructure.CimInstance] -or $DesiredValues -is [Microsoft.Management.Infrastructure.CimInstance[]]) { $DesiredValues = ConvertTo-HashTable -CimInstance $DesiredValues } #endregion Endofconverion #region CheckType of object $types = 'System.Management.Automation.PSBoundParametersDictionary', 'System.Collections.Hashtable', 'Microsoft.Management.Infrastructure.CimInstance' if ($DesiredValues.GetType().FullName -notin $types) { New-InvalidArgumentException ` -Message ($script:localizedData.InvalidDesiredValuesError -f $DesiredValues.GetType().FullName) ` -ArgumentName 'DesiredValues' } if ($CurrentValues.GetType().FullName -notin $types) { New-InvalidArgumentException ` -Message ($script:localizedData.InvalidCurrentValuesError -f $CurrentValues.GetType().FullName) ` -ArgumentName 'CurrentValues' } #endregion checktype #region check if CimInstance and not have properties in parameters invoke exception if ($DesiredValues -is [Microsoft.Management.Infrastructure.CimInstance] -and -not $Properties) { New-InvalidArgumentException ` -Message $script:localizedData.InvalidPropertiesError ` -ArgumentName Properties } #endregion check cim and properties #Clean value if there are a common parameters provide from Test/Get-TargetResource parameter $desiredValuesClean = Remove-CommonParameter -Hashtable $DesiredValues #region generate keyList based on $Properties and $excludeProperties value if (-not $Properties) { $keyList = $desiredValuesClean.Keys } else { $keyList = $Properties } if ($ExcludeProperties) { $keyList = $keyList | Where-Object -FilterScript { $_ -notin $ExcludeProperties } } #endregion #region enumerate of each key in list foreach ($key in $keyList) { #generate default value $InDesiredStateTable = [ordered]@{ Property = $key InDesiredState = $true } $returnValue += $InDesiredStateTable #get value of each key $desiredValue = $desiredValuesClean.$key $currentValue = $CurrentValues.$key #Check if IncludeValue parameter is used. if ($IncludeValue) { $InDesiredStateTable['ExpectedValue'] = $desiredValue $InDesiredStateTable['ActualValue'] = $currentValue } #region convert to hashtable if value of key is CimInstance if ($desiredValue -is [Microsoft.Management.Infrastructure.CimInstance] -or $desiredValue -is [Microsoft.Management.Infrastructure.CimInstance[]]) { $desiredValue = ConvertTo-HashTable -CimInstance $desiredValue } if ($currentValue -is [Microsoft.Management.Infrastructure.CimInstance] -or $currentValue -is [Microsoft.Management.Infrastructure.CimInstance[]]) { $currentValue = ConvertTo-HashTable -CimInstance $currentValue } #endregion converttohashtable #region gettype of value to check if they are the same. if ($null -ne $desiredValue) { $desiredType = $desiredValue.GetType() } else { $desiredType = @{ Name = 'Unknown' } } $InDesiredStateTable['ExpectedType'] = $desiredType if ($null -ne $currentValue) { $currentType = $currentValue.GetType() } else { $currentType = @{ Name = 'Unknown' } } $InDesiredStateTable['ActualType'] = $currentType #endregion #region check if the desiredtype if a credential object. Only if the current type isn't unknown. if ($currentType.Name -ne 'Unknown' -and $desiredType.Name -eq 'PSCredential') { # This is a credential object. Compare only the user name if ($currentType.Name -eq 'PSCredential' -and $currentValue.UserName -eq $desiredValue.UserName) { Write-Verbose -Message ($script:localizedData.MatchPsCredentialUsernameMessage -f $currentValue.UserName, $desiredValue.UserName) continue # pass to the next key } elseif ($currentType.Name -ne 'string') { Write-Verbose -Message ($script:localizedData.NoMatchPsCredentialUsernameMessage -f $currentValue.UserName, $desiredValue.UserName) $InDesiredStateTable.InDesiredState = $false } # Assume the string is our username when the matching desired value is actually a credential if ($currentType.Name -eq 'string' -and $currentValue -eq $desiredValue.UserName) { Write-Verbose -Message ($script:localizedData.MatchPsCredentialUsernameMessage -f $currentValue, $desiredValue.UserName) continue # pass to the next key } else { Write-Verbose -Message ($script:localizedData.NoMatchPsCredentialUsernameMessage -f $currentValue, $desiredValue.UserName) $InDesiredStateTable.InDesiredState = $false } } #endregion test credential #region Test type of object. And if they're not InDesiredState, generate en exception if (-not $TurnOffTypeChecking) { if (($desiredType.Name -ne 'Unknown' -and $currentType.Name -ne 'Unknown') -and $desiredType.FullName -ne $currentType.FullName) { Write-Verbose -Message ($script:localizedData.NoMatchTypeMismatchMessage -f $key, $currentType.FullName, $desiredType.FullName) $InDesiredStateTable.InDesiredState = $false continue # pass to the next key } } #endregion TestType #region Check if the value of Current and desired state is the same but only if they are not an array if ($currentValue -eq $desiredValue -and -not $desiredType.IsArray) { Write-Verbose -Message ($script:localizedData.MatchValueMessage -f $desiredType.FullName, $key, $currentValue, $desiredValue) continue # pass to the next key } #endregion check same value #region Check if the DesiredValuesClean has the key and if it don't have, it's not necessary to check his value if ($desiredValuesClean.GetType().Name -in 'HashTable', 'PSBoundParametersDictionary') { $checkDesiredValue = $desiredValuesClean.ContainsKey($key) } else { $checkDesiredValue = Test-DscObjectHasProperty -Object $desiredValuesClean -PropertyName $key } # if there no key, don't need to check if (-not $checkDesiredValue) { Write-Verbose -Message ($script:localizedData.MatchValueMessage -f $desiredType.FullName, $key, $currentValue, $desiredValue) continue # pass to the next key } #endregion #region Check if desired type is array, ifno Hashtable and currenttype hashtable to if ($desiredType.IsArray) { Write-Verbose -Message ($script:localizedData.TestDscParameterCompareMessage -f $key, $desiredType.FullName) # Check if the currentValues and desiredValue are empty array. if (-not $currentValue -and -not $desiredValue) { Write-Verbose -Message ($script:localizedData.MatchValueMessage -f $desiredType.FullName, $key, 'empty array', 'empty array') continue } elseif (-not $currentValue) { #If only currentvalue is empty, the configuration isn't compliant. Write-Verbose -Message ($script:localizedData.NoMatchValueMessage -f $desiredType.FullName, $key, $currentValue, $desiredValue) $InDesiredStateTable.InDesiredState = $false continue } elseif ($currentValue.Count -ne $desiredValue.Count) { #If there is a difference between the number of objects in arrays, this isn't compliant. Write-Verbose -Message ($script:localizedData.NoMatchValueDifferentCountMessage -f $desiredType.FullName, $key, $currentValue.Count, $desiredValue.Count) $InDesiredStateTable.InDesiredState = $false continue } else { $desiredArrayValues = $desiredValue $currentArrayValues = $currentValue # if the sortArrayValues parameter is using, sort value of array if ($SortArrayValues) { $desiredArrayValues = @($desiredArrayValues | Sort-Object) $currentArrayValues = @($currentArrayValues | Sort-Object) } <# for all object in collection, check their type.ConvertoString if they are script block. #> for ($i = 0; $i -lt $desiredArrayValues.Count; $i++) { if ($desiredArrayValues[$i]) { $desiredType = $desiredArrayValues[$i].GetType() } else { $desiredType = @{ Name = 'Unknown' } } if ($currentArrayValues[$i]) { $currentType = $currentArrayValues[$i].GetType() } else { $currentType = @{ Name = 'Unknown' } } if (-not $TurnOffTypeChecking) { if (($desiredType.Name -ne 'Unknown' -and $currentType.Name -ne 'Unknown') -and $desiredType.FullName -ne $currentType.FullName) { Write-Verbose -Message ($script:localizedData.NoMatchElementTypeMismatchMessage -f $key, $i, $currentType.FullName, $desiredType.FullName) $InDesiredStateTable.InDesiredState = $false continue } } <# Convert a scriptblock into a string as scriptblocks are not comparable if currentvalue is scriptblock and if desired value is string, we invoke the result of script block. Ifno, we convert to string. if Desired value #> $wasCurrentArrayValuesConverted = $false if ($currentArrayValues[$i] -is [scriptblock]) { $currentArrayValues[$i] = if ($desiredArrayValues[$i] -is [string]) { $currentArrayValues[$i] = $currentArrayValues[$i].Invoke() } else { $currentArrayValues[$i].ToString() } $wasCurrentArrayValuesConverted = $true } if ($desiredArrayValues[$i] -is [scriptblock]) { $desiredArrayValues[$i] = if ($currentArrayValues[$i] -is [string] -and -not $wasCurrentArrayValuesConverted) { $desiredArrayValues[$i].Invoke() } else { $desiredArrayValues[$i].ToString() } } if ($desiredType -eq [System.Collections.Hashtable] -and $currentType -eq [System.Collections.Hashtable]) { $param = $PSBoundParameters $param.CurrentValues = $currentArrayValues[$i] $param.DesiredValues = $desiredArrayValues[$i] 'IncludeInDesiredState','IncludeValue' | ForEach-Object { if ($param.ContainsKey($_)) { $null = $param.Remove($_) } } if ($InDesiredStateTable.InDesiredState) { $InDesiredStateTable.InDesiredState = Test-DscParameterState @param } else { Test-DscParameterState @param | Out-Null } continue } if ($desiredArrayValues[$i] -ne $currentArrayValues[$i]) { Write-Verbose -Message ($script:localizedData.NoMatchElementValueMismatchMessage -f $i, $desiredType.FullName, $key, $currentArrayValues[$i], $desiredArrayValues[$i]) $InDesiredStateTable.InDesiredState = $false continue } else { Write-Verbose -Message ($script:localizedData.MatchElementValueMessage -f $i, $desiredType.FullName, $key, $currentArrayValues[$i], $desiredArrayValues[$i]) continue } } } } elseif ($desiredType -eq [System.Collections.Hashtable] -and $currentType -eq [System.Collections.Hashtable]) { $param = $PSBoundParameters $param.CurrentValues = $currentValue $param.DesiredValues = $desiredValue 'IncludeInDesiredState','IncludeValue' | ForEach-Object { if ($param.ContainsKey($_)) { $null = $param.Remove($_) } } if ($InDesiredStateTable.InDesiredState) { $InDesiredStateTable.InDesiredState = Test-DscParameterState @param } else { Test-DscParameterState @param | Out-Null } continue } else { #Convert a scriptblock into a string as scriptblocks are not comparable $wasCurrentValue = $false if ($currentValue -is [scriptblock]) { $currentValue = if ($desiredValue -is [string]) { $currentValue = $currentValue.Invoke() } else { $currentValue.ToString() } $wasCurrentValue = $true } if ($desiredValue -is [scriptblock]) { $desiredValue = if ($currentValue -is [string] -and -not $wasCurrentValue) { $desiredValue.Invoke() } else { $desiredValue.ToString() } } if ($desiredValue -ne $currentValue) { Write-Verbose -Message ($script:localizedData.NoMatchValueMessage -f $desiredType.FullName, $key, $currentValue, $desiredValue) $InDesiredStateTable.InDesiredState = $false } } #endregion check type } #endregion end of enumeration if ($ReverseCheck) { Write-Verbose -Message $script:localizedData.StartingReverseCheck $reverseCheckParameters = $PSBoundParameters $reverseCheckParameters.CurrentValues = $DesiredValues $reverseCheckParameters.DesiredValues = $CurrentValues $null = $reverseCheckParameters.Remove('ReverseCheck') if ($returnValue) { $returnValue = Compare-DscParameterState @reverseCheckParameters } else { $null = Compare-DscParameterState @reverseCheckParameters } } # Remove in desired state value if IncludeDesirateState parameter is not use if (-not $IncludeInDesiredState) { [array]$returnValue = $returnValue.where({$_.InDesiredState -eq $false}) } #change verbose message $returnValue.foreach({ Write-Verbose -Message ($script:localizedData.CompareDscParameterResultMessage -f $_.Property,$_.InDesiredState) }) <# If Compare-DscParameterState is used in precedent step, don't need to convert it We use .foreach() method as we are sure that $returnValue is an array. #> [Array]$returnValue = @( $returnValue.foreach( { if ($_ -is [System.Collections.Hashtable]) { [pscustomobject]$_ } else { $_ } } ) ) return $returnValue } #EndRegion './Public/Compare-DscParameterState.ps1' 604 #Region './Public/Compare-ResourcePropertyState.ps1' 0 <# .SYNOPSIS Compare current and desired property values for any DSC resource. .DESCRIPTION This function is used to compare current and desired property values for any DSC resource, and return a hashtable with the metadata from the comparison. .PARAMETER CurrentValues The current values that should be compared to to desired values. Normally the values returned from Get-TargetResource. .PARAMETER DesiredValues The values set in the configuration and is provided in the call to the functions *-TargetResource, and that will be compared against current values. Normally set to $PSBoundParameters. .PARAMETER Properties An array of property names, from the keys provided in DesiredValues, that will be compared. If this parameter is left out, all the keys in the DesiredValues will be compared. .PARAMETER IgnoreProperties An array of property names, from the keys provided in DesiredValues, that will be ignored in the comparison. If this parameter is left out, all the keys in the DesiredValues will be compared. .PARAMETER CimInstanceKeyProperties A hashtable containing a key for each property that contain a collection of CimInstances and the value is an array of strings of the CimInstance key properties. @{ Permission = @('State') } .EXAMPLE $compareTargetResourceStateParameters = @{ CurrentValues = (Get-TargetResource $PSBoundParameters) DesiredValues = $PSBoundParameters } $propertyState = Compare-ResourcePropertyState @compareTargetResourceStateParameters This examples call Compare-ResourcePropertyState with the current state and the desired state and returns a hashtable array of all the properties that was evaluated based on the properties pass in the parameter DesiredValues. #> function Compare-ResourcePropertyState { [CmdletBinding()] [OutputType([System.Collections.Hashtable[]])] param ( [Parameter(Mandatory = $true)] [System.Collections.Hashtable] $CurrentValues, [Parameter(Mandatory = $true)] [System.Collections.Hashtable] $DesiredValues, [Parameter()] [ValidateNotNullOrEmpty()] [System.String[]] $Properties, [Parameter()] [ValidateNotNullOrEmpty()] [System.String[]] $IgnoreProperties, [Parameter()] [ValidateNotNull()] [System.Collections.Hashtable] $CimInstanceKeyProperties = @{} ) if ($PSBoundParameters.ContainsKey('Properties')) { # Filter out the parameters (keys) not specified in Properties $desiredValuesToRemove = $DesiredValues.Keys | Where-Object -FilterScript { $_ -notin $Properties } $desiredValuesToRemove | ForEach-Object -Process { $DesiredValues.Remove($_) } } else { <# Remove any common parameters that might be part of DesiredValues, if it $PSBoundParameters was used to pass the desired values. #> $commonParametersToRemove = $DesiredValues.Keys | Where-Object -FilterScript { $_ -in [System.Management.Automation.PSCmdlet]::CommonParameters ` -or $_ -in [System.Management.Automation.PSCmdlet]::OptionalCommonParameters } $commonParametersToRemove | ForEach-Object -Process { $DesiredValues.Remove($_) } } # Remove any properties that should be ignored. if ($PSBoundParameters.ContainsKey('IgnoreProperties')) { $IgnoreProperties | ForEach-Object -Process { if ($DesiredValues.ContainsKey($_)) { $DesiredValues.Remove($_) } } } $compareTargetResourceStateReturnValue = @() foreach ($parameterName in $DesiredValues.Keys) { Write-Debug -Message ($script:localizedData.EvaluatePropertyState -f $parameterName) $parameterState = @{ ParameterName = $parameterName Expected = $DesiredValues.$parameterName Actual = $CurrentValues.$parameterName } # Check if the parameter is in compliance. $isPropertyInDesiredState = Test-DscPropertyState -Values @{ CurrentValue = $CurrentValues.$parameterName DesiredValue = $DesiredValues.$parameterName KeyProperties = $CimInstanceKeyProperties.$parameterName } if ($isPropertyInDesiredState) { Write-Verbose -Message ($script:localizedData.PropertyInDesiredState -f $parameterName) $parameterState['InDesiredState'] = $true } else { Write-Verbose -Message ($script:localizedData.PropertyNotInDesiredState -f $parameterName) $parameterState['InDesiredState'] = $false } $compareTargetResourceStateReturnValue += $parameterState } return $compareTargetResourceStateReturnValue } #EndRegion './Public/Compare-ResourcePropertyState.ps1' 158 #Region './Public/ConvertTo-CimInstance.ps1' 0 <# .SYNOPSIS Converts a hashtable into a CimInstance array. .DESCRIPTION This function is used to convert a hashtable into MSFT_KeyValuePair objects. These are stored as an CimInstance array. DSC cannot handle hashtables but CimInstances arrays storing MSFT_KeyValuePair. .PARAMETER Hashtable A hashtable with the values to convert. .OUTPUTS An object array with CimInstance objects. .EXAMPLE ConvertTo-CimInstance -Hashtable @{ String = 'a string' Bool = $true Int = 99 Array = 'a, b, c' } This example returns an CimInstance with the provided hashtable values. #> function ConvertTo-CimInstance { [CmdletBinding()] [OutputType([System.Object[]])] param ( [Parameter(Mandatory = $true, ValueFromPipeline = $true, ParameterSetName = 'Hashtable')] [System.Collections.Hashtable] $Hashtable ) process { foreach ($item in $Hashtable.GetEnumerator()) { New-CimInstance -ClassName 'MSFT_KeyValuePair' -Namespace 'root/microsoft/Windows/DesiredStateConfiguration' -Property @{ Key = $item.Key Value = if ($item.Value -is [array]) { $item.Value -join ',' } else { $item.Value } } -ClientOnly } } } #EndRegion './Public/ConvertTo-CimInstance.ps1' 55 #Region './Public/ConvertTo-HashTable.ps1' 0 <# .SYNOPSIS Converts CimInstances into a hashtable. .DESCRIPTION This function is used to convert a CimInstance array containing MSFT_KeyValuePair objects into a hashtable. .PARAMETER CimInstance An array of CimInstances or a single CimInstance object to convert. .OUTPUTS Hashtable .EXAMPLE $newInstanceParameters = @{ ClassName = 'MSFT_KeyValuePair' Namespace = 'root/microsoft/Windows/DesiredStateConfiguration' ClientOnly = $true } $cimInstance = [Microsoft.Management.Infrastructure.CimInstance[]] ( (New-CimInstance @newInstanceParameters -Property @{ Key = 'FirstName' Value = 'John' }), (New-CimInstance @newInstanceParameters -Property @{ Key = 'LastName' Value = 'Smith' }) ) ConvertTo-HashTable -CimInstance $cimInstance This creates a array om CimInstances of the class name MSFT_KeyValuePair and passes it to ConvertTo-HashTable which returns a hashtable. #> function ConvertTo-HashTable { [CmdletBinding()] [OutputType([System.Collections.Hashtable])] param ( [Parameter(Mandatory = $true, ValueFromPipeline = $true, ParameterSetName = 'CimInstance')] [AllowEmptyCollection()] [Microsoft.Management.Infrastructure.CimInstance[]] $CimInstance ) begin { $result = @{ } } process { foreach ($ci in $CimInstance) { $result.Add($ci.Key, $ci.Value) } } end { $result } } #EndRegion './Public/ConvertTo-HashTable.ps1' 69 #Region './Public/Get-ComputerName.ps1' 0 <# .SYNOPSIS Returns the computer name cross-plattform. .DESCRIPTION The variable `$env:COMPUTERNAME` does not exist cross-platform which hinders development and testing on macOS and Linux. Instead this cmdlet can be used to get the computer name cross-plattform. .EXAMPLE Get-ComputerName This example returns the computer name cross-plattform. #> function Get-ComputerName { [CmdletBinding()] [OutputType([System.String])] param () $computerName = $null if ($IsLinux -or $IsMacOs) { $computerName = hostname } else { <# We could run 'hostname' on Windows too, but $env:COMPUTERNAME is more widely used. #> $computerName = $env:COMPUTERNAME } return $computerName } #EndRegion './Public/Get-ComputerName.ps1' 38 #Region './Public/Get-LocalizedData.ps1' 0 <# .SYNOPSIS Gets language-specific data into scripts and functions based on the UI culture that is selected for the operating system. Similar to Import-LocalizedData, with extra parameter 'DefaultUICulture'. .DESCRIPTION The Get-LocalizedData cmdlet dynamically retrieves strings from a subdirectory whose name matches the UI language set for the current user of the operating system. It is designed to enable scripts to display user messages in the UI language selected by the current user. Get-LocalizedData imports data from .psd1 files in language-specific subdirectories of the script directory and saves them in a local variable that is specified in the command. The cmdlet selects the subdirectory and file based on the value of the $PSUICulture automatic variable. When you use the local variable in the script to display a user message, the message appears in the user's UI language. You can use the parameters of G-LocalizedData to specify an alternate UI culture, path, and file name, to add supported commands, and to suppress the error message that appears if the .psd1 files are not found. The G-LocalizedData cmdlet supports the script internationalization initiative that was introduced in Windows PowerShell 2.0. This initiative aims to better serve users worldwide by making it easy for scripts to display user messages in the UI language of the current user. For more information about this and about the format of the .psd1 files, see about_Script_Internationalization. .PARAMETER BindingVariable Specifies the variable into which the text strings are imported. Enter a variable name without a dollar sign ($). In Windows PowerShell 2.0, this parameter is required. In Windows PowerShell 3.0, this parameter is optional. If you omit this parameter, Import-LocalizedData returns a hash table of the text strings. The hash table is passed down the pipeline or displayed at the command line. When using Import-LocalizedData to replace default text strings specified in the DATA section of a script, assign the DATA section to a variable and enter the name of the DATA section variable in the value of the BindingVariable parameter. Then, when Import-LocalizedData saves the imported content in the BindingVariable, the imported data will replace the default text strings. If you are not specifying default text strings, you can select any variable name. .PARAMETER UICulture Specifies an alternate UI culture. The default is the value of the $PsUICulture automatic variable. Enter a UI culture in <language>-<region> format, such as en-US, de-DE, or ar-SA. The value of the UICulture parameter determines the language-specific subdirectory (within the base directory) from which Import-LocalizedData gets the .psd1 file for the script. The cmdlet searches for a subdirectory with the same name as the value of the UICulture parameter or the $PsUICulture automatic variable, such as de-DE or ar-SA. If it cannot find the directory, or the directory does not contain a .psd1 file for the script, it searches for a subdirectory with the name of the language code, such as de or ar. If it cannot find the subdirectory or .psd1 file, the command fails and the data is displayed in the default language specified in the script. .PARAMETER BaseDirectory Specifies the base directory where the .psd1 files are located. The default is the directory where the script is located. Import-LocalizedData searches for the .psd1 file for the script in a language-specific subdirectory of the base directory. .PARAMETER FileName Specifies the name of the data file (.psd1) to be imported. Enter a file name. You can specify a file name that does not include its .psd1 file name extension, or you can specify the file name including the .psd1 file name extension. The FileName parameter is required when Import-LocalizedData is not used in a script. Otherwise, the parameter is optional and the default value is the base name of the script. You can use this parameter to direct Import-LocalizedData to search for a different .psd1 file. For example, if the FileName is omitted and the script name is FindFiles.ps1, Import-LocalizedData searches for the FindFiles.psd1 data file. .PARAMETER SupportedCommand Specifies cmdlets and functions that generate only data. Use this parameter to include cmdlets and functions that you have written or tested. For more information, see about_Script_Internationalization. .PARAMETER DefaultUICulture Specifies which UICulture to default to if current UI culture or its parents culture don't have matching data file. For example, if you have a data file in 'en-US' but not in 'en' or 'en-GB' and your current culture is 'en-GB', you can default back to 'en-US'. .NOTES Before using Import-LocalizedData, localize your user messages. Format the messages for each locale (UI culture) in a hash table of key/value pairs, and save the hash table in a file with the same name as the script and a .psd1 file name extension. Create a directory under the script directory for each supported UI culture, and then save the .psd1 file for each UI culture in the directory with the UI culture name. For example, localize your user messages for the de-DE locale and format them in a hash table. Save the hash table in a <ScriptName>.psd1 file. Then create a de-DE subdirectory under the script directory, and save the de-DE <ScriptName>.psd1 file in the de-DE subdirectory. Repeat this method for each locale that you support. Import-LocalizedData performs a structured search for the localized user messages for a script. Import-LocalizedData begins the search in the directory where the script file is located (or the value of the BaseDirectory parameter). It then searches within the base directory for a subdirectory with the same name as the value of the $PsUICulture variable (or the value of the UICulture parameter), such as de-DE or ar-SA. Then, it searches in that subdirectory for a .psd1 file with the same name as the script (or the value of the FileName parameter). If Import-LocalizedData cannot find a subdirectory with the name of the UI culture, or the subdirectory does not contain a .psd1 file for the script, it searches for a .psd1 file for the script in a subdirectory with the name of the language code, such as de or ar. If it cannot find the subdirectory or .psd1 file, the command fails, the data is displayed in the default language in the script, and an error message is displayed explaining that the data could not be imported. To suppress the message and fail gracefully, use the ErrorAction common parameter with a value of SilentlyContinue. If Import-LocalizedData finds the subdirectory and the .psd1 file, it imports the hash table of user messages into the value of the BindingVariable parameter in the command. Then, when you display a message from the hash table in the variable, the localized message is displayed. For more information, see about_Script_Internationalization. .EXAMPLE $script:localizedData = Get-LocalizedData -DefaultUICulture 'en-US' This is an example that can be used in DSC resources to import the localized strings and if the current UI culture localized folder does not exist the UI culture 'en-US' is returned. #> function Get-LocalizedData { [CmdletBinding(DefaultParameterSetName = 'DefaultUICulture')] param ( [Parameter(Position = 0)] [Alias('Variable')] [ValidateNotNullOrEmpty()] [System.String] $BindingVariable, [Parameter(Position = 1, ParameterSetName = 'TargetedUICulture')] [System.String] $UICulture, [Parameter()] [System.String] $BaseDirectory, [Parameter()] [System.String] $FileName, [Parameter()] [System.String[]] $SupportedCommand, [Parameter(Position = 1, ParameterSetName = 'DefaultUICulture')] [System.String] $DefaultUICulture = 'en-US' ) begin { <# Because Proxy Command changes the Invocation origin, we need to be explicit when handing the pipeline back to original command. #> if (!$PSBoundParameters.ContainsKey('FileName')) { if ($myInvocation.ScriptName) { $file = [System.IO.FileInfo] $myInvocation.ScriptName } else { $file = [System.IO.FileInfo] $myInvocation.MyCommand.Module.Path } $FileName = $file.BaseName $PSBoundParameters.Add('FileName', $file.Name) } if ($PSBoundParameters.ContainsKey('BaseDirectory')) { $callingScriptRoot = $BaseDirectory } else { $callingScriptRoot = $MyInvocation.PSScriptRoot $PSBoundParameters.Add('BaseDirectory', $callingScriptRoot) } if ($PSBoundParameters.ContainsKey('DefaultUICulture') -and !$PSBoundParameters.ContainsKey('UICulture')) { <# We don't want the resolution to eventually return the ModuleManifest so we run the same GetFilePath() logic than here: https://github.com/PowerShell/PowerShell/blob/master/src/Microsoft.PowerShell.Commands.Utility/commands/utility/Import-LocalizedData.cs#L302-L333 and if we see it will return the wrong thing, set the UICulture to DefaultUI culture, and return the logic to Import-LocalizedData #> $currentCulture = Get-UICulture $evaluateDefaultCulture = $true <# If the LCID is 127 then use default UI culture instead. See more information in issue https://github.com/dsccommunity/DscResource.Common/issues/11. #> if ($currentCulture.LCID -eq 127) { $currentCulture = New-Object -TypeName 'System.Globalization.CultureInfo' -ArgumentList @($DefaultUICulture) $PSBoundParameters['UICulture'] = $DefaultUICulture $evaluateDefaultCulture = $false } $languageFile = $null $localizedFileNames = @( $FileName + '.psd1' $FileName + '.strings.psd1' ) while ($null -ne $currentCulture -and $currentCulture.Name -and -not $languageFile) { foreach ($fullFileName in $localizedFileNames) { $filePath = [System.IO.Path]::Combine($callingScriptRoot, $CurrentCulture.Name, $fullFileName) if (Test-Path -Path $filePath) { Write-Debug -Message "Found $filePath" $languageFile = $filePath # Set the filename to the file we found. $PSBoundParameters['FileName'] = $fullFileName # Exit loop if we find the first filename. break } else { Write-Debug -Message "File $filePath not found" } } if (-not $languageFile) { <# Evaluate the parent culture if there is one. If the parent culture is LCID 127 then move to the default culture. See more information in issue https://github.com/dsccommunity/DscResource.Common/issues/11. #> if ($currentCulture.Parent -and $currentCulture.Parent.LCID -ne 127) { $currentCulture = $currentCulture.Parent } else { if ($evaluateDefaultCulture) { $evaluateDefaultCulture = $false <# Could not find localized strings file for the the operating system UI culture. Evaluating the default UI culture (which defaults to 'en-US' if not specifically set). #> $currentCulture = New-Object -TypeName 'System.Globalization.CultureInfo' -ArgumentList @($DefaultUICulture) $PSBoundParameters['UICulture'] = $DefaultUICulture } else { <# Already evaluated everything we could, exit and let Import-LocalizedData throw an exception. #> break } } } } <# Removes the parameter DefaultUICulture so that isn't used when calling Import-LocalizedData. #> $null = $PSBoundParameters.Remove('DefaultUICulture') } try { $outBuffer = $null if ($PSBoundParameters.TryGetValue('OutBuffer', [ref] $outBuffer)) { $PSBoundParameters['OutBuffer'] = 1 } $wrappedCmd = $ExecutionContext.InvokeCommand.GetCommand('Microsoft.PowerShell.Utility\Import-LocalizedData', [System.Management.Automation.CommandTypes]::Cmdlet) $scriptCmd = { & $wrappedCmd @PSBoundParameters } $steppablePipeline = $scriptCmd.GetSteppablePipeline($myInvocation.CommandOrigin) $steppablePipeline.Begin($PSCmdlet) } catch { throw } } process { try { $steppablePipeline.Process($_) } catch { throw } } end { if ($BindingVariable -and ($valueToBind = Get-Variable -Name $BindingVariable -ValueOnly -ErrorAction 'Ignore')) { # Bringing the variable to the parent scope Set-Variable -Scope 1 -Name $BindingVariable -Force -ErrorAction 'SilentlyContinue' -Value $valueToBind } try { $steppablePipeline.End() } catch { throw } } } #EndRegion './Public/Get-LocalizedData.ps1' 357 #Region './Public/Get-TemporaryFolder.ps1' 0 <# .SYNOPSIS Returns the path of the current user's temporary folder. .DESCRIPTION Returns the path of the current user's temporary folder. .NOTES This is the same as doing the following - Windows: $env:TEMP - macOS: $env:TMPDIR - Linux: /tmp/ .EXAMPLE Get-TemporaryFolder Returns the current user temporary folder on the current operating system. #> function Get-TemporaryFolder { [CmdletBinding()] [OutputType([System.String])] param () return [IO.Path]::GetTempPath() } #EndRegion './Public/Get-TemporaryFolder.ps1' 27 #Region './Public/New-InvalidArgumentException.ps1' 0 <# .SYNOPSIS Creates and throws an invalid argument exception. .DESCRIPTION Creates and throws an invalid argument exception. .PARAMETER Message The message explaining why this error is being thrown. .PARAMETER ArgumentName The name of the invalid argument that is causing this error to be thrown. .EXAMPLE $errorMessage = $script:localizedData.ActionCannotBeUsedInThisContextMessage ` -f $Action, $Parameter New-InvalidArgumentException -ArgumentName 'Action' -Message $errorMessage #> function New-InvalidArgumentException { [Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSUseShouldProcessForStateChangingFunctions', '')] [CmdletBinding()] param ( [Parameter(Mandatory = $true)] [ValidateNotNullOrEmpty()] [System.String] $Message, [Parameter(Mandatory = $true)] [ValidateNotNullOrEmpty()] [System.String] $ArgumentName ) $argumentException = New-Object -TypeName 'ArgumentException' ` -ArgumentList @($Message, $ArgumentName) $newObjectParameters = @{ TypeName = 'System.Management.Automation.ErrorRecord' ArgumentList = @($argumentException, $ArgumentName, 'InvalidArgument', $null) } $errorRecord = New-Object @newObjectParameters throw $errorRecord } #EndRegion './Public/New-InvalidArgumentException.ps1' 49 #Region './Public/New-InvalidDataException.ps1' 0 <# .SYNOPSIS Creates and throws an invalid data exception. .DESCRIPTION Creates and throws an invalid data exception. .PARAMETER ErrorId The error Id to assign to the exception. .PARAMETER ErrorMessage The error message to assign to the exception. .EXAMPLE if ( -not $resultOfEvaluation ) { $errorMessage = $script:localizedData.InvalidData -f $Action New-InvalidDataException -ErrorId 'InvalidDataError' -ErrorMessage $errorMessage } #> function New-InvalidDataException { [System.Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSUseShouldProcessForStateChangingFunctions', '')] [CmdletBinding()] param ( [Parameter(Mandatory = $true)] [System.String] $ErrorId, [Parameter(Mandatory = $true)] [System.String] $ErrorMessage ) $errorCategory = [System.Management.Automation.ErrorCategory]::InvalidData $exception = New-Object ` -TypeName System.InvalidOperationException ` -ArgumentList $ErrorMessage $errorRecord = New-Object ` -TypeName System.Management.Automation.ErrorRecord ` -ArgumentList $exception, $ErrorId, $errorCategory, $null throw $errorRecord } #EndRegion './Public/New-InvalidDataException.ps1' 47 #Region './Public/New-InvalidOperationException.ps1' 0 <# .SYNOPSIS Creates and throws an invalid operation exception. .DESCRIPTION Creates and throws an invalid operation exception. .PARAMETER Message The message explaining why this error is being thrown. .PARAMETER ErrorRecord The error record containing the exception that is causing this terminating error. .EXAMPLE try { Start-Process @startProcessArguments } catch { $errorMessage = $script:localizedData.InstallationFailedMessage -f $Path, $processId New-InvalidOperationException -Message $errorMessage -ErrorRecord $_ } #> function New-InvalidOperationException { [Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSUseShouldProcessForStateChangingFunctions', '')] [CmdletBinding()] param ( [Parameter(Mandatory = $true)] [ValidateNotNullOrEmpty()] [System.String] $Message, [Parameter()] [ValidateNotNull()] [System.Management.Automation.ErrorRecord] $ErrorRecord ) if ($null -eq $ErrorRecord) { $invalidOperationException = New-Object -TypeName 'InvalidOperationException' ` -ArgumentList @($Message) } else { $invalidOperationException = New-Object -TypeName 'InvalidOperationException' ` -ArgumentList @($Message, $ErrorRecord.Exception) } $newObjectParameters = @{ TypeName = 'System.Management.Automation.ErrorRecord' ArgumentList = @( $invalidOperationException.ToString(), 'MachineStateIncorrect', 'InvalidOperation', $null ) } $errorRecordToThrow = New-Object @newObjectParameters throw $errorRecordToThrow } #EndRegion './Public/New-InvalidOperationException.ps1' 67 #Region './Public/New-InvalidResultException.ps1' 0 <# .SYNOPSIS Creates and throws an invalid result exception. .DESCRIPTION Creates and throws an invalid result exception. .PARAMETER Message The message explaining why this error is being thrown. .PARAMETER ErrorRecord The error record containing the exception that is causing this terminating error. .EXAMPLE try { $numberOfObjects = Get-ChildItem -Path $path if ($numberOfObjects -eq 0) { throw 'To few files.' } } catch { $errorMessage = $script:localizedData.TooFewFilesMessage -f $path New-InvalidResultException -Message $errorMessage -ErrorRecord $_ } #> function New-InvalidResultException { [Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSUseShouldProcessForStateChangingFunctions', '')] [CmdletBinding()] param ( [Parameter(Mandatory = $true)] [ValidateNotNullOrEmpty()] [System.String] $Message, [Parameter()] [ValidateNotNull()] [System.Management.Automation.ErrorRecord] $ErrorRecord ) if ($null -eq $ErrorRecord) { $exception = New-Object -TypeName 'System.Exception' ` -ArgumentList @($Message) } else { $exception = New-Object -TypeName 'System.Exception' ` -ArgumentList @($Message, $ErrorRecord.Exception) } $newObjectParameters = @{ TypeName = 'System.Management.Automation.ErrorRecord' ArgumentList = @( $exception.ToString(), 'MachineStateIncorrect', 'InvalidResult', $null ) } $errorRecordToThrow = New-Object @newObjectParameters throw $errorRecordToThrow } #EndRegion './Public/New-InvalidResultException.ps1' 71 #Region './Public/New-NotImplementedException.ps1' 0 <# .SYNOPSIS Creates and throws an not implemented exception. .DESCRIPTION Creates and throws an not implemented exception. .PARAMETER Message The message explaining why this error is being thrown. .PARAMETER ErrorRecord The error record containing the exception that is causing this terminating error. .EXAMPLE if ($runFeature) { $errorMessage = $script:localizedData.FeatureMissing -f $path New-NotImplementedException -Message $errorMessage -ErrorRecord $_ } Throws an not implemented exception if the variable $runFeature contains a value. #> function New-NotImplementedException { [Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSUseShouldProcessForStateChangingFunctions', '')] [CmdletBinding()] param ( [Parameter(Mandatory = $true)] [ValidateNotNullOrEmpty()] [System.String] $Message, [Parameter()] [ValidateNotNull()] [System.Management.Automation.ErrorRecord] $ErrorRecord ) if ($null -eq $ErrorRecord) { $invalidOperationException = New-Object -TypeName 'NotImplementedException' ` -ArgumentList @($Message) } else { $invalidOperationException = New-Object -TypeName 'NotImplementedException' ` -ArgumentList @($Message, $ErrorRecord.Exception) } $newObjectParameters = @{ TypeName = 'System.Management.Automation.ErrorRecord' ArgumentList = @( $invalidOperationException.ToString(), 'MachineStateIncorrect', 'NotImplemented', $null ) } $errorRecordToThrow = New-Object @newObjectParameters throw $errorRecordToThrow } #EndRegion './Public/New-NotImplementedException.ps1' 66 #Region './Public/New-ObjectNotFoundException.ps1' 0 <# .SYNOPSIS Creates and throws an object not found exception. .DESCRIPTION Creates and throws an object not found exception. .PARAMETER Message The message explaining why this error is being thrown. .PARAMETER ErrorRecord The error record containing the exception that is causing this terminating error. .EXAMPLE try { Get-ChildItem -Path $path } catch { $errorMessage = $script:localizedData.PathNotFoundMessage -f $path New-ObjectNotFoundException -Message $errorMessage -ErrorRecord $_ } #> function New-ObjectNotFoundException { [Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSUseShouldProcessForStateChangingFunctions', '')] [CmdletBinding()] param ( [Parameter(Mandatory = $true)] [ValidateNotNullOrEmpty()] [System.String] $Message, [Parameter()] [ValidateNotNull()] [System.Management.Automation.ErrorRecord] $ErrorRecord ) if ($null -eq $ErrorRecord) { $exception = New-Object -TypeName 'System.Exception' ` -ArgumentList @($Message) } else { $exception = New-Object -TypeName 'System.Exception' ` -ArgumentList @($Message, $ErrorRecord.Exception) } $newObjectParameters = @{ TypeName = 'System.Management.Automation.ErrorRecord' ArgumentList = @( $exception.ToString(), 'MachineStateIncorrect', 'ObjectNotFound', $null ) } $errorRecordToThrow = New-Object @newObjectParameters throw $errorRecordToThrow } #EndRegion './Public/New-ObjectNotFoundException.ps1' 68 #Region './Public/Remove-CommonParameter.ps1' 0 <# .SYNOPSIS Removes common parameters from a hashtable. .DESCRIPTION This function serves the purpose of removing common parameters and option common parameters from a parameter hashtable. .PARAMETER Hashtable The parameter hashtable that should be pruned. .EXAMPLE Remove-CommonParameter -Hashtable $PSBoundParameters Returns a new hashtable without the common and optional common parameters. #> function Remove-CommonParameter { [Diagnostics.CodeAnalysis.SuppressMessageAttribute( 'PSUseShouldProcessForStateChangingFunctions', '', Justification = 'ShouldProcess is not supported in DSC resources.' )] [OutputType([System.Collections.Hashtable])] [CmdletBinding()] param ( [Parameter(Mandatory = $true)] [System.Collections.Hashtable] $Hashtable ) $inputClone = $Hashtable.Clone() $commonParameters = [System.Management.Automation.PSCmdlet]::CommonParameters $commonParameters += [System.Management.Automation.PSCmdlet]::OptionalCommonParameters $Hashtable.Keys | Where-Object -FilterScript { $_ -in $commonParameters } | ForEach-Object -Process { $inputClone.Remove($_) } return $inputClone } #EndRegion './Public/Remove-CommonParameter.ps1' 46 #Region './Public/Set-DscMachineRebootRequired.ps1' 0 <# .SYNOPSIS Set the DSC reboot required status variable. .DESCRIPTION Sets the global DSCMachineStatus variable to a value of 1. This function is used to set the global variable that indicates to the LCM that a reboot of the node is required. .EXAMPLE PS C:\> Set-DscMachineRebootRequired Sets the $global:DSCMachineStatus variable to 1. .NOTES This function is implemented so that individual resource modules do not need to use and therefore suppress Global variables directly. It also enables mocking to increase testability of consumers. #> function Set-DscMachineRebootRequired { [System.Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSUseShouldProcessForStateChangingFunctions', '')] # Suppressing this rule because $global:DSCMachineStatus is used to trigger a reboot. [System.Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSAvoidGlobalVars', '')] <# Suppressing this rule because $global:DSCMachineStatus is only set, never used (by design of Desired State Configuration). #> [System.Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSUseDeclaredVarsMoreThanAssignments', '')] [CmdletBinding()] param ( ) $global:DSCMachineStatus = 1 } #EndRegion './Public/Set-DscMachineRebootRequired.ps1' 38 #Region './Public/Set-PSModulePath.ps1' 0 <# .SYNOPSIS Set environment variable PSModulePath in the current session or machine wide. .DESCRIPTION This is a wrapper to set environment variable PSModulePath in current session or machine wide. .PARAMETER Path A string with all the paths separated by semi-colons. .PARAMETER Machine If set the PSModulePath will be changed machine wide. If not set, only the current session will be changed. .EXAMPLE Set-PSModulePath -Path '<Path 1>;<Path 2>' .EXAMPLE Set-PSModulePath -Path '<Path 1>;<Path 2>' -Machine #> function Set-PSModulePath { [Diagnostics.CodeAnalysis.SuppressMessageAttribute( 'PSUseShouldProcessForStateChangingFunctions', '', Justification = 'ShouldProcess is not supported in DSC resources.' )] [CmdletBinding()] param ( [Parameter(Mandatory = $true)] [ValidateNotNullOrEmpty()] [System.String] $Path, [Parameter()] [System.Management.Automation.SwitchParameter] $Machine ) if ($Machine.IsPresent) { [System.Environment]::SetEnvironmentVariable('PSModulePath', $Path, [System.EnvironmentVariableTarget]::Machine) } else { $env:PSModulePath = $Path } } #EndRegion './Public/Set-PSModulePath.ps1' 53 #Region './Public/Test-DscParameterState.ps1' 0 <# .SYNOPSIS This method is used to test current and desired values for any DSC resource. .DESCRIPTION This function tests the parameter status of DSC resource parameters against the current values present on the system. .PARAMETER CurrentValues A hashtable with the current values on the system, obtained by e.g. Get-TargetResource. .PARAMETER DesiredValues The hashtable of desired values. For example $PSBoundParameters with the desired values. .PARAMETER Properties This is a list of properties in the desired values list should be checked. If this is empty then all values in DesiredValues are checked. .PARAMETER ExcludeProperties This is a list of which properties in the desired values list should be checked. If this is empty then all values in DesiredValues are checked. .PARAMETER TurnOffTypeChecking Indicates that the type of the parameter should not be checked. .PARAMETER ReverseCheck Indicates that a reverse check should be done. The current and desired state are swapped for another test. .PARAMETER SortArrayValues If the sorting of array values does not matter, values are sorted internally before doing the comparison. .EXAMPLE $currentState = Get-TargetResource @PSBoundParameters $returnValue = Test-DscParameterState -CurrentValues $currentState -DesiredValues $PSBoundParameters The function Get-TargetResource is called first using all bound parameters to get the values in the current state. The result is then compared to the desired state by calling `Test-DscParameterState`. .EXAMPLE $getTargetResourceParameters = @{ ServerName = $ServerName InstanceName = $InstanceName Name = $Name } $returnValue = Test-DscParameterState ` -CurrentValues (Get-TargetResource @getTargetResourceParameters) ` -DesiredValues $PSBoundParameters ` -ExcludeProperties @( 'FailsafeOperator' 'NotificationMethod' ) This compares the values in the current state against the desires state. The function Get-TargetResource is called using just the required parameters to get the values in the current state. The parameter 'ExcludeProperties' is used to exclude the properties 'FailsafeOperator' and 'NotificationMethod' from the comparison. .EXAMPLE $getTargetResourceParameters = @{ ServerName = $ServerName InstanceName = $InstanceName Name = $Name } $returnValue = Test-DscParameterState ` -CurrentValues (Get-TargetResource @getTargetResourceParameters) ` -DesiredValues $PSBoundParameters ` -Properties ServerName, Name This compares the values in the current state against the desires state. The function Get-TargetResource is called using just the required parameters to get the values in the current state. The 'Properties' parameter is used to to only compare the properties 'ServerName' and 'Name'. #> function Test-DscParameterState { [CmdletBinding()] [OutputType([Bool])] param ( [Parameter(Mandatory = $true)] [System.Object] $CurrentValues, [Parameter(Mandatory = $true)] [System.Object] $DesiredValues, [Parameter()] [System.String[]] [Alias('ValuesToCheck')] $Properties, [Parameter()] [System.String[]] $ExcludeProperties, [Parameter()] [System.Management.Automation.SwitchParameter] $TurnOffTypeChecking, [Parameter()] [System.Management.Automation.SwitchParameter] $ReverseCheck, [Parameter()] [System.Management.Automation.SwitchParameter] $SortArrayValues ) $returnValue = $true $resultCompare = Compare-DscParameterState @PSBoundParameters if ($resultCompare.InDesiredState -contains $false) { $returnValue = $false } return $returnValue } #EndRegion './Public/Test-DscParameterState.ps1' 130 #Region './Public/Test-IsNanoServer.ps1' 0 <# .SYNOPSIS Tests if the current OS is a Nano server. .DESCRIPTION Tests if the current OS is a Nano server. .EXAMPLE Test-IsNanoServer Returns $true if the current operating system is Nano Server, if not $false is returned. #> function Test-IsNanoServer { [OutputType([System.Boolean])] [CmdletBinding()] param () $productDatacenterNanoServer = 143 $productStandardNanoServer = 144 $operatingSystemSKU = (Get-CimInstance -ClassName Win32_OperatingSystem).OperatingSystemSKU Write-Verbose -Message ($script:localizedData.TestIsNanoServerOperatingSystemSku -f $operatingSystemSKU) return ($operatingSystemSKU -in ($productDatacenterNanoServer, $productStandardNanoServer)) } #EndRegion './Public/Test-IsNanoServer.ps1' 29 #Region './suffix.ps1' 0 $script:localizedData = Get-LocalizedData -DefaultUICulture 'en-US' #EndRegion './suffix.ps1' 2 |