< Back
Set-DbaEndpoint
Post
NAME Set-DbaEndpoint
SYNOPSIS
Sets endpoint properties on a SQL Server instance.
SYNTAX
Set-DbaEndpoint [[-SqlInstance] <Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]>] [[-SqlCredential]
<Pscredential>] [[-EndPoint] <System.String[]>] [[-Owner] <String>] [[-Type] <String>] [-AllEndpoints <Switch>]
[[-InputObject] <Microsoft.SqlServer.Management.Smo.Endpoint[]>] [-EnableException <Switch>] [<CommonParameters>]
DESCRIPTION
Sets endpoint properties on a SQL Server instance.
PARAMETERS
-AllEndpoints [<Switch>]
Set all endpoint properties on an instance.
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
-EndPoint [<System.String[]>]
Only set specific endpoint properties.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-InputObject [<Microsoft.SqlServer.Management.Smo.Endpoint[]>]
Enables piping from Get-Endpoint.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-Owner [<String>]
Change the endpoint owner.
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.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-Type [<String>]
Change the endpoint type. Options: DatabaseMirroring, ServiceBroker, Soap, TSql
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: Endpoint
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-DbaEndpoint -SqlInstance sql2016 -AllEndpoints -Owner sa
Sets all endpoint owners to sa on sql2016
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>Get-DbaEndpoint -SqlInstance sql2016 -Endpoint ep1 | Set-DbaEndpoint -Type TSql
Changes the endpoint type to Tsql on endpoint ep1
RELATED LINKS
https://dbatools.io/Set-DbaEndpoint
SYNOPSIS
Sets endpoint properties on a SQL Server instance.
SYNTAX
Set-DbaEndpoint [[-SqlInstance] <Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]>] [[-SqlCredential]
<Pscredential>] [[-EndPoint] <System.String[]>] [[-Owner] <String>] [[-Type] <String>] [-AllEndpoints <Switch>]
[[-InputObject] <Microsoft.SqlServer.Management.Smo.Endpoint[]>] [-EnableException <Switch>] [<CommonParameters>]
DESCRIPTION
Sets endpoint properties on a SQL Server instance.
PARAMETERS
-AllEndpoints [<Switch>]
Set all endpoint properties on an instance.
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
-EndPoint [<System.String[]>]
Only set specific endpoint properties.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-InputObject [<Microsoft.SqlServer.Management.Smo.Endpoint[]>]
Enables piping from Get-Endpoint.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-Owner [<String>]
Change the endpoint owner.
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.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-Type [<String>]
Change the endpoint type. Options: DatabaseMirroring, ServiceBroker, Soap, TSql
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: Endpoint
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-DbaEndpoint -SqlInstance sql2016 -AllEndpoints -Owner sa
Sets all endpoint owners to sa on sql2016
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>Get-DbaEndpoint -SqlInstance sql2016 -Endpoint ep1 | Set-DbaEndpoint -Type TSql
Changes the endpoint type to Tsql on endpoint ep1
RELATED LINKS
https://dbatools.io/Set-DbaEndpoint