• Article

ServerGroups Collection

This feature will be removed in a future version of Microsoft SQL Server. Avoid using this feature in new development work, and plan to modify applications that currently use this feature.

The ServerGroups collection contains ServerGroup objects that expose a classification system for the registry-maintained list of instances of Microsoft SQL Server.

SQL-DMO object model that shows the current object

Properties

Count Property

 

Remarks

SQL Distributed Management Objects (SQL-DMO) applications can maintain lists of some or all instances of SQL Server in an organization. The lists are stored in the Windows registry.

Each registry-maintained list is visible in a SQL-DMO application through the RegisteredServers collection. A ServerGroup object classifies a list, providing a meaningful name for a list of instances of SQL Server.

With the ServerGroups collection, you can:

  • Create a category used to classify a registry-maintained list of instances of SQL Server.

  • Remove a category classifying registry-maintained lists of instances of SQL Server.

To create a classification for registry-maintained lists of instances of SQL Server

  1. Create a ServerGroup object.

  2. Set the Name property of the ServerGroup object.

  3. Add the ServerGroup object to the ServerGroups collection of the Application object.

To remove an organization server classification

  1. Get the ServerGroup object referencing the target classification from the ServerGroups collection of the Application object.

  2. Use the Remove method of the RegisteredServers collection of the target ServerGroup object to remove any instances maintained under the classification.

  3. Use the Remove method of the ServerGroup object to remove the classification.

    Important

    When using the ServerGroups collection to remove an existing registry-maintained classification, the RegisteredServers collection of the target ServerGroup object must be empty.

When using the Item or Remove method, the ServerGroups collection supports member identification using either name or ordinal reference syntax. For example:

Set oServerGroup = oApplication.ServerGroups("London")

Or:

Set oServerGroup = oApplication.ServerGroups(1)