sp_update_agent_profile (T-SQL)

Updates the profile for a type of replication agent.

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

[@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