sp_update_agent_profile (Transact-SQL)
Collapse the table of content
Expand the table of content

sp_update_agent_profile (Transact-SQL)

Applies To: SQL Server 2014, SQL Server 2016 Preview

Topic Status: Some information in this topic is preview and subject to change in future releases. Preview information describes new features or changes to existing features in Microsoft SQL Server 2016 Community Technology Preview 2 (CTP2).

Updates the profile used by a replication agent. This stored procedure is executed at the Distributor on the distribution database.

Topic link icon 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.




Snapshot Agent.


Log Reader Agent.


Distribution Agent.


Merge Agent.


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.

Community Additions

© 2016 Microsoft