commands

^

Get-DbaAgListener

Author Viorel Ciucu (@viorelciucu)
Availability Windows, Linux, macOS

 

Synopsis

Returns availability group listeners.

Description

Returns availability group listeners.

Syntax

Get-DbaAgListener
    [[-SqlInstance] <DbaInstanceParameter[]>]
    [[-SqlCredential] <PSCredential>]
    [[-AvailabilityGroup] <String[]>]
    [[-Listener] <String[]>]
    [[-InputObject] <AvailabilityGroup[]>]
    [-EnableException]
    [<CommonParameters>]

 

Examples

 

Example: 1
PS C:\> Get-DbaAgListener -SqlInstance sql2017a

Returns all listeners found on sql2017a

Example: 2
PS C:\> Get-DbaAgListener -SqlInstance sql2017a -AvailabilityGroup AG-a

Returns all listeners found on sql2017a on sql2017a for the availability group AG-a

Example: 3
PS C:\> Get-DbaAvailabilityGroup -SqlInstance sql2017a -AvailabilityGroup OPP | Get-DbaAgListener

Returns all listeners found on sql2017a on sql2017a for the availability group OPP

Optional Parameters

-SqlInstance

The target SQL Server instance or instances. Server version must be SQL Server version 2012 or higher.

Alias
Required False
Pipeline false
Default Value
-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.

Alias
Required False
Pipeline false
Default Value
-AvailabilityGroup

Specify the availability groups to query.

Alias
Required False
Pipeline false
Default Value
-Listener

Return only specific listeners.

Alias
Required False
Pipeline false
Default Value
-InputObject

Enables piped input from Get-DbaAvailabilityGroup.

Alias
Required False
Pipeline true (ByValue)
Default Value
-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.

Alias
Required False
Pipeline false
Default Value False

 

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