functions/Get-DbaSpConfigure.ps1
|
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 SqlInstance SQL Server name or SMO object representing the SQL Server to connect to. This can be a collection and receive pipeline input .PARAMETER SqlCredential Login to the target instance using alternative credentials. Windows and SQL Authentication supported. Accepts credential objects (Get-Credential) .PARAMETER Name Return only specific configurations -- auto-populated from source server .PARAMETER EnableException By default, when something goes wrong we try to catch it, interpret it and give you a friendly warning message. This avoids overwhelming you with "sea of red" exceptions, but is inconvenient because it basically disables advanced scripting. Using this switch turns this "nice by default" feature off and enables you to catch exceptions with your own try/catch. .NOTES Tags: SpConfig, Configure, Configuration Author: Nic Cain, https://sirsql.net/ Website: https://dbatools.io Copyright: (C) Chrissy LeMaire, clemaire@gmail.com License: MIT https://opensource.org/licenses/MIT .LINK https://dbatools.io/Get-DbaSpConfigure .EXAMPLE Get-DbaSpConfigure -SqlInstance localhost Returns server level configuration data on the localhost (ServerName, Name, 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 -SqlInstance localhost Returns server level configuration data on the localhost (ServerName, Name, DisplayName, Description, IsAdvanced, IsDynamic, MinValue, MaxValue, ConfiguredValue, RunningValue, DefaultValue, IsRunningDefaultValue) .EXAMPLE Get-DbaSpConfigure -SqlInstance sql2012 -Name MaxServerMemory Returns only the system configuration for MaxServerMemory. Configs is auto-populated for tabbing convenience. #> [CmdletBinding()] Param ( [parameter(Position = 0, Mandatory = $true, ValueFromPipeline = $True)] [Alias("ServerInstance", "SqlServer", "SqlServers")] [DbaInstanceParameter[]]$SqlInstance, [PSCredential]$SqlCredential, [Alias("Config", "ConfigName")] [string[]]$Name, [switch]$EnableException ) process { foreach ($instance in $SqlInstance) { try { $server = Connect-SqlInstance -SqlInstance $instance -SqlCredential $sqlcredential } catch { Write-Warning "Failed to connect to: $instance" continue } #Get a list of the configuration property parents, and exclude 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 ($Name) { $proplist = $proplist | Where-Object { $_.Name -in $Name } } #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 ComputerName = $server.ComputerName InstanceName = $server.ServiceName SqlInstance = $server.DomainInstanceName Name = $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 Parent = $server ConfigName = $prop.Name } | Select-DefaultView -ExcludeProperty ServerName, Parent, ConfigName } } } } } |