sp_helpremotelogin (Transact-SQL)

Article
02/28/2023

Applies to: SQL Server

Reports information about remote logins for a particular remote server, or for all remote servers, defined on the local server.

Important

This feature will be removed in a future version of SQL Server. Avoid using this feature in new development work, and plan to modify applications that currently use this feature. Use linked servers and linked server stored procedures instead.

Transact-SQL syntax conventions

Syntax

  
sp_helpremotelogin [ [ @remoteserver = ] 'remoteserver' ]   
     [ , [ @remotename = ] 'remote_name' ]

Arguments

[ @remoteserver = ] 'remoteserver'
Is the remote server about which the remote login information is returned. remoteserver is sysname, with a default of NULL. If remoteserver is not specified, information about all remote servers defined on the local server is returned.

[ @remotename = ] 'remote_name'
Is a specific remote login on the remote server. remote_name is sysname, with a default of NULL. If remote_name is not specified, information about all remote users defined for remoteserver is returned.

Return Code Values

0 (success) or 1 (failure)

Result Sets

Column name	Data type	Description
server	sysname	Name of a remote server defined on the local server.
local_user_name	sysname	Login on the local server that remote logins from server map to.
remote_user_name	sysname	Login on the remote server that maps to local_user_name.
options	sysname	Trusted = The remote login does not need to supply a password when connecting to the local server from the remote server. Untrusted (or blank) = The remote login is prompted for a password when connecting to the local server from the remote server.

Remarks

Use sp_helpserver to list the names of remote servers defined on the local server.

Permissions

No permissions are checked.

Examples

A. Reporting help on a single server

The following example displays information about all remote users on the remote server Accounts.

EXEC sp_helpremotelogin 'Accounts';

B. Reporting help on all remote users

The following example displays information about all remote users on all remote servers known to the local server.

EXEC sp_helpremotelogin;