New-DbaClientAlias

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

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.

Syntax

New-DbaClientAlias
    [[-ComputerName] <DbaInstanceParameter[]>]
    [[-Credential] <PSCredential>]
    [-ServerName] <DbaInstanceParameter>
    [-Alias] <String>
    [[-Protocol] <String>]
    [-EnableException]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Examples

Example: 1

PS C:\> New-DbaClientAlias -ServerName sqlcluster\sharepoint -Alias sp

Creates a new TCP alias on the local workstation called sp, which points sqlcluster\sharepoint

Example: 2

PS C:\> New-DbaClientAlias -ServerName 'sqlcluster,14443' -Alias spinstance

Creates a new TCP alias on the local workstation called spinstance, which points to sqlcluster, port 14443.

Example: 3

PS C:\> New-DbaClientAlias -ServerName sqlcluster\sharepoint -Alias sp -Protocol NamedPipes

Creates a new NamedPipes alias on the local workstation called sp, which points sqlcluster\sharepoint

Required Parameters

-ServerName

Specifies the actual SQL Server instance that the alias will point to.
Can include instance names (server\instance) or custom ports (server,1433) for non-standard configurations.
This is the real connection target that applications will reach when using the alias name.

-Alias

Defines the short, friendly name that applications will use to connect to SQL Server.
Choose a simple name that's easier to remember and type than the full server\instance name.
This alias name will appear in connection strings and SQL management tools.

Optional Parameters

-ComputerName

Specifies the target computer(s) where the client alias will be created in the registry.
Use this when configuring aliases on remote workstations or when managing multiple computers centrally.
Defaults to the local computer if not specified.

-Credential

Allows you to login to remote computers using alternative credentials

-Protocol

Sets the network protocol for the connection, either TCPIP or NamedPipes.
TCPIP is recommended for most scenarios and works across network boundaries.
NamedPipes may be preferred for local connections or specific security requirements. Defaults to TCPIP.

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

-WhatIf

If this switch is enabled, no actions are performed but informational messages will be displayed that explain what would happen if the command were to run.

-Confirm

If this switch is enabled, you will be prompted for confirmation before executing any operations that change state.