functions/Enable-DbaHideInstance.ps1
|
function Enable-DbaHideInstance { <# .SYNOPSIS Enables the Hide Instance setting of the SQL Server network configuration. .DESCRIPTION Enables the Hide Instance setting of the SQL Server network configuration. This setting requires access to the Windows Server and not the SQL Server instance. The setting is found in SQL Server Configuration Manager under the properties of SQL Server Network Configuration > Protocols for "InstanceName". .PARAMETER SqlInstance The target SQL Server instance or instances. .PARAMETER Credential Allows you to login to the computer (not SQL Server instance) using alternative Windows credentials .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. .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: HideInstance, Security Author: Gareth Newman (@gazeranco), ifexists.blog Website: https://dbatools.io Copyright: (c) 2019 by dbatools, licensed under MIT License: MIT https://opensource.org/licenses/MIT .EXAMPLE PS C:\> Enable-DbaHideInstance Enables Hide Instance of SQL Engine on the default (MSSQLSERVER) instance on localhost. Requires (and checks for) RunAs admin. .EXAMPLE PS C:\> Enable-DbaHideInstance -SqlInstance sql01\SQL2008R2SP2 Enables Hide Instance of SQL Engine for the SQL2008R2SP2 on sql01. Uses Windows Credentials to both connect and modify the registry. .EXAMPLE PS C:\> Enable-DbaHideInstance -SqlInstance sql01\SQL2008R2SP2 -WhatIf Shows what would happen if the command were executed. #> [CmdletBinding(SupportsShouldProcess, ConfirmImpact = "Low", DefaultParameterSetName = 'Default')] param ( [Parameter(ValueFromPipeline)] [DbaInstanceParameter[]]$SqlInstance = $env:COMPUTERNAME, [PSCredential]$Credential, [switch]$EnableException ) process { foreach ($instance in $sqlinstance) { Write-Message -Level VeryVerbose -Message "Processing $instance." -Target $instance if ($instance.IsLocalHost) { $null = Test-ElevationRequirement -ComputerName $instance -Continue } try { $resolved = Resolve-DbaNetworkName -ComputerName $instance -Credential $Credential -EnableException } catch { try { $resolved = Resolve-DbaNetworkName -ComputerName $instance -Credential $Credential -Turbo -EnableException } catch { Stop-Function -Message "Issue resolving $instance" -Target $instance -Category InvalidArgument -Continue } } try { $sqlwmi = Invoke-ManagedComputerCommand -ComputerName $resolved.FullComputerName -ScriptBlock { $wmi.Services } -Credential $Credential -EnableException | Where-Object DisplayName -eq "SQL Server ($($instance.InstanceName))" } catch { Stop-Function -Message "Failed to access $instance" -Target $instance -Continue -ErrorRecord $_ } $regroot = ($sqlwmi.AdvancedProperties | Where-Object Name -eq REGROOT).Value $vsname = ($sqlwmi.AdvancedProperties | Where-Object Name -eq VSNAME).Value try { $instancename = $sqlwmi.DisplayName.Replace('SQL Server (', '').Replace(')', '') } catch { $null = 1 } $serviceaccount = $sqlwmi.ServiceAccount if ([System.String]::IsNullOrEmpty($regroot)) { $regroot = $sqlwmi.AdvancedProperties | Where-Object { $_ -match 'REGROOT' } $vsname = $sqlwmi.AdvancedProperties | Where-Object { $_ -match 'VSNAME' } if (![System.String]::IsNullOrEmpty($regroot)) { $regroot = ($regroot -Split 'Value\=')[1] $vsname = ($vsname -Split 'Value\=')[1] } else { Stop-Function -Message "Can't find instance $vsname on $instance." -Continue -Category ObjectNotFound -Target $instance } } if ([System.String]::IsNullOrEmpty($vsname)) { $vsname = $instance } Write-Message -Level Verbose -Message "Regroot: $regroot" -Target $instance Write-Message -Level Verbose -Message "ServiceAcct: $serviceaccount" -Target $instance Write-Message -Level Verbose -Message "InstanceName: $instancename" -Target $instance Write-Message -Level Verbose -Message "VSNAME: $vsname" -Target $instance $scriptblock = { $regpath = "Registry::HKEY_LOCAL_MACHINE\$($args[0])\MSSQLServer\SuperSocketNetLib" Set-ItemProperty -Path $regpath -Name HideInstance -Value $true $HideInstance = (Get-ItemProperty -Path $regpath -Name HideInstance).HideInstance [pscustomobject]@{ ComputerName = $env:COMPUTERNAME InstanceName = $args[2] SqlInstance = $args[1] HideInstance = ($HideInstance -eq $true) } } if ($PScmdlet.ShouldProcess("local", "Connecting to $instance to modify the HideInstance value in $regroot for $($instance.InstanceName)")) { try { Invoke-Command2 -ComputerName $resolved.FullComputerName -Credential $Credential -ArgumentList $regroot, $vsname, $instancename -ScriptBlock $scriptblock -ErrorAction Stop | Select-Object -Property * -ExcludeProperty PSComputerName, RunspaceId, PSShowComputerName Write-Message -Level Critical -Message "HideInstance was successfully set on $($resolved.FullComputerName) for the $instancename instance. The change takes effect immediately for new connections." -Target $instance } catch { Stop-Function -Message "Failed to connect to $($resolved.FullComputerName) using PowerShell remoting" -ErrorRecord $_ -Target $instance -Continue } } } } } |