commands

^

Get-DbaRegServer

Author Bryan Hamby (@galador) , Chrissy LeMaire (@cl)
Availability Windows, Linux, macOS

 

Aliases : Get-DbaRegisteredServer

Synopsis

Gets list of SQL Server objects stored in local registered groups, azure data studio and central management server.

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.

Syntax

Get-DbaRegServer
    [[-SqlInstance] <DbaInstanceParameter[]>]
    [[-SqlCredential] <PSCredential>]
    [[-Name] <String[]>]
    [[-ServerName] <String[]>]
    [[-Group] <String[]>]
    [[-ExcludeGroup] <String[]>]
    [[-Id] <Int32[]>]
    [-IncludeSelf]
    [-ResolveNetworkName]
    [-IncludeLocal]
    [-EnableException]
    [<CommonParameters>]

 

Examples

 

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.

Optional Parameters

-SqlInstance

The target SQL Server instance or instances.

Alias
Required False
Pipeline true (ByValue)
Default Value (Get-DbatoolsConfigValue -FullName 'commands.get-dbaregserver.defaultcms')
-SqlCredential

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
-Name

Specifies one or more names to include. Name is the visible name in SSMS interface (labeled Registered Server Name)

Alias
Required False
Pipeline false
Default Value
-ServerName

Specifies one or more server names to include. Server Name is the actual instance name (labeled Server Name)

Alias
Required False
Pipeline false
Default Value
-Group

Specifies one or more groups to include from SQL Server Central Management Server.

Alias
Required False
Pipeline false
Default Value
-ExcludeGroup

Specifies one or more Central Management Server groups to exclude.

Alias
Required False
Pipeline false
Default Value
-Id

Get server by Id(s)

Alias
Required False
Pipeline false
Default Value
-IncludeSelf

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.

Alias
Required False
Pipeline false
Default Value False
-ResolveNetworkName

If this switch is enabled, the NetBIOS name and IP address(es) of each server will be returned.

Alias
Required False
Pipeline false
Default Value False
-IncludeLocal

Include local registered servers or Azure Data Studio registered servers in results when specifying SqlInstance.

Alias
Required False
Pipeline false
Default Value (Get-DbatoolsConfigValue -FullName 'commands.get-dbaregserver.includelocal')
-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.

Alias
Required False
Pipeline false
Default Value False

 

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.