| Author | Bryan Hamby (@galador) , Chrissy LeMaire (@cl) |
| Availability | Windows, Linux, macOS |
Aliases : Get-DbaRegisteredServer
Want to see the source code for this command? Check out Get-DbaRegServer on GitHub.
Want to see the Bill Of Health for this command? Check out Get-DbaRegServer.
Retrieves registered SQL Server instances from SSMS, Azure Data Studio, and Central Management Server
Retrieves SQL Server instances from registered server configurations stored in SQL Server Management Studio (SSMS), Azure Data Studio, and Central Management Server (CMS). DBAs use registered servers to organize and quickly connect to multiple SQL Server instances across their environment.
When no SqlInstance is specified, returns local registered servers from SSMS and Azure Data Studio. When SqlInstance is provided, connects to that Central Management Server to retrieve its registered server inventory. This is essential for discovering what SQL Server instances are documented and organized in your environment.
Local Registered Servers and Azure Data Studio support alternative authentication (excluding MFA) but Central Management Server does not.
Get-DbaRegServer
[[-SqlInstance] <DbaInstanceParameter[]>]
[[-SqlCredential] <PSCredential>]
[[-Name] <String[]>]
[[-ServerName] <String[]>]
[[-Group] <String[]>]
[[-ExcludeGroup] <String[]>]
[[-Id] <Int32[]>]
[-IncludeSelf]
[-ResolveNetworkName]
[-IncludeLocal]
[-EnableException]
[<CommonParameters>]
PS C:\> Get-DbaRegServer
Gets a list of servers from the local registered servers and azure data studio
PS C:\> Get-DbaRegServer -SqlInstance sqlserver2014a
Gets a list of servers from the CMS on sqlserver2014a, using Windows Credentials.
PS C:\> Get-DbaRegServer -SqlInstance sqlserver2014a -IncludeSelf
Gets a list of servers from the CMS on sqlserver2014a and includes sqlserver2014a in the output results.
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.
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.
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.
The target SQL Server instance or instances.
| Alias | |
| Required | False |
| Pipeline | true (ByValue) |
| Default Value | (Get-DbatoolsConfigValue -FullName 'commands.get-dbaregserver.defaultcms') |
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.
| Alias | |
| Required | False |
| Pipeline | false |
| Default Value |
Filters results to registered servers with specific display names as they appear in SSMS Registered Servers pane.
Use this when you need to find servers by their friendly names rather than actual server names.
| Alias | |
| Required | False |
| Pipeline | false |
| Default Value |
Filters results to registered servers with specific server instance names (the actual SQL Server connection strings).
Use this when you need to find servers by their network names or instance names rather than display names.
| Alias | |
| Required | False |
| Pipeline | false |
| Default Value |
Filters results to registered servers within specific Central Management Server groups.
Supports hierarchical paths using backslash notation (e.g., "Production\Database Servers"). Use this to target servers organized by environment, department, or function.
| Alias | |
| Required | False |
| Pipeline | false |
| Default Value |
Excludes registered servers from specific Central Management Server groups.
Use this when you want to retrieve most servers but skip certain groups like "Test" or "Decommissioned" environments.
| Alias | |
| Required | False |
| Pipeline | false |
| Default Value |
Filters results to registered servers with specific internal ID numbers.
Use this when you need to retrieve specific servers by their unique identifiers, typically when working with programmatic scripts or automation.
| Alias | |
| Required | False |
| Pipeline | false |
| Default Value |
Includes the Central Management Server instance itself in the results along with all registered servers.
Use this when you need to perform operations on both the CMS and its registered servers in the same workflow.
| Alias | |
| Required | False |
| Pipeline | false |
| Default Value | False |
Performs DNS lookups to return NetBIOS names, FQDN, and IP addresses for each registered server.
Use this when you need network information for servers, but be aware this adds processing time due to DNS queries.
| Alias | |
| Required | False |
| Pipeline | false |
| Default Value | False |
Includes local SSMS and Azure Data Studio registered servers in addition to Central Management Server results.
Use this when querying a CMS but also want to see servers registered locally on your workstation.
| Alias | |
| Required | False |
| Pipeline | false |
| Default Value | (Get-DbatoolsConfigValue -FullName 'commands.get-dbaregserver.includelocal') |
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.
| Alias | |
| Required | False |
| Pipeline | false |
| Default Value | False |