xp_loginconfig (Transact-SQL)

  • Article

Reports the login security configuration of an instance of SQL Server.

Important

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.

Topic link icon Transact-SQL Syntax Conventions

Syntax

xp_loginconfig ['config_name']

Arguments

  • ' config_name '
    Is the configuration value to be displayed. If config_name is not specified, all configuration values are reported. config_name is sysname, with a default of NULL, and can be one of these values.

    Value

    Description

    login mode

    Login security mode. Possible values are Mixed and Windows Authentication.

    Replaced by:

    SELECT SERVERPROPERTY('IsIntegratedSecurityOnly');
GO

    default login

    Name of the default SQL Server login ID for authorized users of trusted connections (for users without matching login name). The default login is guest. This value is provided for backward compatibility.

    Default domain

    Name of the default Windows domain for network users of trusted connections. The default domain is the domain of the computer running Windows and SQL Server. This value is provided for backward compatibility.

    audit level

    Audit level. Possible values are none, success, failure, and all. Audits are written to the error log and to the Windows Event Viewer.

    set hostname

    Indicates whether the host name from the client login record is replaced with the Windows network user name. Possible values are true or false. If this is set, the network user name appears in output from sp_who.

    map _

    Reports what special Windows characters are mapped to the valid SQL Server underscore character (_). Possible values are domain separator (default), space, null, or any single character. This value is provided for backward compatibility.

    map $

    Reports what special Windows characters are mapped to the valid SQL Server dollar sign character ($). Possible values are domain separator, space, null, or any single character. The default is space. This value is provided for backward compatibility.

    map #

    Reports what special Windows characters are mapped to the valid SQL Server number sign character (#). Possible values are domain separator, space, null, or any single character. Default is the hyphen. This value is provided for backward compatibility.

Return Code Values

0 (success) or 1 (failure)

Result Sets

Column name

Data type

Description

name

sysname

Configuration value

config value

sysname

Configuration value setting

Remarks

xp_loginconfig cannot be used to set configuration values.

To set the login mode and audit level, use SQL Server Management Studio.

Permissions

Requires CONTROL permission on the master database.

Examples

A. How to report all configuration values

The following example shows all the currently configured settings.

EXEC xp_loginconfig;
GO

B. How to report a specific configuration value

The following example shows the setting for only the login mode.

EXEC xp_loginconfig 'login mode';
GO

See Also

Reference

sp_denylogin (Transact-SQL)

sp_grantlogin (Transact-SQL)

System Stored Procedures (Transact-SQL)

sp_revokelogin (Transact-SQL)

xp_logininfo (Transact-SQL)