sp_msx_set_account (Transact-SQL)

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

Sets the SQL Server Agent master server account name and password on the target server.

Topic link icon Transact-SQL Syntax Conventions

Syntax


sp_msx_set_account [ @credential_name = ] 'credential_name'  | [ @credential_id = ] credential_id  

Arguments

[ @credential_name= ] 'credential_name'
The name of the credential to use to log in to the master server. The name provided must be the name of an existing credential. Either credential_name or credential_id must be specified.

[ @credential_id= ] credential_id
The identifier for the credential to use to log in to the master server. The identifier must be an identifier for an existing credential. Either credential_name or credential_id must be specified.

Return Code Values

0 (success) or 1 (failure)

Result Sets

None.

Remarks

SQL Server uses credentials to store the user name and password information that a target server uses to log in to a master server. This procedure sets the credential that SQL Server Agent for this target server uses to log in to the master server.

The credential specified must be an existing credential. For more information about creating a credential, see CREATE CREDENTIAL (Transact-SQL).

Permissions

Execute permissions for sp_msx_set_account default to members of the sysadmin fixed server role.

Examples

The following example sets this server to use the credential MsxAccount to log in to the master server.

USE msdb ;  
GO  

EXECUTE dbo.sp_msx_set_account @credential_name = MsxAccount ;  
GO  

See Also

SQL Server Agent Stored Procedures (Transact-SQL)
CREATE CREDENTIAL (Transact-SQL)
sp_msx_get_account (Transact-SQL)