Set-SqlAvailabilityGroupListener
Sets the port setting on an availability group listener.
Syntax
Set-SqlAvailabilityGroupListener
[-Port <Int32>]
[[-Path] <String>]
[-Script]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Set-SqlAvailabilityGroupListener
[-Port <Int32>]
[-InputObject] <AvailabilityGroupListener>
[-Script]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Description
The Set-SqlAvailabilityGroupListener cmdlet modifies the port setting on an existing availability group listener. Run this cmdlet on the server instance that hosts the primary replica.
Examples
Example 1: Modify a listener for an availability group
PS C:\> Set-SqlAvailabilityGroupListener -Port 1535 -Path "SQLSERVER:\Sql\PrimaryServer\InstanceName\AvailabilityGroups\MainAG\AvailabilityGroupListeners\MainListener"This command sets the port number for the availability group listener named MainListener to be 1535. This port is used to listen for connections to the listener.
Example 2: Create a script that modifies a listener
PS C:\> Set-SqlAvailabilityGroupListener -Port 1535 -Script -Path "SQLSERVER:\Sql\PrimaryServer\InstanceName\AvailabilityGroups\MainAG\AvailabilityGroupListeners\MainListener"This command generates the Transact-SQL script that sets the port number for the availability group listener named MainListener to 1535. This command does not make that change.
Parameters
-Confirm
Prompts you for confirmation before running the cmdlet.
| Type: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-InputObject
Specifies the listener, as an AvailabilityGroupListener object, that this cmdlet modifies.
| Type: | AvailabilityGroupListener |
| Position: | 2 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Path
Specifies the path of the availability group listener that this cmdlet modifies. If you do not specify this parameter, this cmdlet uses current working location.
| Type: | String |
| Position: | 2 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Port
Specifies the port on which the listener listens for connections. The default port is TCP port 1433.
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Script
Indicates that this cmdlet returns a Transact-SQL script that performs the task that this cmdlet performs.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet is not run.
| Type: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Inputs
Microsoft.SqlServer.Management.Smo.AvailabilityGroupListener