functions/Test-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
function Test-DbaPowerPlan {
    <#
  .SYNOPSIS
   Checks the Power Plan settings for compliance with best practices, which recommend High Performance for SQL Server.
 
  .DESCRIPTION
   Checks the Power Plan settings on a computer against best practices recommendations. If one server is checked, only $true or $false is returned. If multiple servers are checked, each server's name and an IsBestPractice field are returned.
 
   Specify -Detailed for details.
 
   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 check Power Plan settings on.
 
  .PARAMETER Credential
   Specifies a PSCredential object to use in authenticating to the server(s), instead of the current user account.
 
  .PARAMETER CustomPowerPlan
   If your organization uses a custom power plan that's considered best practice, specify it here.
 
  .PARAMETER Detailed
   If this switch is enabled, a detailed list will be returned. This parameter will be removed in 1.0.
 
  .PARAMETER Silent
   If this switch is enabled, the internal messaging functions will be silenced.
 
  .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/Test-DbaPowerPlan
 
  .EXAMPLE
   Test-DbaPowerPlan -ComputerName sqlserver2014a
 
   Checks the Power Plan settings for sqlserver2014a and indicates whether or not it complies with best practices.
 
  .EXAMPLE
   Test-DbaPowerPlan -ComputerName sqlserver2014a -CustomPowerPlan 'Maximum Performance'
 
   Checks the Power Plan settings for sqlserver2014a and indicates whether or not it is set to the custom plan "Maximum Performance".
 
  .EXAMPLE
   Test-DbaPowerPlan -ComputerName sqlserver2014a -Detailed
 
   Returns detailed information about the Power Plans on sqlserver2014a.
 
 #>

    param (
        [parameter(ValueFromPipeline = $true)]
        [Alias("ServerInstance", "SqlServer", "SqlInstance")]
        [string[]]$ComputerName = $env:COMPUTERNAME,
        [PSCredential]$Credential,
        [string]$CustomPowerPlan,
        [switch]$Detailed,
        [switch]$Silent
    )
    
    begin {
        if ($Detailed) {
            Write-Message -Level Warning -Message "Detailed is deprecated and will be removed in dbatools 1.0"
        }
        
        $bpPowerPlan = [PSCustomObject]@{
            InstanceID  = '8c5e7fda-e8bf-4a96-9a85-a6e23a8c635c'
            ElementName = $null
        }
        
        $sessionoption = New-CimSessionOption -Protocol DCom
    }
    
    process {
        foreach ($computer in $ComputerName) {
            $Server = Resolve-DbaNetworkName -ComputerName $computer -Credential $credential
            
            $Computer = $server.ComputerName
            
            if (!$Computer) {
                Stop-Function -Message "Couldn't resolve hostname. Skipping." -Continue
            }
            
            Write-Message -Level Verbose -Message "Creating CimSession on $computer over WSMan."
            
            if (!$Credential) {
                $cimsession = New-CimSession -ComputerName $Computer -ErrorAction SilentlyContinue
            }
            else {
                $cimsession = New-CimSession -ComputerName $Computer -ErrorAction SilentlyContinue -Credential $Credential
            }
            
            if ($null -eq $cimsession.id) {
                Write-Message -Level Verbose -Message "Creating CimSession on $computer over WSMan failed. Creating CimSession on $computer over DCOM."
                
                if (!$Credential) {
                    $cimsession = New-CimSession -ComputerName $Computer -SessionOption $sessionoption -ErrorAction SilentlyContinue -Credential $Credential
                }
                else {
                    $cimsession = New-CimSession -ComputerName $Computer -SessionOption $sessionoption -ErrorAction SilentlyContinue
                }
            }
            
            if ($null -eq $cimsession.id) {
                Stop-Function -Message "Can't create CimSession on $computer." -Target $Computer
            }
            
            Write-Message -Level Verbose -Message "Getting Power Plan information from $Computer."
            
            try {
                $powerplans = Get-CimInstance -CimSession $cimsession -classname Win32_PowerPlan -Namespace "root\cimv2\power" -ErrorAction Stop | Select-Object ElementName, InstanceID, IsActive
            }
            catch {
                if ($_.Exception -match "namespace") {
                    Stop-Function -Message "Can't get Power Plan Info for $Computer. Unsupported operating system." -Continue -InnerErrorRecord $_ -Target $Computer
                }
                else {
                    Stop-Function -Message "Can't get Power Plan Info for $Computer. Check logs for more details." -Continue -InnerErrorRecord $_ -Target $Computer
                }
            }
            
            $powerplan = $powerplans | Where-Object { $_.IsActive -eq 'True' } | Select-Object ElementName, InstanceID
            $powerplan.InstanceID = $powerplan.InstanceID.Split('{')[1].Split('}')[0]
            
            if ($CustomPowerPlan.Length -gt 0) {
                $bpPowerPlan.ElementName = $CustomPowerPlan
                $bpPowerPlan.InstanceID = $($powerplans | Where-Object { $_.ElementName -eq $CustomPowerPlan }).InstanceID
            }
            else {
                $bpPowerPlan.ElementName = $($powerplans | Where-Object { $_.InstanceID.Split('{')[1].Split('}')[0] -eq $bpPowerPlan.InstanceID }).ElementName
                if ($null -eq $bpPowerplan.ElementName) {
                    $bpPowerPlan.ElementName = "You do not have the high performance plan installed on this machine."
                }
            }
            
            Write-Message -Level Verbose -Message "Recommended GUID is $($bpPowerPlan.InstanceID) and you have $($powerplan.InstanceID)."
            
            if ($null -eq $powerplan.InstanceID) {
                $powerplan.ElementName = "Unknown"
            }
            
            if ($powerplan.InstanceID -eq $bpPowerPlan.InstanceID) {
                $IsBestPractice = $true
            }
            else {
                $IsBestPractice = $false
            }
            
            [PSCustomObject]@{
                Server               = $computer
                ActivePowerPlan      = $powerplan.ElementName
                RecommendedPowerPlan = $bpPowerPlan.ElementName
                IsBestPractice       = $IsBestPractice
            }
        }
    }
}