sp-help-agent-parameter-transact-sql.md

title	sp_help_agent_parameter (Transact-SQL) | Microsoft Docs
ms.custom
ms.date	03/06/2017
ms.prod	sql-server-2016
ms.reviewer
ms.suite
ms.technology	replication
ms.tgt_pltfrm
ms.topic	language-reference
applies_to	SQL Server
f1_keywords	sp_help_agent_parameter sp_help_agent_parameter_TSQL
helpviewer_keywords	sp_help_agent_parameter
ms.assetid	8fb4a9c3-19af-4a34-8004-572729ba3d15
caps.latest.revision	29
author	BYHAM
ms.author	rickbyh
manager	jhubbard

sp_help_agent_parameter (Transact-SQL)

[!INCLUDEtsql-appliesto-ss2008-xxxx-xxxx-xxx_md]

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.

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)