DSCResources/DSC_WindowsCapability/DSC_WindowsCapability.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
$modulePath = Join-Path -Path (Split-Path -Path (Split-Path -Path $PSScriptRoot -Parent) -Parent) -ChildPath 'Modules'

# Import the ComputerManagementDsc Common Modules
Import-Module -Name (Join-Path -Path $modulePath `
        -ChildPath (Join-Path -Path 'ComputerManagementDsc.Common' `
            -ChildPath 'ComputerManagementDsc.Common.psm1'))

# Import Localization Strings
$script:localizedData = Get-LocalizedData -ResourceName 'DSC_WindowsCapability'

<#
    .SYNOPSIS
        Gets the current state of the Windows Capability.
 
    .PARAMETER Name
        Specifies the name of the Windows Capability.
#>

function Get-TargetResource
{
    [CmdletBinding()]
    [OutputType([System.Collections.Hashtable])]
    param
    (
        [Parameter(Mandatory = $true)]
        [System.String]
        $Name
    )

    Write-Verbose -Message ($script:localizedData.GetTargetResourceStartMessage -f $Name)
    $windowsCapability = Get-WindowsCapability -Online @PSBoundParameters

    if ([System.String]::IsNullOrEmpty($windowsCapability.Name))
    {
        New-InvalidArgumentException `
            -Message ($script:localizedData.CapabilityNameNotFound -f $Name) `
            -ArgumentName 'Name'
    }
    else
    {
        Write-Verbose -Message ($script:localizedData.CapabilityNameFound -f $Name)
    }

    if ($windowsCapability.State -eq 'Installed')
    {
        $Ensure = 'Present'
    }
    else
    {
        $Ensure = 'Absent'
    }

    $returnValue = @{
        Name     = $Name
        LogLevel = $windowsCapability.LogLevel
        LogPath  = $windowsCapability.LogPath
        Ensure   = $Ensure
    }

    Write-Verbose -Message ($script:localizedData.GetTargetResourceEndMessage -f $Name)
    return $returnValue
}

<#
    .SYNOPSIS
        Sets if the the current state of the Windows Capability is in the desired state.
 
    .PARAMETER Name
        Specifies the name of the Windows Capability.
 
    .PARAMETER Ensure
        Specifies whether the Windows Capability should be installed
        or uninstalled.
 
    .PARAMETER LogLevel
        Specifies the given Log Level of a Windows Capability. This is a write
        only parameter that is used when updating the status of a Windows
        Capability. If not specified, the default is 'WarningsInfo'.
 
    .PARAMETER LogPath
        Specifies the full path and file name to log to. This is a write
        only parameter that is used when updating the status of a Windows
        Capability. If not specified, the default is '%WINDIR%\Logs\Dism\dism.log'.
#>

function Set-TargetResource
{
    [CmdletBinding()]
    param
    (
        [Parameter(Mandatory = $true)]
        [System.String]
        $Name,

        [Parameter()]
        [ValidateSet('Present', 'Absent')]
        [System.String]
        $Ensure = 'Present',

        [Parameter()]
        [ValidateSet('Errors', 'Warnings', 'WarningsInfo')]
        [System.String]
        $LogLevel,

        [Parameter()]
        [System.String]
        $LogPath
    )

    Write-Verbose -Message ($script:localizedData.SetTargetResourceStartMessage -f $Name)
    $null = $PSBoundParameters.Remove('Ensure')
    $currentState = Get-TargetResource -Name $Name

    switch ($Ensure)
    {
        'Present'
        {
            if ($Ensure -ne $currentState.Ensure)
            {
                Write-Verbose -Message ($script:localizedData.SetTargetAddMessage -f $Name)
                $null = Add-WindowsCapability -Online @PSBoundParameters
            }
        }

        'Absent'
        {
            if ($Ensure -ne $currentState.Ensure)
            {
                Write-Verbose -Message ($script:localizedData.SetTargetRemoveMessage -f $Name)
                $null = Remove-WindowsCapability -Online @PSBoundParameters
            }
        }
    }
}

<#
    .SYNOPSIS
        Tests if the the current state of the Windows Capability is in the desired state.
 
    .PARAMETER Name
        Specifies the name of the Windows Capability.
 
    .PARAMETER Ensure
        Specifies whether the Windows Capability should be installed
        or uninstalled.
 
    .PARAMETER LogLevel
        Specifies the given Log Level of a Windows Capability. This is a write
        only parameter that is used when updating the status of a Windows
        Capability. If not specified, the default is 'WarningsInfo'.
 
    .PARAMETER LogPath
        Specifies the full path and file name to log to. This is a write
        only parameter that is used when updating the status of a Windows
        Capability. If not specified, the default is '%WINDIR%\Logs\Dism\dism.log'.
 
    .NOTES
        Get-WindowsCapability will return the LogLevel and LogPath
        properties, but these values don't reflect the values set
        when calling Add-WindowsCapability or Remove-WindowsCapability.
 
        Therefore, these values can not be used to determine if the
        resource is in state.
#>

function Test-TargetResource
{
    [CmdletBinding()]
    [OutputType([System.Boolean])]
    param
    (
        [Parameter(Mandatory = $true)]
        [System.String]
        $Name,

        [Parameter()]
        [ValidateSet('Present', 'Absent')]
        [System.String]
        $Ensure = 'Present',

        [Parameter()]
        [ValidateSet('Errors', 'Warnings', 'WarningsInfo')]
        [System.String]
        $LogLevel,

        [Parameter()]
        [System.String]
        $LogPath
    )

    $inDesiredState = $true

    Write-Verbose -Message ($script:localizedData.TestTargetResourceStartMessage -f $Name)
    $currentState = Get-TargetResource -Name $Name

    if ($Ensure -ne $currentState.Ensure)
    {
        Write-Verbose -Message ($script:localizedData.SetResourceIsNotInDesiredState -f $Name)
        $inDesiredState = $false
    }
    else
    {
        Write-Verbose -Message ($script:localizedData.SetResourceIsInDesiredState -f $Name)
        $inDesiredState = $true
    }

    return $inDesiredState
}

Export-ModuleMember -Function *-TargetResource