Get-DbaClientAlias

Synopsis

Retrieves SQL Server client aliases from the Windows registry on local or remote computers

Description

Retrieves all configured SQL Server client aliases by reading the Windows registry paths where SQL Server Native Client stores alias definitions. Client aliases allow DBAs to create friendly names that map to actual SQL Server instances, making connection strings simpler and more portable across environments. This is particularly useful when managing multiple instances, non-default ports, or when you need to abstract the actual server names from applications and connection strings.

Syntax

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

Examples

Example: 1

PS C:\> Get-DbaClientAlias

Gets all SQL Server client aliases on the local computer

Example: 2

PS C:\> Get-DbaClientAlias -ComputerName workstationx

Gets all SQL Server client aliases on Workstationx

Example: 3

PS C:\> Get-DbaClientAlias -ComputerName workstationx -Credential ad\sqldba

Logs into workstationx as ad\sqldba then retrieves all SQL Server client aliases on Workstationx

Example: 4

PS C:\> 'Server1', 'Server2' | Get-DbaClientAlias

Gets all SQL Server client aliases on Server1 and Server2

Optional Parameters

-ComputerName

Specifies the computer(s) to retrieve SQL Server client aliases from. Accepts multiple computers via pipeline input.
Use this when you need to audit client alias configurations across multiple workstations or servers in your environment.

-Credential

Allows you to login to remote computers using alternative credentials

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

Outputs

PSCustomObject

Returns one object per SQL Server client alias found in the registry. Each object represents a single alias configured on the specified computer(s).

Properties:

• ComputerName: The name of the computer where the client alias is configured
• NetworkLibrary: The network protocol type for the alias (TCP/IP or Named Pipes)
• ServerName: The target server name or instance (with protocol prefix removed)
• AliasName: The alias name as defined in the registry
• AliasString: The complete registry value including protocol prefix (e.g., DBMSSOCN,servername,1433)
• Architecture: The registry hive architecture where the alias was found (32-bit or 64-bit)