< Back
New-DbaClientAlias
Post
NAME New-DbaClientAlias
SYNOPSIS
Creates/updates a sql alias for the specified server - mimics cliconfg.exe
SYNTAX
New-DbaClientAlias [[-ComputerName] <Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]>] [[-Credential]
<Pscredential>] [-ServerName] <Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]> [-Alias] <String>
[[-Protocol] <String>] [-EnableException <Switch>] [<CommonParameters>]
DESCRIPTION
Creates/updates a SQL Server alias by altering HKLM:\\SOFTWARE\\Microsoft\\MSSQLServer\\Client
PARAMETERS
-Alias [<String>]
The alias to be created
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-ComputerName [<Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]>]
The target computer where the alias will be created
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-Credential [<Pscredential>]
Allows you to login to remote computers using alternative credentials
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-EnableException [<Switch>]
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.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-Protocol [<String>]
The protocol for the connection, either TCPIP or NetBIOS. Defaults to TCPIP.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-ServerName [<Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]>]
The target SQL Server
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
NOTES
Tags: Alias
Author: Chrissy LeMaire (@cl), netnerds.net
Website: https://dbatools.io
Copyright: (c) 2018 by dbatools, licensed under MIT
License: MIT https://opensource.org/licenses/MIT
-------------------------- 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
RELATED LINKS
https://dbatools.io/New-DbaClientAlias
SYNOPSIS
Creates/updates a sql alias for the specified server - mimics cliconfg.exe
SYNTAX
New-DbaClientAlias [[-ComputerName] <Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]>] [[-Credential]
<Pscredential>] [-ServerName] <Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]> [-Alias] <String>
[[-Protocol] <String>] [-EnableException <Switch>] [<CommonParameters>]
DESCRIPTION
Creates/updates a SQL Server alias by altering HKLM:\\SOFTWARE\\Microsoft\\MSSQLServer\\Client
PARAMETERS
-Alias [<String>]
The alias to be created
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-ComputerName [<Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]>]
The target computer where the alias will be created
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-Credential [<Pscredential>]
Allows you to login to remote computers using alternative credentials
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-EnableException [<Switch>]
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.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-Protocol [<String>]
The protocol for the connection, either TCPIP or NetBIOS. Defaults to TCPIP.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-ServerName [<Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]>]
The target SQL Server
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
OUTPUTS
NOTES
Tags: Alias
Author: Chrissy LeMaire (@cl), netnerds.net
Website: https://dbatools.io
Copyright: (c) 2018 by dbatools, licensed under MIT
License: MIT https://opensource.org/licenses/MIT
-------------------------- 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
RELATED LINKS
https://dbatools.io/New-DbaClientAlias