commands

^

Remove-DbaClientAlias

Author Chrissy LeMaire (@cl), netnerds.net
Availability Windows only

 

Synopsis

Removes a sql alias for the specified server - mimics cliconfg.exe

Description

Removes a sql alias for the specified server by altering HKLM:\SOFTWARE\Microsoft\MSSQLServer\Client - mimics cliconfg.exe.

Syntax

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

 

Examples

 

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

Required Parameters

-Alias

The alias or array of aliases to be deleted

Alias AliasName
Required True
Pipeline true (ByPropertyName)
Default Value

Optional Parameters

-ComputerName

The target computer where the alias will be created.

Alias
Required False
Pipeline true (ByPropertyName)
Default Value $env:COMPUTERNAME
-Credential

Allows you to login to remote computers using alternative credentials

Alias
Required False
Pipeline false
Default Value
-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.

Alias
Required False
Pipeline false
Default Value False
-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.

Alias wi
Required False
Pipeline false
Default Value
-Confirm

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

Alias cf
Required False
Pipeline false
Default Value

 

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