functions/Get-DbaClientAlias.ps1

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
Function Get-DbaClientAlias {
<#
 .SYNOPSIS
 Creates/updates a sql alias for the specified server - mimics cliconfg.exe
 
 .DESCRIPTION
 Creates/updates a SQL Server alias by altering HKLM:\SOFTWARE\Microsoft\MSSQLServer\Client
 
 .PARAMETER ComputerName
 The target computer where the alias will be created
 
 .PARAMETER Credential
 Allows you to login to remote computers using alternative credentials
 
 .PARAMETER 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.
  
 .NOTES
 Tags: Alias
 
 Website: https://dbatools.io
 Copyright: (C) Chrissy LeMaire, clemaire@gmail.com
 License: GNU GPL v3 https://opensource.org/licenses/GPL-3.0
 
 .LINK
 https://dbatools.io/Get-DbaClientAlias
 
  .EXAMPLE
 Get-DbaClientAlias
 Gets all SQL Server client aliases on the local computer
   
 .EXAMPLE
 Get-DbaClientAlias -ComputerName workstationx
 Gets all SQL Server client aliases on Workstationx
#>

    [CmdletBinding()]
    Param (
        [DbaInstanceParameter[]]$ComputerName = $env:COMPUTERNAME,
        [PSCredential]$Credential,
        [switch][Alias('Silent')]$EnableException
    )
    
    process {
        foreach ($computer in $ComputerName) {
            $scriptblock = {
                
                function Get-ItemPropertyValue {
                    Param (
                        [parameter()]
                        [String]$Path,
                        [parameter()]
                        [String]$Name
                    )
                    (Get-ItemProperty -LiteralPath $Path -Name $Name).$Name
                }
                
                $basekeys = "HKLM:\SOFTWARE\WOW6432Node\Microsoft\MSSQLServer", "HKLM:\SOFTWARE\Microsoft\MSSQLServer"
                
                foreach ($basekey in $basekeys) {
                    
                    if ((Test-Path $basekey) -eq $false) {
                        Write-Warning "Base key ($basekey) does not exist. Quitting."
                        continue
                    }
                    
                    $client = "$basekey\Client"
                    
                    if ((Test-Path $client) -eq $false) {
                        continue
                    }
                    
                    $connect = "$client\ConnectTo"
                    
                    if ((Test-Path $connect) -eq $false) {
                        continue
                    }
                    
                    if ($basekey -like "*WOW64*") {
                        $architecture = "32-bit"
                    }
                    else {
                        $architecture = "64-bit"
                    }
                    
                    # "Creating/updating alias for $ComputerName for $architecture"
                    $all = Get-Item -Path $connect
                    foreach ($entry in $all.Property) {
                        $value = Get-ItemPropertyValue -Path $connect -Name $entry
                        $clean = $value.Replace('DBNMPNTW,', '').Replace('DBMSSOCN,', '')
                        if ($value.StartsWith('DBMSSOCN')) { $protocol = 'TCP/IP' } else { $protocol = 'Named Pipes' }
                        
                        [pscustomobject]@{
                            ComputerName       = $env:COMPUTERNAME
                            NetworkLibrary       = $protocol
                            ServerName           = $clean
                            AliasName           = $entry
                            AliasString           = $value
                            Architecture       = $architecture
                        }
                    }
                }
            }
            
            if ($PScmdlet.ShouldProcess($computer, "Getting aliases")) {
                try {
                    Invoke-Command2 -ComputerName $computer -Credential $Credential -ScriptBlock $scriptblock -ErrorAction Stop |
                    Select-DefaultView -Property ComputerName, Architecture, NetworkLibrary, ServerName, AliasName
                }
                catch {
                    Stop-Function -Message "Failure" -ErrorRecord $_ -Target $computer -Continue
                }
            }
        }
    }
}