functions/Test-SqlConnection.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
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
Function Test-SqlConnection
{
<#
.SYNOPSIS
Exported function. Tests a the connection to a single instance and shows the output.
 
.DESCRIPTION
Tests a the connection to a single instance and shows the output.
 
.PARAMETER SqlServer
The SQL Server Instance to test connection against
 
.PARAMETER SqlCredential
Allows you to login to servers using SQL Logins as opposed to Windows Auth/Integrated/Trusted. To use:
   
$scred = Get-Credential, then pass $scred object to the -SqlCredential parameter.
  
Windows Authentication will be used if SqlCredential is not specified. SQL Server does not accept Windows credentials being passed as credentials. To connect as a different Windows user, run PowerShell as that user.
 
 
.EXAMPLE
Test-SqlConnection sql01
 
Sample output:
 
Local PowerShell Enviornment
 
Windows : 10.0.10240.0
PowerShell : 5.0.10240.16384
CLR : 4.0.30319.42000
SMO : 13.0.0.0
DomainUser : True
RunAsAdmin : False
 
SQL Server Connection Information
 
ServerName : sql01
BaseName : sql01
InstanceName : (Default)
AuthType : Windows Authentication (Trusted)
ConnectingAsUser : ad\dba
ConnectSuccess : True
SqlServerVersion : 12.0.2370
AddlConnectInfo : N/A
RemoteServer : True
IPAddress : 10.0.1.4
NetBIOSname : SQLSERVER2014A
RemotingAccessible : True
Pingable : True
DefaultSQLPortOpen : True
RemotingPortOpen : True
 
 
.NOTES
Tags: CIM
Original Author: Chrissy LeMaire
dbatools PowerShell module (https://dbatools.io, clemaire@gmail.com)
Copyright (C) 2016 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/>.
 
#>

[CmdletBinding()]
param (
[Parameter(Mandatory = $true)]
[Alias("ServerInstance", "SqlInstance")]
[object]$SqlServer,
[System.Management.Automation.PSCredential]$SqlCredential
)


# Get local enviornment
Write-Output "Getting local enivornment information"
$localinfo = @{ } | Select-Object Windows, PowerShell, CLR, SMO, DomainUser, RunAsAdmin
$localinfo.Windows = [environment]::OSVersion.Version.ToString()
$localinfo.PowerShell = $PSVersionTable.PSversion.ToString()
$localinfo.CLR = $PSVersionTable.CLRVersion.ToString()
$smo = (([AppDomain]::CurrentDomain.GetAssemblies() | Where-Object { $_.Fullname -like "Microsoft.SqlServer.SMO,*" }).FullName -Split ", ")[1]
$localinfo.SMO = $smo.TrimStart("Version=")
$localinfo.DomainUser = $env:computername -ne $env:USERDOMAIN
$localinfo.RunAsAdmin = ([Security.Principal.WindowsPrincipal][Security.Principal.WindowsIdentity]::GetCurrent()).IsInRole([Security.Principal.WindowsBuiltInRole] "Administrator")

# SQL Server
if ($SqlServer.GetType() -eq [Microsoft.SqlServer.Management.Smo.Server]) { $SqlServer = $SqlServer.Name.ToString() }

$serverinfo = @{ } | Select-Object ServerName, BaseName, InstanceName, AuthType, ConnectingAsUser, ConnectSuccess, SqlServerVersion, AddlConnectInfo, RemoteServer, IPAddress, NetBIOSname, RemotingAccessible, Pingable, DefaultSQLPortOpen, RemotingPortOpen

$serverinfo.ServerName = $sqlserver

[regex]$portdetection = ":\d{1,5}$"
if ($sqlserver.LastIndexOf(":") -ne -1)
{
$portnumber = $sqlserver.substring($sqlserver.LastIndexOf(":"))
if ($portnumber -match $portdetection)
{
$replacedportseparator = $portnumber -replace ":", ","
$sqlserver = $sqlserver -replace $portnumber, $replacedportseparator
}
}

Write-Output "Determining SQL Server base address"
$baseaddress = $sqlserver.Split(",")[0]
$baseaddress = $baseaddress.Split("\")[0]
try { $instance = $sqlserver.Split("\")[1] }
catch { $instance = "(Default)" }
if ([string]::IsNullOrEmpty($instance)) { $instance = "(Default)" }

if ($baseaddress -eq "." -or $baseaddress -eq $env:COMPUTERNAME)
{
$ipaddr = "."
$hostname = $env:COMPUTERNAME
$baseaddress = $env:COMPUTERNAME
}

$serverinfo.BaseName = $baseaddress
$remote = $baseaddress -ne $env:COMPUTERNAME
$serverinfo.InstanceName = $instance
$serverinfo.RemoteServer = $remote

Write-Output "Resolving IP address"
try
{
$hostentry = [System.Net.Dns]::GetHostEntry($baseaddress)
$ipaddr = ($hostentry.AddressList | Where-Object { $_ -notlike '169.*' } | Select-Object -First 1).IPAddressToString
}
catch { $ipaddr = "Unable to resolve" }

$serverinfo.IPAddress = $ipaddr

Write-Output "Resolving NetBIOS name"
try
{
$sessionoptions = New-CimSessionOption -Protocol DCOM
$CIMsession = New-CimSession -ComputerName $ipaddr -SessionOption $sessionoption -ErrorAction SilentlyContinue -Credential $SqlCredential
$hostname = (Get-CimInstance -CimSession $CIMsession -ClassName Win32_NetworkAdapterConfiguration -Filter "IPEnabled=TRUE").PSComputerName

if ([string]::IsNullOrEmpty($hostname)) { $hostname = (nbtstat -A $ipaddr | Where-Object { $_ -match '\<00\> UNIQUE' } | ForEach-Object { $_.SubString(4, 14) }).Trim() }
}
catch { $hostname = "Unknown" }

$serverinfo.NetBIOSname = $hostname


if ($remote -eq $true)
{
# Test for WinRM #Test-WinRM neh
Write-Output "Checking remote acccess"
winrm id -r:$hostname 2>$null | Out-Null
if ($LastExitCode -eq 0) { $remoting = $true }
else { $remoting = $false }

$serverinfo.RemotingAccessible = $remoting

Write-Output "Testing raw socket connection to PowerShell remoting port"
$tcp = New-Object System.Net.Sockets.TcpClient
try
{
$tcp.Connect($baseaddress, 135)
$tcp.Close()
$tcp.Dispose()
$remotingport = $true
}
catch { $remotingport = $false }

$serverinfo.RemotingPortOpen = $remotingport
}

# Test Connection first using Test-Connection which requires ICMP access then failback to tcp if pings are blocked
Write-Output "Testing ping to $baseaddress"
$testconnect = Test-Connection -ComputerName $baseaddress -Count 1 -Quiet

$serverinfo.Pingable = $testconnect

# SQL Server connection

if ($instance -eq "(Default)")
{
Write-Output "Testing raw socket connection to default SQL port"
$tcp = New-Object System.Net.Sockets.TcpClient
try
{
$tcp.Connect($baseaddress, 1433)
$tcp.Close()
$tcp.Dispose()
$sqlport = $true
}
catch { $sqlport = $false }
$serverinfo.DefaultSQLPortOpen = $sqlport
}
else { $serverinfo.DefaultSQLPortOpen = "N/A" }

$server = New-Object Microsoft.SqlServer.Management.Smo.Server $SqlServer

try
{
if ($SqlCredential -ne $null)
{
$username = ($SqlCredential.username).TrimStart("\")

if ($username -like "*\*")
{
$username = $username.Split("\")[1]
$authtype = "Windows Authentication with Credential"
$server.ConnectionContext.LoginSecure = $true
$server.ConnectionContext.ConnectAsUser = $true
$server.ConnectionContext.ConnectAsUserName = $username
$server.ConnectionContext.ConnectAsUserPassword = ($SqlCredential).GetNetworkCredential().Password
}
else
{
$authtype = "SQL Authentication"
$server.ConnectionContext.LoginSecure = $false
$server.ConnectionContext.set_Login($username)
$server.ConnectionContext.set_SecurePassword($SqlCredential.Password)
}
}
else
{
$authtype = "Windows Authentication (Trusted)"
$username = "$env:USERDOMAIN\$env:username"
}
}
catch
{
Write-Exception $_
$authtype = "Windows Authentication (Trusted)"
$username = "$env:USERDOMAIN\$env:username"
}

$serverinfo.ConnectingAsUser = $username
$serverinfo.AuthType = $authtype


Write-Output "Attempting to connect to $SqlServer as $username "
try
{
$server.ConnectionContext.ConnectTimeout = 10
$server.ConnectionContext.Connect()
$connectSuccess = $true
$version = $server.Version.ToString()
$addlinfo = "N/A"
$server.ConnectionContext.Disconnect()
}
catch
{
$connectSuccess = $false
$version = "N/A"
$addlinfo = $_.Exception
}

$serverinfo.ConnectSuccess = $connectSuccess
$serverinfo.SqlServerVersion = $version
$serverinfo.AddlConnectInfo = $addlinfo

Write-Output "`nLocal PowerShell Enviornment"
$localinfo | Select-Object Windows, PowerShell, CLR, SMO, DomainUser, RunAsAdmin

Write-Output "SQL Server Connection Information`n"
$serverinfo | Select-Object ServerName, BaseName, InstanceName, AuthType, ConnectingAsUser, ConnectSuccess, SqlServerVersion, AddlConnectInfo, RemoteServer, IPAddress, NetBIOSname, RemotingAccessible, Pingable, DefaultSQLPortOpen, RemotingPortOpen

}