sp_update_agent_profile (Transact-SQL)

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

Topic link iconTransact-SQL Syntax Conventions

Syntax

sp_update_agent_profile [@agent_type=] agent_type, [ @agent_id= ] agent_id, [ @profile_id= ] profile_id

Arguments

  • [**@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.

Return Code Values

0 (success) or 1 (failure)

Remarks

sp_update_agent_profile is used in all types of replication.

Permissions

Only members of the sysadmin fixed server role can execute sp_update_agent_profile.