sp_change_agent_parameter (T-SQL)

Changes a parameter of a replication agent profile stored in MSagent_parameters.

Syntax

sp_change_agent_parameter [@profile_id =] profile_id,
[@parameter_name =] 'parameter_name',
[@parameter_value =] 'parameter_value'

Arguments

[@profile_id =] profile_id,: Is the ID of the profile. profile_id is int, with no default.
[@parameter_name =] 'parameter_name': Is the name of the parameter. parameter_name is sysname, with no default.
[@parameter_value =] 'parameter_value': Is the new value of the parameter. parameter_value is nvarchar(255), with no default.

Return Code Values

0 (success) or 1 (failure)

Remarks

sp_change_agent_parameter is used in all types of replication.

Permissions

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