functions/Set-DbaMaxMemory.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
Function Set-DbaMaxMemory
{
    <#
        .SYNOPSIS
            Sets SQL Server 'Max Server Memory' configuration setting to a new value then displays information this setting.
 
        .DESCRIPTION
            Sets SQL Server max memory then displays information relating to SQL Server Max Memory configuration settings.
 
            Inspired by Jonathan Kehayias's post about SQL Server Max memory (http://bit.ly/sqlmemcalc), this uses a formula to
            determine the default optimum RAM to use, then sets the SQL max value to that number.
 
            Jonathan notes that the formula used provides a *general recommendation* that doesn't account for everything that may
            be going on in your specific environment.
 
        .PARAMETER SqlServer
            Allows you to specify a comma separated list of servers to query.
 
        .PARAMETER MaxMb
            Specifies the max megabytes
 
        .PARAMETER SqlCredential
            Allows you to login to servers using SQL Logins as opposed to Windows Auth/Integrated/Trusted. To use:
           
            $scred = Get-Credential, then pass $scred object to the -SqlCredential parameter.
          
            Windows Authentication will be used if SqlCredential is not specified. SQL Server does not accept Windows credentials
         being passed as credentials. To connect as a different Windows user, run PowerShell as that user.
 
        .PARAMETER Collection
            Results of Get-DbaMaxMemory to be passed into the command
     
        .PARAMETER Silent
            Replaces user friendly yellow warnings with bloody red exceptions of doom!
            Use this if you want the function to throw terminating errors you want to catch.
     
        .PARAMETER WhatIf
            Shows what would happen if the cmdlet runs. The cmdlet is not run.
     
        .PARAMETER Confirm
            Prompts you for confirmation before running the cmdlet.
 
        .EXAMPLE
            Set-DbaMaxMemory sqlserver1
 
            Set max memory to the recommended MB on just one server named "sqlserver1"
 
        .EXAMPLE
            Set-DbaMaxMemory -SqlServer sqlserver1 -MaxMb 2048
 
            Explicitly max memory to 2048 MB on just one server, "sqlserver1"
 
        .EXAMPLE
            Get-SqlRegisteredServerName -SqlServer sqlserver| Test-DbaMaxMemory | Where-Object { $_.SqlMaxMB -gt $_.TotalMB } | Set-DbaMaxMemory
 
            Find all servers in SQL Server Central Management server that have Max SQL memory set to higher than the total memory
            of the server (think 2147483647), then pipe those to Set-DbaMaxMemory and use the default recommendation.
 
        .NOTES
            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-DbaMaxMemory
    #>

    [CmdletBinding(SupportsShouldProcess = $true, ConfirmImpact = 'Medium')]
    Param (
        [Parameter(Position = 0)]
        [Alias("ServerInstance", "SqlInstance", "SqlServers", 'ComputerName')]
        [object]
        $SqlServer,
        
        [Parameter(Position = 1)]
        [int]
        $MaxMb,
        
        [Parameter(ValueFromPipeline = $True)]
        [object]
        $Collection,
        
        [Alias('Credential')]
        [System.Management.Automation.PSCredential]
        $SqlCredential,
        
        [switch]
        $Silent
    )
    Process
    {
        if ($SqlServer.length -eq 0 -and $collection -eq $null)
        {
            Stop-Function -Silent $Silent -Category InvalidArgument -Message "You must specify a server list source using -SqlServer or you can pipe results from Test-DbaMaxMemory"
            return
        }
        
        if ($MaxMB -eq 0)
        {
            $UseRecommended = $true
        }
        
        if ($Collection -eq $null)
        {
            $Collection = Test-DbaMaxMemory -SqlServer $SqlServer -SqlCredential $SqlCredential
        }
        
        # We ignore errors, because this will error if we pass the same collection items twice.
        # Given that it is an engine internal command, there is no other plausible error it could encounter.
        $Collection | Add-Member -NotePropertyName OldMaxValue -NotePropertyValue 0 -ErrorAction Ignore
        
        foreach ($row in $Collection)
        {
            if ($row.server -eq $null)
            {
                $row = Test-DbaMaxMemory -sqlserver $row
                $row | Add-Member -NotePropertyName OldMaxValue -NotePropertyValue 0
            }
            
            Write-Verbose "Attempting to connect to $($row.server)"
            
            try
            {
                $server = Connect-SqlServer -SqlServer $row.server -SqlCredential $SqlCredential -ErrorAction Stop
            }
            catch
            {
                Stop-Function -Message "Can't connect to $($row.server) or access denied. Skipping." -Silent $Silent -Category ConnectionError -InnerErrorRecord $_ -Target $row -Continue
            }
            
            if (!(Test-SqlSa -SqlServer $server))
            {
                Stop-Function -Message "Not a sysadmin on $($row.server). Skipping." -Silent $Silent -Category PermissionDenied -InnerErrorRecord $_ -Target $row -Continue
            }
            
            $row.OldMaxValue = $row.SqlMaxMB
            
            try
            {
                if ($UseRecommended)
                {
                    Write-Verbose "Changing $($row.server) SQL Server max from $($row.SqlMaxMB) to $($row.RecommendedMB) MB"
                    
                    if ($row.RecommendedMB -eq 0 -or $row.RecommendedMB -eq $null)
                    {
                        $maxmem = (Test-DbaMaxMemory -SqlServer $server).RecommendedMB
                        Write-Warning $maxmem
                        $server.Configuration.MaxServerMemory.ConfigValue = $maxmem
                    }
                    else
                    {
                        
                        $server.Configuration.MaxServerMemory.ConfigValue = $row.RecommendedMB
                    }
                }
                else
                {
                    Write-Verbose "Changing $($row.server) SQL Server max from $($row.SqlMaxMB) to $MaxMB MB"
                    $server.Configuration.MaxServerMemory.ConfigValue = $MaxMB
                }
                if ($PSCmdlet.ShouldProcess($row.Server, "Changing maximum memory from $($row.OldMaxValue) to $($server.Configuration.MaxServerMemory.ConfigValue)"))
                {
                    try
                    {
                        $server.Configuration.Alter()
                        $row.SqlMaxMB = $server.Configuration.MaxServerMemory.ConfigValue
                    }
                    catch
                    {
                        Stop-Function -Message "Failed to apply configuration change for $($row.Server): $($_.Exception.Message)" -Silent $Silent -InnerErrorRecord $_ -Target $row -Continue
                    }
                }
            }
            catch
            {
                Stop-Function -Message "Could not modify Max Server Memory for $($row.server): $($_.Exception.Message)" -Silent $Silent -InnerErrorRecord $_ -Target $row -Continue
            }
            
            $row | Select-Object Server, TotalMB, OldMaxValue, @{ name = "CurrentMaxValue"; expression = { $_.SqlMaxMB } }
        }
    }
}