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

Creates a RegisteredServersStore object for managing Central Management Server configurations

Description

Creates a RegisteredServersStore object that serves as the foundation for working with SQL Server Central Management Server (CMS). This object provides access to server groups and registered servers stored in the CMS repository, allowing you to programmatically manage multiple SQL Server instances from a centralized location. When no SqlInstance is specified, it returns the local file store which contains your locally registered servers from SQL Server Management Studio. The returned object can be used with other dbatools CMS commands like Get-DbaRegServer and Get-DbaRegServerGroup to retrieve and manage your registered server configurations.

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

Specifies the SQL Server instance hosting the Central Management Server to retrieve the registered server store from.
When omitted, returns the local file store containing your locally registered servers from SQL Server Management Studio.
Use this when you need to access server groups and registered servers stored in a centralized CMS repository.

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