#PSTip Retrieve all SQL instance names on local and remote computers

I was looking at way to retrieve the SQL instance names on a remote computer without using SQL SMO. This is essential for me as I don’t always expect to have the SQL SMO DLLs on the computer where I run my scripts.

We can certainly use the Windows Registry to find this information. If the remote system has a SQL service running, the SQL instance information is stored under HKLM\SOFTWARE\Microsoft\Microsoft SQL Server\Instance Names\SQL key. We can use the remote Registry service to query for this information from remote systems. So, having remote Registry service enabled on the target systems is essential for the following script to work.

Function Get-SQLInstance {

    param (
        [string]$ComputerName = $env:COMPUTERNAME,
        [string]$InstanceName
    )

    try {
        $reg = [Microsoft.Win32.RegistryKey]::OpenRemoteBaseKey('LocalMachine', $ComputerName)
        $regKey= $reg.OpenSubKey("SOFTWARE\\Microsoft\\Microsoft SQL Server\\Instance Names\\SQL" )
        $instances = $regkey.GetValueNames()

        if ($InstanceName) {
            if ($instances -contains $InstanceName) {
                return $true
            } else {
                return $false
            }
        } else {
            $instances
        }
    }
    catch {
        Write-Error $_.Exception.Message
        return $false
    }
}

You can use the above function as follows:

PS C:\> Get-SQLInstance
MSSQLSERVER

PS C:\> Get-SQLInstance -ComputerName SQL1
MSSQLSERVER
MIRRORInstance

PS C:\> Get-SQLInstance -ComputerName SQL1 -InstanceName SQLServer
False

About the author: Ravikanth C

Ravikanth is the founder and editor of the PowerShell Magazine. He is also a PowerShell MVP who works at Dell Inc. He blogs at http://www.ravichaganti.com/blog and you can follow him on Twitter @ravikanth.

Related Posts

%d bloggers like this: