Skip to content

sp-helplinkedsrvlogin-transact-sql.md

Latest commit

 

History

History
130 lines (94 loc) · 4.92 KB

sp-helplinkedsrvlogin-transact-sql.md

File metadata and controls

130 lines (94 loc) · 4.92 KB
title sp_helplinkedsrvlogin (Transact-SQL)
description Provides information about login mappings defined against a specific linked server used for distributed queries and remote stored procedures.
author markingmyname
ms.author maghan
ms.reviewer randolphwest
ms.date 06/23/2025
ms.service sql
ms.subservice system-objects
ms.topic reference
f1_keywords
sp_helplinkedsrvlogin_TSQL
sp_helplinkedsrvlogin
helpviewer_keywords
sp_helplinkedsrvlogin
dev_langs
TSQL

sp_helplinkedsrvlogin (Transact-SQL)

[!INCLUDE SQL Server]

Provides information about login mappings defined against a specific linked server used for distributed queries and remote stored procedures.

:::image type="icon" source="../../includes/media/topic-link-icon.svg" border="false"::: Transact-SQL syntax conventions

Syntax

sp_helplinkedsrvlogin
    [ [ @rmtsrvname = ] N'rmtsrvname' ]
    [ , [ @locallogin = ] N'locallogin' ]
[ ; ]

Arguments

[ @rmtsrvname = ] N'rmtsrvname'

The name of the linked server that the login mapping applies to. @rmtsrvname is sysname, with a default of NULL. If NULL, all login mappings defined against all the linked servers defined in the local computer running [!INCLUDE ssNoVersion] are returned.

[ @locallogin = ] N'locallogin'

The [!INCLUDE ssNoVersion] login on the local server that's a mapping to the linked server @rmtsrvname. @locallogin is sysname, with a default of NULL. NULL specifies that all login mappings defined on @rmtsrvname are returned. If not NULL, a mapping for @locallogin to @rmtsrvname must already exist. @locallogin can be a [!INCLUDE ssNoVersion] login or a Windows user. The Windows user must be granted access to [!INCLUDE ssNoVersion] either directly or through its membership in a Windows group that was granted access.

Return code values

0 (success) or 1 (failure).

Result set

Column name Data type Description
Linked Server sysname Linked server name.
Local Login sysname Local login for which the mapping applies.
Is Self Mapping smallint 0 = Local Login is mapped to Remote Login when connecting to Linked Server.

1 = Local Login is mapped to the same login and password when connecting to Linked Server.
Remote Login sysname Login name on Linked Server that is mapped to Local Login when Is Self Mapping is 0. If Is Self Mapping is 1, Remote Login is NULL.

Remarks

Before you delete login mappings, use sp_helplinkedsrvlogin to determine the linked servers that are involved.

Permissions

No permissions are checked.

Examples

A. Display all login mappings for all linked servers

The following example displays all login mappings for all linked servers defined on the local computer running [!INCLUDE ssNoVersion].

EXECUTE sp_helplinkedsrvlogin;
GO

[!INCLUDE ssResult]

Linked Server    Local Login   Is Self Mapping Remote Login
---------------- ------------- --------------- --------------
Accounts         NULL          1               NULL
Sales            NULL          1               NULL
Sales            Mary          0               sa
Marketing        NULL          1               NULL

B. Display all login mappings for a linked server

The following example displays all locally defined login mappings for the Sales linked server.

EXECUTE sp_helplinkedsrvlogin 'Sales';
GO

[!INCLUDE ssResult]

Linked Server    Local Login   Is Self Mapping Remote Login
---------------- ------------- --------------- --------------
Sales            NULL          1               NULL
Sales            Mary          0               sa

C. Display all login mappings for a local login

The following example displays all locally defined login mappings for the login Mary.

EXECUTE sp_helplinkedsrvlogin NULL, 'Mary';
GO

[!INCLUDE ssResult]

Linked Server    Local Login   Is Self Mapping Remote Login
---------------- ------------- --------------- --------------
Sales            NULL          1               NULL
Sales            Mary          0               sa

Related content