< Back
Get-DbaClientProtocol
Post
NAME Get-DbaClientProtocol
SYNOPSIS
Gets the SQL Server related client protocols on a computer.
SYNTAX
Get-DbaClientProtocol [[-ComputerName] <Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]>]
[[-Credential] <Pscredential>] [-EnableException <Switch>] [<CommonParameters>]
DESCRIPTION
Gets the SQL Server related client protocols on one or more computers.
Requires Local Admin rights on destination computer(s).
The client protocols can be enabled and disabled when retrieved via WSMan.
PARAMETERS
-ComputerName [<Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]>]
The target SQL Server instance or instances.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-Credential [<Pscredential>]
Credential object used to connect to the computer as a different user.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-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
<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: Server, Management
Author: Klaas Vandenberghe (@PowerDBAKlaas)
Website: https://dbatools.io
Copyright: (c) 2018 by dbatools, licensed under MIT
License: MIT https://opensource.org/licenses/MIT
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Get-DbaClientProtocol -ComputerName sqlserver2014a
Gets the SQL Server related client protocols on computer sqlserver2014a.
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>'sql1','sql2','sql3' | Get-DbaClientProtocol
Gets the SQL Server related client protocols on computers sql1, sql2 and sql3.
-------------------------- EXAMPLE 3 --------------------------
PS C:\\>Get-DbaClientProtocol -ComputerName sql1,sql2 | Out-GridView
Gets the SQL Server related client protocols on computers sql1 and sql2, and shows them in a grid view.
-------------------------- EXAMPLE 4 --------------------------
PS C:\\>(Get-DbaClientProtocol -ComputerName sql2 | Where-Object { $_.DisplayName -eq 'Named Pipes' }).Disable()
Disables the VIA ClientNetworkProtocol on computer sql2.
If successful, return code 0 is shown.
RELATED LINKS
https://dbatools.io/Get-DbaClientProtocol
SYNOPSIS
Gets the SQL Server related client protocols on a computer.
SYNTAX
Get-DbaClientProtocol [[-ComputerName] <Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]>]
[[-Credential] <Pscredential>] [-EnableException <Switch>] [<CommonParameters>]
DESCRIPTION
Gets the SQL Server related client protocols on one or more computers.
Requires Local Admin rights on destination computer(s).
The client protocols can be enabled and disabled when retrieved via WSMan.
PARAMETERS
-ComputerName [<Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]>]
The target SQL Server instance or instances.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-Credential [<Pscredential>]
Credential object used to connect to the computer as a different user.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-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
<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: Server, Management
Author: Klaas Vandenberghe (@PowerDBAKlaas)
Website: https://dbatools.io
Copyright: (c) 2018 by dbatools, licensed under MIT
License: MIT https://opensource.org/licenses/MIT
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Get-DbaClientProtocol -ComputerName sqlserver2014a
Gets the SQL Server related client protocols on computer sqlserver2014a.
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>'sql1','sql2','sql3' | Get-DbaClientProtocol
Gets the SQL Server related client protocols on computers sql1, sql2 and sql3.
-------------------------- EXAMPLE 3 --------------------------
PS C:\\>Get-DbaClientProtocol -ComputerName sql1,sql2 | Out-GridView
Gets the SQL Server related client protocols on computers sql1 and sql2, and shows them in a grid view.
-------------------------- EXAMPLE 4 --------------------------
PS C:\\>(Get-DbaClientProtocol -ComputerName sql2 | Where-Object { $_.DisplayName -eq 'Named Pipes' }).Disable()
Disables the VIA ClientNetworkProtocol on computer sql2.
If successful, return code 0 is shown.
RELATED LINKS
https://dbatools.io/Get-DbaClientProtocol