sp_add_agent_parameter (Transact-SQL)

Adds a new parameter and its value to an agent profile. This stored procedure is executed at the Distributor on any database.

Topic link iconTransact-SQL Syntax Conventions

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 profile from the MSagent_profiles table in the msdb database. profile_id is int, with no default.

    To find out what agent type this profile_id represents, find the profile_id in the MSagent_profiles (Transact-SQL) table, and note the agent_type field value. The values are as follows:

    Value

    Description

    1

    Snapshot Agent

    2

    Log Reader Agent

    3

    Distribution Agent

    4

    Merge Agent

    9

    Queue Reader Agent

  • [ **@parameter\_name=** ] 'parameter_name'
    Is the name of the parameter. parameter_name is sysname, with no default. For a list of parameters already defined in system profiles, see Replication Agent Profiles. For a complete list of valid parameters for each agent, see the following topics:

  • [ **@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 replication, transactional replication, and merge replication.

Permissions

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