| title | sp_update_agent_profile (Transact-SQL) | Microsoft Docs | ||
|---|---|---|---|
| ms.custom | |||
| ms.date | 03/06/2017 | ||
| ms.prod | sql | ||
| ms.prod_service | database-engine | ||
| ms.reviewer | |||
| ms.technology | replication | ||
| ms.topic | language-reference | ||
| f1_keywords |
|
||
| helpviewer_keywords |
|
||
| ms.assetid | cc81f227-0df3-4151-bb4d-4f45ea997b71 | ||
| author | stevestein | ||
| ms.author | sstein |
[!INCLUDEtsql-appliesto-ss2008-xxxx-xxxx-xxx-md]
Updates the profile used by a replication agent. This stored procedure is executed at the Distributor on the distribution database.
Transact-SQL Syntax Conventions
sp_update_agent_profile [@agent_type=] agent_type, [ @agent_id= ] agent_id, [ @profile_id= ] profile_id
[ @agent_type = ] 'agent_type'
Is the type of agent. agent_type is int, with no default, and can be one of these values.
| Value | Description |
|---|---|
| 1 | Snapshot Agent. |
| 2 | Log Reader Agent. |
| 3 | Distribution Agent. |
| 4 | Merge Agent. |
| 9 | Queue Reader Agent. |
[ @agent_id = ] 'agent_id'
Is the ID of the agent. agent_id is int, with no default.
[ @profile_id = ] 'profile_id'
Is the ID of the profile that the agent should use. profile_id is int, with no default. To view a list of profiles defined for each agent, use sp_help_agent_profile (Transact-SQL). For more information about system profiles, see Replication Agent Profiles.
0 (success) or 1 (failure)
sp_update_agent_profile is used in all types of replication.
Only members of the sysadmin fixed server role can execute sp_update_agent_profile.
Replication Agent Profiles
sp_add_agent_profile (Transact-SQL)
sp_change_agent_profile (Transact-SQL)
sp_drop_agent_profile (Transact-SQL)
sp_help_agent_profile (Transact-SQL)
System Stored Procedures (Transact-SQL)