sp_addremotelogin (Transact-SQL)
Adds a new remote login ID on the local server. This enables remote servers to connect and execute remote procedure calls.
Note
This feature will be removed in the next version of Microsoft SQL Server. Do not use this feature in new development work, and modify applications that currently use this feature as soon as possible. Use linked servers and linked server stored procedures instead.
.gif "Topic link icon")
Transact-SQL Syntax Conventions
Syntax
sp_addremotelogin [ @remoteserver = ] 'remoteserver'
[ , [ @loginame = ] 'login' ]
[ , [ @remotename = ] 'remote_name' ]
Arguments
- [ @remoteserver = ] 'remoteserver'
Is the name of the remote server that the remote login applies to. remoteserver is sysname, with no default. If only remoteserver is specified, all users on remoteserver are mapped to existing logins of the same name on the local server. The server must be known to the local server. This is added by using sp_addserver. When users on remoteserver connect to the local server that is running SQL Server to execute a remote stored procedure, they connect as the local login that matches their own login on remoteserver. remoteserver is the server that initiates the remote procedure call.
- [ @loginame = ] 'login'
Is the login ID of the user on the local instance of SQL Server. login is sysname, with a default of NULL. loginmust already exist on the local instance of SQL Server. If login is specified, all users on remoteserver are mapped to that specific local login. When users on remoteserver connect to the local instance of SQL Server to execute a remote stored procedure, they connect as login.
- [ @remotename = ] 'remote_name'
Is the login ID of the user on the remote server. remote_name is sysname, with a default of NULL. remote_name must exist on remoteserver. If remote_name is specified, the specific user remote_name is mapped to login on the local server. When remote_name on remoteserver connects to the local instance of SQL Server to execute a remote stored procedure, it connects as login. The login ID of remote_name can be different from the login ID on the remote server, login.
Return Code Values
0 (success) or 1 (failure)
Remarks
To execute distributed queries, use sp_addlinkedsrvlogin.
sp_addremotelogin cannot be used inside a user-defined transaction.
Permissions
Only members of the sysadmin and securityadmin fixed server roles can execute sp_addremotelogin.
Examples
A. Mapping one to one
The following example maps remote names to local names when the remote server ACCOUNTS and local server have the same user logins.
EXEC sp_addremotelogin 'ACCOUNTS';
B. Mapping many to one
The following example creates an entry that maps all users from the remote server ACCOUNTS to the local login ID Albert.
EXEC sp_addremotelogin 'ACCOUNTS', 'Albert';
C. Using explicit one-to-one mapping
The following example maps a remote login from the remote user Chris on the remote server ACCOUNTS to the local user salesmgr.
EXEC sp_addremotelogin 'ACCOUNTS', 'salesmgr', 'Chris';
See Also
Reference
sp_addlinkedsrvlogin (Transact-SQL)
sp_addlogin (Transact-SQL)
sp_addserver (Transact-SQL)
sp_dropremotelogin (Transact-SQL)
sp_grantlogin (Transact-SQL)
sp_helpremotelogin (Transact-SQL)
sp_helpserver (Transact-SQL)
sp_remoteoption (Transact-SQL)
sp_revokelogin (Transact-SQL)
System Stored Procedures (Transact-SQL)