Get‑SqlDscServerProtocol - dsccommunity/SqlServerDsc GitHub Wiki

Returns server protocol information for a SQL Server instance.

Get-SqlDscServerProtocol [-ServerName <String>] -InstanceName <String> [-ProtocolName <String>]
 [<CommonParameters>]

Get-SqlDscServerProtocol -InstanceName <String> [-ProtocolName <String>]
 -ManagedComputerObject <ManagedComputer> [<CommonParameters>]

Get-SqlDscServerProtocol [-ProtocolName <String>] -ManagedComputerInstanceObject <ServerInstance>
 [<CommonParameters>]

Returns server protocol information for a SQL Server instance using SMO (SQL Server Management Objects). The command supports getting information for TcpIp, NamedPipes, and SharedMemory protocols. If no protocol is specified, all protocols are returned.

Get-SqlDscServerProtocol -InstanceName 'MSSQLSERVER' -ProtocolName 'TcpIp'

Returns TcpIp protocol information for the default SQL Server instance on the local computer.

Get-SqlDscServerProtocol -ServerName 'MyServer' -InstanceName 'MyInstance' -ProtocolName 'NamedPipes'

Returns NamedPipes protocol information for the MyInstance SQL Server instance on the MyServer computer.

Get-SqlDscServerProtocol -InstanceName 'MSSQLSERVER'

Returns all protocol information for the default SQL Server instance on the local computer.

Get-SqlDscManagedComputer -ServerName 'MyServer' | Get-SqlDscServerProtocol -InstanceName 'MyInstance'

Uses pipeline input from Get-SqlDscManagedComputer to retrieve all protocols for the specified instance.

Get-SqlDscManagedComputerInstance -InstanceName 'MyInstance' | Get-SqlDscServerProtocol -ProtocolName 'TcpIp'

Uses pipeline input from Get-SqlDscManagedComputerInstance to retrieve TcpIp protocol information.

Specifies the name of the SQL Server instance for which to return protocol information.

Type: String
Parameter Sets: ByServerName, ByManagedComputerObject
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

Specifies a managed computer instance object from which to retrieve server protocol information. This parameter accepts pipeline input from Get-SqlDscManagedComputerInstance.

Type: ServerInstance
Parameter Sets: ByManagedComputerInstanceObject
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

Specifies a managed computer object from which to retrieve server protocol information. This parameter accepts pipeline input from Get-SqlDscManagedComputer.

Type: ManagedComputer
Parameter Sets: ByManagedComputerObject
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

Specifies the name of the network protocol to return information for. Valid values are 'TcpIp', 'NamedPipes', and 'SharedMemory'. If not specified, all protocols are returned.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

Specifies the name of the server where the SQL Server instance is running. Defaults to the local computer name.

Type: String
Parameter Sets: ByServerName
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.