functions/Test-DbaLinkedServerConnection.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
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
function Test-DbaLinkedServerConnection
{
<#
.SYNOPSIS
Test all linked servers from the sql servers passed
 
.DESCRIPTION
Test each linked server on the instance
 
.PARAMETER SqlInstance
The SQL Server that you're connecting to.
 
.PARAMETER SqlCredential
Credential object used to connect to the SQL Server as a different user
 
.PARAMETER Silent
Use this switch to disable any kind of verbose messages
  
.NOTES
Author: Thomas LaRock ( https://thomaslarock.com )
  
dbatools PowerShell module (https://dbatools.io)
Copyright (C) 2017 Chrissy LeMaire
This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with this program. If not, see <http://www.gnu.org/licenses/>.
  
.LINK
https://dbatools.io/Test-DbaLinkedServerConnection
 
.EXAMPLE
Test-DbaLinkedServerConnection -SqlInstance DEV01
 
Test all Linked Servers for the SQL Server instance DEV01
 
.EXAMPLE
Test-DbaLinkedServerConnection -SqlInstance sql2016 | Out-File C:\temp\results.txt
 
Test all Linked Servers for the SQL Server instance sql2016 and output results to file
 
.EXAMPLE
Test-DbaLinkedServerConnection -SqlInstance sql2016, sql2014, sql2012
 
Test all Linked Servers for the SQL Server instances sql2016, sql2014 and sql2012
 
.EXAMPLE
$servers = "sql2016","sql2014","sql2012"
$servers | Test-DbaLinkedServerConnection -SqlCredential (Get-Credential sqladmin)
 
Test all Linked Servers for the SQL Server instances sql2016, sql2014 and sql2012 using SQL login credentials
  
.EXAMPLE
$servers | Get-DbaLinkedServer | Test-DbaLinkedServerConnection
 
Test all Linked Servers for the SQL Server instances sql2016, sql2014 and sql2012
 
#>

    [CmdletBinding()]
    param (
        [Parameter(Mandatory, ValueFromPipeline)]
        [Alias("ServerInstance", "SqlServer")]
        [object[]]$SqlInstance,
        [System.Management.Automation.PSCredential]$SqlCredential,
        [switch]$Silent
    )
    
    begin {
        $LinkedServerCollection = @()
    }
    
    process {
        foreach ($Instance in $SqlInstance) {
            
            # This is a very ugly workaround until we finish the dbaserver custom parameter type.
            # Don't judge! ;) - Chrissy
            if ($Instance.GetType().Name -eq 'LinkedServer') {
                $LinkedServerCollection += $Instance
                continue
            }
            
            try {
                Write-Message -Level Verbose -Message "Connecting to $instance"
                $server = Connect-SqlServer -SqlServer $instance -SqlCredential $sqlcredential
            }
            catch {
                Stop-Function -Message "Failed to connect to: $instance" -Continue -Target $instance
            }
            
            $LinkedServerCollection += $server.LinkedServers
        }
    }
    
    end {
        foreach ($ls in $LinkedServerCollection) {
            Write-Message -Level Verbose -Message "Testing linked server $($ls.name) on server $($ls.parent.name)"
            try {
                $null = $ls.TestConnection()
                $result = "Success"
                $connectivity = $true
            }
            catch {
                $result = $_.Exception.InnerException.InnerException.Message
                $connectivity = $false
            }
            
            [PSCustomObject]@{
                ComputerName = $ls.parent.NetName
                InstanceName = $ls.parent.ServiceName
                SqlInstance = $ls.parent.DomainInstanceName
                LinkedServerName = $ls.Name
                RemoteServer = $ls.DataSource
                Connectivity = $connectivity
                Result = $result
            } | Select-DefaultView -ExcludeProperty ComputerName, InstanceName
        }
    }
}