< Back
Set-DbaAgListener
Post
NAME Set-DbaAgListener
SYNOPSIS
Sets a listener property for an availability group on a SQL Server instance.
SYNTAX
Set-DbaAgListener [[-SqlInstance] <Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]>] [[-SqlCredential]
<Pscredential>] [[-AvailabilityGroup] <System.String[]>] [[-Listener] <System.String[]>] [-Port] <Int>
[[-InputObject] <Microsoft.SqlServer.Management.Smo.AvailabilityGroup[]>] [-EnableException <Switch>]
[<CommonParameters>]
DESCRIPTION
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.
PARAMETERS
-AvailabilityGroup [<System.String[]>]
The Availability Group to which a property will be changed.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-EnableException [<Switch>]
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.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-InputObject [<Microsoft.SqlServer.Management.Smo.AvailabilityGroup[]>]
Enables piping from Get-DbaAvailabilityGroup
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-Listener [<System.String[]>]
Modify only specific listeners.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-Port [<Int>]
Sets the port number used to communicate with the availability group.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-SqlCredential [<Pscredential>]
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.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-SqlInstance [<Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]>]
The target SQL Server instance or instances. Server version must be SQL Server version 2012 or higher.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
NOTES
Tags: AvailabilityGroup, HA, AG
Author: Chrissy LeMaire (@cl), netnerds.net
Website: https://dbatools.io
Copyright: (c) 2018 by dbatools, licensed under MIT
License: MIT https://opensource.org/licenses/MIT
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Set-DbaAgListener -SqlInstance sql2017 -AvailabilityGroup SharePoint -Port 14333
Changes the port for the SharePoint AG Listener on sql2017. Prompts for confirmation.
-------------------------- EXAMPLE 2 --------------------------
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.
RELATED LINKS
https://dbatools.io/Set-DbaAgListener
SYNOPSIS
Sets a listener property for an availability group on a SQL Server instance.
SYNTAX
Set-DbaAgListener [[-SqlInstance] <Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]>] [[-SqlCredential]
<Pscredential>] [[-AvailabilityGroup] <System.String[]>] [[-Listener] <System.String[]>] [-Port] <Int>
[[-InputObject] <Microsoft.SqlServer.Management.Smo.AvailabilityGroup[]>] [-EnableException <Switch>]
[<CommonParameters>]
DESCRIPTION
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.
PARAMETERS
-AvailabilityGroup [<System.String[]>]
The Availability Group to which a property will be changed.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-EnableException [<Switch>]
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.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-InputObject [<Microsoft.SqlServer.Management.Smo.AvailabilityGroup[]>]
Enables piping from Get-DbaAvailabilityGroup
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-Listener [<System.String[]>]
Modify only specific listeners.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-Port [<Int>]
Sets the port number used to communicate with the availability group.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-SqlCredential [<Pscredential>]
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.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-SqlInstance [<Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]>]
The target SQL Server instance or instances. Server version must be SQL Server version 2012 or higher.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
NOTES
Tags: AvailabilityGroup, HA, AG
Author: Chrissy LeMaire (@cl), netnerds.net
Website: https://dbatools.io
Copyright: (c) 2018 by dbatools, licensed under MIT
License: MIT https://opensource.org/licenses/MIT
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Set-DbaAgListener -SqlInstance sql2017 -AvailabilityGroup SharePoint -Port 14333
Changes the port for the SharePoint AG Listener on sql2017. Prompts for confirmation.
-------------------------- EXAMPLE 2 --------------------------
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.
RELATED LINKS
https://dbatools.io/Set-DbaAgListener