Get‑SqlDscServerProtocolName

SYNOPSIS

Returns SQL Server protocol name mappings.

SYNTAX

All (Default)

Get-SqlDscServerProtocolName [-All] [<CommonParameters>]

ByProtocolName

Get-SqlDscServerProtocolName -ProtocolName <String> [<CommonParameters>]

ByDisplayName

Get-SqlDscServerProtocolName -DisplayName <String> [<CommonParameters>]

ByShortName

Get-SqlDscServerProtocolName -ShortName <String> [<CommonParameters>]

DESCRIPTION

Returns SQL Server protocol name mappings including the protocol name, display name, and short name. This command provides standardized protocol naming across different SQL Server management interfaces.

EXAMPLES

EXAMPLE 1

Get-SqlDscServerProtocolName -ProtocolName 'TcpIp'

Returns the protocol name mapping for TCP/IP protocol.

EXAMPLE 2

Get-SqlDscServerProtocolName -DisplayName 'Named Pipes'

Returns the protocol name mapping for Named Pipes protocol using its display name.

EXAMPLE 3

Get-SqlDscServerProtocolName -ShortName 'Sm'

Returns the protocol name mapping for Shared Memory protocol using its short name.

EXAMPLE 4

Get-SqlDscServerProtocolName -All

Returns all available protocol name mappings.

PARAMETERS

-All

Returns all available protocol name mappings.

Type: SwitchParameter
Parameter Sets: All
Aliases:

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

-DisplayName

Specifies the protocol display name as shown in SQL Server Configuration Manager. Valid values are 'TCP/IP', 'Named Pipes', and 'Shared Memory'.

Type: String
Parameter Sets: ByDisplayName
Aliases:

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

-ProtocolName

Specifies the protocol name using the ServerProtocols enumeration. Valid values are 'TcpIp', 'NamedPipes', and 'SharedMemory'.

Type: String
Parameter Sets: ByProtocolName
Aliases:

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

-ShortName

Specifies the short protocol name as used by SMO. Valid values are 'Tcp', 'Np', and 'Sm'.

Type: String
Parameter Sets: ByShortName
Aliases:

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

CommonParameters

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

INPUTS

None.

OUTPUTS

System.Management.Automation.PSCustomObject

Returns a PSCustomObject with the properties Name, DisplayName, and ShortName.

NOTES

This command replaces the deprecated Get-ProtocolNameProperties function.

RELATED LINKS