SqlClient

Get-DbaClientAlias

Chrissy LeMaire (@cl), netnerds.net

Get-DbaClientAlias View Source Chrissy LeMaire (@cl), netnerds.net Windows, Linux, macOS 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.

New-DbaClientAlias

Chrissy LeMaire (@cl), netnerds.net

New-DbaClientAlias View Source Chrissy LeMaire (@cl), netnerds.net Windows, Linux, macOS Synopsis Creates SQL Server client aliases in the Windows registry for simplified connection management Description Creates or updates SQL Server client aliases by modifying registry keys in HKLM:\SOFTWARE\Microsoft\MSSQLServer\Client\ConnectTo, replacing the need for manual cliconfg.exe configuration. This allows applications and connections to use simple alias names instead of complex server names, instance names, or custom port numbers. Particularly useful when standardizing connections across multiple workstations, managing port changes, or simplifying named instance connections without modifying application connection strings.

Remove-DbaClientAlias

Chrissy LeMaire (@cl), netnerds.net

Remove-DbaClientAlias View Source Chrissy LeMaire (@cl), netnerds.net Windows, Linux, macOS Synopsis Removes SQL Server client aliases from Windows registry on local or remote computers Description Removes SQL Server client aliases from the Windows registry by deleting entries from both 32-bit and 64-bit registry locations. Client aliases redirect SQL Server connection requests to different servers or instances, but outdated or incorrect aliases can cause connection failures. This function provides a programmatic way to clean up these aliases when the deprecated cliconfg.