xp_enumgroups (Transact-SQL)

THIS TOPIC APPLIES TO:yesSQL Server (starting with 2008)noAzure SQL DatabasenoAzure SQL Data Warehouse noParallel Data Warehouse

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

||
|-|
|Applies to: SQL Server ( SQL Server 2008 through current version).|

Topic link icon Transact-SQL Syntax Conventions

Syntax


xp_enumgroups [ 'domain_name' ]  

Arguments

' domain_name '
Is 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 Sets

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.

xp_enumgroups cannot be used when an instance of SQL Server is running on Windows 98.

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';  

See Also

sp_grantlogin (Transact-SQL)
sp_revokelogin (Transact-SQL)
System Stored Procedures (Transact-SQL)
General Extended Stored Procedures (Transact-SQL)
xp_loginconfig (Transact-SQL)
xp_logininfo (Transact-SQL)