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
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 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 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
   Requires: WMI access to servers
     
   dbatools PowerShell module (https://dbatools.io, clemaire@gmail.com)
   Copyright (C) 2016 Chrissy LeMaire
   License: GNU GPL v3 https://opensource.org/licenses/GPL-3.0
 
  .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", "SqlServer", "SqlInstance")]
        [object[]]$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
        }
    }
}