Set-SqlAvailabilityGroupListener

SYNOPSIS

Sets the port setting on an availability group listener.

SYNTAX

ByPath (Default)

Set-SqlAvailabilityGroupListener [-Port <Int32>] [[-Path] <String>] [-Script] [-WhatIf] [-Confirm]
 [<CommonParameters>]

ByObject

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

-InputObject

Specifies the listener, as an AvailabilityGroupListener object, that this cmdlet modifies.

Type: AvailabilityGroupListener
Parameter Sets: ByObject
Aliases: 

Required: True
Position: 2
Default value: None
Accept pipeline input: True (ByValue)
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
Parameter Sets: ByPath
Aliases: 

Required: False
Position: 2
Default value: None
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
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: None
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
Parameter Sets: (All)
Aliases: 

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: SwitchParameter
Parameter Sets: (All)
Aliases: cf

Required: False
Position: Named
Default value: 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
Parameter Sets: (All)
Aliases: wi

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).

INPUTS

Microsoft.SqlServer.Management.Smo.AvailabilityGroupListener

OUTPUTS

NOTES

Add-SqlAvailabilityGroupListenerStaticIp

New-SqlAvailabilityGroupListener