functions/Get-DbaRegisteredServersStore.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
function Get-DbaRegisteredServersStore {
<#
.SYNOPSIS
Returns a SQL Server Registered Server Store Object
 
.DESCRIPTION
Returns a SQL Server Registered Server Store object - useful for working with Central Management Store
 
.PARAMETER SqlInstance
SQL Server name or SMO object representing the SQL Server to connect to. This can be a collection and receive pipeline input to allow the function
to be executed against multiple SQL Server instances.
 
.PARAMETER SqlCredential
    SqlCredential object to connect as. If not specified, current Windows login will be used.
 
.PARAMETER Silent
Use this switch to disable any kind of verbose messages
 
.NOTES
Tags: RegisteredServer
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-DbaRegisteredServersStore
 
.EXAMPLE
Get-DbaRegisteredServersStore -SqlInstance sqlserver2014a
 
Returns a SQL Server Registered Server Store Object from sqlserver2014a
 
.EXAMPLE
Get-DbaRegisteredServersStore -SqlInstance sqlserver2014a -SqlCredential (Get-Credential sqladmin)
 
Returns a SQL Server Registered Server Store Object from sqlserver2014a by logging in with the sqladmin login
     
#>

    [CmdletBinding(DefaultParameterSetName = "Default")]
    Param (
        [parameter(Mandatory = $true, ValueFromPipeline = $true)]
        [Alias("ServerInstance", "SqlServer")]
        [DbaInstanceParameter[]]$SqlInstance,
        [object]$SqlCredential,
        [switch]$Silent
    )
    process {
        foreach ($Instance in $SqlInstance) {
            try {
                Write-Message -Level Verbose -Message "Connecting to $instance"
                $server = Connect-SqlInstance -SqlInstance $instance -SqlCredential $sqlcredential
            }
            catch {
                Stop-Function -Message "Failure" -Category ConnectionError -ErrorRecord $_ -Target $instance -Continue
            }
            
            $sqlconnection = $server.ConnectionContext.SqlConnectionObject
            
            try {
                $store = New-Object Microsoft.SqlServer.Management.RegisteredServers.RegisteredServersStore($sqlconnection)
            }
            catch {
                Stop-Function -Message "Cannot access Central Management Server" -Category ConnectionError -ErrorRecord $_ -Target $instance -Continue
            }
            
            Add-Member -Force -InputObject $store -MemberType NoteProperty -Name ComputerName -value $server.NetName
            Add-Member -Force -InputObject $store -MemberType NoteProperty -Name InstanceName -value $server.ServiceName
            Add-Member -Force -InputObject $store -MemberType NoteProperty -Name SqlInstance -value $server.DomainInstanceName
            
            Select-DefaultView -InputObject $store -ExcludeProperty ServerConnection, DomainInstanceName, DomainName, Urn, Properties, Metadata, Parent, ConnectionContext, PropertyMetadataChanged, PropertyChanged
        }
    }
}