functions/Get-DbaSpConfigure.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
FUNCTION Get-DbaSpConfigure
{
<#
.SYNOPSIS
Returns all server level system configuration (sys.configuration/sp_configure) information
 
.DESCRIPTION
This function returns server level system configuration (sys.configuration/sp_configure) information. The information is gathered through SMO Configuration.Properties.
The data includes the default value for each configuration, for quick identification of values that may have been changed.
 
.PARAMETER SqlServer
SQLServer name or SMO object representing the SQL Server to connect to. This can be a
collection and recieve pipeline input
 
.PARAMETER SqlCredential
PSCredential object to connect as. If not specified, current Windows login will be used.
 
.PARAMETER Configs
Return only specific configurations -- auto-populated from source server
  
.PARAMETER Detailed
Returns more information about the configuration settings than standard
 
.NOTES
Original Author: Nic Cain, https://sirsql.net/
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/>.
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/Get-DbaSpConfigure
 
.EXAMPLE
Get-DbaSpConfigure -SqlServer localhost
Returns server level configuration data on the localhost (ServerName, ConfigName, DisplayName, Description, IsAdvanced, IsDynamic, MinValue, MaxValue, ConfiguredValue, RunningValue, DefaultValue, IsRunningDefaultValue)
 
.EXAMPLE
'localhost','localhost\namedinstance' | Get-DbaSpConfigure
Returns system configuration information on multiple instances piped into the function
 
.EXAMPLE
Get-DbaSpConfigure -SqlServer localhost
Returns server level configuration data on the localhost (ServerName, ConfigName, DisplayName, Description, IsAdvanced, IsDynamic, MinValue, MaxValue, ConfiguredValue, RunningValue, DefaultValue, IsRunningDefaultValue)
 
.EXAMPLE
Get-DbaSpConfigure -SqlServer sql2012 -Configs MaxServerMemory
 
Returns only the system configuration for MaxServerMemory. Configs is autopopulated for tabbing convenience.
 
#>

[CmdletBinding()]
Param (
[parameter(Position = 0, Mandatory = $true, ValueFromPipeline = $True)]
[Alias("ServerInstance", "SqlInstance", "SqlServers")]
[string[]]$SqlServer,
[System.Management.Automation.PSCredential]$SqlCredential
)

DynamicParam { if ($SqlServer) { return (Get-ParamSqlServerConfigs -SqlServer $SqlServer -SqlCredential $SqlCredential) } }

BEGIN
{
$configs = $psboundparameters.Configs
}

PROCESS
{
FOREACH ($instance in $SqlServer)
{
TRY
{
$server = Connect-SqlServer -SqlServer $instance -SqlCredential $sqlcredential
}
CATCH
{
Write-Warning "Failed to connect to: $instance"
continue
}

#Get a list of the configuration property parents, and exlude the Parent, Properties values
$proplist = Get-Member -InputObject $server.Configuration -MemberType Property -Force | Select-Object Name | Where-Object { $_.Name -ne "Parent" -and $_.Name -ne "Properties" }

if ($configs)
{
$proplist = $proplist | Where-Object { $_.Name -in $configs }
}

#Grab the default sp_configure property values from the external function
$defaultConfigs = (Get-SqlDefaultSpConfigure -SqlVersion $server.VersionMajor).psobject.properties;

#Iterate through the properties to get the configuration settings
foreach ($prop in $proplist)
{
$propInfo = $server.Configuration.$($prop.Name)
$defaultConfig = $defaultConfigs | Where-Object { $_.Name -eq $propInfo.DisplayName };

if ($defaultConfig.Value -eq $propInfo.RunValue) { $isDefault = $true }
else { $isDefault = $false }

#Ignores properties that are not valid on this version of SQL
if (!([string]::IsNullOrEmpty($propInfo.RunValue)))
{
# some displaynames were empty
$displayname = $propInfo.DisplayName
if ($displayname.Length -eq 0) { $displayname = $prop.Name }

[pscustomobject]@{
ServerName = $server.Name
ConfigName = $prop.Name
DisplayName = $displayname
Description = $propInfo.Description
IsAdvanced = $propInfo.IsAdvanced
IsDynamic = $propInfo.IsDynamic
MinValue = $propInfo.Minimum
MaxValue = $propInfo.Maximum
ConfiguredValue = $propInfo.ConfigValue
RunningValue = $propInfo.RunValue
DefaultValue = $defaultConfig.Value
IsRunningDefaultValue = $isDefault
}
}
}
}
}
}