< Back
Remove-DbaClientAlias
Post
NAME Remove-DbaClientAlias
SYNOPSIS
Removes a sql alias for the specified server - mimics cliconfg.exe
SYNTAX
Remove-DbaClientAlias [[-ComputerName] <Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]>]
[[-Credential] <Pscredential>] [-Alias] <System.String[]> [-EnableException <Switch>] [<CommonParameters>]
DESCRIPTION
Removes a sql alias for the specified server by altering HKLM:\\SOFTWARE\\Microsoft\\MSSQLServer\\Client - mimics
cliconfg.exe.
PARAMETERS
-Alias [<System.String[]>]
The alias or array of aliases to be deleted
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
<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:\\>Remove-DbaClientAlias -ComputerName workstationx -Alias sqlps
Removes the sqlps SQL client alias on workstationx
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>Get-DbaClientAlias | Remove-DbaClientAlias
Removes all SQL Server client aliases on the local computer
RELATED LINKS
https://dbatools.io/Remove-DbaClientAlias
SYNOPSIS
Removes a sql alias for the specified server - mimics cliconfg.exe
SYNTAX
Remove-DbaClientAlias [[-ComputerName] <Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]>]
[[-Credential] <Pscredential>] [-Alias] <System.String[]> [-EnableException <Switch>] [<CommonParameters>]
DESCRIPTION
Removes a sql alias for the specified server by altering HKLM:\\SOFTWARE\\Microsoft\\MSSQLServer\\Client - mimics
cliconfg.exe.
PARAMETERS
-Alias [<System.String[]>]
The alias or array of aliases to be deleted
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
<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:\\>Remove-DbaClientAlias -ComputerName workstationx -Alias sqlps
Removes the sqlps SQL client alias on workstationx
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>Get-DbaClientAlias | Remove-DbaClientAlias
Removes all SQL Server client aliases on the local computer
RELATED LINKS
https://dbatools.io/Remove-DbaClientAlias