commands

^

Get-DbaClientProtocol

Author Klaas Vandenberghe (@PowerDBAKlaas)
Availability Windows only

 

Synopsis

Gets the SQL Server related client protocols on a computer.

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.

Syntax

Get-DbaClientProtocol
    [[-ComputerName] <DbaInstanceParameter[]>]
    [[-Credential] <PSCredential>]
    [-EnableException]
    [<CommonParameters>]

 

Examples

 

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.

Optional Parameters

-ComputerName

The target SQL Server instance or instances.

Alias cn,host,Server
Required False
Pipeline true (ByValue)
Default Value $env:COMPUTERNAME
-Credential

Credential object used to connect to the computer as a different user.

Alias
Required False
Pipeline false
Default Value
-EnableException

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.

Alias
Required False
Pipeline false
Default Value False

 

Want to see the source code for this command? Check out Get-DbaClientProtocol on GitHub.
Want to see the Bill Of Health for this command? Check out Get-DbaClientProtocol.