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
Function Set-DbaPowerPlan
{
<#
.SYNOPSIS
Sets the SQL Server OS's Power Plan.
  
.DESCRIPTION
Sets the SQL Server OS's Power Plan. It 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 SQL Server (or server in general) that you're connecting to. The -SqlServer parameter also works. This command handles named instances.
  
.PARAMETER PowerPlan
The Power Plan that you wish to use. These are validated to Windows default Power Plans (Power saver, Balanced, High Performance)
  
.PARAMETER CustomPowerPlan
If you use a custom power plan instead of Windows default, use CustomPowerPlan
 
.PARAMETER WhatIf
Shows what would happen if the command were to run. No actions are actually performed.
 
.PARAMETER Confirm
Prompts you for confirmation before executing any changing operations within the command.
 
.NOTES
Requires: WMI access to servers
  
dbatools PowerShell module (https://dbatools.io, clemaire@gmail.com)
Copyright (C) 2016 Chrissy LeMaire
 
This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
 
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
 
You should have received a copy of the GNU General Public License along with this program. If not, see <http://www.gnu.org/licenses/>.
 
.LINK
https://dbatools.io/Set-DbaPowerPlan
 
.EXAMPLE
Set-DbaPowerPlan -ComputerName sqlserver2014a
 
Sets the Power Plan to High Performance. Skips it if its already set.
  
.EXAMPLE
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 = $true)]
Param (
[parameter(Mandatory = $true, ValueFromPipeline = $true)]
[Alias("ServerInstance", "SqlInstance", "SqlServer")]
[string[]]$ComputerName,
[ValidateSet('High Performance', 'Balanced', 'Power saver')]
[string]$PowerPlan = 'High Performance',
[string]$CustomPowerPlan
)

BEGIN
{
if ($CustomPowerPlan.Length -gt 0) { $PowerPlan = $CustomPowerPlan }

Function Set-DbaPowerPlan
{
try
{
Write-Verbose "Testing connection to $server and resolving IP address"
$ipaddr = (Test-Connection $server -Count 1 -ErrorAction SilentlyContinue).Ipv4Address | Select-Object -First 1

}
catch
{
Write-Warning "Can't connect to $server"
return
}

try
{
Write-Verbose "Getting Power Plan information from $server"
$query = "Select ElementName from Win32_PowerPlan WHERE IsActive = 'true'"
$currentplan = Get-WmiObject -Namespace Root\CIMV2\Power -ComputerName $ipaddr -Query $query -ErrorAction SilentlyContinue
$currentplan = $currentplan.ElementName
}
catch
{
Write-Warning "Can't connect to WMI on $server"
return
}

if ($currentplan -eq $null)
{
# the try/catch above isn't working, so make it silent and handle it here.
Write-Warning "Cannot get Power Plan for $server"
return
}

$planinfo = [PSCustomObject]@{
Server = $server
PreviousPowerPlan = $currentplan
ActivePowerPlan = $PowerPlan
}

if ($PowerPlan -ne $currentplan)
{
If ($Pscmdlet.ShouldProcess($server, "Changing Power Plan from $CurrentPlan to $PowerPlan"))
{
try
{
Write-Verbose "Setting Power Plan to $PowerPlan"
$null = (Get-WmiObject -Name root\cimv2\power -ComputerName $ipaddr -Class Win32_PowerPlan -Filter "ElementName='$PowerPlan'").Activate()
}
catch
{
Write-Exception $_
Write-Warning "Couldn't set Power Plan on $server"
return
}
}
}
else
{
If ($Pscmdlet.ShouldProcess($server, "Stating power plan is already set to $PowerPlan, won't change."))
{
Write-Warning "PowerPlan on $server is already set to $PowerPlan. Skipping."
}
}

return $planinfo
}


$collection = New-Object System.Collections.ArrayList
$processed = New-Object System.Collections.ArrayList
}

PROCESS
{
foreach ($server in $ComputerName)
{
if ($server -match 'Server\=')
{
Write-Verbose "Matched that value was piped from Test-DbaPowerPlan"
# I couldn't properly unwrap the output from Test-DbaPowerPlan so here goes.
$lol = $server.Split("\;")[0]
$lol = $lol.TrimEnd("\}")
$lol = $lol.TrimStart("\@\{Server")
# There was some kind of parsing bug here, don't clown
$server = $lol.TrimStart("\=")
}

if ($server -match '\\')
{
$server = $server.Split('\\')[0]
}

if ($server -notin $processed)
{
$null = $processed.Add($server)
Write-Verbose "Connecting to $server"
}
else
{
continue
}

$data = Set-DbaPowerPlan $server

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

END
{
If ($Pscmdlet.ShouldProcess("console", "Showing results"))
{
return $collection
}
}
}