Author | Chrissy LeMaire (@cl), netnerds.net |
Availability | Windows, Linux, macOS |
Want to see the source code for this command? Check out Stop-DbaEndpoint on GitHub.
Want to see the Bill Of Health for this command? Check out Stop-DbaEndpoint.
Stops endpoints on a SQL Server instance.
Stops endpoints on a SQL Server instance.
Stop-DbaEndpoint
[[-SqlInstance] <DbaInstanceParameter[]>]
[[-SqlCredential] <PSCredential>]
[[-Endpoint] <String[]>]
[-AllEndpoints]
[[-InputObject] <Endpoint[]>]
[-EnableException]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
PS C:\> Stop-DbaEndpoint -SqlInstance sql2017a -AllEndpoints
Stops all endpoints on the sqlserver2014 instance.
PS C:\> Stop-DbaEndpoint -SqlInstance sql2017a -Endpoint endpoint1,endpoint2
Stops the endpoint1 and endpoint2 endpoints.
PS C:\> Get-Endpoint -SqlInstance sql2017a -Endpoint endpoint1 | Stop-DbaEndpoint
Stops the endpoints returned from the Get-Endpoint command.
The target SQL Server instance or instances.
Alias | |
Required | False |
Pipeline | false |
Default Value |
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.
Alias | |
Required | False |
Pipeline | false |
Default Value |
Only stop specific endpoints.
Alias | |
Required | False |
Pipeline | false |
Default Value |
Stops all endpoints on an instance.
Alias | |
Required | False |
Pipeline | false |
Default Value | False |
Enables piping from Get-Endpoint.
Alias | |
Required | False |
Pipeline | true (ByValue) |
Default Value |
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.
Alias | |
Required | False |
Pipeline | false |
Default Value | False |
Shows what would happen if the command were to run. No actions are actually performed.
Alias | wi |
Required | False |
Pipeline | false |
Default Value |
Prompts you for confirmation before executing any changing operations within the command.
Alias | cf |
Required | False |
Pipeline | false |
Default Value |