< Back
Test-DbaConnectionAuthScheme
Post
NAME Test-DbaConnectionAuthScheme
SYNOPSIS
Returns the transport protocol and authentication scheme of the connection. This is useful to determine if your
connection is using Kerberos.
SYNTAX
Test-DbaConnectionAuthScheme [-SqlInstance] <Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]>
[[-SqlCredential] <Pscredential>] [-Kerberos <Switch>] [-Ntlm <Switch>] [-EnableException <Switch>]
[<CommonParameters>]
DESCRIPTION
By default, this command will return the ConnectName, ServerName, Transport and AuthScheme of the current
connection.
ConnectName is the name you used to connect. ServerName is the name that the SQL Server reports as its
@@SERVERNAME which is used to register its SPN. If you were expecting a Kerberos connection and got NTLM instead,
ensure ConnectName and ServerName match.
If -Kerberos or -Ntlm is specified, the $true/$false results of the test will be returned. Returns $true or $false
by default for one server. Returns Server name and Results for more than one server.
PARAMETERS
-EnableException [<Switch>]
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.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-Kerberos [<Switch>]
If this switch is enabled, checks will be made for Kerberos authentication.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-Ntlm [<Switch>]
If this switch is enabled, checks will be made for NTLM authentication.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-SqlCredential [<Pscredential>]
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.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-SqlInstance [<Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]>]
The target SQL Server instance or instances. Server(s) must be SQL Server 2005 or higher.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
NOTES
Tags: SPN, Kerberos
Author: Chrissy LeMaire (@cl), netnerds.net
Website: https://dbatools.io
Copyright: (c) 2018 by dbatools, licensed under MIT
License: MIT https://opensource.org/licenses/MIT
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Test-DbaConnectionAuthScheme -SqlInstance sqlserver2014a, sql2016
Returns ConnectName, ServerName, Transport and AuthScheme for sqlserver2014a and sql2016.
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>Test-DbaConnectionAuthScheme -SqlInstance sqlserver2014a -Kerberos
Returns $true or $false depending on if the connection is Kerberos or not.
-------------------------- EXAMPLE 3 --------------------------
PS C:\\>Test-DbaConnectionAuthScheme -SqlInstance sqlserver2014a | Select-Object *
Returns the results of "SELECT * from sys.dm_exec_connections WHERE session_id = @@SPID"
RELATED LINKS
https://dbatools.io/Test-DbaConnectionAuthScheme
SYNOPSIS
Returns the transport protocol and authentication scheme of the connection. This is useful to determine if your
connection is using Kerberos.
SYNTAX
Test-DbaConnectionAuthScheme [-SqlInstance] <Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]>
[[-SqlCredential] <Pscredential>] [-Kerberos <Switch>] [-Ntlm <Switch>] [-EnableException <Switch>]
[<CommonParameters>]
DESCRIPTION
By default, this command will return the ConnectName, ServerName, Transport and AuthScheme of the current
connection.
ConnectName is the name you used to connect. ServerName is the name that the SQL Server reports as its
@@SERVERNAME which is used to register its SPN. If you were expecting a Kerberos connection and got NTLM instead,
ensure ConnectName and ServerName match.
If -Kerberos or -Ntlm is specified, the $true/$false results of the test will be returned. Returns $true or $false
by default for one server. Returns Server name and Results for more than one server.
PARAMETERS
-EnableException [<Switch>]
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.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-Kerberos [<Switch>]
If this switch is enabled, checks will be made for Kerberos authentication.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-Ntlm [<Switch>]
If this switch is enabled, checks will be made for NTLM authentication.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-SqlCredential [<Pscredential>]
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.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-SqlInstance [<Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]>]
The target SQL Server instance or instances. Server(s) must be SQL Server 2005 or higher.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
NOTES
Tags: SPN, Kerberos
Author: Chrissy LeMaire (@cl), netnerds.net
Website: https://dbatools.io
Copyright: (c) 2018 by dbatools, licensed under MIT
License: MIT https://opensource.org/licenses/MIT
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Test-DbaConnectionAuthScheme -SqlInstance sqlserver2014a, sql2016
Returns ConnectName, ServerName, Transport and AuthScheme for sqlserver2014a and sql2016.
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>Test-DbaConnectionAuthScheme -SqlInstance sqlserver2014a -Kerberos
Returns $true or $false depending on if the connection is Kerberos or not.
-------------------------- EXAMPLE 3 --------------------------
PS C:\\>Test-DbaConnectionAuthScheme -SqlInstance sqlserver2014a | Select-Object *
Returns the results of "SELECT * from sys.dm_exec_connections WHERE session_id = @@SPID"
RELATED LINKS
https://dbatools.io/Test-DbaConnectionAuthScheme