Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
sp_help_agent_parameter (Transact-SQL)
Collapse the table of content
Expand the table of content

sp_help_agent_parameter (Transact-SQL)

Applies To: SQL Server 2014, SQL Server 2016 Preview

Topic Status: Some information in this topic is preview and subject to change in future releases. Preview information describes new features or changes to existing features in Microsoft SQL Server 2016 Community Technology Preview 2 (CTP2).

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

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.

Community Additions

ADD
Show:
© 2015 Microsoft