< Back
Add-DbaRegServerGroup
Post
NAME Add-DbaRegServerGroup
SYNOPSIS
Adds registered server groups to SQL Server Central Management Server (CMS)
SYNTAX
Add-DbaRegServerGroup [[-SqlInstance] <Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]>]
[[-SqlCredential] <Pscredential>] [-Name] <String> [[-Description] <String>] [[-Group] <String>] [[-InputObject]
<Microsoft.SqlServer.Management.RegisteredServers.ServerGroup[]>] [-EnableException <Switch>] [<CommonParameters>]
DESCRIPTION
Adds registered server groups to SQL Server Central Management Server (CMS). If you need more flexibility, look
into Import-DbaRegServer which accepts multiple kinds of input and allows you to add reg servers and groups from
different CMS.
PARAMETERS
-Description [<String>]
The description for the registered server group
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-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
-Group [<String>]
The SQL Server Central Management Server group. If no groups are specified, the new group will be created at
the root.
You can pass sub groups using the '\\' to split the path. Group\\SubGroup will create both folders. Folder
'SubGroup' under 'Group' folder.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-InputObject [<Microsoft.SqlServer.Management.RegisteredServers.ServerGroup[]>]
Allows results from Get-DbaRegServerGroup to be piped in
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-Name [<String>]
The name of the registered server group.
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
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: Chrissy LeMaire (@cl), netnerds.net
Website: https://dbatools.io
Copyright: (c) 2018 by dbatools, licensed under MIT
License: MIT https://opensource.org/licenses/MIT
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Add-DbaRegServerGroup -SqlInstance sql2012 -Name HR
Creates a registered server group called HR, in the root of sql2012's CMS
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>Add-DbaRegServerGroup -SqlInstance sql2012, sql2014 -Name sub-folder -Group HR
Creates a registered server group on sql2012 and sql2014 called sub-folder within the HR group
-------------------------- EXAMPLE 3 --------------------------
PS C:\\>Get-DbaRegServerGroup -SqlInstance sql2012, sql2014 -Group HR | Add-DbaRegServerGroup -Name sub-folder
Creates a registered server group on sql2012 and sql2014 called sub-folder within the HR group of each server
RELATED LINKS
https://dbatools.io/Add-DbaRegServerGroup
SYNOPSIS
Adds registered server groups to SQL Server Central Management Server (CMS)
SYNTAX
Add-DbaRegServerGroup [[-SqlInstance] <Sqlcollaborative.Dbatools.Parameter.DbaInstanceParameter[]>]
[[-SqlCredential] <Pscredential>] [-Name] <String> [[-Description] <String>] [[-Group] <String>] [[-InputObject]
<Microsoft.SqlServer.Management.RegisteredServers.ServerGroup[]>] [-EnableException <Switch>] [<CommonParameters>]
DESCRIPTION
Adds registered server groups to SQL Server Central Management Server (CMS). If you need more flexibility, look
into Import-DbaRegServer which accepts multiple kinds of input and allows you to add reg servers and groups from
different CMS.
PARAMETERS
-Description [<String>]
The description for the registered server group
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-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
-Group [<String>]
The SQL Server Central Management Server group. If no groups are specified, the new group will be created at
the root.
You can pass sub groups using the '\\' to split the path. Group\\SubGroup will create both folders. Folder
'SubGroup' under 'Group' folder.
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-InputObject [<Microsoft.SqlServer.Management.RegisteredServers.ServerGroup[]>]
Allows results from Get-DbaRegServerGroup to be piped in
Required? false
Position? named
Default value
Accept pipeline input? False
Accept wildcard characters? false
-Name [<String>]
The name of the registered server group.
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
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: Chrissy LeMaire (@cl), netnerds.net
Website: https://dbatools.io
Copyright: (c) 2018 by dbatools, licensed under MIT
License: MIT https://opensource.org/licenses/MIT
-------------------------- EXAMPLE 1 --------------------------
PS C:\\>Add-DbaRegServerGroup -SqlInstance sql2012 -Name HR
Creates a registered server group called HR, in the root of sql2012's CMS
-------------------------- EXAMPLE 2 --------------------------
PS C:\\>Add-DbaRegServerGroup -SqlInstance sql2012, sql2014 -Name sub-folder -Group HR
Creates a registered server group on sql2012 and sql2014 called sub-folder within the HR group
-------------------------- EXAMPLE 3 --------------------------
PS C:\\>Get-DbaRegServerGroup -SqlInstance sql2012, sql2014 -Group HR | Add-DbaRegServerGroup -Name sub-folder
Creates a registered server group on sql2012 and sql2014 called sub-folder within the HR group of each server
RELATED LINKS
https://dbatools.io/Add-DbaRegServerGroup