sp_help_agent_parameter (Transact-SQL)


Applies To: SQL Server

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

sp_help_agent_parameter [ [ @profile_id = ] profile_id ]  

[ @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.

Column nameData typeDescription
profile_idintID of the agent profile.
parameter_namesysnameName of the parameter.
valuenvarchar(255)Value of the parameter.

0 (success) or 1 (failure)

sp_help_agent_parameter is used in all types of replication.

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

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

Community Additions