| title | description | author | ms.author | ms.reviewer | ms.date | ms.service | ms.subservice | ms.topic | f1_keywords | helpviewer_keywords | dev_langs | ||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
sp_update_agent_profile (Transact-SQL) |
Updates the profile used by a replication agent. |
markingmyname |
maghan |
randolphwest |
08/22/2024 |
sql |
replication |
reference |
|
|
|
[!INCLUDE SQL Server]
Updates the profile used by a replication agent. This stored procedure is executed at the Distributor on the distribution database.
:::image type="icon" source="../../includes/media/topic-link-icon.svg" border="false"::: Transact-SQL syntax conventions
sp_update_agent_profile
[ @agent_type = ] agent_type
, [ @agent_id = ] agent_id
, [ @profile_id = ] profile_id
[ ; ]
@agent_type is int, with no default.
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. |
The ID of the agent. @agent_id is int, with no default.
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. 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.