| Author | Chrissy LeMaire (@cl), netnerds.net |
| Availability | Windows, Linux, macOS |
Want to see the source code for this command? Check out Set-DbaAgListener on GitHub.
Want to see the Bill Of Health for this command? Check out Set-DbaAgListener.
Sets a listener property for an availability group on a SQL Server instance.
Sets a listener property for an availability group on a SQL Server instance.
Basically, only the port is settable at this time, so this command updates the listener port.
Set-DbaAgListener
[[-SqlInstance] <DbaInstanceParameter[]>]
[[-SqlCredential] <PSCredential>]
[[-AvailabilityGroup] <String[]>]
[[-Listener] <String[]>]
[-Port] <Int32>
[[-InputObject] <AvailabilityGroupListener[]>]
[-EnableException]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
PS C:\> Set-DbaAgListener -SqlInstance sql2017 -AvailabilityGroup SharePoint -Port 14333
Changes the port for the SharePoint AG Listener on sql2017. Prompts for confirmation.
PS C:\> Get-DbaAgListener -SqlInstance sql2017 | Out-GridView -Passthru | Set-DbaAgListener -Port 1433 -Confirm:$false
Changes the port for selected AG listeners to 1433. Does not prompt for confirmation.
Sets the port number used to communicate with the availability group.
| Alias | |
| Required | True |
| Pipeline | false |
| Default Value | 0 |
The target SQL Server instance or instances. Server version must be SQL Server version 2012 or higher.
| Alias | |
| Required | False |
| Pipeline | false |
| Default Value |
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 |
The Availability Group to which a property will be changed.
| Alias | |
| Required | False |
| Pipeline | false |
| Default Value |
Modify only specific listeners.
| Alias | |
| Required | False |
| Pipeline | false |
| Default Value |
Enables piping from Get-DbaAvailabilityGroup
| Alias | |
| Required | False |
| Pipeline | true (ByValue) |
| Default Value |
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 |
Shows what would happen if the command were to run. No actions are actually performed.
| Alias | wi |
| Required | False |
| Pipeline | false |
| Default Value |
Prompts you for confirmation before executing any changing operations within the command.
| Alias | cf |
| Required | False |
| Pipeline | false |
| Default Value |