functions/Get-SqlRegisteredServerName.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-SqlRegisteredServerName
{
<#
.SYNOPSIS
Gets list of SQL Server names stored in SQL Server Central Management Server

.DESCRIPTION
Returns a simple array of server namess

.PARAMETER SqlServer
The SQL Server instance.

.PARAMETER SqlCredential
Allows you to login to servers using SQL Logins as opposed to Windows Auth/Integrated/Trusted. To use:
$scred = Get-Credential, then pass $scred object to the -SqlCredential parameter.
Windows Authentication will be used if SqlCredential is not specified. SQL Server does not accept Windows credentials being passed as credentials. To connect as a different Windows user, run PowerShell as that user.

.PARAMETER Group
Auto-populated list of groups in SQL Server Central Management Server. You can specify one or more, comma separated.
        
.PARAMETER NoCmsServer
By default, the Central Management Server name is included in the list. use -NoCmsServer to exclude the CMS itself.
    
.NOTES
dbatools PowerShell module (https://dbatools.io, clemaire@gmail.com)
Copyright (C) 2016 Chrissy LeMaire

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.

.LINK
https://dbatools.io/Get-SqlRegisteredServerName

.EXAMPLE
Get-SqlRegisteredServerName -SqlServer sqlserver2014a

Gets a list of all server names from the Central Management Server on sqlserver2014a, using Windows Credentials

.EXAMPLE
Get-SqlRegisteredServerName -SqlServer sqlserver2014a -SqlCredential $credential

Gets a list of all server names from the Central Management Server on sqlserver2014a, using SQL Authentication
        
.EXAMPLE
Get-SqlRegisteredServerName -SqlServer sqlserver2014a -Groups HR, Accounting
    
Gets a list of server names in the HR and Accouting groups from the Central Management Server on sqlserver2014a.
    
#>

    Param (
        [parameter(Mandatory = $true, ValueFromPipeline = $true)]
        [Alias("ServerInstance", "SqlInstance")]
        [object]$SqlServer,
        [object]$SqlCredential,
        [switch]$NoCmsServer
    )
    
    DynamicParam { if ($sqlserver) { return Get-ParamSqlCmsGroups -SqlServer $sqlserver -SqlCredential $SqlCredential } }
    
    BEGIN
    {
        $server = Connect-SqlServer -SqlServer $SqlServer -SqlCredential $SqlCredential
        $sqlconnection = $server.ConnectionContext.SqlConnectionObject
        
        try
        {
            $cmstore = New-Object Microsoft.SqlServer.Management.RegisteredServers.RegisteredServersStore($sqlconnection)
        }
        catch
        {
            throw "Cannot access Central Management Server"
        }
        
        $groups = $psboundparameters.Group
    }
    
    PROCESS
    {
        
        
        $servers = @()
        if ($groups -ne $null)
        {
            foreach ($group in $groups)
            {
                $cms = $cmstore.ServerGroups["DatabaseEngineServerGroup"].ServerGroups[$group]
                $servers += ($cms.GetDescendantRegisteredServers()).servername
            }
        }
        else
        {
            $cms = $cmstore.ServerGroups["DatabaseEngineServerGroup"]
            $servers = ($cms.GetDescendantRegisteredServers()).servername
        }
        
        if ($NoCmsServer -eq $false)
        {
            $servers += $sqlserver
        }
        return $servers
    }
    
    END
    {
        $server.ConnectionContext.Disconnect()
    }
}