| title | description | author | ms.author | ms.reviewer | ms.date | ms.service | ms.subservice | ms.topic | f1_keywords | helpviewer_keywords | dev_langs | ||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
sp_add_agent_parameter (Transact-SQL) |
sp_add_agent_parameter (Transact-SQL) |
mashamsft |
mathoma |
randolphwest |
12/28/2023 |
sql |
replication |
reference |
|
|
|
[!INCLUDE SQL Server SQL MI]
Adds a new parameter and its value to an agent profile. This stored procedure is executed at the Distributor on any database.
:::image type="icon" source="../../includes/media/topic-link-icon.svg" border="false"::: Transact-SQL syntax conventions
sp_add_agent_parameter [ @profile_id = ] profile_id
, [ @parameter_name = ] 'parameter_name'
, [ @parameter_value = ] 'parameter_value'
[ ; ]
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 |
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:
- Replication Snapshot Agent
- Replication Log Reader Agent
- Replication Distribution Agent
- Replication Merge Agent
- Replication Queue Reader Agent
The value to be assigned to the parameter. @parameter_value is nvarchar(255), with no default.
0 (success) or 1 (failure).
sp_add_agent_parameter is used in snapshot replication, transactional replication, and merge replication.
Only members of the sysadmin fixed server role can execute sp_add_agent_parameter.