commands

^

Get-DbaLinkedServer

Author Stephen Bennett, https://sqlnotesfromtheunderground.wordpress.com/
Availability Windows, Linux, macOS

 

Synopsis

Gets all linked servers and a summary of information from the linked servers listed.

Description

Retrieves information about each linked server on the instance(s).

Syntax

Get-DbaLinkedServer
    [-SqlInstance] <DbaInstanceParameter[]>
    [[-SqlCredential] <PSCredential>]
    [[-LinkedServer] <Object[]>]
    [[-ExcludeLinkedServer] <Object[]>]
    [-EnableException]
    [<CommonParameters>]

 

Examples

 

Example: 1
PS C:\> Get-DbaLinkedServer -SqlInstance DEV01

Returns all linked servers for the SQL Server instance DEV01

Example: 2
PS C:\> Get-DbaRegServer -SqlInstance DEV01 -Group SQLDEV | Get-DbaLinkedServer | Out-GridView

Returns all linked servers for a group of servers from SQL Server Central Management Server (CMS). Send output to GridView.

Required 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.

Alias
Required True
Pipeline true (ByValue)
Default Value

Optional Parameters

-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.

Alias
Required False
Pipeline false
Default Value
-LinkedServer

The linked server(s) to process - this list is auto-populated from the server. If unspecified, all linked servers will be processed.

Alias
Required False
Pipeline false
Default Value
-ExcludeLinkedServer

The linked server(s) to exclude - this list is auto-populated from the server

Alias
Required False
Pipeline false
Default Value
-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.

Alias
Required False
Pipeline false
Default Value False

 

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