Get-DbaClientAlias

NAME Get-DbaClientAlias



SYNOPSIS

Gets any SQL Server alias for the specified server(s)





SYNTAX

Get-DbaClientAlias [[-ComputerName] <Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]>] [[-Credential]

<Pscredential>] [-EnableException <Switch>] [<CommonParameters>]





DESCRIPTION

Gets SQL Server alias by reading HKLM:\\SOFTWARE\\Microsoft\\MSSQLServer\\Client





PARAMETERS

-ComputerName [<Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]>]

The target computer where the alias has been 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: Server, Management

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:\\>Get-DbaClientAlias



Gets all SQL Server client aliases on the local computer

-------------------------- EXAMPLE 2 --------------------------



PS C:\\>Get-DbaClientAlias -ComputerName workstationx



Gets all SQL Server client aliases on Workstationx

-------------------------- EXAMPLE 3 --------------------------



PS C:\\>Get-DbaClientAlias -ComputerName workstationx -Credential ad\\sqldba



Logs into workstationx as ad\\sqldba then retrieves all SQL Server client aliases on Workstationx

-------------------------- EXAMPLE 4 --------------------------



PS C:\\>'Server1', 'Server2' | Get-DbaClientAlias



Gets all SQL Server client aliases on Server1 and Server2



RELATED LINKS

https://dbatools.io/Get-DbaClientAlias