Remove-DbaLinkedServer

Want to see the source code for this command? Check out Remove-DbaLinkedServer on GitHub.
Want to see the Bill Of Health for this command? Check out Remove-DbaLinkedServer.

Synopsis

Removes a linked server.

Description

Removes a linked server.

Syntax

Remove-DbaLinkedServer
    [[-SqlInstance] <DbaInstanceParameter[]>]
    [[-SqlCredential] <PSCredential>]
    [[-LinkedServer] <String[]>]
    [[-InputObject] <Object[]>]
    [-Force]
    [-EnableException]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Examples

Example: 1

PS C:\> Remove-DbaLinkedServer -SqlInstance sql01 -LinkedServer linkedServer1 -Confirm:$false

Removes the linked server "linkedServer1" from the sql01 instance.

Example: 2

PS C:\> Remove-DbaLinkedServer -SqlInstance sql01 -LinkedServer linkedServer1 -Confirm:$false -Force

Removes the linked server "linkedServer1" and the associated linked server logins from the sql01 instance.

Example: 3

PS C:\> $linkedServer1 = Get-DbaLinkedServer -SqlInstance sql01 -LinkedServer linkedServer1
PS C:\> $linkedServer1 | Remove-DbaLinkedServer -Confirm:$false

Passes in a linked server via pipeline and removes it from the sql01 instance.

Example: 4

PS C:\> Connect-DbaInstance -SqlInstance sql01 | Remove-DbaLinkedServer -LinkedServer linkedServer1 -Confirm:$false

Removes the linked server "linkedServer1" from the sql01 instance, which is passed in via pipeline.

Optional Parameters

-SqlInstance

The target SQL Server instance or instances. This can be a collection and receive pipeline input to allow the function to be executed against multiple SQL Server instances.

-SqlCredential

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.

-LinkedServer

The name(s) of the linked server(s).

-InputObject

Allows piping from Connect-DbaInstance and Get-DbaLinkedServer.

-Force

Drops the linked server login(s) associated with the linked server and then drops the linked server.

-EnableException

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.

-WhatIf

Shows what would happen if the command were to run. No actions are actually performed.

-Confirm

Prompts you for confirmation before executing any changing operations within the command.