Get-DbaRegServerStore

Want to see the source code for this command? Check out Get-DbaRegServerStore on GitHub.
Want to see the Bill Of Health for this command? Check out Get-DbaRegServerStore.

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

Syntax

Get-DbaRegServerStore
    [[-SqlInstance] <DbaInstanceParameter[]>]
    [[-SqlCredential] <PSCredential>]
    [-EnableException]
    [<CommonParameters>]

Examples

Example: 1

PS C:\> Get-DbaRegServerStore -SqlInstance sqlserver2014a

Returns a SQL Server Registered Server Store Object from sqlserver2014a

Example: 2

PS C:\> Get-DbaRegServerStore -SqlInstance sqlserver2014a -SqlCredential sqladmin

Returns a SQL Server Registered Server Store Object from sqlserver2014a by logging in with the sqladmin login

Optional Parameters

-SqlInstance

The target SQL Server instance or instances. This can be a collection and receive pipeline input to allow the function to be executed against multiple SQL Server instances.

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

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