< Back
Get-DbaRegServer
Post
NAME Get-DbaRegServer
SYNOPSIS
Gets list of SQL Server objects stored in local registered groups, azure data studio and central management server.
SYNTAX
Get-DbaRegServer [[-SqlInstance] <Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]>] [[-SqlCredential]
<Pscredential>] [[-Name] <System.String[]>] [[-ServerName] <System.String[]>] [[-Group] <System.String[]>]
[[-ExcludeGroup] <System.String[]>] [[-Id] <System.Int32[]>] [-IncludeSelf <Switch>] [-ResolveNetworkName
<Switch>] [-IncludeLocal <Switch>] [-EnableException <Switch>] [<CommonParameters>]
DESCRIPTION
Gets list of SQL Server objects stored in local registered groups, azure data studio and central management server.
Local Registered Servers and Azure Data Studio support alternative authentication (excluding MFA) but Central
Management Studio does not.
PARAMETERS
-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
-ExcludeGroup [<System.String[]>]
Specifies one or more Central Management Server groups to exclude.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-Group [<System.String[]>]
Specifies one or more groups to include from SQL Server Central Management Server.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-Id [<System.Int32[]>]
Get server by Id(s)
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-IncludeLocal [<Switch>]
Include local registered servers or Azure Data Studio registered servers in results when specifying
SqlInstance.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-IncludeSelf [<Switch>]
If this switch is enabled and you're connecting to a Central Management Server, the CMS server itself will be
included in the results, along with all other Registered Servers.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-Name [<System.String[]>]
Specifies one or more names to include. Name is the visible name in SSMS interface (labeled Registered Server
Name)
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-ResolveNetworkName [<Switch>]
If this switch is enabled, the NetBIOS name and IP address(es) of each server will be returned.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-ServerName [<System.String[]>]
Specifies one or more server names to include. Server Name is the actual instance name (labeled Server Name)
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-SqlCredential [<Pscredential>]
Login to the target instance using alternative credentials. Accepts PowerShell credentials (Get-Credential).
Windows Authentication, SQL Server Authentication, Active Directory - Password, and Active Directory -
Integrated are all supported.
For MFA support, please use Connect-DbaInstance.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-SqlInstance [<Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]>]
The target SQL Server instance or instances.
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: RegisteredServer, CMS
Author: Bryan Hamby (@galador) | Chrissy LeMaire (@cl)
Website: https://dbatools.io
Copyright: (c) 2018 by dbatools, licensed under MIT
License: MIT https://opensource.org/licenses/MIT
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Get-DbaRegServer
Gets a list of servers from the local registered servers and azure data studio
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>Get-DbaRegServer -SqlInstance sqlserver2014a
Gets a list of servers from the CMS on sqlserver2014a, using Windows Credentials.
-------------------------- EXAMPLE 3 --------------------------
PS C:\\>Get-DbaRegServer -SqlInstance sqlserver2014a -IncludeSelf
Gets a list of servers from the CMS on sqlserver2014a and includes sqlserver2014a in the output results.
-------------------------- EXAMPLE 4 --------------------------
PS C:\\>Get-DbaRegServer -SqlInstance sqlserver2014a -SqlCredential $credential | Select-Object -Unique
-ExpandProperty ServerName
Returns only the server names from the CMS on sqlserver2014a, using SQL Authentication to authenticate to the
server.
-------------------------- EXAMPLE 5 --------------------------
PS C:\\>Get-DbaRegServer -SqlInstance sqlserver2014a -Group HR, Accounting
Gets a list of servers in the HR and Accounting groups from the CMS on sqlserver2014a.
-------------------------- EXAMPLE 6 --------------------------
PS C:\\>Get-DbaRegServer -SqlInstance sqlserver2014a -Group HR\\Development
Returns a list of servers in the HR and sub-group Development from the CMS on sqlserver2014a.
RELATED LINKS
https://dbatools.io/Get-DbaRegServer
SYNOPSIS
Gets list of SQL Server objects stored in local registered groups, azure data studio and central management server.
SYNTAX
Get-DbaRegServer [[-SqlInstance] <Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]>] [[-SqlCredential]
<Pscredential>] [[-Name] <System.String[]>] [[-ServerName] <System.String[]>] [[-Group] <System.String[]>]
[[-ExcludeGroup] <System.String[]>] [[-Id] <System.Int32[]>] [-IncludeSelf <Switch>] [-ResolveNetworkName
<Switch>] [-IncludeLocal <Switch>] [-EnableException <Switch>] [<CommonParameters>]
DESCRIPTION
Gets list of SQL Server objects stored in local registered groups, azure data studio and central management server.
Local Registered Servers and Azure Data Studio support alternative authentication (excluding MFA) but Central
Management Studio does not.
PARAMETERS
-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
-ExcludeGroup [<System.String[]>]
Specifies one or more Central Management Server groups to exclude.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-Group [<System.String[]>]
Specifies one or more groups to include from SQL Server Central Management Server.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-Id [<System.Int32[]>]
Get server by Id(s)
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-IncludeLocal [<Switch>]
Include local registered servers or Azure Data Studio registered servers in results when specifying
SqlInstance.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-IncludeSelf [<Switch>]
If this switch is enabled and you're connecting to a Central Management Server, the CMS server itself will be
included in the results, along with all other Registered Servers.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-Name [<System.String[]>]
Specifies one or more names to include. Name is the visible name in SSMS interface (labeled Registered Server
Name)
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-ResolveNetworkName [<Switch>]
If this switch is enabled, the NetBIOS name and IP address(es) of each server will be returned.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-ServerName [<System.String[]>]
Specifies one or more server names to include. Server Name is the actual instance name (labeled Server Name)
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-SqlCredential [<Pscredential>]
Login to the target instance using alternative credentials. Accepts PowerShell credentials (Get-Credential).
Windows Authentication, SQL Server Authentication, Active Directory - Password, and Active Directory -
Integrated are all supported.
For MFA support, please use Connect-DbaInstance.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-SqlInstance [<Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]>]
The target SQL Server instance or instances.
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: RegisteredServer, CMS
Author: Bryan Hamby (@galador) | Chrissy LeMaire (@cl)
Website: https://dbatools.io
Copyright: (c) 2018 by dbatools, licensed under MIT
License: MIT https://opensource.org/licenses/MIT
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Get-DbaRegServer
Gets a list of servers from the local registered servers and azure data studio
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>Get-DbaRegServer -SqlInstance sqlserver2014a
Gets a list of servers from the CMS on sqlserver2014a, using Windows Credentials.
-------------------------- EXAMPLE 3 --------------------------
PS C:\\>Get-DbaRegServer -SqlInstance sqlserver2014a -IncludeSelf
Gets a list of servers from the CMS on sqlserver2014a and includes sqlserver2014a in the output results.
-------------------------- EXAMPLE 4 --------------------------
PS C:\\>Get-DbaRegServer -SqlInstance sqlserver2014a -SqlCredential $credential | Select-Object -Unique
-ExpandProperty ServerName
Returns only the server names from the CMS on sqlserver2014a, using SQL Authentication to authenticate to the
server.
-------------------------- EXAMPLE 5 --------------------------
PS C:\\>Get-DbaRegServer -SqlInstance sqlserver2014a -Group HR, Accounting
Gets a list of servers in the HR and Accounting groups from the CMS on sqlserver2014a.
-------------------------- EXAMPLE 6 --------------------------
PS C:\\>Get-DbaRegServer -SqlInstance sqlserver2014a -Group HR\\Development
Returns a list of servers in the HR and sub-group Development from the CMS on sqlserver2014a.
RELATED LINKS
https://dbatools.io/Get-DbaRegServer