Get-DbaInstanceProtocol

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

Synopsis

Gets the SQL Server related server protocols on a computer.

Description

Gets the SQL Server related server protocols on one or more computers.

Requires Local Admin rights on destination computer(s). The server protocols can be enabled and disabled when retrieved via WSMan.

Syntax

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

Examples

Example: 1

PS C:\> Get-DbaInstanceProtocol -ComputerName sqlserver2014a

Gets the SQL Server related server protocols on computer sqlserver2014a.

Example: 2

PS C:\> 'sql1','sql2','sql3' | Get-DbaInstanceProtocol

Gets the SQL Server related server protocols on computers sql1, sql2 and sql3.

Example: 3

PS C:\> Get-DbaInstanceProtocol -ComputerName sql1,sql2

Gets the SQL Server related server protocols on computers sql1 and sql2.

Example: 4

PS C:\> (Get-DbaInstanceProtocol -ComputerName sql1 | Where-Object { $_.DisplayName -eq 'Named Pipes' }).Disable()

Disables the VIA ServerNetworkProtocol on computer sql1.
If successful, return code 0 is shown.

Optional Parameters

-ComputerName

The target SQL Server instance or instances.

-Credential

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

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