Edit

Share via

sp_msx_set_account (Transact-SQL)

  • Article

Applies to: SQL Server

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

Transact-SQL syntax conventions

Syntax

sp_msx_set_account
    [ [ @credential_name = ] N'credential_name' ]
    [ , [ @credential_id = ] credential_id ]
[ ; ]

Arguments

[ @credential_name = ] N'credential_name'

The name of the credential to use to sign in to the master server. @credential_name is sysname, with a default of NULL. 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 sign in to the master server. @credential_id is int, with a default of NULL. 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 set

None.

Remarks

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

The credential specified must be an existing credential. For more information about creating a credential, see CREATE CREDENTIAL.

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 connect to the master server.

USE msdb;
GO

EXECUTE dbo.sp_msx_set_account @credential_name = MsxAccount;
GO

Related content