sp_getagentparameterlist (Transact-SQL)

Applies to: SQL Server

Returns a list of all replication agent parameters that can be set in an agent profile for the specified agent type. This stored procedure is executed at the Distributor where the agent is running, on any database.

Transact-SQL syntax conventions

Syntax

sp_getagentparameterlist [ @agent_type = ] agent_type
[ ; ]

Arguments

[ @agent_type = ] agent_type

The replication agent for which the parameter is being added. @agent_type is int, and can be one of these values:

Value	Agent
1	Snapshot
2	Log Reader
3	Distribution
4	Merge
9	Queue Reader

Return code values

0 (success) or 1 (failure).

Remarks

Permissions

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

Related content

• sp_add_agent_parameter (Transact-SQL)
• sp_add_agent_profile (Transact-SQL)
• sp_drop_agent_parameter (Transact-SQL)
• sp_help_agent_parameter (Transact-SQL)
• Replication Agent Profiles
• System stored procedures (Transact-SQL)