xp_enumgroups (Transact-SQL)

Applies to: SQL Server

Provides a list of local Microsoft Windows groups or a list of global groups that are defined in a specified Windows domain.

Transact-SQL syntax conventions

Syntax

xp_enumgroups [ 'domain_name' ]

Arguments

'domain_name'

The name of the Windows domain for which to enumerate a list of global groups. domain_name is sysname, with a default of NULL.

Return code values

0 (success) or 1 (failure).

Result set

Column name Data type Description
group sysname Name of the Windows group
comment sysname Description of the Windows group provided by Windows

Remarks

If domain_name is the name of the Windows-based computer that an instance of SQL Server is running on, or no domain name is specified, xp_enumgroups enumerates the local groups from the computer that is running SQL Server.

Permissions

Requires membership in the db_owner fixed database role in the master database, or membership in the sysadmin fixed server role.

Examples

The following example lists the groups in the sales domain.

EXEC xp_enumgroups 'sales';