< Back
Remove-DbaEndpoint
Post
NAME Remove-DbaEndpoint
SYNOPSIS
Removes endpoints from a SQL Server instance.
SYNTAX
Remove-DbaEndpoint [[-SqlInstance] <Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]>] [[-SqlCredential]
<Pscredential>] [[-EndPoint] <System.String[]>] [-AllEndpoints <Switch>] [[-InputObject]
<Microsoft.SqlServer.Management.Smo.Endpoint[]>] [-EnableException <Switch>] [<CommonParameters>]
DESCRIPTION
Removes endpoints from a SQL Server instance.
PARAMETERS
-AllEndpoints [<Switch>]
Remove all endpoints 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 remove specific endpoints.
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
-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
<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:\\>Remove-DbaEndpoint -SqlInstance sqlserver2012 -AllEndpoints
Removes all endpoints on the sqlserver2014 instance. Prompts for confirmation.
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>Remove-DbaEndpoint -SqlInstance sqlserver2012 -Endpoint endpoint1,endpoint2 -Confirm:$false
Removes the endpoint1 and endpoint2 endpoints. Does not prompt for confirmation.
-------------------------- EXAMPLE 3 --------------------------
PS C:\\>Get-DbaEndpoint -SqlInstance sqlserver2012 -Endpoint endpoint1 | Remove-DbaEndpoint
Removes the endpoints returned from the Get-DbaEndpoint function. Prompts for confirmation.
RELATED LINKS
https://dbatools.io/Remove-DbaEndpoint
SYNOPSIS
Removes endpoints from a SQL Server instance.
SYNTAX
Remove-DbaEndpoint [[-SqlInstance] <Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]>] [[-SqlCredential]
<Pscredential>] [[-EndPoint] <System.String[]>] [-AllEndpoints <Switch>] [[-InputObject]
<Microsoft.SqlServer.Management.Smo.Endpoint[]>] [-EnableException <Switch>] [<CommonParameters>]
DESCRIPTION
Removes endpoints from a SQL Server instance.
PARAMETERS
-AllEndpoints [<Switch>]
Remove all endpoints 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 remove specific endpoints.
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
-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
<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:\\>Remove-DbaEndpoint -SqlInstance sqlserver2012 -AllEndpoints
Removes all endpoints on the sqlserver2014 instance. Prompts for confirmation.
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>Remove-DbaEndpoint -SqlInstance sqlserver2012 -Endpoint endpoint1,endpoint2 -Confirm:$false
Removes the endpoint1 and endpoint2 endpoints. Does not prompt for confirmation.
-------------------------- EXAMPLE 3 --------------------------
PS C:\\>Get-DbaEndpoint -SqlInstance sqlserver2012 -Endpoint endpoint1 | Remove-DbaEndpoint
Removes the endpoints returned from the Get-DbaEndpoint function. Prompts for confirmation.
RELATED LINKS
https://dbatools.io/Remove-DbaEndpoint