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

    [CmdletBinding()]
    param (
        [Parameter(Mandatory = $true, ValueFromPipeline = $true)]
        [Alias("ServerInstance", "SqlServer")]
        [object[]]$SqlInstance,
        [System.Management.Automation.PSCredential]$SqlCredential
    )
    process
    {
        foreach ($Instance in $SqlInstance)
        {
            try
            {
                Write-Verbose "Connecting to $Instance"
                $server = Connect-SqlServer -SqlServer $Instance -SqlCredential $sqlcredential
            }
            catch
            {
                Write-Warning "Failed to connect to: $Instance"
                continue
            }
            
            foreach ($ls in $server.LinkedServers)
            {
                try
                {
                    $null = $ls.TestConnection()
                    $result = "Success"
                    $connectivity = $true
                }
                catch
                {
                    $result = $_.Exception.InnerException
                    $connectivity = $false
                }
                
                [PSCustomObject]@{
                    ComputerName = $server.NetName
                    InstanceName = $server.ServiceName
                    SqlInstance = $server.DomainInstanceName
                    LinkedServerName = $ls.Name
                    RemoteServer = $ls.DataSource
                    Connectivity = $connectivity
                    Result = $result
                } | Select-DefaultView -ExcludeProperty ComputerName, InstanceName
            }
        }
    }
}