Transact-SQL Reference

sp_update_agent_profile

Updates the profile for a type of replication agent. This stored procedure is executed at the Distributor on the distribution database.

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 default configuration for the type of agent. profile_id is int, with no default.

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.

See Also

sp_add_agent_profile

sp_change_agent_profile

sp_drop_agent_profile

sp_help_agent_profile

System Stored Procedures