sp_help_agent_parameter (Transact-SQL)

THIS TOPIC APPLIES TO:yesSQL Server (starting with 2008)noAzure SQL DatabasenoAzure SQL Data Warehouse noParallel Data Warehouse

Returns all the parameters of a profile from the MSagent_parameters (Transact-SQL) system table. This stored procedure is executed at the Distributor where the agent is running, on any database.

Topic link icon Transact-SQL Syntax Conventions

Syntax


sp_help_agent_parameter [ [ @profile_id = ] profile_id ]  

Arguments

[ @profile_id=] profile_id
Is the ID of the profile from the MSagent_parameters (Transact-SQL) table. profile_id is int, with a default of -1, which returns all parameters.

Result Sets

Column name Data type Description
profile_id int ID of the agent profile.
parameter_name sysname Name of the parameter.
value nvarchar(255) Value of the parameter.

Return Code Values

0 (success) or 1 (failure)

Remarks

sp_help_agent_parameter is used in all types of replication.

Permissions

Only members of the sysadmin fixed server role or the replmonitor fixed database role can execute sp_help_agent_parameter.

See Also

Work with Replication Agent Profiles
sp_add_agent_parameter (Transact-SQL)
sp_drop_agent_parameter (Transact-SQL)
System Stored Procedures (Transact-SQL)