#PSTip List all endpoints in a SQL deployment

Note: This tip requires PowerShell 2.0 or above.

When working with SQL Server database mirroring, it is desired to understand how to create and troubleshoot database endpoints. As with many other things, we can use SQL SMO to work with endpoints. In today’s tip, I will show you how to retrieve all database endpoints including the mirroring endpoints.

Add-Type -AssemblyName "Microsoft.SqlServer.Smo, Version=, Culture=neutral, PublicKeyToken=89845dcd8080cc91"
$smo = New-Object Microsoft.SqlServer.Management.Smo.Server -ArgumentList $env:computername

The above code retrieves all endpoints on the local SQL server’s default instance. Now, let us extend the above code to retrieve database endpoints from any SQL Server in the network and from any instance.

Function Get-SQLEndpoint {
    param (

    Begin {
        Write-Verbose "Loading SQL SMO"
        Add-Type -AssemblyName "Microsoft.SqlServer.Smo, Version=, Culture=neutral, PublicKeyToken=89845dcd8080cc91"
        Add-Type -AssemblyName "Microsoft.SqlServer.ConnectionInfo, Version=, Culture=neutral, PublicKeyToken=89845dcd8080cc91"

    Process {

        try {
            $connection = New-Object Microsoft.SqlServer.Management.Common.ServerConnection -ArgumentList $ComputerName
            $connection.applicationName = "PowerShell SQL SMO"

            if ($InstanceName) {
                Write-Verbose "Connecting to SQL named instance"
                $connection.ServerInstance = "${ComputerName}\${InstanceName}"
            } else {
                Write-Verbose "Connecting to default SQL instance"

            $connection.StatementTimeout = 0
            $smo = New-Object Microsoft.SqlServer.Management.Smo.Server -ArgumentList $connection
            $smo.Endpoints | Select Name, EndPointType, ProtocolType, EndpointState, @{Name="ListenerPort";Expression={if ($_.ProtocolType -eq "TCP") {$_.Protocol.TCP.ListenerPort} else {$_.Protocol.HTTP.ListenerPort}}}
        catch {
            Write-Error $_

You can use this function as shown below.

Get-SQLEndpoint -ComputerName "SQL-SERVER-01" -InstanceName "MyInstance"
Get-SQLEndpoint -ComputerName "SQL-SERVER-01" -InstanceName "MyInstance" | Where-Object { $_.EndPointType -eq "DatabaseMirroring" }

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