functions/Get-DbaLinkedServer.ps1

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
function Get-DbaLinkedServer {
    <#
  .SYNOPSIS
   Gets all linked servers and summary of information from the sql servers listed
 
  .DESCRIPTION
   Retrieves information about each linked server on the instance
 
  .PARAMETER SqlInstance
   SQL Server name or SMO object representing the SQL Server to connect to. This can be a collection and receive pipeline input to allow the function
   to be executed against multiple SQL Server instances.
 
  .PARAMETER SqlCredential
   SqlCredential object to connect as. If not specified, current Windows login will be used.
   
  .PARAMETER LinkedServer
   The linked server(s) to process - this list is auto-populated from the server. If unspecified, all linked servers will be processed.
 
  .PARAMETER ExcludeLinkedServer
   The linked server(s) to exclude - this list is auto-populated from the server
  
  .PARAMETER Silent
   Use this switch to disable any kind of verbose messages
 
  .NOTES
   Author: Stephen Bennett ( https://sqlnotesfromtheunderground.wordpress.com/ )
 
   Website: https://dbatools.io
   Copyright: (C) Chrissy LeMaire, clemaire@gmail.com
   License: GNU GPL v3 https://opensource.org/licenses/GPL-3.0
 
  .LINK
   https://dbatools.io/Get-DbaLinkedServer
 
  .EXAMPLE
   Get-DbaLinkedServer -SqlInstance DEV01
 
   Returns all Linked Servers for the SQL Server instance DEV01
 #>

    [CmdletBinding(DefaultParameterSetName = 'Default')]
    param (
        [Parameter(Mandatory, ValueFromPipeline)]
        [Alias("ServerInstance", "SqlServer")]
        [DbaInstanceParameter[]]$SqlInstance,
        [PSCredential]$SqlCredential,
        [object[]]$LinkedServer,
        [object[]]$ExcludeLinkedServer,
        [switch]$Silent
    )
    foreach ($Instance in $SqlInstance) {
        try {
            Write-Message -Level Verbose -Message "Connecting to $instance"
            $server = Connect-SqlInstance -SqlInstance $instance -SqlCredential $sqlcredential
        }
        catch {
            Stop-Function -Message "Failure" -Category ConnectionError -ErrorRecord $_ -Target $instance -Continue
        }

        $lservers = $server.LinkedServers

        if ($LinkedServer) {
            $lservers = $lservers | Where-Object { $_.Name -in $LinkedServer }
        }
        if ($ExcludeLinkedServer) {
            $lservers = $lservers | Where-Object { $_.Name -notin $ExcludeLinkedServer }
        }
        
        foreach ($ls in $lservers) {
            Add-Member -Force -InputObject $ls -MemberType NoteProperty -Name ComputerName -value $server.NetName
            Add-Member -Force -InputObject $ls -MemberType NoteProperty -Name InstanceName -value $server.ServiceName
            Add-Member -Force -InputObject $ls -MemberType NoteProperty -Name SqlInstance -value $server.DomainInstanceName
            Add-Member -Force -InputObject $ls -MemberType NoteProperty -Name Impersonate -value $ls.LinkedServerLogins.Impersonate
            Add-Member -Force -InputObject $ls -MemberType NoteProperty -Name RemoteUser -value $ls.LinkedServerLogins.RemoteUser

            Select-DefaultView -InputObject $ls -Property ComputerName, InstanceName, SqlInstance, Name, 'DataSource as RemoteServer', ProductName, Impersonate, RemoteUser, 'DistPublisher as Publisher', Distributor, DateLastModified
        }
    }
}