Get-DbaEndpoint

Want to see the source code for this command? Check out Get-DbaEndpoint on GitHub.
Want to see the Bill Of Health for this command? Check out Get-DbaEndpoint.

Synopsis

Returns endpoint objects from a SQL Server instance.

Description

Returns endpoint objects from a SQL Server instance.

Syntax

Get-DbaEndpoint
    [-SqlInstance] <DbaInstanceParameter[]>
    [[-SqlCredential] <PSCredential>]
    [[-Endpoint] <String[]>]
    [[-Type] <String[]>]
    [-EnableException]
    [<CommonParameters>]

Examples

Example: 1

PS C:\> Get-DbaEndpoint -SqlInstance localhost

Returns all endpoints on the local default SQL Server instance

Example: 2

PS C:\> Get-DbaEndpoint -SqlInstance localhost, sql2016

Returns all endpoints for the local and sql2016 SQL Server instances

Required Parameters

-SqlInstance

The target SQL Server instance or instances.

Optional Parameters

-SqlCredential

Login to the target instance using alternative credentials. Accepts PowerShell credentials (Get-Credential).
Windows Authentication, SQL Server Authentication, Active Directory - Password, and Active Directory - Integrated are all supported.
For MFA support, please use Connect-DbaInstance.

-Endpoint

Return only specific endpoints.

-Type

Return only specific types of endpoints. Options include: DatabaseMirroring, ServiceBroker, Soap, and TSql.

-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.