< Back
Get-DbaRegServerGroup
Post
NAME Get-DbaRegServerGroup
SYNOPSIS
Gets list of Server Groups objects stored in SQL Server Central Management Server (CMS).
SYNTAX
Get-DbaRegServerGroup [[-SqlInstance] <Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]>]
[[-SqlCredential] <Pscredential>] [[-Group] <System.Object[]>] [[-ExcludeGroup] <System.Object[]>] [[-Id]
<System.Int32[]>] [-EnableException <Switch>] [<CommonParameters>]
DESCRIPTION
Returns an array of Server Groups found in the CMS.
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.Object[]>]
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.Object[]>]
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 group by Id(s). This parameter only works if the group has a registered server in it.
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: Tony Wilhelm (@tonywsql)
Website: https://dbatools.io
Copyright: (c) 2018 by dbatools, licensed under MIT
License: MIT https://opensource.org/licenses/MIT
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Get-DbaRegServerGroup -SqlInstance sqlserver2014a
Gets the top level groups from the CMS on sqlserver2014a, using Windows Credentials.
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>Get-DbaRegServerGroup -SqlInstance sqlserver2014a -SqlCredential $credential
Gets the top level groups from the CMS on sqlserver2014a, using alternative credentials to authenticate to the
server.
-------------------------- EXAMPLE 3 --------------------------
PS C:\\>Get-DbaRegServerGroup -SqlInstance sqlserver2014a -Group HR, Accounting
Gets the HR and Accounting groups from the CMS on sqlserver2014a.
-------------------------- EXAMPLE 4 --------------------------
PS C:\\>Get-DbaRegServerGroup -SqlInstance sqlserver2014a -Group HR\\Development
Returns the sub-group Development of the HR group from the CMS on sqlserver2014a.
RELATED LINKS
https://dbatools.io/Get-DbaRegServerGroup
SYNOPSIS
Gets list of Server Groups objects stored in SQL Server Central Management Server (CMS).
SYNTAX
Get-DbaRegServerGroup [[-SqlInstance] <Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]>]
[[-SqlCredential] <Pscredential>] [[-Group] <System.Object[]>] [[-ExcludeGroup] <System.Object[]>] [[-Id]
<System.Int32[]>] [-EnableException <Switch>] [<CommonParameters>]
DESCRIPTION
Returns an array of Server Groups found in the CMS.
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.Object[]>]
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.Object[]>]
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 group by Id(s). This parameter only works if the group has a registered server in it.
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: Tony Wilhelm (@tonywsql)
Website: https://dbatools.io
Copyright: (c) 2018 by dbatools, licensed under MIT
License: MIT https://opensource.org/licenses/MIT
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Get-DbaRegServerGroup -SqlInstance sqlserver2014a
Gets the top level groups from the CMS on sqlserver2014a, using Windows Credentials.
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>Get-DbaRegServerGroup -SqlInstance sqlserver2014a -SqlCredential $credential
Gets the top level groups from the CMS on sqlserver2014a, using alternative credentials to authenticate to the
server.
-------------------------- EXAMPLE 3 --------------------------
PS C:\\>Get-DbaRegServerGroup -SqlInstance sqlserver2014a -Group HR, Accounting
Gets the HR and Accounting groups from the CMS on sqlserver2014a.
-------------------------- EXAMPLE 4 --------------------------
PS C:\\>Get-DbaRegServerGroup -SqlInstance sqlserver2014a -Group HR\\Development
Returns the sub-group Development of the HR group from the CMS on sqlserver2014a.
RELATED LINKS
https://dbatools.io/Get-DbaRegServerGroup