sp_add_agent_parameter (T-SQL)

Adds a new parameter and its value to an agent’s profile.

Syntax

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

Arguments

[@profile_id =] profile_id

Is the ID of the configuration from the MSagent_profiles table in the msdb database. 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 value to be assigned to the parameter. parameter_value is nvarchar(255), with no default.

Return Code Values

0 (success) or 1 (failure)

Remarks

sp_add_agent_parameter is used in snapshot, transactional, and merge replication.

Permissions

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

See Also