| 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.
Modifies the port number for Availability Group listeners on SQL Server instances.
Modifies the port number for Availability Group listeners, allowing you to change the network port that clients use to connect to the availability group. This is commonly needed when standardizing ports across environments, resolving port conflicts with other services, or implementing security policies that require non-default ports. The command works with existing listeners and requires the availability group to be online to complete the port change.
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 new port number for the availability group listener. This is the TCP port clients will use to connect to the availability group.
Commonly changed to standardize ports across environments, resolve conflicts with other services, or meet security requirements.
| 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 |
Specifies the name of the availability group containing the listener to modify. Required when using SqlInstance parameter.
Use this to target specific availability groups when multiple groups exist on the same instance.
| Alias | |
| Required | False |
| Pipeline | false |
| Default Value |
Specifies the name of specific listeners to modify within the availability group. Optional parameter to target only certain listeners.
Use this when an availability group has multiple listeners and you only want to change the port for specific ones.
| Alias | |
| Required | False |
| Pipeline | false |
| Default Value |
Accepts availability group listener objects from the pipeline, typically from Get-DbaAgListener. Allows you to chain commands together.
Use this approach when you want to filter or select specific listeners before modifying their ports.
| 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 |