functions/Set-DbaPowerPlan.ps1

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
function Set-DbaPowerPlan {
    <#
    .SYNOPSIS
        Sets the SQL Server OS's Power Plan.
 
    .DESCRIPTION
        Sets the SQL Server OS's Power Plan. Defaults to High Performance which is best practice.
 
        If your organization uses a custom power plan that is considered best practice, specify -CustomPowerPlan.
 
        References:
        https://support.microsoft.com/en-us/kb/2207548
        http://www.sqlskills.com/blogs/glenn/windows-power-plan-effects-on-newer-intel-processors/
 
    .PARAMETER ComputerName
        The server(s) to set the Power Plan on.
 
    .PARAMETER Credential
        Specifies a PSCredential object to use in authenticating to the server(s), instead of the current user account.
 
    .PARAMETER PowerPlan
        Specifies the Power Plan that you wish to use. Valid options for this match the Windows default Power Plans of "Power Saver", "Balanced", and "High Performance".
 
    .PARAMETER CustomPowerPlan
        Specifies the name of a custom Power Plan to use.
 
    .PARAMETER InputObject
        Enables piping from Get-DbaPowerPlan
 
    .PARAMETER EnableException
        By default, when something goes wrong we try to catch it, interpret it and give you a friendly warning message.
        This avoids overwhelming you with "sea of red" exceptions, but is inconvenient because it basically disables advanced scripting.
        Using this switch turns this "nice by default" feature off and enables you to catch exceptions with your own try/catch.
 
    .PARAMETER WhatIf
        If this switch is enabled, no actions are performed but informational messages will be displayed that explain what would happen if the command were to run.
 
    .PARAMETER Confirm
        If this switch is enabled, you will be prompted for confirmation before executing any operations that change state.
 
    .NOTES
        Tags: PowerPlan, OS, Configure
        Author: Chrissy LeMaire (@cl), netnerds.net
 
        Website: https://dbatools.io
        Copyright: (c) 2018 by dbatools, licensed under MIT
        License: MIT https://opensource.org/licenses/MIT
 
        Requires: WMI access to servers
 
    .LINK
        https://dbatools.io/Set-DbaPowerPlan
 
    .EXAMPLE
        PS C:\> Set-DbaPowerPlan -ComputerName sql2017
 
        Sets the Power Plan to High Performance. Skips it if its already set.
 
    .EXAMPLE
        PS C:\> 'Server1', 'Server2' | Set-DbaPowerPlan -PowerPlan Balanced
 
        Sets the Power Plan to Balanced for Server1 and Server2. Skips it if its already set.
 
    .EXAMPLE
        PS C:\> $cred = Get-Credential 'Domain\User'
        PS C:\> Set-DbaPowerPlan -ComputerName sql2017 -Credential $cred
 
        Connects using alternative Windows credential and sets the Power Plan to High Performance. Skips it if its already set.
 
    .EXAMPLE
        PS C:\> Set-DbaPowerPlan -ComputerName sqlcluster -CustomPowerPlan 'Maximum Performance'
 
        Sets the Power Plan to the custom power plan called "Maximum Performance". Skips it if its already set.
 
       #>

    [CmdletBinding(SupportsShouldProcess)]
    [Diagnostics.CodeAnalysis.SuppressMessageAttribute("PSUseOutputTypeCorrectly", "", Justification = "PSSA Rule Ignored by BOH")]
    param (
        [parameter(ValueFromPipeline)]
        [DbaInstance[]]$ComputerName,
        [PSCredential]$Credential,
        [string]$PowerPlan = 'High Performance',
        [string]$CustomPowerPlan,
        [parameter(ValueFromPipeline)]
        [pscustomobject]$InputObject,
        [switch]$EnableException
    )

    begin {
        if ($CustomPowerPlan) {
            $powerPlanRequested = $CustomPowerPlan
        } else {
            $powerPlanRequested = $PowerPlan
        }
        function Set-DbaPowerPlanInternal {
            [CmdletBinding(SupportsShouldProcess)]
            param (
                [string]$ComputerName,
                [PSCredential]$Credential
            )

            if (Test-Bound -ParameterName Credential) {
                $IncludeCred = $true
            }
            try {
                Write-Message -Level Verbose -Message "Testing connection to $computer"
                $computerResolved = Resolve-DbaNetworkName -ComputerName $computer -Credential $Credential

                $computerResolved = $computerResolved.FullComputerName
            } catch {
                Stop-Function -Message "Error occurred while establishing connection to $instance" -Category ConnectionError -ErrorRecord $_ -Target $computer
                return
            }

            $splatDbaCmObject = @{
                ComputerName    = $computerResolved
                EnableException = $true
            }
            if ($IncludeCred) {
                $splatDbaCmObject["Credential"] = $Credential
            }

            try {
                Write-Message -Level Verbose -Message "Getting Power Plan information from $computer."
                $currentplan = Get-DbaCmObject @splatDbaCmObject -ClassName Win32_PowerPlan -Namespace "root\cimv2\power" | Where-Object IsActive -eq 'True'
                $currentplan = $currentplan.ElementName
            } catch {
                if ($_.Exception -match "namespace") {
                    Stop-Function -Message "Can't get Power Plan Info for $computer. Unsupported operating system." -Continue -ErrorRecord $_ -Target $computer
                } else {
                    Stop-Function -Message "Can't get Power Plan Info for $computer. Check logs for more details." -Continue -ErrorRecord $_ -Target $computer
                }
            }

            if ($null -eq $currentplan) {
                # the try/catch above isn't working, so make it silent and handle it here.
                Stop-Function -Message "Cannot get Power Plan for $computer." -Category ConnectionError -ErrorRecord $_ -Target $computer
                return
            }

            $planinfo = [PSCustomObject]@{
                ComputerName      = $computer
                PreviousPowerPlan = $currentplan
                ActivePowerPlan   = $powerPlanRequested
            }
            if ($Pscmdlet.ShouldProcess($powerPlanRequested, "Setting Powerplan on $computer")) {
                if ($powerPlanRequested -ne $currentplan) {
                    if ($Pscmdlet.ShouldProcess($computer, "Changing Power Plan from $CurrentPlan to $powerPlanRequested")) {
                        Write-Message -Level Verbose -Message "Creating CIMSession on $computer over WSMan"
                        if ($IncludeCred) {
                            $cimSession = New-CimSession -ComputerName $computer -ErrorAction SilentlyContinue -Credential $Credential
                        } else {
                            $cimSession = New-CimSession -ComputerName $computer -ErrorAction SilentlyContinue
                        }
                        if (-not $cimSession) {
                            Write-Message -Level Verbose -Message "Creating CIMSession on $computer over WSMan failed. Creating CIMSession on $computer over DCom"
                            $sessionOption = New-CimSessionOption -Protocol DCom
                            if ($IncludeCred) {
                                $cimSession = New-CimSession -ComputerName $computer -SessionOption $sessionoption -ErrorAction SilentlyContinue -Credential $Credential
                            } else {
                                $cimSession = New-CimSession -ComputerName $computer -SessionOption $sessionoption -ErrorAction SilentlyContinue
                            }
                        }
                        if ($cimSession) {
                            Write-Message -Level Verbose -Message "Setting Power Plan to $powerPlanRequested."

                            $cimInstance = Get-CimInstance -Namespace root\cimv2\power -ClassName win32_PowerPlan -Filter "ElementName = '$powerPlanRequested'" -CimSession $CIMSession
                            if ($cimInstance) {
                                $cimResult = Invoke-CimMethod -InputObject $cimInstance[0] -MethodName Activate -CimSession $cimSession
                                if (!$cimResult) {
                                    Stop-Function -Message "Couldn't set the requested Power Plan '$powerPlanRequested' on $computer." -Category ConnectionError -Target $computer
                                    return
                                }
                            } else {
                                Stop-Function -Message "Couldn't find the requested Power Plan '$powerPlanRequested' on $computer." -Category ConnectionError -Target $computer
                                return
                            }
                        } else {
                            Stop-Function -Message "Couldn't set Power Plan on $computer." -Category ConnectionError -ErrorRecord $_ -Target $computer
                            return
                        }
                    }
                } else {
                    if ($Pscmdlet.ShouldProcess($computer, "Stating power plan is already set to $powerPlanRequested, won't change.")) {
                        Write-Message -Level Verbose -Message "PowerPlan on $computer is already set to $powerPlanRequested. Skipping."
                    }
                }

                return $planInfo
            }
        }
    }

    process {
        # uses cim commands
        
        
        if (Test-Bound -ParameterName ComputerName) {
            $InputObject += Get-DbaPowerPlan -ComputerName $ComputerName -Credential $Credential
        }

        foreach ($pplan in $InputObject) {
            $computer = $pplan.ComputerName
            $Credential = $pplan.Credential
            Write-Message -Level Verbose -Message "Calling Set-DbaPowerPlanInternal for $computer"
            if (Test-Bound -ParameterName Credential) {
                $data = Set-DbaPowerPlanInternal -ComputerName $Computer -Credential $Credential
            } else {
                $data = Set-DbaPowerPlanInternal -ComputerName $Computer
            }

            if ($data.Count -gt 1) {
                $data.GetEnumerator() | ForEach-Object {
                    $_
                }
            } else {
                $data
            }
        }
    }
}